blob: c9b9a1a89238b5ec75f1e73f750edc2a8c35d5e1 [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.
Bjorn Bringert964e7d22013-03-12 19:35:57 +00001167 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001168 */
1169 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1170 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1171
1172 /**
Bjorn Bringert964e7d22013-03-12 19:35:57 +00001173 * An optional field on {@link #ACTION_ASSIST}
Bjorn Bringertbc086862013-03-01 12:59:24 +00001174 * containing the name of the current foreground application package at the time
1175 * the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001176 */
1177 public static final String EXTRA_ASSIST_PACKAGE
1178 = "android.intent.extra.ASSIST_PACKAGE";
1179
1180 /**
Bjorn Bringert964e7d22013-03-12 19:35:57 +00001181 * An optional field on {@link #ACTION_ASSIST}
Bjorn Bringertbc086862013-03-01 12:59:24 +00001182 * containing additional contextual information supplied by the current
1183 * foreground app at the time of the assist request. This is a {@link Bundle} of
1184 * additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001185 */
1186 public static final String EXTRA_ASSIST_CONTEXT
1187 = "android.intent.extra.ASSIST_CONTEXT";
1188
Jim Miller07994402012-05-02 14:22:27 -07001189 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001190 * Activity Action: List all available applications
1191 * <p>Input: Nothing.
1192 * <p>Output: nothing.
1193 */
1194 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1195 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1196 /**
1197 * Activity Action: Show settings for choosing wallpaper
1198 * <p>Input: Nothing.
1199 * <p>Output: Nothing.
1200 */
1201 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1202 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1203
1204 /**
1205 * Activity Action: Show activity for reporting a bug.
1206 * <p>Input: Nothing.
1207 * <p>Output: Nothing.
1208 */
1209 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1210 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1211
1212 /**
1213 * Activity Action: Main entry point for factory tests. Only used when
1214 * the device is booting in factory test node. The implementing package
1215 * must be installed in the system image.
1216 * <p>Input: nothing
1217 * <p>Output: nothing
1218 */
1219 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1220
1221 /**
1222 * Activity Action: The user pressed the "call" button to go to the dialer
1223 * or other appropriate UI for placing a call.
1224 * <p>Input: Nothing.
1225 * <p>Output: Nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1229
1230 /**
1231 * Activity Action: Start Voice Command.
1232 * <p>Input: Nothing.
1233 * <p>Output: Nothing.
1234 */
1235 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1236 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001237
1238 /**
1239 * Activity Action: Start action associated with long pressing on the
1240 * search key.
1241 * <p>Input: Nothing.
1242 * <p>Output: Nothing.
1243 */
1244 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1245 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001246
Jacek Surazski86b6c532009-05-13 14:38:28 +02001247 /**
1248 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1249 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001250 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001251 * <p>Input: No data is specified. The bug report is passed in using
1252 * an {@link #EXTRA_BUG_REPORT} field.
1253 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001254 *
1255 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001256 */
1257 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1258 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001259
1260 /**
1261 * Activity Action: Show power usage information to the user.
1262 * <p>Input: Nothing.
1263 * <p>Output: Nothing.
1264 */
1265 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1266 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001267
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001268 /**
1269 * Activity Action: Setup wizard to launch after a platform update. This
1270 * activity should have a string meta-data field associated with it,
1271 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1272 * the platform for setup. The activity will be launched only if
1273 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1274 * same value.
1275 * <p>Input: Nothing.
1276 * <p>Output: Nothing.
1277 * @hide
1278 */
1279 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1280 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001281
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001282 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001283 * Activity Action: Show settings for managing network data usage of a
1284 * specific application. Applications should define an activity that offers
1285 * options to control data usage.
1286 */
1287 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1288 public static final String ACTION_MANAGE_NETWORK_USAGE =
1289 "android.intent.action.MANAGE_NETWORK_USAGE";
1290
1291 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001292 * Activity Action: Launch application installer.
1293 * <p>
1294 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001295 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1296 * you can also use "package:<package-name>" to install an application for the
1297 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001298 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1299 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1300 * <p>
1301 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1302 * succeeded.
1303 *
1304 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1305 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1306 * @see #EXTRA_RETURN_RESULT
1307 */
1308 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1309 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1310
1311 /**
1312 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1313 * package. Specifies the installer package name; this package will receive the
1314 * {@link #ACTION_APP_ERROR} intent.
1315 */
1316 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1317 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1318
1319 /**
1320 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1321 * package. Specifies that the application being installed should not be
1322 * treated as coming from an unknown source, but as coming from the app
1323 * invoking the Intent. For this to work you must start the installer with
1324 * startActivityForResult().
1325 */
1326 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1327 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1328
1329 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001330 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1331 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001332 * data field originated from.
1333 */
rich cannings706e8ba2012-08-20 13:20:14 -07001334 public static final String EXTRA_ORIGINATING_URI
1335 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001336
1337 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001338 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1339 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1340 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001341 */
1342 public static final String EXTRA_REFERRER
1343 = "android.intent.extra.REFERRER";
1344
1345 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001346 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1347 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1348 * @hide
1349 */
1350 public static final String EXTRA_ORIGINATING_UID
1351 = "android.intent.extra.ORIGINATING_UID";
1352
1353 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001354 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1355 * package. Tells the installer UI to skip the confirmation with the user
1356 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001357 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1358 * will no longer show an interstitial message about updating existing
1359 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001360 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001361 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001362 public static final String EXTRA_ALLOW_REPLACE
1363 = "android.intent.extra.ALLOW_REPLACE";
1364
1365 /**
1366 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1367 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1368 * return to the application the result code of the install/uninstall. The returned result
1369 * code will be {@link android.app.Activity#RESULT_OK} on success or
1370 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1371 */
1372 public static final String EXTRA_RETURN_RESULT
1373 = "android.intent.extra.RETURN_RESULT";
1374
1375 /**
1376 * Package manager install result code. @hide because result codes are not
1377 * yet ready to be exposed.
1378 */
1379 public static final String EXTRA_INSTALL_RESULT
1380 = "android.intent.extra.INSTALL_RESULT";
1381
1382 /**
1383 * Activity Action: Launch application uninstaller.
1384 * <p>
1385 * Input: The data must be a package: URI whose scheme specific part is
1386 * the package name of the current installed package to be uninstalled.
1387 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1388 * <p>
1389 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1390 * succeeded.
1391 */
1392 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1393 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1394
1395 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001396 * Specify whether the package should be uninstalled for all users.
1397 * @hide because these should not be part of normal application flow.
1398 */
1399 public static final String EXTRA_UNINSTALL_ALL_USERS
1400 = "android.intent.extra.UNINSTALL_ALL_USERS";
1401
1402 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001403 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1404 * describing the last run version of the platform that was setup.
1405 * @hide
1406 */
1407 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1408
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001409 // ---------------------------------------------------------------------
1410 // ---------------------------------------------------------------------
1411 // Standard intent broadcast actions (see action variable).
1412
1413 /**
1414 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001415 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001416 * <p class="note">This is a protected intent that can only be sent
1417 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001418 */
1419 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1420 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1421 /**
1422 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001423 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001424 * <p class="note">This is a protected intent that can only be sent
1425 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001426 */
1427 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1428 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001429
1430 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001431 * Broadcast Action: Sent after the system stops dreaming.
1432 *
1433 * <p class="note">This is a protected intent that can only be sent by the system.
1434 * It is only sent to registered receivers.</p>
1435 */
1436 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1437 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1438
1439 /**
1440 * Broadcast Action: Sent after the system starts dreaming.
1441 *
1442 * <p class="note">This is a protected intent that can only be sent by the system.
1443 * It is only sent to registered receivers.</p>
1444 */
1445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1446 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1447
1448 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001449 * Broadcast Action: Sent when the user is present after device wakes up (e.g when the
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001450 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001451 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001452 * <p class="note">This is a protected intent that can only be sent
1453 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001454 */
1455 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001456 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001457
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001458 /**
1459 * Broadcast Action: The current time has changed. Sent every
1460 * minute. You can <em>not</em> receive this through components declared
1461 * in manifests, only by exlicitly registering for it with
1462 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1463 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001464 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001465 * <p class="note">This is a protected intent that can only be sent
1466 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001467 */
1468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1469 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1470 /**
1471 * Broadcast Action: The time was set.
1472 */
1473 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1474 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1475 /**
1476 * Broadcast Action: The date has changed.
1477 */
1478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1479 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1480 /**
1481 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1482 * <ul>
1483 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1484 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001485 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001486 * <p class="note">This is a protected intent that can only be sent
1487 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001488 */
1489 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1490 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1491 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001492 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1493 * DNS entries should be tossed.
1494 * @hide
1495 */
1496 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1497 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1498 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001499 * Alarm Changed Action: This is broadcast when the AlarmClock
1500 * application's alarm is set or unset. It is used by the
1501 * AlarmClock application and the StatusBar service.
1502 * @hide
1503 */
1504 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1505 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1506 /**
1507 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1508 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1509 * @hide
1510 */
1511 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1512 public static final String ACTION_SYNC_STATE_CHANGED
1513 = "android.intent.action.SYNC_STATE_CHANGED";
1514 /**
1515 * Broadcast Action: This is broadcast once, after the system has finished
1516 * booting. It can be used to perform application-specific initialization,
1517 * such as installing alarms. You must hold the
1518 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1519 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001520 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001521 * <p class="note">This is a protected intent that can only be sent
1522 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001523 */
1524 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1525 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1526 /**
1527 * Broadcast Action: This is broadcast when a user action should request a
1528 * temporary system dialog to dismiss. Some examples of temporary system
1529 * dialogs are the notification window-shade and the recent tasks dialog.
1530 */
1531 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1532 /**
1533 * Broadcast Action: Trigger the download and eventual installation
1534 * of a package.
1535 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001536 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001537 * <p class="note">This is a protected intent that can only be sent
1538 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001539 *
1540 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001541 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001542 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001543 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1544 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1545 /**
1546 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001547 * device. The data contains the name of the package. Note that the
1548 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001549 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001550 * <ul>
1551 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1552 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1553 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1554 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001555 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001556 * <p class="note">This is a protected intent that can only be sent
1557 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001558 */
1559 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1560 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1561 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001562 * Broadcast Action: A new version of an application package has been
1563 * installed, replacing an existing version that was previously installed.
1564 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001565 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001566 * <ul>
1567 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1568 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001569 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001570 * <p class="note">This is a protected intent that can only be sent
1571 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001572 */
1573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1574 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1575 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001576 * Broadcast Action: A new version of your application has been installed
1577 * over an existing one. This is only sent to the application that was
1578 * replaced. It does not contain any additional data; to receive it, just
1579 * use an intent filter for this action.
1580 *
1581 * <p class="note">This is a protected intent that can only be sent
1582 * by the system.
1583 */
1584 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1585 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1586 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001587 * Broadcast Action: An existing application package has been removed from
1588 * the device. The data contains the name of the package. The package
1589 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001590 * <ul>
1591 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1592 * to the package.
1593 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1594 * application -- data and code -- is being removed.
1595 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1596 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1597 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001598 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001599 * <p class="note">This is a protected intent that can only be sent
1600 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001601 */
1602 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1603 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1604 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001605 * Broadcast Action: An existing application package has been completely
1606 * removed from the device. The data contains the name of the package.
1607 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1608 * {@link #EXTRA_DATA_REMOVED} is true and
1609 * {@link #EXTRA_REPLACING} is false of that broadcast.
1610 *
1611 * <ul>
1612 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1613 * to the package.
1614 * </ul>
1615 *
1616 * <p class="note">This is a protected intent that can only be sent
1617 * by the system.
1618 */
1619 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1620 public static final String ACTION_PACKAGE_FULLY_REMOVED
1621 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1622 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001623 * Broadcast Action: An existing application package has been changed (e.g.
1624 * a component has been enabled or disabled). The data contains the name of
1625 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001626 * <ul>
1627 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001628 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001629 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001630 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1631 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001632 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001633 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001634 * <p class="note">This is a protected intent that can only be sent
1635 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001636 */
1637 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1638 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1639 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001640 * @hide
1641 * Broadcast Action: Ask system services if there is any reason to
1642 * restart the given package. The data contains the name of the
1643 * package.
1644 * <ul>
1645 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1646 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1647 * </ul>
1648 *
1649 * <p class="note">This is a protected intent that can only be sent
1650 * by the system.
1651 */
1652 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1653 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1654 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001655 * Broadcast Action: The user has restarted a package, and all of its
1656 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001657 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001658 * be removed. Note that the restarted package does <em>not</em>
1659 * receive this broadcast.
1660 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001661 * <ul>
1662 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1663 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001664 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001665 * <p class="note">This is a protected intent that can only be sent
1666 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001667 */
1668 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1669 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1670 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001671 * Broadcast Action: The user has cleared the data of a package. This should
1672 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001673 * its persistent data is erased and this broadcast sent.
1674 * Note that the cleared package does <em>not</em>
1675 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001676 * <ul>
1677 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1678 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001679 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001680 * <p class="note">This is a protected intent that can only be sent
1681 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001682 */
1683 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1684 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1685 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001686 * Broadcast Action: A user ID has been removed from the system. The user
1687 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001688 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001689 * <p class="note">This is a protected intent that can only be sent
1690 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001691 */
1692 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1693 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001694
1695 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001696 * Broadcast Action: Sent to the installer package of an application
1697 * when that application is first launched (that is the first time it
1698 * is moved out of the stopped state). The data contains the name of the package.
1699 *
1700 * <p class="note">This is a protected intent that can only be sent
1701 * by the system.
1702 */
1703 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1704 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1705
1706 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001707 * Broadcast Action: Sent to the system package verifier when a package
1708 * needs to be verified. The data contains the package URI.
1709 * <p class="note">
1710 * This is a protected intent that can only be sent by the system.
1711 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001712 */
1713 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1714 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1715
1716 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001717 * Broadcast Action: Sent to the system package verifier when a package is
1718 * verified. The data contains the package URI.
1719 * <p class="note">
1720 * This is a protected intent that can only be sent by the system.
1721 */
1722 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1723 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1724
1725 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001726 * Broadcast Action: Resources for a set of packages (which were
1727 * previously unavailable) are currently
1728 * available since the media on which they exist is available.
1729 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1730 * list of packages whose availability changed.
1731 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1732 * list of uids of packages whose availability changed.
1733 * Note that the
1734 * packages in this list do <em>not</em> receive this broadcast.
1735 * The specified set of packages are now available on the system.
1736 * <p>Includes the following extras:
1737 * <ul>
1738 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1739 * whose resources(were previously unavailable) are currently available.
1740 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1741 * packages whose resources(were previously unavailable)
1742 * are currently available.
1743 * </ul>
1744 *
1745 * <p class="note">This is a protected intent that can only be sent
1746 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001747 */
1748 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001749 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1750 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001751
1752 /**
1753 * Broadcast Action: Resources for a set of packages are currently
1754 * unavailable since the media on which they exist is unavailable.
1755 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1756 * list of packages whose availability changed.
1757 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1758 * list of uids of packages whose availability changed.
1759 * The specified set of packages can no longer be
1760 * launched and are practically unavailable on the system.
1761 * <p>Inclues the following extras:
1762 * <ul>
1763 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1764 * whose resources are no longer available.
1765 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1766 * whose resources are no longer available.
1767 * </ul>
1768 *
1769 * <p class="note">This is a protected intent that can only be sent
1770 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001771 */
1772 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001773 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001774 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001775
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001776 /**
1777 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001778 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001779 * This should <em>only</em> be used to determine when the wallpaper
1780 * has changed to show the new wallpaper to the user. You should certainly
1781 * never, in response to this, change the wallpaper or other attributes of
1782 * it such as the suggested size. That would be crazy, right? You'd cause
1783 * all kinds of loops, especially if other apps are doing similar things,
1784 * right? Of course. So please don't do this.
1785 *
1786 * @deprecated Modern applications should use
1787 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1788 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1789 * shown behind their UI, rather than watching for this broadcast and
1790 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001791 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001792 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001793 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1794 /**
1795 * Broadcast Action: The current device {@link android.content.res.Configuration}
1796 * (orientation, locale, etc) has changed. When such a change happens, the
1797 * UIs (view hierarchy) will need to be rebuilt based on this new
1798 * information; for the most part, applications don't need to worry about
1799 * this, because the system will take care of stopping and restarting the
1800 * application to make sure it sees the new changes. Some system code that
1801 * can not be restarted will need to watch for this action and handle it
1802 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001803 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001804 * <p class="note">
1805 * You can <em>not</em> receive this through components declared
1806 * in manifests, only by explicitly registering for it with
1807 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1808 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001809 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001810 * <p class="note">This is a protected intent that can only be sent
1811 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001812 *
1813 * @see android.content.res.Configuration
1814 */
1815 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1816 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1817 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001818 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001819 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001820 * <p class="note">This is a protected intent that can only be sent
1821 * by the system.
1822 */
1823 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1824 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1825 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001826 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1827 * charging state, level, and other information about the battery.
1828 * See {@link android.os.BatteryManager} for documentation on the
1829 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001830 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001831 * <p class="note">
1832 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001833 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001834 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001835 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1836 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1837 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1838 * broadcasts that are sent and can be received through manifest
1839 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001840 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001841 * <p class="note">This is a protected intent that can only be sent
1842 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001843 */
1844 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1845 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1846 /**
1847 * Broadcast Action: Indicates low battery condition on the device.
1848 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001849 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001850 * <p class="note">This is a protected intent that can only be sent
1851 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001852 */
1853 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1854 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1855 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001856 * Broadcast Action: Indicates the battery is now okay after being low.
1857 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1858 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001859 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001860 * <p class="note">This is a protected intent that can only be sent
1861 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001862 */
1863 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1864 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1865 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001866 * Broadcast Action: External power has been connected to the device.
1867 * This is intended for applications that wish to register specifically to this notification.
1868 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1869 * stay active to receive this notification. This action can be used to implement actions
1870 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001871 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001872 * <p class="note">This is a protected intent that can only be sent
1873 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001874 */
1875 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001876 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001877 /**
1878 * Broadcast Action: External power has been removed from the device.
1879 * This is intended for applications that wish to register specifically to this notification.
1880 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1881 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001882 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001883 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001884 * <p class="note">This is a protected intent that can only be sent
1885 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001886 */
1887 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001888 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001889 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001890 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001891 * Broadcast Action: Device is shutting down.
1892 * This is broadcast when the device is being shut down (completely turned
1893 * off, not sleeping). Once the broadcast is complete, the final shutdown
1894 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001895 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001896 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001897 * <p class="note">This is a protected intent that can only be sent
1898 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001899 */
1900 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001901 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001902 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001903 * Activity Action: Start this activity to request system shutdown.
1904 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1905 * to request confirmation from the user before shutting down.
1906 *
1907 * <p class="note">This is a protected intent that can only be sent
1908 * by the system.
1909 *
1910 * {@hide}
1911 */
1912 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1913 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001914 * Broadcast Action: A sticky broadcast that indicates low memory
1915 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001916 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001917 * <p class="note">This is a protected intent that can only be sent
1918 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001919 */
1920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1921 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1922 /**
1923 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001924 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001925 * <p class="note">This is a protected intent that can only be sent
1926 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001927 */
1928 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1929 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1930 /**
Jake Hambybb371632010-08-23 18:16:48 -07001931 * Broadcast Action: A sticky broadcast that indicates a memory full
1932 * condition on the device. This is intended for activities that want
1933 * to be able to fill the data partition completely, leaving only
1934 * enough free space to prevent system-wide SQLite failures.
1935 *
1936 * <p class="note">This is a protected intent that can only be sent
1937 * by the system.
1938 *
1939 * {@hide}
1940 */
1941 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1942 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1943 /**
1944 * Broadcast Action: Indicates memory full condition on the device
1945 * no longer exists.
1946 *
1947 * <p class="note">This is a protected intent that can only be sent
1948 * by the system.
1949 *
1950 * {@hide}
1951 */
1952 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1953 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1954 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001955 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1956 * and package management should be started.
1957 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1958 * notification.
1959 */
1960 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1961 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1962 /**
1963 * Broadcast Action: The device has entered USB Mass Storage mode.
1964 * This is used mainly for the USB Settings panel.
1965 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1966 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001967 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001968 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001969 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001970 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1971
1972 /**
1973 * Broadcast Action: The device has exited USB Mass Storage mode.
1974 * This is used mainly for the USB Settings panel.
1975 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1976 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001977 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001978 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001979 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001980 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1981
1982 /**
1983 * Broadcast Action: External media has been removed.
1984 * The path to the mount point for the removed media is contained in the Intent.mData field.
1985 */
1986 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1987 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1988
1989 /**
1990 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001991 * The path to the mount point for the unmounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001992 */
1993 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1994 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1995
1996 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001997 * Broadcast Action: External media is present, and being disk-checked
1998 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2002
2003 /**
2004 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2005 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002006 */
2007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2008 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2009
2010 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002011 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002012 * The path to the mount point for the mounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002013 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2014 * media was mounted read only.
2015 */
2016 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2017 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2018
2019 /**
2020 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002021 * The path to the mount point for the shared media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002022 */
2023 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2024 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2025
2026 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002027 * Broadcast Action: External media is no longer being shared via USB mass storage.
2028 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2029 *
2030 * @hide
2031 */
2032 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2033
2034 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002035 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2036 * The path to the mount point for the removed media is contained in the Intent.mData field.
2037 */
2038 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2039 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2040
2041 /**
2042 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002043 * The path to the mount point for the unmountable media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002044 */
2045 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2046 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2047
2048 /**
2049 * Broadcast Action: User has expressed the desire to remove the external storage media.
2050 * Applications should close all files they have open within the mount point when they receive this intent.
2051 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2052 */
2053 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2054 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2055
2056 /**
2057 * Broadcast Action: The media scanner has started scanning a directory.
2058 * The path to the directory being scanned is contained in the Intent.mData field.
2059 */
2060 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2061 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2062
2063 /**
2064 * Broadcast Action: The media scanner has finished scanning a directory.
2065 * The path to the scanned directory is contained in the Intent.mData field.
2066 */
2067 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2068 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2069
2070 /**
2071 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2072 * The path to the file is contained in the Intent.mData field.
2073 */
2074 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2075 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2076
2077 /**
2078 * Broadcast Action: The "Media Button" was pressed. Includes a single
2079 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2080 * caused the broadcast.
2081 */
2082 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2083 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2084
2085 /**
2086 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2087 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2088 * caused the broadcast.
2089 */
2090 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2091 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2092
2093 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2094 // location; they are not general-purpose actions.
2095
2096 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002097 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002098 */
2099 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2100 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2101 "android.intent.action.GTALK_CONNECTED";
2102
2103 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002104 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002105 */
2106 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2107 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2108 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002109
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002110 /**
2111 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002112 */
2113 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2114 public static final String ACTION_INPUT_METHOD_CHANGED =
2115 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002116
2117 /**
2118 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2119 * more radios have been turned off or on. The intent will have the following extra value:</p>
2120 * <ul>
2121 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2122 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2123 * turned off</li>
2124 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002125 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002126 * <p class="note">This is a protected intent that can only be sent
2127 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002128 */
2129 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2130 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2131
2132 /**
2133 * Broadcast Action: Some content providers have parts of their namespace
2134 * where they publish new events or items that the user may be especially
2135 * interested in. For these things, they may broadcast this action when the
2136 * set of interesting items change.
2137 *
2138 * For example, GmailProvider sends this notification when the set of unread
2139 * mail in the inbox changes.
2140 *
2141 * <p>The data of the intent identifies which part of which provider
2142 * changed. When queried through the content resolver, the data URI will
2143 * return the data set in question.
2144 *
2145 * <p>The intent will have the following extra values:
2146 * <ul>
2147 * <li><em>count</em> - The number of items in the data set. This is the
2148 * same as the number of items in the cursor returned by querying the
2149 * data URI. </li>
2150 * </ul>
2151 *
2152 * This intent will be sent at boot (if the count is non-zero) and when the
2153 * data set changes. It is possible for the data set to change without the
2154 * count changing (for example, if a new unread message arrives in the same
2155 * sync operation in which a message is archived). The phone should still
2156 * ring/vibrate/etc as normal in this case.
2157 */
2158 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2159 public static final String ACTION_PROVIDER_CHANGED =
2160 "android.intent.action.PROVIDER_CHANGED";
2161
2162 /**
2163 * Broadcast Action: Wired Headset plugged in or unplugged.
2164 *
2165 * <p>The intent will have the following extra values:
2166 * <ul>
2167 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2168 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002169 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002170 * </ul>
2171 * </ul>
2172 */
2173 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2174 public static final String ACTION_HEADSET_PLUG =
2175 "android.intent.action.HEADSET_PLUG";
2176
2177 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002178 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2179 *
2180 * <p>The intent will have the following extra values:
2181 * <ul>
2182 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2183 * <li><em>name</em> - Headset type, human readable string </li>
2184 * </ul>
2185 * </ul>
2186 * @hide
2187 */
2188 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002189 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2190 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002191
2192 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002193 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002194 *
2195 * <p>The intent will have the following extra values:
2196 * <ul>
2197 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2198 * <li><em>name</em> - Headset type, human readable string </li>
2199 * </ul>
2200 * </ul>
2201 * @hide
2202 */
2203 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002204 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2205 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002206
2207 /**
2208 * Broadcast Action: A HMDI cable was plugged or unplugged
2209 *
2210 * <p>The intent will have the following extra values:
2211 * <ul>
2212 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2213 * <li><em>name</em> - HDMI cable, human readable string </li>
2214 * </ul>
2215 * </ul>
2216 * @hide
2217 */
2218 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2219 public static final String ACTION_HDMI_AUDIO_PLUG =
2220 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002221
2222 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002223 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2224 *
2225 * <p>The intent will have the following extra values:
2226 * <ul>
2227 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2228 * <li><em>card</em> - ALSA card number (integer) </li>
2229 * <li><em>device</em> - ALSA device number (integer) </li>
2230 * </ul>
2231 * </ul>
2232 * @hide
2233 */
2234 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2235 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2236 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2237
2238 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002239 * Broadcast Action: A USB audio device was plugged in or unplugged.
2240 *
2241 * <p>The intent will have the following extra values:
2242 * <ul>
2243 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2244 * <li><em>card</em> - ALSA card number (integer) </li>
2245 * <li><em>device</em> - ALSA device number (integer) </li>
2246 * </ul>
2247 * </ul>
2248 * @hide
2249 */
2250 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2251 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2252 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2253
2254 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002255 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2256 * <ul>
2257 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2258 * </ul>
2259 *
2260 * <p class="note">This is a protected intent that can only be sent
2261 * by the system.
2262 *
2263 * @hide
2264 */
2265 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2266 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2267 = "android.intent.action.ADVANCED_SETTINGS";
2268
2269 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002270 * Broadcast Action: An outgoing call is about to be placed.
2271 *
2272 * <p>The Intent will have the following extra value:
2273 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002274 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002275 * the phone number originally intended to be dialed.</li>
2276 * </ul>
2277 * <p>Once the broadcast is finished, the resultData is used as the actual
2278 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002279 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002280 * outgoing call in turn: for example, a parental control application
2281 * might verify that the user is authorized to place the call at that
2282 * time, then a number-rewriting application might add an area code if
2283 * one was not specified.</p>
2284 * <p>For consistency, any receiver whose purpose is to prohibit phone
2285 * calls should have a priority of 0, to ensure it will see the final
2286 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002287 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002288 * should have a positive priority.
2289 * Negative priorities are reserved for the system for this broadcast;
2290 * using them may cause problems.</p>
2291 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2292 * abort the broadcast.</p>
2293 * <p>Emergency calls cannot be intercepted using this mechanism, and
2294 * other calls cannot be modified to call emergency numbers using this
2295 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002296 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002297 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2298 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002299 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002300 * <p class="note">This is a protected intent that can only be sent
2301 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002302 */
2303 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2304 public static final String ACTION_NEW_OUTGOING_CALL =
2305 "android.intent.action.NEW_OUTGOING_CALL";
2306
2307 /**
2308 * Broadcast Action: Have the device reboot. This is only for use by
2309 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002310 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002311 * <p class="note">This is a protected intent that can only be sent
2312 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002313 */
2314 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2315 public static final String ACTION_REBOOT =
2316 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002317
Wei Huang97ecc9c2009-05-11 17:44:20 -07002318 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002319 * Broadcast Action: A sticky broadcast for changes in the physical
2320 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002321 *
2322 * <p>The intent will have the following extra values:
2323 * <ul>
2324 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002325 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002326 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002327 * <p>This is intended for monitoring the current physical dock state.
2328 * See {@link android.app.UiModeManager} for the normal API dealing with
2329 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002330 */
2331 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2332 public static final String ACTION_DOCK_EVENT =
2333 "android.intent.action.DOCK_EVENT";
2334
2335 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002336 * Broadcast Action: A broadcast when idle maintenance can be started.
2337 * This means that the user is not interacting with the device and is
2338 * not expected to do so soon. Typical use of the idle maintenance is
2339 * to perform somehow expensive tasks that can be postponed at a moment
2340 * when they will not degrade user experience.
2341 * <p>
2342 * <p class="note">In order to keep the device responsive in case of an
2343 * unexpected user interaction, implementations of a maintenance task
2344 * should be interruptible. In such a scenario a broadcast with action
2345 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2346 * should not do the maintenance work in
2347 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2348 * maintenance service by {@link Context#startService(Intent)}. Also
2349 * you should hold a wake lock while your maintenance service is running
2350 * to prevent the device going to sleep.
2351 * </p>
2352 * <p>
2353 * <p class="note">This is a protected intent that can only be sent by
2354 * the system.
2355 * </p>
2356 *
2357 * @see #ACTION_IDLE_MAINTENANCE_END
2358 */
2359 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2360 public static final String ACTION_IDLE_MAINTENANCE_START =
2361 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2362
2363 /**
2364 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2365 * This means that the user was not interacting with the device as a result
2366 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2367 * was sent and now the user started interacting with the device. Typical
2368 * use of the idle maintenance is to perform somehow expensive tasks that
2369 * can be postponed at a moment when they will not degrade user experience.
2370 * <p>
2371 * <p class="note">In order to keep the device responsive in case of an
2372 * unexpected user interaction, implementations of a maintenance task
2373 * should be interruptible. Hence, on receiving a broadcast with this
2374 * action, the maintenance task should be interrupted as soon as possible.
2375 * In other words, you should not do the maintenance work in
2376 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2377 * maintenance service that was started on receiving of
2378 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2379 * lock you acquired when your maintenance service started.
2380 * </p>
2381 * <p class="note">This is a protected intent that can only be sent
2382 * by the system.
2383 *
2384 * @see #ACTION_IDLE_MAINTENANCE_START
2385 */
2386 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2387 public static final String ACTION_IDLE_MAINTENANCE_END =
2388 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2389
2390 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002391 * Broadcast Action: a remote intent is to be broadcasted.
2392 *
2393 * A remote intent is used for remote RPC between devices. The remote intent
2394 * is serialized and sent from one device to another device. The receiving
2395 * device parses the remote intent and broadcasts it. Note that anyone can
2396 * broadcast a remote intent. However, if the intent receiver of the remote intent
2397 * does not trust intent broadcasts from arbitrary intent senders, it should require
2398 * the sender to hold certain permissions so only trusted sender's broadcast will be
2399 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002400 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002401 */
2402 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002403 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002404
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002405 /**
2406 * Broadcast Action: hook for permforming cleanup after a system update.
2407 *
2408 * The broadcast is sent when the system is booting, before the
2409 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2410 * image. A receiver for this should do its work and then disable itself
2411 * so that it does not get run again at the next boot.
2412 * @hide
2413 */
2414 public static final String ACTION_PRE_BOOT_COMPLETED =
2415 "android.intent.action.PRE_BOOT_COMPLETED";
2416
Amith Yamasani13593602012-03-22 16:16:17 -07002417 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002418 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani86118ba2013-03-28 14:33:16 -07002419 * on restricted users. The response should contain an extra {@link #EXTRA_RESTRICTIONS},
2420 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2421 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2422 * The activity specified by that intent will be launched for a result which must contain
2423 * the extra {@link #EXTRA_RESTRICTIONS}. The returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002424 * @see RestrictionEntry
2425 */
2426 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2427 "android.intent.action.GET_RESTRICTION_ENTRIES";
2428
2429 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002430 * Sent the first time a user is starting, to allow system apps to
2431 * perform one time initialization. (This will not be seen by third
2432 * party applications because a newly initialized user does not have any
2433 * third party applications installed for it.) This is sent early in
2434 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002435 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2436 * broadcast, since it is part of a visible user interaction; be as quick
2437 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002438 */
2439 public static final String ACTION_USER_INITIALIZE =
2440 "android.intent.action.USER_INITIALIZE";
2441
2442 /**
2443 * Sent when a user switch is happening, causing the process's user to be
2444 * brought to the foreground. This is only sent to receivers registered
2445 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2446 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002447 * foreground. This is sent as a foreground
2448 * broadcast, since it is part of a visible user interaction; be as quick
2449 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002450 */
2451 public static final String ACTION_USER_FOREGROUND =
2452 "android.intent.action.USER_FOREGROUND";
2453
2454 /**
2455 * Sent when a user switch is happening, causing the process's user to be
2456 * sent to the background. This is only sent to receivers registered
2457 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2458 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002459 * background. This is sent as a foreground
2460 * broadcast, since it is part of a visible user interaction; be as quick
2461 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002462 */
2463 public static final String ACTION_USER_BACKGROUND =
2464 "android.intent.action.USER_BACKGROUND";
2465
2466 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002467 * Broadcast sent to the system when a user is added. Carries an extra
2468 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2469 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002470 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002471 * @hide
2472 */
2473 public static final String ACTION_USER_ADDED =
2474 "android.intent.action.USER_ADDED";
2475
2476 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002477 * Broadcast sent by the system when a user is started. Carries an extra
2478 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002479 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002480 * that has been started. This is sent as a foreground
2481 * broadcast, since it is part of a visible user interaction; be as quick
2482 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002483 * @hide
2484 */
2485 public static final String ACTION_USER_STARTED =
2486 "android.intent.action.USER_STARTED";
2487
2488 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002489 * Broadcast sent when a user is in the process of starting. Carries an extra
2490 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2491 * sent to registered receivers, not manifest receivers. It is sent to all
2492 * users (including the one that is being started). You must hold
2493 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2494 * this broadcast. This is sent as a background broadcast, since
2495 * its result is not part of the primary UX flow; to safely keep track of
2496 * started/stopped state of a user you can use this in conjunction with
2497 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2498 * other user state broadcasts since those are foreground broadcasts so can
2499 * execute in a different order.
2500 * @hide
2501 */
2502 public static final String ACTION_USER_STARTING =
2503 "android.intent.action.USER_STARTING";
2504
2505 /**
2506 * Broadcast sent when a user is going to be stopped. Carries an extra
2507 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2508 * sent to registered receivers, not manifest receivers. It is sent to all
2509 * users (including the one that is being stopped). You must hold
2510 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2511 * this broadcast. The user will not stop until all receivers have
2512 * handled the broadcast. This is sent as a background broadcast, since
2513 * its result is not part of the primary UX flow; to safely keep track of
2514 * started/stopped state of a user you can use this in conjunction with
2515 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2516 * other user state broadcasts since those are foreground broadcasts so can
2517 * execute in a different order.
2518 * @hide
2519 */
2520 public static final String ACTION_USER_STOPPING =
2521 "android.intent.action.USER_STOPPING";
2522
2523 /**
2524 * Broadcast sent to the system when a user is stopped. Carries an extra
2525 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2526 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2527 * specific package. This is only sent to registered receivers, not manifest
2528 * receivers. It is sent to all running users <em>except</em> the one that
2529 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002530 * @hide
2531 */
2532 public static final String ACTION_USER_STOPPED =
2533 "android.intent.action.USER_STOPPED";
2534
2535 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002536 * 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 -07002537 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002538 * one that has been removed. The user will not be completely removed until all receivers have
2539 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002540 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002541 * @hide
2542 */
2543 public static final String ACTION_USER_REMOVED =
2544 "android.intent.action.USER_REMOVED";
2545
2546 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002547 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002548 * the userHandle of the user to become the current one. This is only sent to
2549 * registered receivers, not manifest receivers. It is sent to all running users.
2550 * You must hold
2551 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002552 * @hide
2553 */
2554 public static final String ACTION_USER_SWITCHED =
2555 "android.intent.action.USER_SWITCHED";
2556
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002557 /**
2558 * Broadcast sent to the system when a user's information changes. Carries an extra
2559 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2560 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2561 * whose information has changed.
2562 * @hide
2563 */
2564 public static final String ACTION_USER_INFO_CHANGED =
2565 "android.intent.action.USER_INFO_CHANGED";
2566
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002567 /**
2568 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2569 */
2570 public static final String ACTION_QUICK_CLOCK =
2571 "android.intent.action.QUICK_CLOCK";
2572
Michael Wright0087a142013-02-05 16:29:39 -08002573 /**
2574 * Broadcast Action: This is broadcast when a user action should request the
2575 * brightness setting dialog.
2576 * @hide
2577 */
2578 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2579 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2580
Justin Kohd378ad72013-04-01 12:18:26 -07002581 /**
2582 * Broadcast Action: A global button was pressed. Includes a single
2583 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2584 * caused the broadcast.
2585 * @hide
2586 */
2587 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2588
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002589 // ---------------------------------------------------------------------
2590 // ---------------------------------------------------------------------
2591 // Standard intent categories (see addCategory()).
2592
2593 /**
2594 * Set if the activity should be an option for the default action
2595 * (center press) to perform on a piece of data. Setting this will
2596 * hide from the user any activities without it set when performing an
2597 * action on some data. Note that this is normal -not- set in the
2598 * Intent when initiating an action -- it is for use in intent filters
2599 * specified in packages.
2600 */
2601 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2602 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2603 /**
2604 * Activities that can be safely invoked from a browser must support this
2605 * category. For example, if the user is viewing a web page or an e-mail
2606 * and clicks on a link in the text, the Intent generated execute that
2607 * link will require the BROWSABLE category, so that only activities
2608 * supporting this category will be considered as possible actions. By
2609 * supporting this category, you are promising that there is nothing
2610 * damaging (without user intervention) that can happen by invoking any
2611 * matching Intent.
2612 */
2613 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2614 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2615 /**
2616 * Set if the activity should be considered as an alternative action to
2617 * the data the user is currently viewing. See also
2618 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2619 * applies to the selection in a list of items.
2620 *
2621 * <p>Supporting this category means that you would like your activity to be
2622 * displayed in the set of alternative things the user can do, usually as
2623 * part of the current activity's options menu. You will usually want to
2624 * include a specific label in the &lt;intent-filter&gt; of this action
2625 * describing to the user what it does.
2626 *
2627 * <p>The action of IntentFilter with this category is important in that it
2628 * describes the specific action the target will perform. This generally
2629 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2630 * a specific name such as "com.android.camera.action.CROP. Only one
2631 * alternative of any particular action will be shown to the user, so using
2632 * a specific action like this makes sure that your alternative will be
2633 * displayed while also allowing other applications to provide their own
2634 * overrides of that particular action.
2635 */
2636 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2637 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2638 /**
2639 * Set if the activity should be considered as an alternative selection
2640 * action to the data the user has currently selected. This is like
2641 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2642 * of items from which the user can select, giving them alternatives to the
2643 * default action that will be performed on it.
2644 */
2645 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2646 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2647 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002648 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002649 */
2650 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2651 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2652 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002653 * Should be displayed in the top-level launcher.
2654 */
2655 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2656 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2657 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002658 * Provides information about the package it is in; typically used if
2659 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2660 * a front-door to the user without having to be shown in the all apps list.
2661 */
2662 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2663 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2664 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002665 * This is the home activity, that is the first activity that is displayed
2666 * when the device boots.
2667 */
2668 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2669 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2670 /**
2671 * This activity is a preference panel.
2672 */
2673 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2674 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2675 /**
2676 * This activity is a development preference panel.
2677 */
2678 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2679 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2680 /**
2681 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002682 */
2683 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2684 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2685 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002686 * This activity allows the user to browse and download new applications.
2687 */
2688 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2689 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2690 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002691 * This activity may be exercised by the monkey or other automated test tools.
2692 */
2693 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2694 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2695 /**
2696 * To be used as a test (not part of the normal user experience).
2697 */
2698 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2699 /**
2700 * To be used as a unit test (run through the Test Harness).
2701 */
2702 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2703 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002704 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002705 * experience).
2706 */
2707 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2708 /**
2709 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
Dianne Hackborna53ee352013-02-20 12:47:02 -08002710 * ContentResolver.openInputStream. Openable URIs must support the columns in
2711 * {@link android.provider.OpenableColumns}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002712 * when queried, though it is allowable for those columns to be blank.
2713 */
2714 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2715 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2716
2717 /**
2718 * To be used as code under test for framework instrumentation tests.
2719 */
2720 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2721 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002722 /**
2723 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002724 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2725 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002726 */
2727 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2728 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2729 /**
2730 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002731 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2732 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002733 */
2734 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2735 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002736 /**
2737 * An activity to run when device is inserted into a analog (low end) dock.
2738 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2739 * information, see {@link android.app.UiModeManager}.
2740 */
2741 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2742 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2743
2744 /**
2745 * An activity to run when device is inserted into a digital (high end) dock.
2746 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2747 * information, see {@link android.app.UiModeManager}.
2748 */
2749 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2750 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002751
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002752 /**
2753 * Used to indicate that the activity can be used in a car environment.
2754 */
2755 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2756 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2757
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002758 // ---------------------------------------------------------------------
2759 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002760 // Application launch intent categories (see addCategory()).
2761
2762 /**
2763 * Used with {@link #ACTION_MAIN} to launch the browser application.
2764 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002765 * <p>NOTE: This should not be used as the primary key of an Intent,
2766 * since it will not result in the app launching with the correct
2767 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002768 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002769 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002770 */
2771 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2772 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2773
2774 /**
2775 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2776 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002777 * <p>NOTE: This should not be used as the primary key of an Intent,
2778 * since it will not result in the app launching with the correct
2779 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002780 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002781 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002782 */
2783 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2784 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2785
2786 /**
2787 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2788 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002789 * <p>NOTE: This should not be used as the primary key of an Intent,
2790 * since it will not result in the app launching with the correct
2791 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002792 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002793 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002794 */
2795 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2796 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2797
2798 /**
2799 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2800 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002801 * <p>NOTE: This should not be used as the primary key of an Intent,
2802 * since it will not result in the app launching with the correct
2803 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002804 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002805 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002806 */
2807 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2808 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2809
2810 /**
2811 * Used with {@link #ACTION_MAIN} to launch the email application.
2812 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002813 * <p>NOTE: This should not be used as the primary key of an Intent,
2814 * since it will not result in the app launching with the correct
2815 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002816 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002817 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002818 */
2819 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2820 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2821
2822 /**
2823 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2824 * The activity should be able to view and manipulate image and video files
2825 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002826 * <p>NOTE: This should not be used as the primary key of an Intent,
2827 * since it will not result in the app launching with the correct
2828 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002829 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002830 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002831 */
2832 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2833 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2834
2835 /**
2836 * Used with {@link #ACTION_MAIN} to launch the maps application.
2837 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002838 * <p>NOTE: This should not be used as the primary key of an Intent,
2839 * since it will not result in the app launching with the correct
2840 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002841 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002842 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002843 */
2844 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2845 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2846
2847 /**
2848 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2849 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002850 * <p>NOTE: This should not be used as the primary key of an Intent,
2851 * since it will not result in the app launching with the correct
2852 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002853 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002854 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002855 */
2856 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2857 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2858
2859 /**
2860 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002861 * The activity should be able to play, browse, or manipulate music files
2862 * stored on the device.
2863 * <p>NOTE: This should not be used as the primary key of an Intent,
2864 * since it will not result in the app launching with the correct
2865 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002866 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002867 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002868 */
2869 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2870 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2871
2872 // ---------------------------------------------------------------------
2873 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002874 // Standard extra data keys.
2875
2876 /**
2877 * The initial data to place in a newly created record. Use with
2878 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2879 * fields as would be given to the underlying ContentProvider.insert()
2880 * call.
2881 */
2882 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2883
2884 /**
2885 * A constant CharSequence that is associated with the Intent, used with
2886 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2887 * this may be a styled CharSequence, so you must use
2888 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2889 * retrieve it.
2890 */
2891 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2892
2893 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002894 * A constant String that is associated with the Intent, used with
2895 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2896 * as HTML formatted text. Note that you <em>must</em> also supply
2897 * {@link #EXTRA_TEXT}.
2898 */
2899 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2900
2901 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002902 * A content: URI holding a stream of data associated with the Intent,
2903 * used with {@link #ACTION_SEND} to supply the data being sent.
2904 */
2905 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2906
2907 /**
2908 * A String[] holding e-mail addresses that should be delivered to.
2909 */
2910 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2911
2912 /**
2913 * A String[] holding e-mail addresses that should be carbon copied.
2914 */
2915 public static final String EXTRA_CC = "android.intent.extra.CC";
2916
2917 /**
2918 * A String[] holding e-mail addresses that should be blind carbon copied.
2919 */
2920 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2921
2922 /**
2923 * A constant string holding the desired subject line of a message.
2924 */
2925 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2926
2927 /**
2928 * An Intent describing the choices you would like shown with
2929 * {@link #ACTION_PICK_ACTIVITY}.
2930 */
2931 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2932
2933 /**
2934 * A CharSequence dialog title to provide to the user when used with a
2935 * {@link #ACTION_CHOOSER}.
2936 */
2937 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2938
2939 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002940 * A Parcelable[] of {@link Intent} or
2941 * {@link android.content.pm.LabeledIntent} objects as set with
2942 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2943 * a the front of the list of choices, when shown to the user with a
2944 * {@link #ACTION_CHOOSER}.
2945 */
2946 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2947
2948 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002949 * A {@link android.view.KeyEvent} object containing the event that
2950 * triggered the creation of the Intent it is in.
2951 */
2952 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2953
2954 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002955 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2956 * before shutting down.
2957 *
2958 * {@hide}
2959 */
2960 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2961
2962 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002963 * 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 -07002964 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2965 * of restarting the application.
2966 */
2967 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2968
2969 /**
2970 * A String holding the phone number originally entered in
2971 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2972 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2973 */
2974 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002975
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002976 /**
2977 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2978 * intents to supply the uid the package had been assigned. Also an optional
2979 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2980 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2981 * purpose.
2982 */
2983 public static final String EXTRA_UID = "android.intent.extra.UID";
2984
2985 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002986 * @hide String array of package names.
2987 */
2988 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2989
2990 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002991 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2992 * intents to indicate whether this represents a full uninstall (removing
2993 * both the code and its data) or a partial uninstall (leaving its data,
2994 * implying that this is an update).
2995 */
2996 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002997
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002998 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07002999 * @hide
3000 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3001 * intents to indicate that at this point the package has been removed for
3002 * all users on the device.
3003 */
3004 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3005 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3006
3007 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003008 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3009 * intents to indicate that this is a replacement of the package, so this
3010 * broadcast will immediately be followed by an add broadcast for a
3011 * different version of the same package.
3012 */
3013 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003014
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003015 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003016 * Used as an int extra field in {@link android.app.AlarmManager} intents
3017 * to tell the application being invoked how many pending alarms are being
3018 * delievered with the intent. For one-shot alarms this will always be 1.
3019 * For recurring alarms, this might be greater than 1 if the device was
3020 * asleep or powered off at the time an earlier alarm would have been
3021 * delivered.
3022 */
3023 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003024
Jacek Surazski86b6c532009-05-13 14:38:28 +02003025 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003026 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3027 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003028 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3029 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003030 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3031 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3032 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003033 */
3034 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3035
3036 /**
3037 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3038 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003039 */
3040 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3041
3042 /**
3043 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3044 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003045 */
3046 public static final int EXTRA_DOCK_STATE_DESK = 1;
3047
3048 /**
3049 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3050 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003051 */
3052 public static final int EXTRA_DOCK_STATE_CAR = 2;
3053
3054 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003055 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3056 * to represent that the phone is in a analog (low end) dock.
3057 */
3058 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3059
3060 /**
3061 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3062 * to represent that the phone is in a digital (high end) dock.
3063 */
3064 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3065
3066 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003067 * Boolean that can be supplied as meta-data with a dock activity, to
3068 * indicate that the dock should take over the home key when it is active.
3069 */
3070 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003071
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003072 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003073 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3074 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003075 */
3076 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3077
3078 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003079 * Used in the extra field in the remote intent. It's astring token passed with the
3080 * remote intent.
3081 */
3082 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3083 "android.intent.extra.remote_intent_token";
3084
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003085 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003086 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003087 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003088 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003089 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003090 "android.intent.extra.changed_component_name";
3091
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003092 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003093 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003094 * and contains a string array of all of the components that have changed. If
3095 * the state of the overall package has changed, then it will contain an entry
3096 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003097 */
3098 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3099 "android.intent.extra.changed_component_name_list";
3100
3101 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003102 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003103 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3104 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003105 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003106 */
3107 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3108 "android.intent.extra.changed_package_list";
3109
3110 /**
3111 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003112 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3113 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003114 * and contains an integer array of uids of all of the components
3115 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003116 */
3117 public static final String EXTRA_CHANGED_UID_LIST =
3118 "android.intent.extra.changed_uid_list";
3119
3120 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003121 * @hide
3122 * Magic extra system code can use when binding, to give a label for
3123 * who it is that has bound to a service. This is an integer giving
3124 * a framework string resource that can be displayed to the user.
3125 */
3126 public static final String EXTRA_CLIENT_LABEL =
3127 "android.intent.extra.client_label";
3128
3129 /**
3130 * @hide
3131 * Magic extra system code can use when binding, to give a PendingIntent object
3132 * that can be launched for the user to disable the system's use of this
3133 * service.
3134 */
3135 public static final String EXTRA_CLIENT_INTENT =
3136 "android.intent.extra.client_intent";
3137
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003138 /**
3139 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3140 * data that is on the local device. This is a boolean extra; the default
3141 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3142 * the user to select media that is already on the device, not requiring it
3143 * be downloaded from a remote service when opened. Another way to look
3144 * at it is that such content should generally have a "_data" column to the
3145 * path of the content on local external storage.
3146 */
3147 public static final String EXTRA_LOCAL_ONLY =
3148 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003149
Amith Yamasani13593602012-03-22 16:16:17 -07003150 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003151 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3152 * user to select and return multiple items. This is a boolean extra; the default
3153 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3154 * present the user with a UI where they can pick multiple items that are all
3155 * returned to the caller. When this happens, they should be returned as
3156 * the {@link #getClipData()} part of the result Intent.
3157 */
3158 public static final String EXTRA_ALLOW_MULTIPLE =
3159 "android.intent.extra.ALLOW_MULTIPLE";
3160
3161 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003162 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07003163 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3164 * @hide
3165 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003166 public static final String EXTRA_USER_HANDLE =
3167 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003168
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003169 /**
3170 * Extra used in the response from a BroadcastReceiver that handles
3171 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3172 */
3173 public static final String EXTRA_RESTRICTIONS = "android.intent.extra.restrictions";
3174
Amith Yamasani86118ba2013-03-28 14:33:16 -07003175 /**
3176 * Extra used in the response from a BroadcastReceiver that handles
3177 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3178 */
3179 public static final String EXTRA_RESTRICTIONS_INTENT =
3180 "android.intent.extra.restrictions_intent";
3181
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003182 // ---------------------------------------------------------------------
3183 // ---------------------------------------------------------------------
3184 // Intent flags (see mFlags variable).
3185
3186 /**
3187 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003188 * perform read operations on the Uri in the Intent's data and any URIs
3189 * specified in its ClipData. When applying to an Intent's ClipData,
3190 * all URIs as well as recursive traversals through data or other ClipData
3191 * in Intent items will be granted; only the grant flags of the top-level
3192 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003193 */
3194 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3195 /**
3196 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003197 * perform write operations on the Uri in the Intent's data and any URIs
3198 * specified in its ClipData. When applying to an Intent's ClipData,
3199 * all URIs as well as recursive traversals through data or other ClipData
3200 * in Intent items will be granted; only the grant flags of the top-level
3201 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003202 */
3203 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3204 /**
3205 * Can be set by the caller to indicate that this Intent is coming from
3206 * a background operation, not from direct user interaction.
3207 */
3208 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3209 /**
3210 * A flag you can enable for debugging: when set, log messages will be
3211 * printed during the resolution of this intent to show you what has
3212 * been found to create the final resolved list.
3213 */
3214 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003215 /**
3216 * If set, this intent will not match any components in packages that
3217 * are currently stopped. If this is not set, then the default behavior
3218 * is to include such applications in the result.
3219 */
3220 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3221 /**
3222 * If set, this intent will always match any components in packages that
3223 * are currently stopped. This is the default behavior when
3224 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3225 * flags are set, this one wins (it allows overriding of exclude for
3226 * places where the framework may automatically set the exclude flag).
3227 */
3228 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003229
3230 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003231 * If set, the new activity is not kept in the history stack. As soon as
3232 * the user navigates away from it, the activity is finished. This may also
3233 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3234 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003235 */
3236 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3237 /**
3238 * If set, the activity will not be launched if it is already running
3239 * at the top of the history stack.
3240 */
3241 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3242 /**
3243 * If set, this activity will become the start of a new task on this
3244 * history stack. A task (from the activity that started it to the
3245 * next task activity) defines an atomic group of activities that the
3246 * user can move to. Tasks can be moved to the foreground and background;
3247 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003248 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003249 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3250 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003251 *
3252 * <p>This flag is generally used by activities that want
3253 * to present a "launcher" style behavior: they give the user a list of
3254 * separate things that can be done, which otherwise run completely
3255 * independently of the activity launching them.
3256 *
3257 * <p>When using this flag, if a task is already running for the activity
3258 * you are now starting, then a new activity will not be started; instead,
3259 * the current task will simply be brought to the front of the screen with
3260 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3261 * to disable this behavior.
3262 *
3263 * <p>This flag can not be used when the caller is requesting a result from
3264 * the activity being launched.
3265 */
3266 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3267 /**
3268 * <strong>Do not use this flag unless you are implementing your own
3269 * top-level application launcher.</strong> Used in conjunction with
3270 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3271 * behavior of bringing an existing task to the foreground. When set,
3272 * a new task is <em>always</em> started to host the Activity for the
3273 * Intent, regardless of whether there is already an existing task running
3274 * the same thing.
3275 *
3276 * <p><strong>Because the default system does not include graphical task management,
3277 * you should not use this flag unless you provide some way for a user to
3278 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003279 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003280 * <p>This flag is ignored if
3281 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3282 *
Scott Main7aee61f2011-02-08 11:25:01 -08003283 * <p>See
3284 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3285 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003286 */
3287 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3288 /**
3289 * If set, and the activity being launched is already running in the
3290 * current task, then instead of launching a new instance of that activity,
3291 * all of the other activities on top of it will be closed and this Intent
3292 * will be delivered to the (now on top) old activity as a new Intent.
3293 *
3294 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3295 * If D calls startActivity() with an Intent that resolves to the component
3296 * of activity B, then C and D will be finished and B receive the given
3297 * Intent, resulting in the stack now being: A, B.
3298 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003299 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003300 * either receive the new intent you are starting here in its
3301 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003302 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003303 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3304 * the same intent, then it will be finished and re-created; for all other
3305 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3306 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003307 *
3308 * <p>This launch mode can also be used to good effect in conjunction with
3309 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3310 * of a task, it will bring any currently running instance of that task
3311 * to the foreground, and then clear it to its root state. This is
3312 * especially useful, for example, when launching an activity from the
3313 * notification manager.
3314 *
Scott Main7aee61f2011-02-08 11:25:01 -08003315 * <p>See
3316 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3317 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003318 */
3319 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3320 /**
3321 * If set and this intent is being used to launch a new activity from an
3322 * existing one, then the reply target of the existing activity will be
3323 * transfered to the new activity. This way the new activity can call
3324 * {@link android.app.Activity#setResult} and have that result sent back to
3325 * the reply target of the original activity.
3326 */
3327 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3328 /**
3329 * If set and this intent is being used to launch a new activity from an
3330 * existing one, the current activity will not be counted as the top
3331 * activity for deciding whether the new intent should be delivered to
3332 * the top instead of starting a new one. The previous activity will
3333 * be used as the top, with the assumption being that the current activity
3334 * will finish itself immediately.
3335 */
3336 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3337 /**
3338 * If set, the new activity is not kept in the list of recently launched
3339 * activities.
3340 */
3341 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3342 /**
3343 * This flag is not normally set by application code, but set for you by
3344 * the system as described in the
3345 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3346 * launchMode} documentation for the singleTask mode.
3347 */
3348 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3349 /**
3350 * If set, and this activity is either being started in a new task or
3351 * bringing to the top an existing task, then it will be launched as
3352 * the front door of the task. This will result in the application of
3353 * any affinities needed to have that task in the proper state (either
3354 * moving activities to or from it), or simply resetting that task to
3355 * its initial state if needed.
3356 */
3357 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3358 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003359 * This flag is not normally set by application code, but set for you by
3360 * the system if this activity is being launched from history
3361 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003362 */
3363 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003364 /**
3365 * If set, this marks a point in the task's activity stack that should
3366 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003367 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003368 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3369 * the user re-launching it from home), this activity and all on top of
3370 * it will be finished so that the user does not return to them, but
3371 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003372 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003373 * <p>This is useful for cases where you have a logical break in your
3374 * application. For example, an e-mail application may have a command
3375 * to view an attachment, which launches an image view activity to
3376 * display it. This activity should be part of the e-mail application's
3377 * task, since it is a part of the task the user is involved in. However,
3378 * if the user leaves that task, and later selects the e-mail app from
3379 * home, we may like them to return to the conversation they were
3380 * viewing, not the picture attachment, since that is confusing. By
3381 * setting this flag when launching the image viewer, that viewer and
3382 * any activities it starts will be removed the next time the user returns
3383 * to mail.
3384 */
3385 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003386 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003387 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003388 * callback from occurring on the current frontmost activity before it is
3389 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003390 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003391 * <p>Typically, an activity can rely on that callback to indicate that an
3392 * explicit user action has caused their activity to be moved out of the
3393 * foreground. The callback marks an appropriate point in the activity's
3394 * lifecycle for it to dismiss any notifications that it intends to display
3395 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003396 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003397 * <p>If an activity is ever started via any non-user-driven events such as
3398 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3399 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003400 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003401 */
3402 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003403 /**
3404 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3405 * this flag will cause the launched activity to be brought to the front of its
3406 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003407 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003408 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3409 * If D calls startActivity() with an Intent that resolves to the component
3410 * of activity B, then B will be brought to the front of the history stack,
3411 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003412 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003413 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003414 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003415 */
3416 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003417 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003418 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3419 * this flag will prevent the system from applying an activity transition
3420 * animation to go to the next activity state. This doesn't mean an
3421 * animation will never run -- if another activity change happens that doesn't
3422 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003423 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003424 * when you are going to do a series of activity operations but the
3425 * animation seen by the user shouldn't be driven by the first activity
3426 * change but rather a later one.
3427 */
3428 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3429 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003430 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3431 * this flag will cause any existing task that would be associated with the
3432 * activity to be cleared before the activity is started. That is, the activity
3433 * becomes the new root of an otherwise empty task, and any old activities
3434 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3435 */
3436 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3437 /**
3438 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3439 * this flag will cause a newly launching task to be placed on top of the current
3440 * home activity task (if there is one). That is, pressing back from the task
3441 * will always return the user to home even if that was not the last activity they
3442 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3443 */
3444 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3445 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003446 * If set, when sending a broadcast only registered receivers will be
3447 * called -- no BroadcastReceiver components will be launched.
3448 */
3449 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003450 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003451 * If set, when sending a broadcast the new broadcast will replace
3452 * any existing pending broadcast that matches it. Matching is defined
3453 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3454 * true for the intents of the two broadcasts. When a match is found,
3455 * the new broadcast (and receivers associated with it) will replace the
3456 * existing one in the pending broadcast list, remaining at the same
3457 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003458 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003459 * <p>This flag is most typically used with sticky broadcasts, which
3460 * only care about delivering the most recent values of the broadcast
3461 * to their receivers.
3462 */
3463 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3464 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003465 * If set, when sending a broadcast the recipient is allowed to run at
3466 * foreground priority, with a shorter timeout interval. During normal
3467 * broadcasts the receivers are not automatically hoisted out of the
3468 * background priority class.
3469 */
3470 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3471 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003472 * If set, when sending a broadcast <i>before boot has completed</i> only
3473 * registered receivers will be called -- no BroadcastReceiver components
3474 * will be launched. Sticky intent state will be recorded properly even
3475 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3476 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003477 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003478 * <p>This flag is only for use by system sevices as a convenience to
3479 * avoid having to implement a more complex mechanism around detection
3480 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003481 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003482 * @hide
3483 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003484 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003485 /**
3486 * Set when this broadcast is for a boot upgrade, a special mode that
3487 * allows the broadcast to be sent before the system is ready and launches
3488 * the app process with no providers running in it.
3489 * @hide
3490 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003491 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003492
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003493 /**
3494 * @hide Flags that can't be changed with PendingIntent.
3495 */
3496 public static final int IMMUTABLE_FLAGS =
3497 FLAG_GRANT_READ_URI_PERMISSION
3498 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003499
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003500 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003501 // ---------------------------------------------------------------------
3502 // toUri() and parseUri() options.
3503
3504 /**
3505 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3506 * always has the "intent:" scheme. This syntax can be used when you want
3507 * to later disambiguate between URIs that are intended to describe an
3508 * Intent vs. all others that should be treated as raw URIs. When used
3509 * with {@link #parseUri}, any other scheme will result in a generic
3510 * VIEW action for that raw URI.
3511 */
3512 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003513
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003514 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003515
3516 private String mAction;
3517 private Uri mData;
3518 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003519 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003520 private ComponentName mComponent;
3521 private int mFlags;
3522 private HashSet<String> mCategories;
3523 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003524 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003525 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003526 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003527
3528 // ---------------------------------------------------------------------
3529
3530 /**
3531 * Create an empty intent.
3532 */
3533 public Intent() {
3534 }
3535
3536 /**
3537 * Copy constructor.
3538 */
3539 public Intent(Intent o) {
3540 this.mAction = o.mAction;
3541 this.mData = o.mData;
3542 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003543 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003544 this.mComponent = o.mComponent;
3545 this.mFlags = o.mFlags;
3546 if (o.mCategories != null) {
3547 this.mCategories = new HashSet<String>(o.mCategories);
3548 }
3549 if (o.mExtras != null) {
3550 this.mExtras = new Bundle(o.mExtras);
3551 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003552 if (o.mSourceBounds != null) {
3553 this.mSourceBounds = new Rect(o.mSourceBounds);
3554 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003555 if (o.mSelector != null) {
3556 this.mSelector = new Intent(o.mSelector);
3557 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003558 if (o.mClipData != null) {
3559 this.mClipData = new ClipData(o.mClipData);
3560 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003561 }
3562
3563 @Override
3564 public Object clone() {
3565 return new Intent(this);
3566 }
3567
3568 private Intent(Intent o, boolean all) {
3569 this.mAction = o.mAction;
3570 this.mData = o.mData;
3571 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003572 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003573 this.mComponent = o.mComponent;
3574 if (o.mCategories != null) {
3575 this.mCategories = new HashSet<String>(o.mCategories);
3576 }
3577 }
3578
3579 /**
3580 * Make a clone of only the parts of the Intent that are relevant for
3581 * filter matching: the action, data, type, component, and categories.
3582 */
3583 public Intent cloneFilter() {
3584 return new Intent(this, false);
3585 }
3586
3587 /**
3588 * Create an intent with a given action. All other fields (data, type,
3589 * class) are null. Note that the action <em>must</em> be in a
3590 * namespace because Intents are used globally in the system -- for
3591 * example the system VIEW action is android.intent.action.VIEW; an
3592 * application's custom action would be something like
3593 * com.google.app.myapp.CUSTOM_ACTION.
3594 *
3595 * @param action The Intent action, such as ACTION_VIEW.
3596 */
3597 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003598 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003599 }
3600
3601 /**
3602 * Create an intent with a given action and for a given data url. Note
3603 * that the action <em>must</em> be in a namespace because Intents are
3604 * used globally in the system -- for example the system VIEW action is
3605 * android.intent.action.VIEW; an application's custom action would be
3606 * something like com.google.app.myapp.CUSTOM_ACTION.
3607 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003608 * <p><em>Note: scheme and host name matching in the Android framework is
3609 * case-sensitive, unlike the formal RFC. As a result,
3610 * you should always ensure that you write your Uri with these elements
3611 * using lower case letters, and normalize any Uris you receive from
3612 * outside of Android to ensure the scheme and host is lower case.</em></p>
3613 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003614 * @param action The Intent action, such as ACTION_VIEW.
3615 * @param uri The Intent data URI.
3616 */
3617 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003618 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003619 mData = uri;
3620 }
3621
3622 /**
3623 * Create an intent for a specific component. All other fields (action, data,
3624 * type, class) are null, though they can be modified later with explicit
3625 * calls. This provides a convenient way to create an intent that is
3626 * intended to execute a hard-coded class name, rather than relying on the
3627 * system to find an appropriate class for you; see {@link #setComponent}
3628 * for more information on the repercussions of this.
3629 *
3630 * @param packageContext A Context of the application package implementing
3631 * this class.
3632 * @param cls The component class that is to be used for the intent.
3633 *
3634 * @see #setClass
3635 * @see #setComponent
3636 * @see #Intent(String, android.net.Uri , Context, Class)
3637 */
3638 public Intent(Context packageContext, Class<?> cls) {
3639 mComponent = new ComponentName(packageContext, cls);
3640 }
3641
3642 /**
3643 * Create an intent for a specific component with a specified action and data.
3644 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3645 * construct the Intent and then calling {@link #setClass} to set its
3646 * class.
3647 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003648 * <p><em>Note: scheme and host name matching in the Android framework is
3649 * case-sensitive, unlike the formal RFC. As a result,
3650 * you should always ensure that you write your Uri with these elements
3651 * using lower case letters, and normalize any Uris you receive from
3652 * outside of Android to ensure the scheme and host is lower case.</em></p>
3653 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003654 * @param action The Intent action, such as ACTION_VIEW.
3655 * @param uri The Intent data URI.
3656 * @param packageContext A Context of the application package implementing
3657 * this class.
3658 * @param cls The component class that is to be used for the intent.
3659 *
3660 * @see #Intent(String, android.net.Uri)
3661 * @see #Intent(Context, Class)
3662 * @see #setClass
3663 * @see #setComponent
3664 */
3665 public Intent(String action, Uri uri,
3666 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003667 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003668 mData = uri;
3669 mComponent = new ComponentName(packageContext, cls);
3670 }
3671
3672 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003673 * Create an intent to launch the main (root) activity of a task. This
3674 * is the Intent that is started when the application's is launched from
3675 * Home. For anything else that wants to launch an application in the
3676 * same way, it is important that they use an Intent structured the same
3677 * way, and can use this function to ensure this is the case.
3678 *
3679 * <p>The returned Intent has the given Activity component as its explicit
3680 * component, {@link #ACTION_MAIN} as its action, and includes the
3681 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3682 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3683 * to do that through {@link #addFlags(int)} on the returned Intent.
3684 *
3685 * @param mainActivity The main activity component that this Intent will
3686 * launch.
3687 * @return Returns a newly created Intent that can be used to launch the
3688 * activity as a main application entry.
3689 *
3690 * @see #setClass
3691 * @see #setComponent
3692 */
3693 public static Intent makeMainActivity(ComponentName mainActivity) {
3694 Intent intent = new Intent(ACTION_MAIN);
3695 intent.setComponent(mainActivity);
3696 intent.addCategory(CATEGORY_LAUNCHER);
3697 return intent;
3698 }
3699
3700 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003701 * Make an Intent for the main activity of an application, without
3702 * specifying a specific activity to run but giving a selector to find
3703 * the activity. This results in a final Intent that is structured
3704 * the same as when the application is launched from
3705 * Home. For anything else that wants to launch an application in the
3706 * same way, it is important that they use an Intent structured the same
3707 * way, and can use this function to ensure this is the case.
3708 *
3709 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3710 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3711 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3712 * to do that through {@link #addFlags(int)} on the returned Intent.
3713 *
3714 * @param selectorAction The action name of the Intent's selector.
3715 * @param selectorCategory The name of a category to add to the Intent's
3716 * selector.
3717 * @return Returns a newly created Intent that can be used to launch the
3718 * activity as a main application entry.
3719 *
3720 * @see #setSelector(Intent)
3721 */
3722 public static Intent makeMainSelectorActivity(String selectorAction,
3723 String selectorCategory) {
3724 Intent intent = new Intent(ACTION_MAIN);
3725 intent.addCategory(CATEGORY_LAUNCHER);
3726 Intent selector = new Intent();
3727 selector.setAction(selectorAction);
3728 selector.addCategory(selectorCategory);
3729 intent.setSelector(selector);
3730 return intent;
3731 }
3732
3733 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003734 * Make an Intent that can be used to re-launch an application's task
3735 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3736 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3737 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3738 *
3739 * @param mainActivity The activity component that is the root of the
3740 * task; this is the activity that has been published in the application's
3741 * manifest as the main launcher icon.
3742 *
3743 * @return Returns a newly created Intent that can be used to relaunch the
3744 * activity's task in its root state.
3745 */
3746 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3747 Intent intent = makeMainActivity(mainActivity);
3748 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3749 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3750 return intent;
3751 }
3752
3753 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003754 * Call {@link #parseUri} with 0 flags.
3755 * @deprecated Use {@link #parseUri} instead.
3756 */
3757 @Deprecated
3758 public static Intent getIntent(String uri) throws URISyntaxException {
3759 return parseUri(uri, 0);
3760 }
Tom Taylord4a47292009-12-21 13:59:18 -08003761
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003762 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003763 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003764 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003765 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003766 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003767 *
3768 * <p>The URI given here must not be relative -- that is, it must include
3769 * the scheme and full path.
3770 *
3771 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003772 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003773 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003774 *
3775 * @return Intent The newly created Intent object.
3776 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003777 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3778 * it bad (as parsed by the Uri class) or the Intent data within the
3779 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003780 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003781 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003782 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003783 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003784 int i = 0;
3785 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003786 // Validate intent scheme for if requested.
3787 if ((flags&URI_INTENT_SCHEME) != 0) {
3788 if (!uri.startsWith("intent:")) {
3789 Intent intent = new Intent(ACTION_VIEW);
3790 try {
3791 intent.setData(Uri.parse(uri));
3792 } catch (IllegalArgumentException e) {
3793 throw new URISyntaxException(uri, e.getMessage());
3794 }
3795 return intent;
3796 }
3797 }
Tom Taylord4a47292009-12-21 13:59:18 -08003798
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003799 // simple case
3800 i = uri.lastIndexOf("#");
3801 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3802
3803 // old format Intent URI
3804 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003805
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003806 // new format
3807 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003808 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003809
3810 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003811 String data = i >= 0 ? uri.substring(0, i) : null;
3812 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003813 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003814
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003815 // loop over contents of Intent, all name=value;
3816 while (!uri.startsWith("end", i)) {
3817 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003818 if (eq < 0) eq = i-1;
3819 int semi = uri.indexOf(';', i);
3820 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003821
3822 // action
3823 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003824 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003825 }
3826
3827 // categories
3828 else if (uri.startsWith("category=", i)) {
3829 intent.addCategory(value);
3830 }
3831
3832 // type
3833 else if (uri.startsWith("type=", i)) {
3834 intent.mType = value;
3835 }
3836
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003837 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003838 else if (uri.startsWith("launchFlags=", i)) {
3839 intent.mFlags = Integer.decode(value).intValue();
3840 }
3841
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003842 // package
3843 else if (uri.startsWith("package=", i)) {
3844 intent.mPackage = value;
3845 }
3846
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003847 // component
3848 else if (uri.startsWith("component=", i)) {
3849 intent.mComponent = ComponentName.unflattenFromString(value);
3850 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003851
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003852 // scheme
3853 else if (uri.startsWith("scheme=", i)) {
3854 scheme = value;
3855 }
3856
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003857 // source bounds
3858 else if (uri.startsWith("sourceBounds=", i)) {
3859 intent.mSourceBounds = Rect.unflattenFromString(value);
3860 }
3861
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003862 // selector
3863 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3864 intent = new Intent();
3865 }
3866
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003867 // extra
3868 else {
3869 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003870 // create Bundle if it doesn't already exist
3871 if (intent.mExtras == null) intent.mExtras = new Bundle();
3872 Bundle b = intent.mExtras;
3873 // add EXTRA
3874 if (uri.startsWith("S.", i)) b.putString(key, value);
3875 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3876 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3877 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3878 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3879 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3880 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3881 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3882 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3883 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3884 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003885
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003886 // move to the next item
3887 i = semi + 1;
3888 }
3889
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003890 if (intent != baseIntent) {
3891 // The Intent had a selector; fix it up.
3892 baseIntent.setSelector(intent);
3893 intent = baseIntent;
3894 }
3895
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003896 if (data != null) {
3897 if (data.startsWith("intent:")) {
3898 data = data.substring(7);
3899 if (scheme != null) {
3900 data = scheme + ':' + data;
3901 }
3902 }
Tom Taylord4a47292009-12-21 13:59:18 -08003903
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003904 if (data.length() > 0) {
3905 try {
3906 intent.mData = Uri.parse(data);
3907 } catch (IllegalArgumentException e) {
3908 throw new URISyntaxException(uri, e.getMessage());
3909 }
3910 }
3911 }
Tom Taylord4a47292009-12-21 13:59:18 -08003912
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003913 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003914
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003915 } catch (IndexOutOfBoundsException e) {
3916 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3917 }
3918 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003919
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003920 public static Intent getIntentOld(String uri) throws URISyntaxException {
3921 Intent intent;
3922
3923 int i = uri.lastIndexOf('#');
3924 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003925 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003926 final int intentFragmentStart = i;
3927 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003928
3929 i++;
3930
3931 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003932 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003933 i += 7;
3934 int j = uri.indexOf(')', i);
3935 action = uri.substring(i, j);
3936 i = j + 1;
3937 }
3938
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003939 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003940
3941 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003942 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003943 i += 11;
3944 int j = uri.indexOf(')', i);
3945 while (i < j) {
3946 int sep = uri.indexOf('!', i);
3947 if (sep < 0) sep = j;
3948 if (i < sep) {
3949 intent.addCategory(uri.substring(i, sep));
3950 }
3951 i = sep + 1;
3952 }
3953 i = j + 1;
3954 }
3955
3956 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003957 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003958 i += 5;
3959 int j = uri.indexOf(')', i);
3960 intent.mType = uri.substring(i, j);
3961 i = j + 1;
3962 }
3963
3964 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003965 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003966 i += 12;
3967 int j = uri.indexOf(')', i);
3968 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3969 i = j + 1;
3970 }
3971
3972 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003973 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003974 i += 10;
3975 int j = uri.indexOf(')', i);
3976 int sep = uri.indexOf('!', i);
3977 if (sep >= 0 && sep < j) {
3978 String pkg = uri.substring(i, sep);
3979 String cls = uri.substring(sep + 1, j);
3980 intent.mComponent = new ComponentName(pkg, cls);
3981 }
3982 i = j + 1;
3983 }
3984
3985 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003986 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003987 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003988
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003989 final int closeParen = uri.indexOf(')', i);
3990 if (closeParen == -1) throw new URISyntaxException(uri,
3991 "EXTRA missing trailing ')'", i);
3992
3993 while (i < closeParen) {
3994 // fetch the key value
3995 int j = uri.indexOf('=', i);
3996 if (j <= i + 1 || i >= closeParen) {
3997 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3998 }
3999 char type = uri.charAt(i);
4000 i++;
4001 String key = uri.substring(i, j);
4002 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004003
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004004 // get type-value
4005 j = uri.indexOf('!', i);
4006 if (j == -1 || j >= closeParen) j = closeParen;
4007 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4008 String value = uri.substring(i, j);
4009 i = j;
4010
4011 // create Bundle if it doesn't already exist
4012 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004013
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004014 // add item to bundle
4015 try {
4016 switch (type) {
4017 case 'S':
4018 intent.mExtras.putString(key, Uri.decode(value));
4019 break;
4020 case 'B':
4021 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4022 break;
4023 case 'b':
4024 intent.mExtras.putByte(key, Byte.parseByte(value));
4025 break;
4026 case 'c':
4027 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4028 break;
4029 case 'd':
4030 intent.mExtras.putDouble(key, Double.parseDouble(value));
4031 break;
4032 case 'f':
4033 intent.mExtras.putFloat(key, Float.parseFloat(value));
4034 break;
4035 case 'i':
4036 intent.mExtras.putInt(key, Integer.parseInt(value));
4037 break;
4038 case 'l':
4039 intent.mExtras.putLong(key, Long.parseLong(value));
4040 break;
4041 case 's':
4042 intent.mExtras.putShort(key, Short.parseShort(value));
4043 break;
4044 default:
4045 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4046 }
4047 } catch (NumberFormatException e) {
4048 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4049 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004050
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004051 char ch = uri.charAt(i);
4052 if (ch == ')') break;
4053 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4054 i++;
4055 }
4056 }
4057
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004058 if (isIntentFragment) {
4059 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4060 } else {
4061 intent.mData = Uri.parse(uri);
4062 }
Tom Taylord4a47292009-12-21 13:59:18 -08004063
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004064 if (intent.mAction == null) {
4065 // By default, if no action is specified, then use VIEW.
4066 intent.mAction = ACTION_VIEW;
4067 }
4068
4069 } else {
4070 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4071 }
4072
4073 return intent;
4074 }
4075
4076 /**
4077 * Retrieve the general action to be performed, such as
4078 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4079 * the information in the intent should be interpreted -- most importantly,
4080 * what to do with the data returned by {@link #getData}.
4081 *
4082 * @return The action of this intent or null if none is specified.
4083 *
4084 * @see #setAction
4085 */
4086 public String getAction() {
4087 return mAction;
4088 }
4089
4090 /**
4091 * Retrieve data this intent is operating on. This URI specifies the name
4092 * of the data; often it uses the content: scheme, specifying data in a
4093 * content provider. Other schemes may be handled by specific activities,
4094 * such as http: by the web browser.
4095 *
4096 * @return The URI of the data this intent is targeting or null.
4097 *
4098 * @see #getScheme
4099 * @see #setData
4100 */
4101 public Uri getData() {
4102 return mData;
4103 }
4104
4105 /**
4106 * The same as {@link #getData()}, but returns the URI as an encoded
4107 * String.
4108 */
4109 public String getDataString() {
4110 return mData != null ? mData.toString() : null;
4111 }
4112
4113 /**
4114 * Return the scheme portion of the intent's data. If the data is null or
4115 * does not include a scheme, null is returned. Otherwise, the scheme
4116 * prefix without the final ':' is returned, i.e. "http".
4117 *
4118 * <p>This is the same as calling getData().getScheme() (and checking for
4119 * null data).
4120 *
4121 * @return The scheme of this intent.
4122 *
4123 * @see #getData
4124 */
4125 public String getScheme() {
4126 return mData != null ? mData.getScheme() : null;
4127 }
4128
4129 /**
4130 * Retrieve any explicit MIME type included in the intent. This is usually
4131 * null, as the type is determined by the intent data.
4132 *
4133 * @return If a type was manually set, it is returned; else null is
4134 * returned.
4135 *
4136 * @see #resolveType(ContentResolver)
4137 * @see #setType
4138 */
4139 public String getType() {
4140 return mType;
4141 }
4142
4143 /**
4144 * Return the MIME data type of this intent. If the type field is
4145 * explicitly set, that is simply returned. Otherwise, if the data is set,
4146 * the type of that data is returned. If neither fields are set, a null is
4147 * returned.
4148 *
4149 * @return The MIME type of this intent.
4150 *
4151 * @see #getType
4152 * @see #resolveType(ContentResolver)
4153 */
4154 public String resolveType(Context context) {
4155 return resolveType(context.getContentResolver());
4156 }
4157
4158 /**
4159 * Return the MIME data type of this intent. If the type field is
4160 * explicitly set, that is simply returned. Otherwise, if the data is set,
4161 * the type of that data is returned. If neither fields are set, a null is
4162 * returned.
4163 *
4164 * @param resolver A ContentResolver that can be used to determine the MIME
4165 * type of the intent's data.
4166 *
4167 * @return The MIME type of this intent.
4168 *
4169 * @see #getType
4170 * @see #resolveType(Context)
4171 */
4172 public String resolveType(ContentResolver resolver) {
4173 if (mType != null) {
4174 return mType;
4175 }
4176 if (mData != null) {
4177 if ("content".equals(mData.getScheme())) {
4178 return resolver.getType(mData);
4179 }
4180 }
4181 return null;
4182 }
4183
4184 /**
4185 * Return the MIME data type of this intent, only if it will be needed for
4186 * intent resolution. This is not generally useful for application code;
4187 * it is used by the frameworks for communicating with back-end system
4188 * services.
4189 *
4190 * @param resolver A ContentResolver that can be used to determine the MIME
4191 * type of the intent's data.
4192 *
4193 * @return The MIME type of this intent, or null if it is unknown or not
4194 * needed.
4195 */
4196 public String resolveTypeIfNeeded(ContentResolver resolver) {
4197 if (mComponent != null) {
4198 return mType;
4199 }
4200 return resolveType(resolver);
4201 }
4202
4203 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004204 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004205 *
4206 * @param category The category to check.
4207 *
4208 * @return boolean True if the intent contains the category, else false.
4209 *
4210 * @see #getCategories
4211 * @see #addCategory
4212 */
4213 public boolean hasCategory(String category) {
4214 return mCategories != null && mCategories.contains(category);
4215 }
4216
4217 /**
4218 * Return the set of all categories in the intent. If there are no categories,
4219 * returns NULL.
4220 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004221 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004222 *
4223 * @see #hasCategory
4224 * @see #addCategory
4225 */
4226 public Set<String> getCategories() {
4227 return mCategories;
4228 }
4229
4230 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004231 * Return the specific selector associated with this Intent. If there is
4232 * none, returns null. See {@link #setSelector} for more information.
4233 *
4234 * @see #setSelector
4235 */
4236 public Intent getSelector() {
4237 return mSelector;
4238 }
4239
4240 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004241 * Return the {@link ClipData} associated with this Intent. If there is
4242 * none, returns null. See {@link #setClipData} for more information.
4243 *
4244 * @see #setClipData;
4245 */
4246 public ClipData getClipData() {
4247 return mClipData;
4248 }
4249
4250 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004251 * Sets the ClassLoader that will be used when unmarshalling
4252 * any Parcelable values from the extras of this Intent.
4253 *
4254 * @param loader a ClassLoader, or null to use the default loader
4255 * at the time of unmarshalling.
4256 */
4257 public void setExtrasClassLoader(ClassLoader loader) {
4258 if (mExtras != null) {
4259 mExtras.setClassLoader(loader);
4260 }
4261 }
4262
4263 /**
4264 * Returns true if an extra value is associated with the given name.
4265 * @param name the extra's name
4266 * @return true if the given extra is present.
4267 */
4268 public boolean hasExtra(String name) {
4269 return mExtras != null && mExtras.containsKey(name);
4270 }
4271
4272 /**
4273 * Returns true if the Intent's extras contain a parcelled file descriptor.
4274 * @return true if the Intent contains a parcelled file descriptor.
4275 */
4276 public boolean hasFileDescriptors() {
4277 return mExtras != null && mExtras.hasFileDescriptors();
4278 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004279
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004280 /** @hide */
4281 public void setAllowFds(boolean allowFds) {
4282 if (mExtras != null) {
4283 mExtras.setAllowFds(allowFds);
4284 }
4285 }
4286
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004287 /**
4288 * Retrieve extended data from the intent.
4289 *
4290 * @param name The name of the desired item.
4291 *
4292 * @return the value of an item that previously added with putExtra()
4293 * or null if none was found.
4294 *
4295 * @deprecated
4296 * @hide
4297 */
4298 @Deprecated
4299 public Object getExtra(String name) {
4300 return getExtra(name, null);
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, boolean)
4314 */
4315 public boolean getBooleanExtra(String name, boolean defaultValue) {
4316 return mExtras == null ? defaultValue :
4317 mExtras.getBoolean(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, byte)
4331 */
4332 public byte getByteExtra(String name, byte defaultValue) {
4333 return mExtras == null ? defaultValue :
4334 mExtras.getByte(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, short)
4348 */
4349 public short getShortExtra(String name, short defaultValue) {
4350 return mExtras == null ? defaultValue :
4351 mExtras.getShort(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, char)
4365 */
4366 public char getCharExtra(String name, char defaultValue) {
4367 return mExtras == null ? defaultValue :
4368 mExtras.getChar(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 none was found.
4380 *
4381 * @see #putExtra(String, int)
4382 */
4383 public int getIntExtra(String name, int defaultValue) {
4384 return mExtras == null ? defaultValue :
4385 mExtras.getInt(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, long)
4399 */
4400 public long getLongExtra(String name, long defaultValue) {
4401 return mExtras == null ? defaultValue :
4402 mExtras.getLong(name, defaultValue);
4403 }
4404
4405 /**
4406 * Retrieve extended data from the intent.
4407 *
4408 * @param name The name of the desired item.
4409 * @param defaultValue the value to be returned if no value of the desired
4410 * type is stored with the given name.
4411 *
4412 * @return the value of an item that previously added with putExtra(),
4413 * or the default value if no such item is present
4414 *
4415 * @see #putExtra(String, float)
4416 */
4417 public float getFloatExtra(String name, float defaultValue) {
4418 return mExtras == null ? defaultValue :
4419 mExtras.getFloat(name, defaultValue);
4420 }
4421
4422 /**
4423 * Retrieve extended data from the intent.
4424 *
4425 * @param name The name of the desired item.
4426 * @param defaultValue the value to be returned if no value of the desired
4427 * type is stored with the given name.
4428 *
4429 * @return the value of an item that previously added with putExtra()
4430 * or the default value if none was found.
4431 *
4432 * @see #putExtra(String, double)
4433 */
4434 public double getDoubleExtra(String name, double defaultValue) {
4435 return mExtras == null ? defaultValue :
4436 mExtras.getDouble(name, defaultValue);
4437 }
4438
4439 /**
4440 * Retrieve extended data from the intent.
4441 *
4442 * @param name The name of the desired item.
4443 *
4444 * @return the value of an item that previously added with putExtra()
4445 * or null if no String value was found.
4446 *
4447 * @see #putExtra(String, String)
4448 */
4449 public String getStringExtra(String name) {
4450 return mExtras == null ? null : mExtras.getString(name);
4451 }
4452
4453 /**
4454 * Retrieve extended data from the intent.
4455 *
4456 * @param name The name of the desired item.
4457 *
4458 * @return the value of an item that previously added with putExtra()
4459 * or null if no CharSequence value was found.
4460 *
4461 * @see #putExtra(String, CharSequence)
4462 */
4463 public CharSequence getCharSequenceExtra(String name) {
4464 return mExtras == null ? null : mExtras.getCharSequence(name);
4465 }
4466
4467 /**
4468 * Retrieve extended data from the intent.
4469 *
4470 * @param name The name of the desired item.
4471 *
4472 * @return the value of an item that previously added with putExtra()
4473 * or null if no Parcelable value was found.
4474 *
4475 * @see #putExtra(String, Parcelable)
4476 */
4477 public <T extends Parcelable> T getParcelableExtra(String name) {
4478 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4479 }
4480
4481 /**
4482 * Retrieve extended data from the intent.
4483 *
4484 * @param name The name of the desired item.
4485 *
4486 * @return the value of an item that previously added with putExtra()
4487 * or null if no Parcelable[] value was found.
4488 *
4489 * @see #putExtra(String, Parcelable[])
4490 */
4491 public Parcelable[] getParcelableArrayExtra(String name) {
4492 return mExtras == null ? null : mExtras.getParcelableArray(name);
4493 }
4494
4495 /**
4496 * Retrieve extended data from the intent.
4497 *
4498 * @param name The name of the desired item.
4499 *
4500 * @return the value of an item that previously added with putExtra()
4501 * or null if no ArrayList<Parcelable> value was found.
4502 *
4503 * @see #putParcelableArrayListExtra(String, ArrayList)
4504 */
4505 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4506 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4507 }
4508
4509 /**
4510 * Retrieve extended data from the intent.
4511 *
4512 * @param name The name of the desired item.
4513 *
4514 * @return the value of an item that previously added with putExtra()
4515 * or null if no Serializable value was found.
4516 *
4517 * @see #putExtra(String, Serializable)
4518 */
4519 public Serializable getSerializableExtra(String name) {
4520 return mExtras == null ? null : mExtras.getSerializable(name);
4521 }
4522
4523 /**
4524 * Retrieve extended data from the intent.
4525 *
4526 * @param name The name of the desired item.
4527 *
4528 * @return the value of an item that previously added with putExtra()
4529 * or null if no ArrayList<Integer> value was found.
4530 *
4531 * @see #putIntegerArrayListExtra(String, ArrayList)
4532 */
4533 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4534 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4535 }
4536
4537 /**
4538 * Retrieve extended data from the intent.
4539 *
4540 * @param name The name of the desired item.
4541 *
4542 * @return the value of an item that previously added with putExtra()
4543 * or null if no ArrayList<String> value was found.
4544 *
4545 * @see #putStringArrayListExtra(String, ArrayList)
4546 */
4547 public ArrayList<String> getStringArrayListExtra(String name) {
4548 return mExtras == null ? null : mExtras.getStringArrayList(name);
4549 }
4550
4551 /**
4552 * Retrieve extended data from the intent.
4553 *
4554 * @param name The name of the desired item.
4555 *
4556 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004557 * or null if no ArrayList<CharSequence> value was found.
4558 *
4559 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4560 */
4561 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4562 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4563 }
4564
4565 /**
4566 * Retrieve extended data from the intent.
4567 *
4568 * @param name The name of the desired item.
4569 *
4570 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004571 * or null if no boolean array value was found.
4572 *
4573 * @see #putExtra(String, boolean[])
4574 */
4575 public boolean[] getBooleanArrayExtra(String name) {
4576 return mExtras == null ? null : mExtras.getBooleanArray(name);
4577 }
4578
4579 /**
4580 * Retrieve extended data from the intent.
4581 *
4582 * @param name The name of the desired item.
4583 *
4584 * @return the value of an item that previously added with putExtra()
4585 * or null if no byte array value was found.
4586 *
4587 * @see #putExtra(String, byte[])
4588 */
4589 public byte[] getByteArrayExtra(String name) {
4590 return mExtras == null ? null : mExtras.getByteArray(name);
4591 }
4592
4593 /**
4594 * Retrieve extended data from the intent.
4595 *
4596 * @param name The name of the desired item.
4597 *
4598 * @return the value of an item that previously added with putExtra()
4599 * or null if no short array value was found.
4600 *
4601 * @see #putExtra(String, short[])
4602 */
4603 public short[] getShortArrayExtra(String name) {
4604 return mExtras == null ? null : mExtras.getShortArray(name);
4605 }
4606
4607 /**
4608 * Retrieve extended data from the intent.
4609 *
4610 * @param name The name of the desired item.
4611 *
4612 * @return the value of an item that previously added with putExtra()
4613 * or null if no char array value was found.
4614 *
4615 * @see #putExtra(String, char[])
4616 */
4617 public char[] getCharArrayExtra(String name) {
4618 return mExtras == null ? null : mExtras.getCharArray(name);
4619 }
4620
4621 /**
4622 * Retrieve extended data from the intent.
4623 *
4624 * @param name The name of the desired item.
4625 *
4626 * @return the value of an item that previously added with putExtra()
4627 * or null if no int array value was found.
4628 *
4629 * @see #putExtra(String, int[])
4630 */
4631 public int[] getIntArrayExtra(String name) {
4632 return mExtras == null ? null : mExtras.getIntArray(name);
4633 }
4634
4635 /**
4636 * Retrieve extended data from the intent.
4637 *
4638 * @param name The name of the desired item.
4639 *
4640 * @return the value of an item that previously added with putExtra()
4641 * or null if no long array value was found.
4642 *
4643 * @see #putExtra(String, long[])
4644 */
4645 public long[] getLongArrayExtra(String name) {
4646 return mExtras == null ? null : mExtras.getLongArray(name);
4647 }
4648
4649 /**
4650 * Retrieve extended data from the intent.
4651 *
4652 * @param name The name of the desired item.
4653 *
4654 * @return the value of an item that previously added with putExtra()
4655 * or null if no float array value was found.
4656 *
4657 * @see #putExtra(String, float[])
4658 */
4659 public float[] getFloatArrayExtra(String name) {
4660 return mExtras == null ? null : mExtras.getFloatArray(name);
4661 }
4662
4663 /**
4664 * Retrieve extended data from the intent.
4665 *
4666 * @param name The name of the desired item.
4667 *
4668 * @return the value of an item that previously added with putExtra()
4669 * or null if no double array value was found.
4670 *
4671 * @see #putExtra(String, double[])
4672 */
4673 public double[] getDoubleArrayExtra(String name) {
4674 return mExtras == null ? null : mExtras.getDoubleArray(name);
4675 }
4676
4677 /**
4678 * Retrieve extended data from the intent.
4679 *
4680 * @param name The name of the desired item.
4681 *
4682 * @return the value of an item that previously added with putExtra()
4683 * or null if no String array value was found.
4684 *
4685 * @see #putExtra(String, String[])
4686 */
4687 public String[] getStringArrayExtra(String name) {
4688 return mExtras == null ? null : mExtras.getStringArray(name);
4689 }
4690
4691 /**
4692 * Retrieve extended data from the intent.
4693 *
4694 * @param name The name of the desired item.
4695 *
4696 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004697 * or null if no CharSequence array value was found.
4698 *
4699 * @see #putExtra(String, CharSequence[])
4700 */
4701 public CharSequence[] getCharSequenceArrayExtra(String name) {
4702 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4703 }
4704
4705 /**
4706 * Retrieve extended data from the intent.
4707 *
4708 * @param name The name of the desired item.
4709 *
4710 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004711 * or null if no Bundle value was found.
4712 *
4713 * @see #putExtra(String, Bundle)
4714 */
4715 public Bundle getBundleExtra(String name) {
4716 return mExtras == null ? null : mExtras.getBundle(name);
4717 }
4718
4719 /**
4720 * Retrieve extended data from the intent.
4721 *
4722 * @param name The name of the desired item.
4723 *
4724 * @return the value of an item that previously added with putExtra()
4725 * or null if no IBinder value was found.
4726 *
4727 * @see #putExtra(String, IBinder)
4728 *
4729 * @deprecated
4730 * @hide
4731 */
4732 @Deprecated
4733 public IBinder getIBinderExtra(String name) {
4734 return mExtras == null ? null : mExtras.getIBinder(name);
4735 }
4736
4737 /**
4738 * Retrieve extended data from the intent.
4739 *
4740 * @param name The name of the desired item.
4741 * @param defaultValue The default value to return in case no item is
4742 * associated with the key 'name'
4743 *
4744 * @return the value of an item that previously added with putExtra()
4745 * or defaultValue if none was found.
4746 *
4747 * @see #putExtra
4748 *
4749 * @deprecated
4750 * @hide
4751 */
4752 @Deprecated
4753 public Object getExtra(String name, Object defaultValue) {
4754 Object result = defaultValue;
4755 if (mExtras != null) {
4756 Object result2 = mExtras.get(name);
4757 if (result2 != null) {
4758 result = result2;
4759 }
4760 }
4761
4762 return result;
4763 }
4764
4765 /**
4766 * Retrieves a map of extended data from the intent.
4767 *
4768 * @return the map of all extras previously added with putExtra(),
4769 * or null if none have been added.
4770 */
4771 public Bundle getExtras() {
4772 return (mExtras != null)
4773 ? new Bundle(mExtras)
4774 : null;
4775 }
4776
4777 /**
4778 * Retrieve any special flags associated with this intent. You will
4779 * normally just set them with {@link #setFlags} and let the system
4780 * take the appropriate action with them.
4781 *
4782 * @return int The currently set flags.
4783 *
4784 * @see #setFlags
4785 */
4786 public int getFlags() {
4787 return mFlags;
4788 }
4789
Dianne Hackborne7f97212011-02-24 14:40:20 -08004790 /** @hide */
4791 public boolean isExcludingStopped() {
4792 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4793 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4794 }
4795
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004796 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004797 * Retrieve the application package name this Intent is limited to. When
4798 * resolving an Intent, if non-null this limits the resolution to only
4799 * components in the given application package.
4800 *
4801 * @return The name of the application package for the Intent.
4802 *
4803 * @see #resolveActivity
4804 * @see #setPackage
4805 */
4806 public String getPackage() {
4807 return mPackage;
4808 }
4809
4810 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004811 * Retrieve the concrete component associated with the intent. When receiving
4812 * an intent, this is the component that was found to best handle it (that is,
4813 * yourself) and will always be non-null; in all other cases it will be
4814 * null unless explicitly set.
4815 *
4816 * @return The name of the application component to handle the intent.
4817 *
4818 * @see #resolveActivity
4819 * @see #setComponent
4820 */
4821 public ComponentName getComponent() {
4822 return mComponent;
4823 }
4824
4825 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004826 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4827 * used as a hint to the receiver for animations and the like. Null means that there
4828 * is no source bounds.
4829 */
4830 public Rect getSourceBounds() {
4831 return mSourceBounds;
4832 }
4833
4834 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004835 * Return the Activity component that should be used to handle this intent.
4836 * The appropriate component is determined based on the information in the
4837 * intent, evaluated as follows:
4838 *
4839 * <p>If {@link #getComponent} returns an explicit class, that is returned
4840 * without any further consideration.
4841 *
4842 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4843 * category to be considered.
4844 *
4845 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4846 * action.
4847 *
4848 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4849 * this type.
4850 *
4851 * <p>If {@link #addCategory} has added any categories, the activity must
4852 * handle ALL of the categories specified.
4853 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004854 * <p>If {@link #getPackage} is non-NULL, only activity components in
4855 * that application package will be considered.
4856 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004857 * <p>If there are no activities that satisfy all of these conditions, a
4858 * null string is returned.
4859 *
4860 * <p>If multiple activities are found to satisfy the intent, the one with
4861 * the highest priority will be used. If there are multiple activities
4862 * with the same priority, the system will either pick the best activity
4863 * based on user preference, or resolve to a system class that will allow
4864 * the user to pick an activity and forward from there.
4865 *
4866 * <p>This method is implemented simply by calling
4867 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4868 * true.</p>
4869 * <p> This API is called for you as part of starting an activity from an
4870 * intent. You do not normally need to call it yourself.</p>
4871 *
4872 * @param pm The package manager with which to resolve the Intent.
4873 *
4874 * @return Name of the component implementing an activity that can
4875 * display the intent.
4876 *
4877 * @see #setComponent
4878 * @see #getComponent
4879 * @see #resolveActivityInfo
4880 */
4881 public ComponentName resolveActivity(PackageManager pm) {
4882 if (mComponent != null) {
4883 return mComponent;
4884 }
4885
4886 ResolveInfo info = pm.resolveActivity(
4887 this, PackageManager.MATCH_DEFAULT_ONLY);
4888 if (info != null) {
4889 return new ComponentName(
4890 info.activityInfo.applicationInfo.packageName,
4891 info.activityInfo.name);
4892 }
4893
4894 return null;
4895 }
4896
4897 /**
4898 * Resolve the Intent into an {@link ActivityInfo}
4899 * describing the activity that should execute the intent. Resolution
4900 * follows the same rules as described for {@link #resolveActivity}, but
4901 * you get back the completely information about the resolved activity
4902 * instead of just its class name.
4903 *
4904 * @param pm The package manager with which to resolve the Intent.
4905 * @param flags Addition information to retrieve as per
4906 * {@link PackageManager#getActivityInfo(ComponentName, int)
4907 * PackageManager.getActivityInfo()}.
4908 *
4909 * @return PackageManager.ActivityInfo
4910 *
4911 * @see #resolveActivity
4912 */
4913 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4914 ActivityInfo ai = null;
4915 if (mComponent != null) {
4916 try {
4917 ai = pm.getActivityInfo(mComponent, flags);
4918 } catch (PackageManager.NameNotFoundException e) {
4919 // ignore
4920 }
4921 } else {
4922 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004923 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004924 if (info != null) {
4925 ai = info.activityInfo;
4926 }
4927 }
4928
4929 return ai;
4930 }
4931
4932 /**
4933 * Set the general action to be performed.
4934 *
4935 * @param action An action name, such as ACTION_VIEW. Application-specific
4936 * actions should be prefixed with the vendor's package name.
4937 *
4938 * @return Returns the same Intent object, for chaining multiple calls
4939 * into a single statement.
4940 *
4941 * @see #getAction
4942 */
4943 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004944 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004945 return this;
4946 }
4947
4948 /**
4949 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004950 * clears any type that was previously set by {@link #setType} or
4951 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004952 *
Nick Pellyccae4122012-01-09 14:12:58 -08004953 * <p><em>Note: scheme matching in the Android framework is
4954 * case-sensitive, unlike the formal RFC. As a result,
4955 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004956 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004957 * {@link #setDataAndNormalize}
4958 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004959 *
Nick Pellyccae4122012-01-09 14:12:58 -08004960 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004961 *
4962 * @return Returns the same Intent object, for chaining multiple calls
4963 * into a single statement.
4964 *
4965 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004966 * @see #setDataAndNormalize
4967 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004968 */
4969 public Intent setData(Uri data) {
4970 mData = data;
4971 mType = null;
4972 return this;
4973 }
4974
4975 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004976 * Normalize and set the data this intent is operating on.
4977 *
4978 * <p>This method automatically clears any type that was
4979 * previously set (for example, by {@link #setType}).
4980 *
4981 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004982 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004983 * so really this is just a convenience method for
4984 * <pre>
4985 * setData(data.normalize())
4986 * </pre>
4987 *
4988 * @param data The Uri of the data this intent is now targeting.
4989 *
4990 * @return Returns the same Intent object, for chaining multiple calls
4991 * into a single statement.
4992 *
4993 * @see #getData
4994 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004995 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004996 */
4997 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004998 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004999 }
5000
5001 /**
5002 * Set an explicit MIME data type.
5003 *
5004 * <p>This is used to create intents that only specify a type and not data,
5005 * for example to indicate the type of data to return.
5006 *
5007 * <p>This method automatically clears any data that was
5008 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005009 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005010 * <p><em>Note: MIME type matching in the Android framework is
5011 * case-sensitive, unlike formal RFC MIME types. As a result,
5012 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005013 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5014 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005015 *
5016 * @param type The MIME type of the data being handled by this intent.
5017 *
5018 * @return Returns the same Intent object, for chaining multiple calls
5019 * into a single statement.
5020 *
5021 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005022 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005023 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005024 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005025 */
5026 public Intent setType(String type) {
5027 mData = null;
5028 mType = type;
5029 return this;
5030 }
5031
5032 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005033 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005034 *
Nick Pellyccae4122012-01-09 14:12:58 -08005035 * <p>This is used to create intents that only specify a type and not data,
5036 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005037 *
Nick Pellyccae4122012-01-09 14:12:58 -08005038 * <p>This method automatically clears any data that was
5039 * previously set (for example by {@link #setData}).
5040 *
5041 * <p>The MIME type is normalized using
5042 * {@link #normalizeMimeType} before it is set,
5043 * so really this is just a convenience method for
5044 * <pre>
5045 * setType(Intent.normalizeMimeType(type))
5046 * </pre>
5047 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005048 * @param type The MIME type of the data being handled by this intent.
5049 *
5050 * @return Returns the same Intent object, for chaining multiple calls
5051 * into a single statement.
5052 *
Nick Pellyccae4122012-01-09 14:12:58 -08005053 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005054 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005055 * @see #normalizeMimeType
5056 */
5057 public Intent setTypeAndNormalize(String type) {
5058 return setType(normalizeMimeType(type));
5059 }
5060
5061 /**
5062 * (Usually optional) Set the data for the intent along with an explicit
5063 * MIME data type. This method should very rarely be used -- it allows you
5064 * to override the MIME type that would ordinarily be inferred from the
5065 * data with your own type given here.
5066 *
5067 * <p><em>Note: MIME type and Uri scheme matching in the
5068 * Android framework is case-sensitive, unlike the formal RFC definitions.
5069 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005070 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005071 * {@link #setDataAndTypeAndNormalize}
5072 * to ensure that they are converted to lower case.</em>
5073 *
5074 * @param data The Uri of the data this intent is now targeting.
5075 * @param type The MIME type of the data being handled by this intent.
5076 *
5077 * @return Returns the same Intent object, for chaining multiple calls
5078 * into a single statement.
5079 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005080 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005081 * @see #setData
5082 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005083 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005084 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005085 */
5086 public Intent setDataAndType(Uri data, String type) {
5087 mData = data;
5088 mType = type;
5089 return this;
5090 }
5091
5092 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005093 * (Usually optional) Normalize and set both the data Uri and an explicit
5094 * MIME data type. This method should very rarely be used -- it allows you
5095 * to override the MIME type that would ordinarily be inferred from the
5096 * data with your own type given here.
5097 *
5098 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005099 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005100 * before they are set, so really this is just a convenience method for
5101 * <pre>
5102 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5103 * </pre>
5104 *
5105 * @param data The Uri of the data this intent is now targeting.
5106 * @param type The MIME type of the data being handled by this intent.
5107 *
5108 * @return Returns the same Intent object, for chaining multiple calls
5109 * into a single statement.
5110 *
5111 * @see #setType
5112 * @see #setData
5113 * @see #setDataAndType
5114 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005115 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005116 */
5117 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005118 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005119 }
5120
5121 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005122 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005123 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005124 * activities that provide <em>all</em> of the requested categories will be
5125 * used.
5126 *
5127 * @param category The desired category. This can be either one of the
5128 * predefined Intent categories, or a custom category in your own
5129 * namespace.
5130 *
5131 * @return Returns the same Intent object, for chaining multiple calls
5132 * into a single statement.
5133 *
5134 * @see #hasCategory
5135 * @see #removeCategory
5136 */
5137 public Intent addCategory(String category) {
5138 if (mCategories == null) {
5139 mCategories = new HashSet<String>();
5140 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005141 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005142 return this;
5143 }
5144
5145 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005146 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005147 *
5148 * @param category The category to remove.
5149 *
5150 * @see #addCategory
5151 */
5152 public void removeCategory(String category) {
5153 if (mCategories != null) {
5154 mCategories.remove(category);
5155 if (mCategories.size() == 0) {
5156 mCategories = null;
5157 }
5158 }
5159 }
5160
5161 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005162 * Set a selector for this Intent. This is a modification to the kinds of
5163 * things the Intent will match. If the selector is set, it will be used
5164 * when trying to find entities that can handle the Intent, instead of the
5165 * main contents of the Intent. This allows you build an Intent containing
5166 * a generic protocol while targeting it more specifically.
5167 *
5168 * <p>An example of where this may be used is with things like
5169 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5170 * Intent that will launch the Browser application. However, the correct
5171 * main entry point of an application is actually {@link #ACTION_MAIN}
5172 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5173 * used to specify the actual Activity to launch. If you launch the browser
5174 * with something different, undesired behavior may happen if the user has
5175 * previously or later launches it the normal way, since they do not match.
5176 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5177 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5178 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5179 *
5180 * <p>Setting a selector does not impact the behavior of
5181 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5182 * desired behavior of a selector -- it does not impact the base meaning
5183 * of the Intent, just what kinds of things will be matched against it
5184 * when determining who can handle it.</p>
5185 *
5186 * <p>You can not use both a selector and {@link #setPackage(String)} on
5187 * the same base Intent.</p>
5188 *
5189 * @param selector The desired selector Intent; set to null to not use
5190 * a special selector.
5191 */
5192 public void setSelector(Intent selector) {
5193 if (selector == this) {
5194 throw new IllegalArgumentException(
5195 "Intent being set as a selector of itself");
5196 }
5197 if (selector != null && mPackage != null) {
5198 throw new IllegalArgumentException(
5199 "Can't set selector when package name is already set");
5200 }
5201 mSelector = selector;
5202 }
5203
5204 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005205 * Set a {@link ClipData} associated with this Intent. This replaces any
5206 * previously set ClipData.
5207 *
5208 * <p>The ClipData in an intent is not used for Intent matching or other
5209 * such operations. Semantically it is like extras, used to transmit
5210 * additional data with the Intent. The main feature of using this over
5211 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5212 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5213 * items included in the clip data. This is useful, in particular, if
5214 * you want to transmit an Intent containing multiple <code>content:</code>
5215 * URIs for which the recipient may not have global permission to access the
5216 * content provider.
5217 *
5218 * <p>If the ClipData contains items that are themselves Intents, any
5219 * grant flags in those Intents will be ignored. Only the top-level flags
5220 * of the main Intent are respected, and will be applied to all Uri or
5221 * Intent items in the clip (or sub-items of the clip).
5222 *
5223 * <p>The MIME type, label, and icon in the ClipData object are not
5224 * directly used by Intent. Applications should generally rely on the
5225 * MIME type of the Intent itself, not what it may find in the ClipData.
5226 * A common practice is to construct a ClipData for use with an Intent
5227 * with a MIME type of "*\/*".
5228 *
5229 * @param clip The new clip to set. May be null to clear the current clip.
5230 */
5231 public void setClipData(ClipData clip) {
5232 mClipData = clip;
5233 }
5234
5235 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005236 * Add extended data to the intent. The name must include a package
5237 * prefix, for example the app com.android.contacts would use names
5238 * like "com.android.contacts.ShowAll".
5239 *
5240 * @param name The name of the extra data, with package prefix.
5241 * @param value The boolean data value.
5242 *
5243 * @return Returns the same Intent object, for chaining multiple calls
5244 * into a single statement.
5245 *
5246 * @see #putExtras
5247 * @see #removeExtra
5248 * @see #getBooleanExtra(String, boolean)
5249 */
5250 public Intent putExtra(String name, boolean value) {
5251 if (mExtras == null) {
5252 mExtras = new Bundle();
5253 }
5254 mExtras.putBoolean(name, value);
5255 return this;
5256 }
5257
5258 /**
5259 * Add extended data to the intent. The name must include a package
5260 * prefix, for example the app com.android.contacts would use names
5261 * like "com.android.contacts.ShowAll".
5262 *
5263 * @param name The name of the extra data, with package prefix.
5264 * @param value The byte data value.
5265 *
5266 * @return Returns the same Intent object, for chaining multiple calls
5267 * into a single statement.
5268 *
5269 * @see #putExtras
5270 * @see #removeExtra
5271 * @see #getByteExtra(String, byte)
5272 */
5273 public Intent putExtra(String name, byte value) {
5274 if (mExtras == null) {
5275 mExtras = new Bundle();
5276 }
5277 mExtras.putByte(name, value);
5278 return this;
5279 }
5280
5281 /**
5282 * Add extended data to the intent. The name must include a package
5283 * prefix, for example the app com.android.contacts would use names
5284 * like "com.android.contacts.ShowAll".
5285 *
5286 * @param name The name of the extra data, with package prefix.
5287 * @param value The char data value.
5288 *
5289 * @return Returns the same Intent object, for chaining multiple calls
5290 * into a single statement.
5291 *
5292 * @see #putExtras
5293 * @see #removeExtra
5294 * @see #getCharExtra(String, char)
5295 */
5296 public Intent putExtra(String name, char value) {
5297 if (mExtras == null) {
5298 mExtras = new Bundle();
5299 }
5300 mExtras.putChar(name, value);
5301 return this;
5302 }
5303
5304 /**
5305 * Add extended data to the intent. The name must include a package
5306 * prefix, for example the app com.android.contacts would use names
5307 * like "com.android.contacts.ShowAll".
5308 *
5309 * @param name The name of the extra data, with package prefix.
5310 * @param value The short data value.
5311 *
5312 * @return Returns the same Intent object, for chaining multiple calls
5313 * into a single statement.
5314 *
5315 * @see #putExtras
5316 * @see #removeExtra
5317 * @see #getShortExtra(String, short)
5318 */
5319 public Intent putExtra(String name, short value) {
5320 if (mExtras == null) {
5321 mExtras = new Bundle();
5322 }
5323 mExtras.putShort(name, value);
5324 return this;
5325 }
5326
5327 /**
5328 * Add extended data to the intent. The name must include a package
5329 * prefix, for example the app com.android.contacts would use names
5330 * like "com.android.contacts.ShowAll".
5331 *
5332 * @param name The name of the extra data, with package prefix.
5333 * @param value The integer data value.
5334 *
5335 * @return Returns the same Intent object, for chaining multiple calls
5336 * into a single statement.
5337 *
5338 * @see #putExtras
5339 * @see #removeExtra
5340 * @see #getIntExtra(String, int)
5341 */
5342 public Intent putExtra(String name, int value) {
5343 if (mExtras == null) {
5344 mExtras = new Bundle();
5345 }
5346 mExtras.putInt(name, value);
5347 return this;
5348 }
5349
5350 /**
5351 * Add extended data to the intent. The name must include a package
5352 * prefix, for example the app com.android.contacts would use names
5353 * like "com.android.contacts.ShowAll".
5354 *
5355 * @param name The name of the extra data, with package prefix.
5356 * @param value The long data value.
5357 *
5358 * @return Returns the same Intent object, for chaining multiple calls
5359 * into a single statement.
5360 *
5361 * @see #putExtras
5362 * @see #removeExtra
5363 * @see #getLongExtra(String, long)
5364 */
5365 public Intent putExtra(String name, long value) {
5366 if (mExtras == null) {
5367 mExtras = new Bundle();
5368 }
5369 mExtras.putLong(name, value);
5370 return this;
5371 }
5372
5373 /**
5374 * Add extended data to the intent. The name must include a package
5375 * prefix, for example the app com.android.contacts would use names
5376 * like "com.android.contacts.ShowAll".
5377 *
5378 * @param name The name of the extra data, with package prefix.
5379 * @param value The float data value.
5380 *
5381 * @return Returns the same Intent object, for chaining multiple calls
5382 * into a single statement.
5383 *
5384 * @see #putExtras
5385 * @see #removeExtra
5386 * @see #getFloatExtra(String, float)
5387 */
5388 public Intent putExtra(String name, float value) {
5389 if (mExtras == null) {
5390 mExtras = new Bundle();
5391 }
5392 mExtras.putFloat(name, value);
5393 return this;
5394 }
5395
5396 /**
5397 * Add extended data to the intent. The name must include a package
5398 * prefix, for example the app com.android.contacts would use names
5399 * like "com.android.contacts.ShowAll".
5400 *
5401 * @param name The name of the extra data, with package prefix.
5402 * @param value The double data value.
5403 *
5404 * @return Returns the same Intent object, for chaining multiple calls
5405 * into a single statement.
5406 *
5407 * @see #putExtras
5408 * @see #removeExtra
5409 * @see #getDoubleExtra(String, double)
5410 */
5411 public Intent putExtra(String name, double value) {
5412 if (mExtras == null) {
5413 mExtras = new Bundle();
5414 }
5415 mExtras.putDouble(name, value);
5416 return this;
5417 }
5418
5419 /**
5420 * Add extended data to the intent. The name must include a package
5421 * prefix, for example the app com.android.contacts would use names
5422 * like "com.android.contacts.ShowAll".
5423 *
5424 * @param name The name of the extra data, with package prefix.
5425 * @param value The String data value.
5426 *
5427 * @return Returns the same Intent object, for chaining multiple calls
5428 * into a single statement.
5429 *
5430 * @see #putExtras
5431 * @see #removeExtra
5432 * @see #getStringExtra(String)
5433 */
5434 public Intent putExtra(String name, String value) {
5435 if (mExtras == null) {
5436 mExtras = new Bundle();
5437 }
5438 mExtras.putString(name, value);
5439 return this;
5440 }
5441
5442 /**
5443 * Add extended data to the intent. The name must include a package
5444 * prefix, for example the app com.android.contacts would use names
5445 * like "com.android.contacts.ShowAll".
5446 *
5447 * @param name The name of the extra data, with package prefix.
5448 * @param value The CharSequence data value.
5449 *
5450 * @return Returns the same Intent object, for chaining multiple calls
5451 * into a single statement.
5452 *
5453 * @see #putExtras
5454 * @see #removeExtra
5455 * @see #getCharSequenceExtra(String)
5456 */
5457 public Intent putExtra(String name, CharSequence value) {
5458 if (mExtras == null) {
5459 mExtras = new Bundle();
5460 }
5461 mExtras.putCharSequence(name, value);
5462 return this;
5463 }
5464
5465 /**
5466 * Add extended data to the intent. The name must include a package
5467 * prefix, for example the app com.android.contacts would use names
5468 * like "com.android.contacts.ShowAll".
5469 *
5470 * @param name The name of the extra data, with package prefix.
5471 * @param value The Parcelable data value.
5472 *
5473 * @return Returns the same Intent object, for chaining multiple calls
5474 * into a single statement.
5475 *
5476 * @see #putExtras
5477 * @see #removeExtra
5478 * @see #getParcelableExtra(String)
5479 */
5480 public Intent putExtra(String name, Parcelable value) {
5481 if (mExtras == null) {
5482 mExtras = new Bundle();
5483 }
5484 mExtras.putParcelable(name, value);
5485 return this;
5486 }
5487
5488 /**
5489 * Add extended data to the intent. The name must include a package
5490 * prefix, for example the app com.android.contacts would use names
5491 * like "com.android.contacts.ShowAll".
5492 *
5493 * @param name The name of the extra data, with package prefix.
5494 * @param value The Parcelable[] data value.
5495 *
5496 * @return Returns the same Intent object, for chaining multiple calls
5497 * into a single statement.
5498 *
5499 * @see #putExtras
5500 * @see #removeExtra
5501 * @see #getParcelableArrayExtra(String)
5502 */
5503 public Intent putExtra(String name, Parcelable[] value) {
5504 if (mExtras == null) {
5505 mExtras = new Bundle();
5506 }
5507 mExtras.putParcelableArray(name, value);
5508 return this;
5509 }
5510
5511 /**
5512 * Add extended data to the intent. The name must include a package
5513 * prefix, for example the app com.android.contacts would use names
5514 * like "com.android.contacts.ShowAll".
5515 *
5516 * @param name The name of the extra data, with package prefix.
5517 * @param value The ArrayList<Parcelable> data value.
5518 *
5519 * @return Returns the same Intent object, for chaining multiple calls
5520 * into a single statement.
5521 *
5522 * @see #putExtras
5523 * @see #removeExtra
5524 * @see #getParcelableArrayListExtra(String)
5525 */
5526 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5527 if (mExtras == null) {
5528 mExtras = new Bundle();
5529 }
5530 mExtras.putParcelableArrayList(name, value);
5531 return this;
5532 }
5533
5534 /**
5535 * Add extended data to the intent. The name must include a package
5536 * prefix, for example the app com.android.contacts would use names
5537 * like "com.android.contacts.ShowAll".
5538 *
5539 * @param name The name of the extra data, with package prefix.
5540 * @param value The ArrayList<Integer> data value.
5541 *
5542 * @return Returns the same Intent object, for chaining multiple calls
5543 * into a single statement.
5544 *
5545 * @see #putExtras
5546 * @see #removeExtra
5547 * @see #getIntegerArrayListExtra(String)
5548 */
5549 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5550 if (mExtras == null) {
5551 mExtras = new Bundle();
5552 }
5553 mExtras.putIntegerArrayList(name, value);
5554 return this;
5555 }
5556
5557 /**
5558 * Add extended data to the intent. The name must include a package
5559 * prefix, for example the app com.android.contacts would use names
5560 * like "com.android.contacts.ShowAll".
5561 *
5562 * @param name The name of the extra data, with package prefix.
5563 * @param value The ArrayList<String> data value.
5564 *
5565 * @return Returns the same Intent object, for chaining multiple calls
5566 * into a single statement.
5567 *
5568 * @see #putExtras
5569 * @see #removeExtra
5570 * @see #getStringArrayListExtra(String)
5571 */
5572 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5573 if (mExtras == null) {
5574 mExtras = new Bundle();
5575 }
5576 mExtras.putStringArrayList(name, value);
5577 return this;
5578 }
5579
5580 /**
5581 * Add extended data to the intent. The name must include a package
5582 * prefix, for example the app com.android.contacts would use names
5583 * like "com.android.contacts.ShowAll".
5584 *
5585 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005586 * @param value The ArrayList<CharSequence> data value.
5587 *
5588 * @return Returns the same Intent object, for chaining multiple calls
5589 * into a single statement.
5590 *
5591 * @see #putExtras
5592 * @see #removeExtra
5593 * @see #getCharSequenceArrayListExtra(String)
5594 */
5595 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5596 if (mExtras == null) {
5597 mExtras = new Bundle();
5598 }
5599 mExtras.putCharSequenceArrayList(name, value);
5600 return this;
5601 }
5602
5603 /**
5604 * Add extended data to the intent. The name must include a package
5605 * prefix, for example the app com.android.contacts would use names
5606 * like "com.android.contacts.ShowAll".
5607 *
5608 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005609 * @param value The Serializable data value.
5610 *
5611 * @return Returns the same Intent object, for chaining multiple calls
5612 * into a single statement.
5613 *
5614 * @see #putExtras
5615 * @see #removeExtra
5616 * @see #getSerializableExtra(String)
5617 */
5618 public Intent putExtra(String name, Serializable value) {
5619 if (mExtras == null) {
5620 mExtras = new Bundle();
5621 }
5622 mExtras.putSerializable(name, value);
5623 return this;
5624 }
5625
5626 /**
5627 * Add extended data to the intent. The name must include a package
5628 * prefix, for example the app com.android.contacts would use names
5629 * like "com.android.contacts.ShowAll".
5630 *
5631 * @param name The name of the extra data, with package prefix.
5632 * @param value The boolean array data value.
5633 *
5634 * @return Returns the same Intent object, for chaining multiple calls
5635 * into a single statement.
5636 *
5637 * @see #putExtras
5638 * @see #removeExtra
5639 * @see #getBooleanArrayExtra(String)
5640 */
5641 public Intent putExtra(String name, boolean[] value) {
5642 if (mExtras == null) {
5643 mExtras = new Bundle();
5644 }
5645 mExtras.putBooleanArray(name, value);
5646 return this;
5647 }
5648
5649 /**
5650 * Add extended data to the intent. The name must include a package
5651 * prefix, for example the app com.android.contacts would use names
5652 * like "com.android.contacts.ShowAll".
5653 *
5654 * @param name The name of the extra data, with package prefix.
5655 * @param value The byte array data value.
5656 *
5657 * @return Returns the same Intent object, for chaining multiple calls
5658 * into a single statement.
5659 *
5660 * @see #putExtras
5661 * @see #removeExtra
5662 * @see #getByteArrayExtra(String)
5663 */
5664 public Intent putExtra(String name, byte[] value) {
5665 if (mExtras == null) {
5666 mExtras = new Bundle();
5667 }
5668 mExtras.putByteArray(name, value);
5669 return this;
5670 }
5671
5672 /**
5673 * Add extended data to the intent. The name must include a package
5674 * prefix, for example the app com.android.contacts would use names
5675 * like "com.android.contacts.ShowAll".
5676 *
5677 * @param name The name of the extra data, with package prefix.
5678 * @param value The short array data value.
5679 *
5680 * @return Returns the same Intent object, for chaining multiple calls
5681 * into a single statement.
5682 *
5683 * @see #putExtras
5684 * @see #removeExtra
5685 * @see #getShortArrayExtra(String)
5686 */
5687 public Intent putExtra(String name, short[] value) {
5688 if (mExtras == null) {
5689 mExtras = new Bundle();
5690 }
5691 mExtras.putShortArray(name, value);
5692 return this;
5693 }
5694
5695 /**
5696 * Add extended data to the intent. The name must include a package
5697 * prefix, for example the app com.android.contacts would use names
5698 * like "com.android.contacts.ShowAll".
5699 *
5700 * @param name The name of the extra data, with package prefix.
5701 * @param value The char array data value.
5702 *
5703 * @return Returns the same Intent object, for chaining multiple calls
5704 * into a single statement.
5705 *
5706 * @see #putExtras
5707 * @see #removeExtra
5708 * @see #getCharArrayExtra(String)
5709 */
5710 public Intent putExtra(String name, char[] value) {
5711 if (mExtras == null) {
5712 mExtras = new Bundle();
5713 }
5714 mExtras.putCharArray(name, value);
5715 return this;
5716 }
5717
5718 /**
5719 * Add extended data to the intent. The name must include a package
5720 * prefix, for example the app com.android.contacts would use names
5721 * like "com.android.contacts.ShowAll".
5722 *
5723 * @param name The name of the extra data, with package prefix.
5724 * @param value The int array data value.
5725 *
5726 * @return Returns the same Intent object, for chaining multiple calls
5727 * into a single statement.
5728 *
5729 * @see #putExtras
5730 * @see #removeExtra
5731 * @see #getIntArrayExtra(String)
5732 */
5733 public Intent putExtra(String name, int[] value) {
5734 if (mExtras == null) {
5735 mExtras = new Bundle();
5736 }
5737 mExtras.putIntArray(name, value);
5738 return this;
5739 }
5740
5741 /**
5742 * Add extended data to the intent. The name must include a package
5743 * prefix, for example the app com.android.contacts would use names
5744 * like "com.android.contacts.ShowAll".
5745 *
5746 * @param name The name of the extra data, with package prefix.
5747 * @param value The byte array data value.
5748 *
5749 * @return Returns the same Intent object, for chaining multiple calls
5750 * into a single statement.
5751 *
5752 * @see #putExtras
5753 * @see #removeExtra
5754 * @see #getLongArrayExtra(String)
5755 */
5756 public Intent putExtra(String name, long[] value) {
5757 if (mExtras == null) {
5758 mExtras = new Bundle();
5759 }
5760 mExtras.putLongArray(name, value);
5761 return this;
5762 }
5763
5764 /**
5765 * Add extended data to the intent. The name must include a package
5766 * prefix, for example the app com.android.contacts would use names
5767 * like "com.android.contacts.ShowAll".
5768 *
5769 * @param name The name of the extra data, with package prefix.
5770 * @param value The float array data value.
5771 *
5772 * @return Returns the same Intent object, for chaining multiple calls
5773 * into a single statement.
5774 *
5775 * @see #putExtras
5776 * @see #removeExtra
5777 * @see #getFloatArrayExtra(String)
5778 */
5779 public Intent putExtra(String name, float[] value) {
5780 if (mExtras == null) {
5781 mExtras = new Bundle();
5782 }
5783 mExtras.putFloatArray(name, value);
5784 return this;
5785 }
5786
5787 /**
5788 * Add extended data to the intent. The name must include a package
5789 * prefix, for example the app com.android.contacts would use names
5790 * like "com.android.contacts.ShowAll".
5791 *
5792 * @param name The name of the extra data, with package prefix.
5793 * @param value The double array data value.
5794 *
5795 * @return Returns the same Intent object, for chaining multiple calls
5796 * into a single statement.
5797 *
5798 * @see #putExtras
5799 * @see #removeExtra
5800 * @see #getDoubleArrayExtra(String)
5801 */
5802 public Intent putExtra(String name, double[] value) {
5803 if (mExtras == null) {
5804 mExtras = new Bundle();
5805 }
5806 mExtras.putDoubleArray(name, value);
5807 return this;
5808 }
5809
5810 /**
5811 * Add extended data to the intent. The name must include a package
5812 * prefix, for example the app com.android.contacts would use names
5813 * like "com.android.contacts.ShowAll".
5814 *
5815 * @param name The name of the extra data, with package prefix.
5816 * @param value The String array data value.
5817 *
5818 * @return Returns the same Intent object, for chaining multiple calls
5819 * into a single statement.
5820 *
5821 * @see #putExtras
5822 * @see #removeExtra
5823 * @see #getStringArrayExtra(String)
5824 */
5825 public Intent putExtra(String name, String[] value) {
5826 if (mExtras == null) {
5827 mExtras = new Bundle();
5828 }
5829 mExtras.putStringArray(name, value);
5830 return this;
5831 }
5832
5833 /**
5834 * Add extended data to the intent. The name must include a package
5835 * prefix, for example the app com.android.contacts would use names
5836 * like "com.android.contacts.ShowAll".
5837 *
5838 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005839 * @param value The CharSequence array data value.
5840 *
5841 * @return Returns the same Intent object, for chaining multiple calls
5842 * into a single statement.
5843 *
5844 * @see #putExtras
5845 * @see #removeExtra
5846 * @see #getCharSequenceArrayExtra(String)
5847 */
5848 public Intent putExtra(String name, CharSequence[] value) {
5849 if (mExtras == null) {
5850 mExtras = new Bundle();
5851 }
5852 mExtras.putCharSequenceArray(name, value);
5853 return this;
5854 }
5855
5856 /**
5857 * Add extended data to the intent. The name must include a package
5858 * prefix, for example the app com.android.contacts would use names
5859 * like "com.android.contacts.ShowAll".
5860 *
5861 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005862 * @param value The Bundle data value.
5863 *
5864 * @return Returns the same Intent object, for chaining multiple calls
5865 * into a single statement.
5866 *
5867 * @see #putExtras
5868 * @see #removeExtra
5869 * @see #getBundleExtra(String)
5870 */
5871 public Intent putExtra(String name, Bundle value) {
5872 if (mExtras == null) {
5873 mExtras = new Bundle();
5874 }
5875 mExtras.putBundle(name, value);
5876 return this;
5877 }
5878
5879 /**
5880 * Add extended data to the intent. The name must include a package
5881 * prefix, for example the app com.android.contacts would use names
5882 * like "com.android.contacts.ShowAll".
5883 *
5884 * @param name The name of the extra data, with package prefix.
5885 * @param value The IBinder data value.
5886 *
5887 * @return Returns the same Intent object, for chaining multiple calls
5888 * into a single statement.
5889 *
5890 * @see #putExtras
5891 * @see #removeExtra
5892 * @see #getIBinderExtra(String)
5893 *
5894 * @deprecated
5895 * @hide
5896 */
5897 @Deprecated
5898 public Intent putExtra(String name, IBinder value) {
5899 if (mExtras == null) {
5900 mExtras = new Bundle();
5901 }
5902 mExtras.putIBinder(name, value);
5903 return this;
5904 }
5905
5906 /**
5907 * Copy all extras in 'src' in to this intent.
5908 *
5909 * @param src Contains the extras to copy.
5910 *
5911 * @see #putExtra
5912 */
5913 public Intent putExtras(Intent src) {
5914 if (src.mExtras != null) {
5915 if (mExtras == null) {
5916 mExtras = new Bundle(src.mExtras);
5917 } else {
5918 mExtras.putAll(src.mExtras);
5919 }
5920 }
5921 return this;
5922 }
5923
5924 /**
5925 * Add a set of extended data to the intent. The keys must include a package
5926 * prefix, for example the app com.android.contacts would use names
5927 * like "com.android.contacts.ShowAll".
5928 *
5929 * @param extras The Bundle of extras to add to this intent.
5930 *
5931 * @see #putExtra
5932 * @see #removeExtra
5933 */
5934 public Intent putExtras(Bundle extras) {
5935 if (mExtras == null) {
5936 mExtras = new Bundle();
5937 }
5938 mExtras.putAll(extras);
5939 return this;
5940 }
5941
5942 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005943 * Completely replace the extras in the Intent with the extras in the
5944 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005945 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005946 * @param src The exact extras contained in this Intent are copied
5947 * into the target intent, replacing any that were previously there.
5948 */
5949 public Intent replaceExtras(Intent src) {
5950 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5951 return this;
5952 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005953
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005954 /**
5955 * Completely replace the extras in the Intent with the given Bundle of
5956 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005957 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005958 * @param extras The new set of extras in the Intent, or null to erase
5959 * all extras.
5960 */
5961 public Intent replaceExtras(Bundle extras) {
5962 mExtras = extras != null ? new Bundle(extras) : null;
5963 return this;
5964 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005965
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005966 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005967 * Remove extended data from the intent.
5968 *
5969 * @see #putExtra
5970 */
5971 public void removeExtra(String name) {
5972 if (mExtras != null) {
5973 mExtras.remove(name);
5974 if (mExtras.size() == 0) {
5975 mExtras = null;
5976 }
5977 }
5978 }
5979
5980 /**
5981 * Set special flags controlling how this intent is handled. Most values
5982 * here depend on the type of component being executed by the Intent,
5983 * specifically the FLAG_ACTIVITY_* flags are all for use with
5984 * {@link Context#startActivity Context.startActivity()} and the
5985 * FLAG_RECEIVER_* flags are all for use with
5986 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5987 *
Scott Main7aee61f2011-02-08 11:25:01 -08005988 * <p>See the
5989 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5990 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005991 * the behavior of your application.
5992 *
5993 * @param flags The desired flags.
5994 *
5995 * @return Returns the same Intent object, for chaining multiple calls
5996 * into a single statement.
5997 *
5998 * @see #getFlags
5999 * @see #addFlags
6000 *
6001 * @see #FLAG_GRANT_READ_URI_PERMISSION
6002 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6003 * @see #FLAG_DEBUG_LOG_RESOLUTION
6004 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006005 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006006 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006007 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006008 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006009 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6010 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006011 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006012 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
6013 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006014 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006015 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006016 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006017 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6018 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006019 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006020 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006021 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006022 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6023 */
6024 public Intent setFlags(int flags) {
6025 mFlags = flags;
6026 return this;
6027 }
6028
6029 /**
6030 * Add additional flags to the intent (or with existing flags
6031 * value).
6032 *
6033 * @param flags The new flags to set.
6034 *
6035 * @return Returns the same Intent object, for chaining multiple calls
6036 * into a single statement.
6037 *
6038 * @see #setFlags
6039 */
6040 public Intent addFlags(int flags) {
6041 mFlags |= flags;
6042 return this;
6043 }
6044
6045 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006046 * (Usually optional) Set an explicit application package name that limits
6047 * the components this Intent will resolve to. If left to the default
6048 * value of null, all components in all applications will considered.
6049 * If non-null, the Intent can only match the components in the given
6050 * application package.
6051 *
6052 * @param packageName The name of the application package to handle the
6053 * intent, or null to allow any application package.
6054 *
6055 * @return Returns the same Intent object, for chaining multiple calls
6056 * into a single statement.
6057 *
6058 * @see #getPackage
6059 * @see #resolveActivity
6060 */
6061 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006062 if (packageName != null && mSelector != null) {
6063 throw new IllegalArgumentException(
6064 "Can't set package name when selector is already set");
6065 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006066 mPackage = packageName;
6067 return this;
6068 }
6069
6070 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006071 * (Usually optional) Explicitly set the component to handle the intent.
6072 * If left with the default value of null, the system will determine the
6073 * appropriate class to use based on the other fields (action, data,
6074 * type, categories) in the Intent. If this class is defined, the
6075 * specified class will always be used regardless of the other fields. You
6076 * should only set this value when you know you absolutely want a specific
6077 * class to be used; otherwise it is better to let the system find the
6078 * appropriate class so that you will respect the installed applications
6079 * and user preferences.
6080 *
6081 * @param component The name of the application component to handle the
6082 * intent, or null to let the system find one for you.
6083 *
6084 * @return Returns the same Intent object, for chaining multiple calls
6085 * into a single statement.
6086 *
6087 * @see #setClass
6088 * @see #setClassName(Context, String)
6089 * @see #setClassName(String, String)
6090 * @see #getComponent
6091 * @see #resolveActivity
6092 */
6093 public Intent setComponent(ComponentName component) {
6094 mComponent = component;
6095 return this;
6096 }
6097
6098 /**
6099 * Convenience for calling {@link #setComponent} with an
6100 * explicit class name.
6101 *
6102 * @param packageContext A Context of the application package implementing
6103 * this class.
6104 * @param className The name of a class inside of the application package
6105 * that will be used as the component for this Intent.
6106 *
6107 * @return Returns the same Intent object, for chaining multiple calls
6108 * into a single statement.
6109 *
6110 * @see #setComponent
6111 * @see #setClass
6112 */
6113 public Intent setClassName(Context packageContext, String className) {
6114 mComponent = new ComponentName(packageContext, className);
6115 return this;
6116 }
6117
6118 /**
6119 * Convenience for calling {@link #setComponent} with an
6120 * explicit application package name and class name.
6121 *
6122 * @param packageName The name of the package implementing the desired
6123 * component.
6124 * @param className The name of a class inside of the application package
6125 * that will be used as the component for this Intent.
6126 *
6127 * @return Returns the same Intent object, for chaining multiple calls
6128 * into a single statement.
6129 *
6130 * @see #setComponent
6131 * @see #setClass
6132 */
6133 public Intent setClassName(String packageName, String className) {
6134 mComponent = new ComponentName(packageName, className);
6135 return this;
6136 }
6137
6138 /**
6139 * Convenience for calling {@link #setComponent(ComponentName)} with the
6140 * name returned by a {@link Class} object.
6141 *
6142 * @param packageContext A Context of the application package implementing
6143 * this class.
6144 * @param cls The class name to set, equivalent to
6145 * <code>setClassName(context, cls.getName())</code>.
6146 *
6147 * @return Returns the same Intent object, for chaining multiple calls
6148 * into a single statement.
6149 *
6150 * @see #setComponent
6151 */
6152 public Intent setClass(Context packageContext, Class<?> cls) {
6153 mComponent = new ComponentName(packageContext, cls);
6154 return this;
6155 }
6156
6157 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006158 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6159 * used as a hint to the receiver for animations and the like. Null means that there
6160 * is no source bounds.
6161 */
6162 public void setSourceBounds(Rect r) {
6163 if (r != null) {
6164 mSourceBounds = new Rect(r);
6165 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006166 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006167 }
6168 }
6169
6170 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006171 * Use with {@link #fillIn} to allow the current action value to be
6172 * overwritten, even if it is already set.
6173 */
6174 public static final int FILL_IN_ACTION = 1<<0;
6175
6176 /**
6177 * Use with {@link #fillIn} to allow the current data or type value
6178 * overwritten, even if it is already set.
6179 */
6180 public static final int FILL_IN_DATA = 1<<1;
6181
6182 /**
6183 * Use with {@link #fillIn} to allow the current categories to be
6184 * overwritten, even if they are already set.
6185 */
6186 public static final int FILL_IN_CATEGORIES = 1<<2;
6187
6188 /**
6189 * Use with {@link #fillIn} to allow the current component value to be
6190 * overwritten, even if it is already set.
6191 */
6192 public static final int FILL_IN_COMPONENT = 1<<3;
6193
6194 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006195 * Use with {@link #fillIn} to allow the current package value to be
6196 * overwritten, even if it is already set.
6197 */
6198 public static final int FILL_IN_PACKAGE = 1<<4;
6199
6200 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006201 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006202 * overwritten, even if it is already set.
6203 */
6204 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6205
6206 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006207 * Use with {@link #fillIn} to allow the current selector to be
6208 * overwritten, even if it is already set.
6209 */
6210 public static final int FILL_IN_SELECTOR = 1<<6;
6211
6212 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006213 * Use with {@link #fillIn} to allow the current ClipData to be
6214 * overwritten, even if it is already set.
6215 */
6216 public static final int FILL_IN_CLIP_DATA = 1<<7;
6217
6218 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006219 * Copy the contents of <var>other</var> in to this object, but only
6220 * where fields are not defined by this object. For purposes of a field
6221 * being defined, the following pieces of data in the Intent are
6222 * considered to be separate fields:
6223 *
6224 * <ul>
6225 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006226 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006227 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6228 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006229 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006230 * <li> component, as set by {@link #setComponent(ComponentName)} or
6231 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006232 * <li> source bounds, as set by {@link #setSourceBounds}.
6233 * <li> selector, as set by {@link #setSelector(Intent)}.
6234 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006235 * <li> each top-level name in the associated extras.
6236 * </ul>
6237 *
6238 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006239 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006240 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6241 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6242 * the restriction where the corresponding field will not be replaced if
6243 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006244 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006245 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6246 * is explicitly specified. The selector will only be copied if
6247 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006248 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006249 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6250 * and Intent B with {action="gotit", data-type="some/thing",
6251 * categories="one","two"}.
6252 *
6253 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6254 * containing: {action="gotit", data-type="some/thing",
6255 * categories="bar"}.
6256 *
6257 * @param other Another Intent whose values are to be used to fill in
6258 * the current one.
6259 * @param flags Options to control which fields can be filled in.
6260 *
6261 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006262 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006263 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6264 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006265 */
6266 public int fillIn(Intent other, int flags) {
6267 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006268 if (other.mAction != null
6269 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006270 mAction = other.mAction;
6271 changes |= FILL_IN_ACTION;
6272 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006273 if ((other.mData != null || other.mType != null)
6274 && ((mData == null && mType == null)
6275 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006276 mData = other.mData;
6277 mType = other.mType;
6278 changes |= FILL_IN_DATA;
6279 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006280 if (other.mCategories != null
6281 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006282 if (other.mCategories != null) {
6283 mCategories = new HashSet<String>(other.mCategories);
6284 }
6285 changes |= FILL_IN_CATEGORIES;
6286 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006287 if (other.mPackage != null
6288 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006289 // Only do this if mSelector is not set.
6290 if (mSelector == null) {
6291 mPackage = other.mPackage;
6292 changes |= FILL_IN_PACKAGE;
6293 }
6294 }
6295 // Selector is special: it can only be set if explicitly allowed,
6296 // for the same reason as the component name.
6297 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6298 if (mPackage == null) {
6299 mSelector = new Intent(other.mSelector);
6300 mPackage = null;
6301 changes |= FILL_IN_SELECTOR;
6302 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006303 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006304 if (other.mClipData != null
6305 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6306 mClipData = other.mClipData;
6307 changes |= FILL_IN_CLIP_DATA;
6308 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006309 // Component is special: it can -only- be set if explicitly allowed,
6310 // since otherwise the sender could force the intent somewhere the
6311 // originator didn't intend.
6312 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006313 mComponent = other.mComponent;
6314 changes |= FILL_IN_COMPONENT;
6315 }
6316 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006317 if (other.mSourceBounds != null
6318 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6319 mSourceBounds = new Rect(other.mSourceBounds);
6320 changes |= FILL_IN_SOURCE_BOUNDS;
6321 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006322 if (mExtras == null) {
6323 if (other.mExtras != null) {
6324 mExtras = new Bundle(other.mExtras);
6325 }
6326 } else if (other.mExtras != null) {
6327 try {
6328 Bundle newb = new Bundle(other.mExtras);
6329 newb.putAll(mExtras);
6330 mExtras = newb;
6331 } catch (RuntimeException e) {
6332 // Modifying the extras can cause us to unparcel the contents
6333 // of the bundle, and if we do this in the system process that
6334 // may fail. We really should handle this (i.e., the Bundle
6335 // impl shouldn't be on top of a plain map), but for now just
6336 // ignore it and keep the original contents. :(
6337 Log.w("Intent", "Failure filling in extras", e);
6338 }
6339 }
6340 return changes;
6341 }
6342
6343 /**
6344 * Wrapper class holding an Intent and implementing comparisons on it for
6345 * the purpose of filtering. The class implements its
6346 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6347 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6348 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6349 * on the wrapped Intent.
6350 */
6351 public static final class FilterComparison {
6352 private final Intent mIntent;
6353 private final int mHashCode;
6354
6355 public FilterComparison(Intent intent) {
6356 mIntent = intent;
6357 mHashCode = intent.filterHashCode();
6358 }
6359
6360 /**
6361 * Return the Intent that this FilterComparison represents.
6362 * @return Returns the Intent held by the FilterComparison. Do
6363 * not modify!
6364 */
6365 public Intent getIntent() {
6366 return mIntent;
6367 }
6368
6369 @Override
6370 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006371 if (obj instanceof FilterComparison) {
6372 Intent other = ((FilterComparison)obj).mIntent;
6373 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006374 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006375 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006376 }
6377
6378 @Override
6379 public int hashCode() {
6380 return mHashCode;
6381 }
6382 }
6383
6384 /**
6385 * Determine if two intents are the same for the purposes of intent
6386 * resolution (filtering). That is, if their action, data, type,
6387 * class, and categories are the same. This does <em>not</em> compare
6388 * any extra data included in the intents.
6389 *
6390 * @param other The other Intent to compare against.
6391 *
6392 * @return Returns true if action, data, type, class, and categories
6393 * are the same.
6394 */
6395 public boolean filterEquals(Intent other) {
6396 if (other == null) {
6397 return false;
6398 }
6399 if (mAction != other.mAction) {
6400 if (mAction != null) {
6401 if (!mAction.equals(other.mAction)) {
6402 return false;
6403 }
6404 } else {
6405 if (!other.mAction.equals(mAction)) {
6406 return false;
6407 }
6408 }
6409 }
6410 if (mData != other.mData) {
6411 if (mData != null) {
6412 if (!mData.equals(other.mData)) {
6413 return false;
6414 }
6415 } else {
6416 if (!other.mData.equals(mData)) {
6417 return false;
6418 }
6419 }
6420 }
6421 if (mType != other.mType) {
6422 if (mType != null) {
6423 if (!mType.equals(other.mType)) {
6424 return false;
6425 }
6426 } else {
6427 if (!other.mType.equals(mType)) {
6428 return false;
6429 }
6430 }
6431 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006432 if (mPackage != other.mPackage) {
6433 if (mPackage != null) {
6434 if (!mPackage.equals(other.mPackage)) {
6435 return false;
6436 }
6437 } else {
6438 if (!other.mPackage.equals(mPackage)) {
6439 return false;
6440 }
6441 }
6442 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006443 if (mComponent != other.mComponent) {
6444 if (mComponent != null) {
6445 if (!mComponent.equals(other.mComponent)) {
6446 return false;
6447 }
6448 } else {
6449 if (!other.mComponent.equals(mComponent)) {
6450 return false;
6451 }
6452 }
6453 }
6454 if (mCategories != other.mCategories) {
6455 if (mCategories != null) {
6456 if (!mCategories.equals(other.mCategories)) {
6457 return false;
6458 }
6459 } else {
6460 if (!other.mCategories.equals(mCategories)) {
6461 return false;
6462 }
6463 }
6464 }
6465
6466 return true;
6467 }
6468
6469 /**
6470 * Generate hash code that matches semantics of filterEquals().
6471 *
6472 * @return Returns the hash value of the action, data, type, class, and
6473 * categories.
6474 *
6475 * @see #filterEquals
6476 */
6477 public int filterHashCode() {
6478 int code = 0;
6479 if (mAction != null) {
6480 code += mAction.hashCode();
6481 }
6482 if (mData != null) {
6483 code += mData.hashCode();
6484 }
6485 if (mType != null) {
6486 code += mType.hashCode();
6487 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006488 if (mPackage != null) {
6489 code += mPackage.hashCode();
6490 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006491 if (mComponent != null) {
6492 code += mComponent.hashCode();
6493 }
6494 if (mCategories != null) {
6495 code += mCategories.hashCode();
6496 }
6497 return code;
6498 }
6499
6500 @Override
6501 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006502 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006503
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006504 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006505 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006506 b.append(" }");
6507
6508 return b.toString();
6509 }
6510
6511 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006512 public String toInsecureString() {
6513 StringBuilder b = new StringBuilder(128);
6514
6515 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006516 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006517 b.append(" }");
6518
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006519 return b.toString();
6520 }
Romain Guy4969af72009-06-17 10:53:19 -07006521
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006522 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006523 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006524 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006525
6526 b.append("Intent { ");
6527 toShortString(b, false, true, true, true);
6528 b.append(" }");
6529
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006530 return b.toString();
6531 }
6532
6533 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006534 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6535 StringBuilder b = new StringBuilder(128);
6536 toShortString(b, secure, comp, extras, clip);
6537 return b.toString();
6538 }
6539
6540 /** @hide */
6541 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6542 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006543 boolean first = true;
6544 if (mAction != null) {
6545 b.append("act=").append(mAction);
6546 first = false;
6547 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006548 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006549 if (!first) {
6550 b.append(' ');
6551 }
6552 first = false;
6553 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006554 Iterator<String> i = mCategories.iterator();
6555 boolean didone = false;
6556 while (i.hasNext()) {
6557 if (didone) b.append(",");
6558 didone = true;
6559 b.append(i.next());
6560 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006561 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006562 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006563 if (mData != null) {
6564 if (!first) {
6565 b.append(' ');
6566 }
6567 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006568 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006569 if (secure) {
6570 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006571 } else {
6572 b.append(mData);
6573 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006574 }
6575 if (mType != null) {
6576 if (!first) {
6577 b.append(' ');
6578 }
6579 first = false;
6580 b.append("typ=").append(mType);
6581 }
6582 if (mFlags != 0) {
6583 if (!first) {
6584 b.append(' ');
6585 }
6586 first = false;
6587 b.append("flg=0x").append(Integer.toHexString(mFlags));
6588 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006589 if (mPackage != null) {
6590 if (!first) {
6591 b.append(' ');
6592 }
6593 first = false;
6594 b.append("pkg=").append(mPackage);
6595 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006596 if (comp && mComponent != null) {
6597 if (!first) {
6598 b.append(' ');
6599 }
6600 first = false;
6601 b.append("cmp=").append(mComponent.flattenToShortString());
6602 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006603 if (mSourceBounds != null) {
6604 if (!first) {
6605 b.append(' ');
6606 }
6607 first = false;
6608 b.append("bnds=").append(mSourceBounds.toShortString());
6609 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006610 if (mClipData != null) {
6611 if (!first) {
6612 b.append(' ');
6613 }
6614 first = false;
6615 if (clip) {
6616 b.append("clip={");
6617 mClipData.toShortString(b);
6618 b.append('}');
6619 } else {
6620 b.append("(has clip)");
6621 }
6622 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006623 if (extras && mExtras != null) {
6624 if (!first) {
6625 b.append(' ');
6626 }
6627 first = false;
6628 b.append("(has extras)");
6629 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006630 if (mSelector != null) {
6631 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006632 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006633 b.append("}");
6634 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006635 }
6636
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006637 /**
6638 * Call {@link #toUri} with 0 flags.
6639 * @deprecated Use {@link #toUri} instead.
6640 */
6641 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006642 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006643 return toUri(0);
6644 }
6645
6646 /**
6647 * Convert this Intent into a String holding a URI representation of it.
6648 * The returned URI string has been properly URI encoded, so it can be
6649 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6650 * Intent's data as the base URI, with an additional fragment describing
6651 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006652 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006653 * <p>You can convert the returned string back to an Intent with
6654 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006655 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006656 * @param flags Additional operating flags. Either 0 or
6657 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006658 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006659 * @return Returns a URI encoding URI string describing the entire contents
6660 * of the Intent.
6661 */
6662 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006663 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006664 String scheme = null;
6665 if (mData != null) {
6666 String data = mData.toString();
6667 if ((flags&URI_INTENT_SCHEME) != 0) {
6668 final int N = data.length();
6669 for (int i=0; i<N; i++) {
6670 char c = data.charAt(i);
6671 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6672 || c == '.' || c == '-') {
6673 continue;
6674 }
6675 if (c == ':' && i > 0) {
6676 // Valid scheme.
6677 scheme = data.substring(0, i);
6678 uri.append("intent:");
6679 data = data.substring(i+1);
6680 break;
6681 }
Tom Taylord4a47292009-12-21 13:59:18 -08006682
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006683 // No scheme.
6684 break;
6685 }
6686 }
6687 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006688
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006689 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6690 uri.append("intent:");
6691 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006692
6693 uri.append("#Intent;");
6694
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006695 toUriInner(uri, scheme, flags);
6696 if (mSelector != null) {
6697 uri.append("SEL;");
6698 // Note that for now we are not going to try to handle the
6699 // data part; not clear how to represent this as a URI, and
6700 // not much utility in it.
6701 mSelector.toUriInner(uri, null, flags);
6702 }
6703
6704 uri.append("end");
6705
6706 return uri.toString();
6707 }
6708
6709 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006710 if (scheme != null) {
6711 uri.append("scheme=").append(scheme).append(';');
6712 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006713 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006714 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006715 }
6716 if (mCategories != null) {
6717 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006718 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006719 }
6720 }
6721 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006722 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006723 }
6724 if (mFlags != 0) {
6725 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6726 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006727 if (mPackage != null) {
6728 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6729 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006730 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006731 uri.append("component=").append(Uri.encode(
6732 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006733 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006734 if (mSourceBounds != null) {
6735 uri.append("sourceBounds=")
6736 .append(Uri.encode(mSourceBounds.flattenToString()))
6737 .append(';');
6738 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006739 if (mExtras != null) {
6740 for (String key : mExtras.keySet()) {
6741 final Object value = mExtras.get(key);
6742 char entryType =
6743 value instanceof String ? 'S' :
6744 value instanceof Boolean ? 'B' :
6745 value instanceof Byte ? 'b' :
6746 value instanceof Character ? 'c' :
6747 value instanceof Double ? 'd' :
6748 value instanceof Float ? 'f' :
6749 value instanceof Integer ? 'i' :
6750 value instanceof Long ? 'l' :
6751 value instanceof Short ? 's' :
6752 '\0';
6753
6754 if (entryType != '\0') {
6755 uri.append(entryType);
6756 uri.append('.');
6757 uri.append(Uri.encode(key));
6758 uri.append('=');
6759 uri.append(Uri.encode(value.toString()));
6760 uri.append(';');
6761 }
6762 }
6763 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006764 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006765
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006766 public int describeContents() {
6767 return (mExtras != null) ? mExtras.describeContents() : 0;
6768 }
6769
6770 public void writeToParcel(Parcel out, int flags) {
6771 out.writeString(mAction);
6772 Uri.writeToParcel(out, mData);
6773 out.writeString(mType);
6774 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006775 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006776 ComponentName.writeToParcel(mComponent, out);
6777
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006778 if (mSourceBounds != null) {
6779 out.writeInt(1);
6780 mSourceBounds.writeToParcel(out, flags);
6781 } else {
6782 out.writeInt(0);
6783 }
6784
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006785 if (mCategories != null) {
6786 out.writeInt(mCategories.size());
6787 for (String category : mCategories) {
6788 out.writeString(category);
6789 }
6790 } else {
6791 out.writeInt(0);
6792 }
6793
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006794 if (mSelector != null) {
6795 out.writeInt(1);
6796 mSelector.writeToParcel(out, flags);
6797 } else {
6798 out.writeInt(0);
6799 }
6800
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006801 if (mClipData != null) {
6802 out.writeInt(1);
6803 mClipData.writeToParcel(out, flags);
6804 } else {
6805 out.writeInt(0);
6806 }
6807
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006808 out.writeBundle(mExtras);
6809 }
6810
6811 public static final Parcelable.Creator<Intent> CREATOR
6812 = new Parcelable.Creator<Intent>() {
6813 public Intent createFromParcel(Parcel in) {
6814 return new Intent(in);
6815 }
6816 public Intent[] newArray(int size) {
6817 return new Intent[size];
6818 }
6819 };
6820
Dianne Hackborneb034652009-09-07 00:49:58 -07006821 /** @hide */
6822 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006823 readFromParcel(in);
6824 }
6825
6826 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006827 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006828 mData = Uri.CREATOR.createFromParcel(in);
6829 mType = in.readString();
6830 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006831 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006832 mComponent = ComponentName.readFromParcel(in);
6833
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006834 if (in.readInt() != 0) {
6835 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6836 }
6837
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006838 int N = in.readInt();
6839 if (N > 0) {
6840 mCategories = new HashSet<String>();
6841 int i;
6842 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006843 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006844 }
6845 } else {
6846 mCategories = null;
6847 }
6848
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006849 if (in.readInt() != 0) {
6850 mSelector = new Intent(in);
6851 }
6852
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006853 if (in.readInt() != 0) {
6854 mClipData = new ClipData(in);
6855 }
6856
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006857 mExtras = in.readBundle();
6858 }
6859
6860 /**
6861 * Parses the "intent" element (and its children) from XML and instantiates
6862 * an Intent object. The given XML parser should be located at the tag
6863 * where parsing should start (often named "intent"), from which the
6864 * basic action, data, type, and package and class name will be
6865 * retrieved. The function will then parse in to any child elements,
6866 * looking for <category android:name="xxx"> tags to add categories and
6867 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6868 * to the intent.
6869 *
6870 * @param resources The Resources to use when inflating resources.
6871 * @param parser The XML parser pointing at an "intent" tag.
6872 * @param attrs The AttributeSet interface for retrieving extended
6873 * attribute data at the current <var>parser</var> location.
6874 * @return An Intent object matching the XML data.
6875 * @throws XmlPullParserException If there was an XML parsing error.
6876 * @throws IOException If there was an I/O error.
6877 */
6878 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6879 throws XmlPullParserException, IOException {
6880 Intent intent = new Intent();
6881
6882 TypedArray sa = resources.obtainAttributes(attrs,
6883 com.android.internal.R.styleable.Intent);
6884
6885 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6886
6887 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6888 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6889 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6890
6891 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6892 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6893 if (packageName != null && className != null) {
6894 intent.setComponent(new ComponentName(packageName, className));
6895 }
6896
6897 sa.recycle();
6898
6899 int outerDepth = parser.getDepth();
6900 int type;
6901 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6902 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6903 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6904 continue;
6905 }
6906
6907 String nodeName = parser.getName();
6908 if (nodeName.equals("category")) {
6909 sa = resources.obtainAttributes(attrs,
6910 com.android.internal.R.styleable.IntentCategory);
6911 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6912 sa.recycle();
6913
6914 if (cat != null) {
6915 intent.addCategory(cat);
6916 }
6917 XmlUtils.skipCurrentTag(parser);
6918
6919 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006920 if (intent.mExtras == null) {
6921 intent.mExtras = new Bundle();
6922 }
6923 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6924 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006925
6926 } else {
6927 XmlUtils.skipCurrentTag(parser);
6928 }
6929 }
6930
6931 return intent;
6932 }
Nick Pellyccae4122012-01-09 14:12:58 -08006933
6934 /**
6935 * Normalize a MIME data type.
6936 *
6937 * <p>A normalized MIME type has white-space trimmed,
6938 * content-type parameters removed, and is lower-case.
6939 * This aligns the type with Android best practices for
6940 * intent filtering.
6941 *
6942 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6943 * "text/x-vCard" becomes "text/x-vcard".
6944 *
6945 * <p>All MIME types received from outside Android (such as user input,
6946 * or external sources like Bluetooth, NFC, or the Internet) should
6947 * be normalized before they are used to create an Intent.
6948 *
6949 * @param type MIME data type to normalize
6950 * @return normalized MIME data type, or null if the input was null
6951 * @see {@link #setType}
6952 * @see {@link #setTypeAndNormalize}
6953 */
6954 public static String normalizeMimeType(String type) {
6955 if (type == null) {
6956 return null;
6957 }
6958
6959 type = type.trim().toLowerCase(Locale.US);
6960
6961 final int semicolonIndex = type.indexOf(';');
6962 if (semicolonIndex != -1) {
6963 type = type.substring(0, semicolonIndex);
6964 }
6965 return type;
6966 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006967
6968 /**
6969 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006970 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6971 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006972 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006973 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006974 * @hide
6975 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006976 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006977 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006978 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006979
6980 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006981 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006982
6983 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006984 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006985 try {
6986 // Inspect target intent to see if we need to migrate
6987 final Intent target = getParcelableExtra(EXTRA_INTENT);
6988 if (target != null && target.migrateExtraStreamToClipData()) {
6989 // Since we migrated in child, we need to promote ClipData
6990 // and flags to ourselves to grant.
6991 setClipData(target.getClipData());
6992 addFlags(target.getFlags()
6993 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6994 return true;
6995 } else {
6996 return false;
6997 }
6998 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006999 }
7000
7001 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007002 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007003 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7004 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7005 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7006 if (stream != null || text != null || htmlText != null) {
7007 final ClipData clipData = new ClipData(
7008 null, new String[] { getType() },
7009 new ClipData.Item(text, htmlText, null, stream));
7010 setClipData(clipData);
7011 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007012 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007013 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007014 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007015 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007016
7017 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007018 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007019 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7020 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7021 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7022 int num = -1;
7023 if (streams != null) {
7024 num = streams.size();
7025 }
7026 if (texts != null) {
7027 if (num >= 0 && num != texts.size()) {
7028 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007029 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007030 }
7031 num = texts.size();
7032 }
7033 if (htmlTexts != null) {
7034 if (num >= 0 && num != htmlTexts.size()) {
7035 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007036 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007037 }
7038 num = htmlTexts.size();
7039 }
7040 if (num > 0) {
7041 final ClipData clipData = new ClipData(
7042 null, new String[] { getType() },
7043 makeClipItem(streams, texts, htmlTexts, 0));
7044
7045 for (int i = 1; i < num; i++) {
7046 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7047 }
7048
7049 setClipData(clipData);
7050 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007051 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007052 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007053 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007054 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007055 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007056
7057 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007058 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007059
7060 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7061 ArrayList<String> htmlTexts, int which) {
7062 Uri uri = streams != null ? streams.get(which) : null;
7063 CharSequence text = texts != null ? texts.get(which) : null;
7064 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7065 return new ClipData.Item(text, htmlText, null, uri);
7066 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007067}