blob: cb8fea21d5932441846be93a266d548191956afe [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}
573 * <li> {@link #EXTRA_PHONE_NUMBER}
574 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
575 * <li> {@link #EXTRA_REPLACING}
576 * <li> {@link #EXTRA_SHORTCUT_ICON}
577 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
578 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700579 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800580 * <li> {@link #EXTRA_SHORTCUT_NAME}
581 * <li> {@link #EXTRA_SUBJECT}
582 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700583 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800584 * <li> {@link #EXTRA_TITLE}
585 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700586 * </ul>
587 *
588 * <h3>Flags</h3>
589 *
590 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800591 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
592 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700593 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800594public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 // ---------------------------------------------------------------------
596 // ---------------------------------------------------------------------
597 // Standard intent activity actions (see action variable).
598
599 /**
600 * Activity Action: Start as a main entry point, does not expect to
601 * receive data.
602 * <p>Input: nothing
603 * <p>Output: nothing
604 */
605 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
606 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800607
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 /**
609 * Activity Action: Display the data to the user. This is the most common
610 * action performed on data -- it is the generic action you can use on
611 * a piece of data to get the most reasonable thing to occur. For example,
612 * when used on a contacts entry it will view the entry; when used on a
613 * mailto: URI it will bring up a compose window filled with the information
614 * supplied by the URI; when used with a tel: URI it will invoke the
615 * dialer.
616 * <p>Input: {@link #getData} is URI from which to retrieve data.
617 * <p>Output: nothing.
618 */
619 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
620 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800621
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700622 /**
623 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
624 * performed on a piece of data.
625 */
626 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800627
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700628 /**
629 * Used to indicate that some piece of data should be attached to some other
630 * place. For example, image data could be attached to a contact. It is up
631 * to the recipient to decide where the data should be attached; the intent
632 * does not specify the ultimate destination.
633 * <p>Input: {@link #getData} is URI of data to be attached.
634 * <p>Output: nothing.
635 */
636 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
637 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800638
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700639 /**
640 * Activity Action: Provide explicit editable access to the given data.
641 * <p>Input: {@link #getData} is URI of data to be edited.
642 * <p>Output: nothing.
643 */
644 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
645 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800646
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700647 /**
648 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
649 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
650 * The extras can contain type specific data to pass through to the editing/creating
651 * activity.
652 * <p>Output: The URI of the item that was picked. This must be a content:
653 * URI so that any receiver can access it.
654 */
655 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
656 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800657
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700658 /**
659 * Activity Action: Pick an item from the data, returning what was selected.
660 * <p>Input: {@link #getData} is URI containing a directory of data
661 * (vnd.android.cursor.dir/*) from which to pick an item.
662 * <p>Output: The URI of the item that was picked.
663 */
664 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
665 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800666
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700667 /**
668 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800669 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700670 * <p>Output: An Intent representing the shortcut. The intent must contain three
671 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
672 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800673 * (value: ShortcutIconResource).</p>
674 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700675 * @see #EXTRA_SHORTCUT_INTENT
676 * @see #EXTRA_SHORTCUT_NAME
677 * @see #EXTRA_SHORTCUT_ICON
678 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
679 * @see android.content.Intent.ShortcutIconResource
680 */
681 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
682 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
683
684 /**
685 * The name of the extra used to define the Intent of a shortcut.
686 *
687 * @see #ACTION_CREATE_SHORTCUT
688 */
689 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
690 /**
691 * The name of the extra used to define the name of a shortcut.
692 *
693 * @see #ACTION_CREATE_SHORTCUT
694 */
695 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
696 /**
697 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
698 *
699 * @see #ACTION_CREATE_SHORTCUT
700 */
701 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
702 /**
703 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
704 *
705 * @see #ACTION_CREATE_SHORTCUT
706 * @see android.content.Intent.ShortcutIconResource
707 */
708 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
709 "android.intent.extra.shortcut.ICON_RESOURCE";
710
711 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800712 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700713 *
714 * @see Intent#ACTION_CREATE_SHORTCUT
715 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800716 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
717 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700718 */
719 public static class ShortcutIconResource implements Parcelable {
720 /**
721 * The package name of the application containing the icon.
722 */
723 public String packageName;
724
725 /**
726 * The resource name of the icon, including package, name and type.
727 */
728 public String resourceName;
729
730 /**
731 * Creates a new ShortcutIconResource for the specified context and resource
732 * identifier.
733 *
734 * @param context The context of the application.
735 * @param resourceId The resource idenfitier for the icon.
736 * @return A new ShortcutIconResource with the specified's context package name
737 * and icon resource idenfitier.
738 */
739 public static ShortcutIconResource fromContext(Context context, int resourceId) {
740 ShortcutIconResource icon = new ShortcutIconResource();
741 icon.packageName = context.getPackageName();
742 icon.resourceName = context.getResources().getResourceName(resourceId);
743 return icon;
744 }
745
746 /**
747 * Used to read a ShortcutIconResource from a Parcel.
748 */
749 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
750 new Parcelable.Creator<ShortcutIconResource>() {
751
752 public ShortcutIconResource createFromParcel(Parcel source) {
753 ShortcutIconResource icon = new ShortcutIconResource();
754 icon.packageName = source.readString();
755 icon.resourceName = source.readString();
756 return icon;
757 }
758
759 public ShortcutIconResource[] newArray(int size) {
760 return new ShortcutIconResource[size];
761 }
762 };
763
764 /**
765 * No special parcel contents.
766 */
767 public int describeContents() {
768 return 0;
769 }
770
771 public void writeToParcel(Parcel dest, int flags) {
772 dest.writeString(packageName);
773 dest.writeString(resourceName);
774 }
775
776 @Override
777 public String toString() {
778 return resourceName;
779 }
780 }
781
782 /**
783 * Activity Action: Display an activity chooser, allowing the user to pick
784 * what they want to before proceeding. This can be used as an alternative
785 * to the standard activity picker that is displayed by the system when
786 * you try to start an activity with multiple possible matches, with these
787 * differences in behavior:
788 * <ul>
789 * <li>You can specify the title that will appear in the activity chooser.
790 * <li>The user does not have the option to make one of the matching
791 * activities a preferred activity, and all possible activities will
792 * always be shown even if one of them is currently marked as the
793 * preferred activity.
794 * </ul>
795 * <p>
796 * This action should be used when the user will naturally expect to
797 * select an activity in order to proceed. An example if when not to use
798 * it is when the user clicks on a "mailto:" link. They would naturally
799 * expect to go directly to their mail app, so startActivity() should be
800 * called directly: it will
801 * either launch the current preferred app, or put up a dialog allowing the
802 * user to pick an app to use and optionally marking that as preferred.
803 * <p>
804 * In contrast, if the user is selecting a menu item to send a picture
805 * they are viewing to someone else, there are many different things they
806 * may want to do at this point: send it through e-mail, upload it to a
807 * web service, etc. In this case the CHOOSER action should be used, to
808 * always present to the user a list of the things they can do, with a
809 * nice title given by the caller such as "Send this photo with:".
810 * <p>
811 * As a convenience, an Intent of this form can be created with the
812 * {@link #createChooser} function.
813 * <p>Input: No data should be specified. get*Extra must have
814 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
815 * and can optionally have a {@link #EXTRA_TITLE} field containing the
816 * title text to display in the chooser.
817 * <p>Output: Depends on the protocol of {@link #EXTRA_INTENT}.
818 */
819 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
820 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
821
822 /**
823 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
824 *
825 * @param target The Intent that the user will be selecting an activity
826 * to perform.
827 * @param title Optional title that will be displayed in the chooser.
828 * @return Return a new Intent object that you can hand to
829 * {@link Context#startActivity(Intent) Context.startActivity()} and
830 * related methods.
831 */
832 public static Intent createChooser(Intent target, CharSequence title) {
833 Intent intent = new Intent(ACTION_CHOOSER);
834 intent.putExtra(EXTRA_INTENT, target);
835 if (title != null) {
836 intent.putExtra(EXTRA_TITLE, title);
837 }
838 return intent;
839 }
840 /**
841 * Activity Action: Allow the user to select a particular kind of data and
842 * return it. This is different than {@link #ACTION_PICK} in that here we
843 * just say what kind of data is desired, not a URI of existing data from
844 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
845 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900846 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700847 * etc.
848 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900849 * 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 -0700850 * of data, such as a person contact, you set the MIME type to the kind of
851 * data you want and launch it with {@link Context#startActivity(Intent)}.
852 * The system will then launch the best application to select that kind
853 * of data for you.
854 * <p>
855 * You may also be interested in any of a set of types of content the user
856 * can pick. For example, an e-mail application that wants to allow the
857 * user to add an attachment to an e-mail message can use this action to
858 * bring up a list of all of the types of content the user can attach.
859 * <p>
860 * In this case, you should wrap the GET_CONTENT intent with a chooser
861 * (through {@link #createChooser}), which will give the proper interface
862 * for the user to pick how to send your data and allow you to specify
863 * a prompt indicating what they are doing. You will usually specify a
864 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
865 * broad range of content types the user can select from.
866 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900867 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700868 * only pick from data that can be represented as a stream. This is
869 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
870 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800871 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900872 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800873 * is locally available on the device. For example, if this extra is set
874 * to true then an image picker should not show any pictures that are available
875 * from a remote server but not already on the local device (thus requiring
876 * they be downloaded when opened).
877 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700878 * Input: {@link #getType} is the desired MIME type to retrieve. Note
879 * that no URI is supplied in the intent, as there are no constraints on
880 * where the returned data originally comes from. You may also include the
881 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800882 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
883 * selection to local data.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700884 * <p>
885 * Output: The URI of the item that was picked. This must be a content:
886 * URI so that any receiver can access it.
887 */
888 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
889 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
890 /**
891 * Activity Action: Dial a number as specified by the data. This shows a
892 * UI with the number being dialed, allowing the user to explicitly
893 * initiate the call.
894 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
895 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
896 * number.
897 * <p>Output: nothing.
898 */
899 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
900 public static final String ACTION_DIAL = "android.intent.action.DIAL";
901 /**
902 * Activity Action: Perform a call to someone specified by the data.
903 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
904 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
905 * number.
906 * <p>Output: nothing.
907 *
908 * <p>Note: there will be restrictions on which applications can initiate a
909 * call; most applications should use the {@link #ACTION_DIAL}.
910 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
911 * numbers. Applications can <strong>dial</strong> emergency numbers using
912 * {@link #ACTION_DIAL}, however.
913 */
914 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
915 public static final String ACTION_CALL = "android.intent.action.CALL";
916 /**
917 * Activity Action: Perform a call to an emergency number specified by the
918 * data.
919 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
920 * tel: URI of an explicit phone number.
921 * <p>Output: nothing.
922 * @hide
923 */
924 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
925 /**
926 * Activity action: Perform a call to any number (emergency or not)
927 * specified by the data.
928 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
929 * tel: URI of an explicit phone number.
930 * <p>Output: nothing.
931 * @hide
932 */
933 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
934 /**
935 * Activity Action: Send a message to someone specified by the data.
936 * <p>Input: {@link #getData} is URI describing the target.
937 * <p>Output: nothing.
938 */
939 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
940 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
941 /**
942 * Activity Action: Deliver some data to someone else. Who the data is
943 * being delivered to is not specified; it is up to the receiver of this
944 * action to ask the user where the data should be sent.
945 * <p>
946 * When launching a SEND intent, you should usually wrap it in a chooser
947 * (through {@link #createChooser}), which will give the proper interface
948 * for the user to pick how to send your data and allow you to specify
949 * a prompt indicating what they are doing.
950 * <p>
951 * Input: {@link #getType} is the MIME type of the data being sent.
952 * get*Extra can have either a {@link #EXTRA_TEXT}
953 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
954 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
955 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
956 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700957 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
958 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
959 * your text with HTML formatting.
960 * <p>
961 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
962 * being sent can be supplied through {@link #setClipData(ClipData)}. This
963 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
964 * content: URIs and other advanced features of {@link ClipData}. If
965 * using this approach, you still must supply the same data through the
966 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
967 * for compatibility with old applications. If you don't set a ClipData,
968 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700969 * <p>
970 * Optional standard extras, which may be interpreted by some recipients as
971 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
972 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
973 * <p>
974 * Output: nothing.
975 */
976 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
977 public static final String ACTION_SEND = "android.intent.action.SEND";
978 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800979 * Activity Action: Deliver multiple data to someone else.
980 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700981 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800982 * <p>
983 * Input: {@link #getType} is the MIME type of the data being sent.
984 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700985 * #EXTRA_STREAM} field, containing the data to be sent. If using
986 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
987 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800988 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +0800989 * Multiple types are supported, and receivers should handle mixed types
990 * whenever possible. The right way for the receiver to check them is to
991 * use the content resolver on each URI. The intent sender should try to
992 * put the most concrete mime type in the intent type, but it can fall
993 * back to {@literal <type>/*} or {@literal *}/* as needed.
994 * <p>
995 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
996 * be image/jpg, but if you are sending image/jpg and image/png, then the
997 * intent's type should be image/*.
998 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700999 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1000 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1001 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1002 * content: URIs and other advanced features of {@link ClipData}. If
1003 * using this approach, you still must supply the same data through the
1004 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1005 * for compatibility with old applications. If you don't set a ClipData,
1006 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1007 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001008 * Optional standard extras, which may be interpreted by some recipients as
1009 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1010 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1011 * <p>
1012 * Output: nothing.
1013 */
1014 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1015 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1016 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001017 * Activity Action: Handle an incoming phone call.
1018 * <p>Input: nothing.
1019 * <p>Output: nothing.
1020 */
1021 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1022 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1023 /**
1024 * Activity Action: Insert an empty item into the given container.
1025 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1026 * in which to place the data.
1027 * <p>Output: URI of the new data that was created.
1028 */
1029 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1030 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1031 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001032 * Activity Action: Create a new item in the given container, initializing it
1033 * from the current contents of the clipboard.
1034 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1035 * in which to place the data.
1036 * <p>Output: URI of the new data that was created.
1037 */
1038 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1039 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1040 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001041 * Activity Action: Delete the given data from its container.
1042 * <p>Input: {@link #getData} is URI of data to be deleted.
1043 * <p>Output: nothing.
1044 */
1045 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1046 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1047 /**
1048 * Activity Action: Run the data, whatever that means.
1049 * <p>Input: ? (Note: this is currently specific to the test harness.)
1050 * <p>Output: nothing.
1051 */
1052 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1053 public static final String ACTION_RUN = "android.intent.action.RUN";
1054 /**
1055 * Activity Action: Perform a data synchronization.
1056 * <p>Input: ?
1057 * <p>Output: ?
1058 */
1059 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1060 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1061 /**
1062 * Activity Action: Pick an activity given an intent, returning the class
1063 * selected.
1064 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1065 * used with {@link PackageManager#queryIntentActivities} to determine the
1066 * set of activities from which to pick.
1067 * <p>Output: Class name of the activity that was selected.
1068 */
1069 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1070 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1071 /**
1072 * Activity Action: Perform a search.
1073 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1074 * is the text to search for. If empty, simply
1075 * enter your search results Activity with the search UI activated.
1076 * <p>Output: nothing.
1077 */
1078 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1079 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1080 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001081 * Activity Action: Start the platform-defined tutorial
1082 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1083 * is the text to search for. If empty, simply
1084 * enter your search results Activity with the search UI activated.
1085 * <p>Output: nothing.
1086 */
1087 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1088 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1089 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001090 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001091 * <p>
1092 * Input: {@link android.app.SearchManager#QUERY
1093 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1094 * a url starts with http or https, the site will be opened. If it is plain
1095 * text, Google search will be applied.
1096 * <p>
1097 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001098 */
1099 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1100 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1101 /**
1102 * Activity Action: List all available applications
1103 * <p>Input: Nothing.
1104 * <p>Output: nothing.
1105 */
1106 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1107 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1108 /**
1109 * Activity Action: Show settings for choosing wallpaper
1110 * <p>Input: Nothing.
1111 * <p>Output: Nothing.
1112 */
1113 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1114 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1115
1116 /**
1117 * Activity Action: Show activity for reporting a bug.
1118 * <p>Input: Nothing.
1119 * <p>Output: Nothing.
1120 */
1121 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1122 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1123
1124 /**
1125 * Activity Action: Main entry point for factory tests. Only used when
1126 * the device is booting in factory test node. The implementing package
1127 * must be installed in the system image.
1128 * <p>Input: nothing
1129 * <p>Output: nothing
1130 */
1131 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1132
1133 /**
1134 * Activity Action: The user pressed the "call" button to go to the dialer
1135 * or other appropriate UI for placing a call.
1136 * <p>Input: Nothing.
1137 * <p>Output: Nothing.
1138 */
1139 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1140 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1141
1142 /**
1143 * Activity Action: Start Voice Command.
1144 * <p>Input: Nothing.
1145 * <p>Output: Nothing.
1146 */
1147 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1148 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001149
1150 /**
1151 * Activity Action: Start action associated with long pressing on the
1152 * search key.
1153 * <p>Input: Nothing.
1154 * <p>Output: Nothing.
1155 */
1156 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1157 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001158
Jacek Surazski86b6c532009-05-13 14:38:28 +02001159 /**
1160 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1161 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001162 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001163 * <p>Input: No data is specified. The bug report is passed in using
1164 * an {@link #EXTRA_BUG_REPORT} field.
1165 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001166 *
1167 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001168 */
1169 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1170 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001171
1172 /**
1173 * Activity Action: Show power usage information to the user.
1174 * <p>Input: Nothing.
1175 * <p>Output: Nothing.
1176 */
1177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1178 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001179
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001180 /**
1181 * Activity Action: Setup wizard to launch after a platform update. This
1182 * activity should have a string meta-data field associated with it,
1183 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1184 * the platform for setup. The activity will be launched only if
1185 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1186 * same value.
1187 * <p>Input: Nothing.
1188 * <p>Output: Nothing.
1189 * @hide
1190 */
1191 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1192 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001193
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001194 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001195 * Activity Action: Show settings for managing network data usage of a
1196 * specific application. Applications should define an activity that offers
1197 * options to control data usage.
1198 */
1199 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1200 public static final String ACTION_MANAGE_NETWORK_USAGE =
1201 "android.intent.action.MANAGE_NETWORK_USAGE";
1202
1203 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001204 * Activity Action: Launch application installer.
1205 * <p>
1206 * Input: The data must be a content: or file: URI at which the application
1207 * can be retrieved. You can optionally supply
1208 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1209 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1210 * <p>
1211 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1212 * succeeded.
1213 *
1214 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1215 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1216 * @see #EXTRA_RETURN_RESULT
1217 */
1218 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1219 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1220
1221 /**
1222 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1223 * package. Specifies the installer package name; this package will receive the
1224 * {@link #ACTION_APP_ERROR} intent.
1225 */
1226 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1227 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1228
1229 /**
1230 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1231 * package. Specifies that the application being installed should not be
1232 * treated as coming from an unknown source, but as coming from the app
1233 * invoking the Intent. For this to work you must start the installer with
1234 * startActivityForResult().
1235 */
1236 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1237 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1238
1239 /**
1240 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1241 * package. Tells the installer UI to skip the confirmation with the user
1242 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001243 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1244 * will no longer show an interstitial message about updating existing
1245 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001246 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001247 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001248 public static final String EXTRA_ALLOW_REPLACE
1249 = "android.intent.extra.ALLOW_REPLACE";
1250
1251 /**
1252 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1253 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1254 * return to the application the result code of the install/uninstall. The returned result
1255 * code will be {@link android.app.Activity#RESULT_OK} on success or
1256 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1257 */
1258 public static final String EXTRA_RETURN_RESULT
1259 = "android.intent.extra.RETURN_RESULT";
1260
1261 /**
1262 * Package manager install result code. @hide because result codes are not
1263 * yet ready to be exposed.
1264 */
1265 public static final String EXTRA_INSTALL_RESULT
1266 = "android.intent.extra.INSTALL_RESULT";
1267
1268 /**
1269 * Activity Action: Launch application uninstaller.
1270 * <p>
1271 * Input: The data must be a package: URI whose scheme specific part is
1272 * the package name of the current installed package to be uninstalled.
1273 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1274 * <p>
1275 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1276 * succeeded.
1277 */
1278 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1279 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1280
1281 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001282 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1283 * describing the last run version of the platform that was setup.
1284 * @hide
1285 */
1286 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1287
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001288 // ---------------------------------------------------------------------
1289 // ---------------------------------------------------------------------
1290 // Standard intent broadcast actions (see action variable).
1291
1292 /**
1293 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001294 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001295 * <p class="note">This is a protected intent that can only be sent
1296 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001297 */
1298 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1299 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1300 /**
1301 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001302 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001303 * <p class="note">This is a protected intent that can only be sent
1304 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001305 */
1306 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1307 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001308
1309 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001310 * 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 -07001311 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001312 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001313 * <p class="note">This is a protected intent that can only be sent
1314 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001315 */
1316 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001317 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001318
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001319 /**
1320 * Broadcast Action: The current time has changed. Sent every
1321 * minute. You can <em>not</em> receive this through components declared
1322 * in manifests, only by exlicitly registering for it with
1323 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1324 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001325 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001326 * <p class="note">This is a protected intent that can only be sent
1327 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001328 */
1329 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1330 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1331 /**
1332 * Broadcast Action: The time was set.
1333 */
1334 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1335 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1336 /**
1337 * Broadcast Action: The date has changed.
1338 */
1339 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1340 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1341 /**
1342 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1343 * <ul>
1344 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1345 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001346 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001347 * <p class="note">This is a protected intent that can only be sent
1348 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001349 */
1350 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1351 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1352 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001353 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1354 * DNS entries should be tossed.
1355 * @hide
1356 */
1357 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1358 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1359 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001360 * Alarm Changed Action: This is broadcast when the AlarmClock
1361 * application's alarm is set or unset. It is used by the
1362 * AlarmClock application and the StatusBar service.
1363 * @hide
1364 */
1365 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1366 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1367 /**
1368 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1369 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1370 * @hide
1371 */
1372 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1373 public static final String ACTION_SYNC_STATE_CHANGED
1374 = "android.intent.action.SYNC_STATE_CHANGED";
1375 /**
1376 * Broadcast Action: This is broadcast once, after the system has finished
1377 * booting. It can be used to perform application-specific initialization,
1378 * such as installing alarms. You must hold the
1379 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1380 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001381 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001382 * <p class="note">This is a protected intent that can only be sent
1383 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001384 */
1385 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1386 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1387 /**
1388 * Broadcast Action: This is broadcast when a user action should request a
1389 * temporary system dialog to dismiss. Some examples of temporary system
1390 * dialogs are the notification window-shade and the recent tasks dialog.
1391 */
1392 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1393 /**
1394 * Broadcast Action: Trigger the download and eventual installation
1395 * of a package.
1396 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001397 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001398 * <p class="note">This is a protected intent that can only be sent
1399 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001400 *
1401 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001402 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001403 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001404 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1405 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1406 /**
1407 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001408 * device. The data contains the name of the package. Note that the
1409 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001410 * <p>My include the following extras:
1411 * <ul>
1412 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1413 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1414 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1415 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001416 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001417 * <p class="note">This is a protected intent that can only be sent
1418 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001419 */
1420 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1421 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1422 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001423 * Broadcast Action: A new version of an application package has been
1424 * installed, replacing an existing version that was previously installed.
1425 * The data contains the name of the package.
1426 * <p>My include the following extras:
1427 * <ul>
1428 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1429 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001430 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001431 * <p class="note">This is a protected intent that can only be sent
1432 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001433 */
1434 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1435 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1436 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001437 * Broadcast Action: A new version of your application has been installed
1438 * over an existing one. This is only sent to the application that was
1439 * replaced. It does not contain any additional data; to receive it, just
1440 * use an intent filter for this action.
1441 *
1442 * <p class="note">This is a protected intent that can only be sent
1443 * by the system.
1444 */
1445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1446 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1447 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001448 * Broadcast Action: An existing application package has been removed from
1449 * the device. The data contains the name of the package. The package
1450 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001451 * <ul>
1452 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1453 * to the package.
1454 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1455 * application -- data and code -- is being removed.
1456 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1457 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1458 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001459 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001460 * <p class="note">This is a protected intent that can only be sent
1461 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001462 */
1463 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1464 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1465 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001466 * Broadcast Action: An existing application package has been completely
1467 * removed from the device. The data contains the name of the package.
1468 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1469 * {@link #EXTRA_DATA_REMOVED} is true and
1470 * {@link #EXTRA_REPLACING} is false of that broadcast.
1471 *
1472 * <ul>
1473 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1474 * to the package.
1475 * </ul>
1476 *
1477 * <p class="note">This is a protected intent that can only be sent
1478 * by the system.
1479 */
1480 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1481 public static final String ACTION_PACKAGE_FULLY_REMOVED
1482 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1483 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001484 * Broadcast Action: An existing application package has been changed (e.g.
1485 * a component has been enabled or disabled). The data contains the name of
1486 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001487 * <ul>
1488 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001489 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1490 * of the changed components.
1491 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1492 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001493 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001494 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001495 * <p class="note">This is a protected intent that can only be sent
1496 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001497 */
1498 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1499 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1500 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001501 * @hide
1502 * Broadcast Action: Ask system services if there is any reason to
1503 * restart the given package. The data contains the name of the
1504 * package.
1505 * <ul>
1506 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1507 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1508 * </ul>
1509 *
1510 * <p class="note">This is a protected intent that can only be sent
1511 * by the system.
1512 */
1513 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1514 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1515 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001516 * Broadcast Action: The user has restarted a package, and all of its
1517 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001518 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001519 * be removed. Note that the restarted package does <em>not</em>
1520 * receive this broadcast.
1521 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001522 * <ul>
1523 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1524 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001525 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001526 * <p class="note">This is a protected intent that can only be sent
1527 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001528 */
1529 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1530 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1531 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001532 * Broadcast Action: The user has cleared the data of a package. This should
1533 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001534 * its persistent data is erased and this broadcast sent.
1535 * Note that the cleared package does <em>not</em>
1536 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001537 * <ul>
1538 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1539 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001540 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001541 * <p class="note">This is a protected intent that can only be sent
1542 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001543 */
1544 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1545 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1546 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001547 * Broadcast Action: A user ID has been removed from the system. The user
1548 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001549 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001550 * <p class="note">This is a protected intent that can only be sent
1551 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001552 */
1553 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1554 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001555
1556 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001557 * Broadcast Action: Sent to the installer package of an application
1558 * when that application is first launched (that is the first time it
1559 * is moved out of the stopped state). The data contains the name of the package.
1560 *
1561 * <p class="note">This is a protected intent that can only be sent
1562 * by the system.
1563 */
1564 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1565 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1566
1567 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001568 * Broadcast Action: Sent to the system package verifier when a package
1569 * needs to be verified. The data contains the package URI.
1570 * <p class="note">
1571 * This is a protected intent that can only be sent by the system.
1572 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001573 */
1574 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1575 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1576
1577 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001578 * Broadcast Action: Resources for a set of packages (which were
1579 * previously unavailable) are currently
1580 * available since the media on which they exist is available.
1581 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1582 * list of packages whose availability changed.
1583 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1584 * list of uids of packages whose availability changed.
1585 * Note that the
1586 * packages in this list do <em>not</em> receive this broadcast.
1587 * The specified set of packages are now available on the system.
1588 * <p>Includes the following extras:
1589 * <ul>
1590 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1591 * whose resources(were previously unavailable) are currently available.
1592 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1593 * packages whose resources(were previously unavailable)
1594 * are currently available.
1595 * </ul>
1596 *
1597 * <p class="note">This is a protected intent that can only be sent
1598 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001599 */
1600 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001601 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1602 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001603
1604 /**
1605 * Broadcast Action: Resources for a set of packages are currently
1606 * unavailable since the media on which they exist is unavailable.
1607 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1608 * list of packages whose availability changed.
1609 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1610 * list of uids of packages whose availability changed.
1611 * The specified set of packages can no longer be
1612 * launched and are practically unavailable on the system.
1613 * <p>Inclues the following extras:
1614 * <ul>
1615 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1616 * whose resources are no longer available.
1617 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1618 * whose resources are no longer available.
1619 * </ul>
1620 *
1621 * <p class="note">This is a protected intent that can only be sent
1622 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001623 */
1624 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001625 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001626 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001627
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001628 /**
1629 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001630 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001631 * This should <em>only</em> be used to determine when the wallpaper
1632 * has changed to show the new wallpaper to the user. You should certainly
1633 * never, in response to this, change the wallpaper or other attributes of
1634 * it such as the suggested size. That would be crazy, right? You'd cause
1635 * all kinds of loops, especially if other apps are doing similar things,
1636 * right? Of course. So please don't do this.
1637 *
1638 * @deprecated Modern applications should use
1639 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1640 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1641 * shown behind their UI, rather than watching for this broadcast and
1642 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001643 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001644 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001645 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1646 /**
1647 * Broadcast Action: The current device {@link android.content.res.Configuration}
1648 * (orientation, locale, etc) has changed. When such a change happens, the
1649 * UIs (view hierarchy) will need to be rebuilt based on this new
1650 * information; for the most part, applications don't need to worry about
1651 * this, because the system will take care of stopping and restarting the
1652 * application to make sure it sees the new changes. Some system code that
1653 * can not be restarted will need to watch for this action and handle it
1654 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001655 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001656 * <p class="note">
1657 * You can <em>not</em> receive this through components declared
1658 * in manifests, only by explicitly registering for it with
1659 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1660 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001661 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001662 * <p class="note">This is a protected intent that can only be sent
1663 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001664 *
1665 * @see android.content.res.Configuration
1666 */
1667 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1668 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1669 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001670 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001671 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001672 * <p class="note">This is a protected intent that can only be sent
1673 * by the system.
1674 */
1675 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1676 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1677 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001678 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1679 * charging state, level, and other information about the battery.
1680 * See {@link android.os.BatteryManager} for documentation on the
1681 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001682 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001683 * <p class="note">
1684 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001685 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001686 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001687 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1688 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1689 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1690 * broadcasts that are sent and can be received through manifest
1691 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001692 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001693 * <p class="note">This is a protected intent that can only be sent
1694 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001695 */
1696 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1697 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1698 /**
1699 * Broadcast Action: Indicates low battery condition on the device.
1700 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001701 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001702 * <p class="note">This is a protected intent that can only be sent
1703 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001704 */
1705 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1706 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1707 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001708 * Broadcast Action: Indicates the battery is now okay after being low.
1709 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1710 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001711 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001712 * <p class="note">This is a protected intent that can only be sent
1713 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001714 */
1715 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1716 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1717 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001718 * Broadcast Action: External power has been connected to the device.
1719 * This is intended for applications that wish to register specifically to this notification.
1720 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1721 * stay active to receive this notification. This action can be used to implement actions
1722 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001723 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001724 * <p class="note">This is a protected intent that can only be sent
1725 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001726 */
1727 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001728 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001729 /**
1730 * Broadcast Action: External power has been removed from the device.
1731 * This is intended for applications that wish to register specifically to this notification.
1732 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1733 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001734 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001735 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001736 * <p class="note">This is a protected intent that can only be sent
1737 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001738 */
1739 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001740 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001741 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001742 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001743 * Broadcast Action: Device is shutting down.
1744 * This is broadcast when the device is being shut down (completely turned
1745 * off, not sleeping). Once the broadcast is complete, the final shutdown
1746 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001747 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001748 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001749 * <p class="note">This is a protected intent that can only be sent
1750 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001751 */
1752 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001753 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001754 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001755 * Activity Action: Start this activity to request system shutdown.
1756 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1757 * to request confirmation from the user before shutting down.
1758 *
1759 * <p class="note">This is a protected intent that can only be sent
1760 * by the system.
1761 *
1762 * {@hide}
1763 */
1764 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1765 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001766 * Broadcast Action: A sticky broadcast that indicates low memory
1767 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001768 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001769 * <p class="note">This is a protected intent that can only be sent
1770 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001771 */
1772 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1773 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1774 /**
1775 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001776 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001777 * <p class="note">This is a protected intent that can only be sent
1778 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001779 */
1780 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1781 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1782 /**
Jake Hambybb371632010-08-23 18:16:48 -07001783 * Broadcast Action: A sticky broadcast that indicates a memory full
1784 * condition on the device. This is intended for activities that want
1785 * to be able to fill the data partition completely, leaving only
1786 * enough free space to prevent system-wide SQLite failures.
1787 *
1788 * <p class="note">This is a protected intent that can only be sent
1789 * by the system.
1790 *
1791 * {@hide}
1792 */
1793 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1794 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1795 /**
1796 * Broadcast Action: Indicates memory full condition on the device
1797 * no longer exists.
1798 *
1799 * <p class="note">This is a protected intent that can only be sent
1800 * by the system.
1801 *
1802 * {@hide}
1803 */
1804 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1805 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1806 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001807 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1808 * and package management should be started.
1809 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1810 * notification.
1811 */
1812 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1813 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1814 /**
1815 * Broadcast Action: The device has entered USB Mass Storage mode.
1816 * This is used mainly for the USB Settings panel.
1817 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1818 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001819 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001820 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001821 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001822 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1823
1824 /**
1825 * Broadcast Action: The device has exited USB Mass Storage mode.
1826 * This is used mainly for the USB Settings panel.
1827 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1828 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001829 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001830 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001831 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001832 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1833
1834 /**
1835 * Broadcast Action: External media has been removed.
1836 * The path to the mount point for the removed media is contained in the Intent.mData field.
1837 */
1838 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1839 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1840
1841 /**
1842 * Broadcast Action: External media is present, but not mounted at its mount point.
1843 * The path to the mount point for the removed media is contained in the Intent.mData field.
1844 */
1845 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1846 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1847
1848 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001849 * Broadcast Action: External media is present, and being disk-checked
1850 * 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 -08001851 */
1852 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1853 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1854
1855 /**
1856 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1857 * 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 -08001858 */
1859 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1860 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1861
1862 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001863 * Broadcast Action: External media is present and mounted at its mount point.
1864 * The path to the mount point for the removed media is contained in the Intent.mData field.
1865 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1866 * media was mounted read only.
1867 */
1868 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1869 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1870
1871 /**
1872 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001873 * 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 -07001874 */
1875 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1876 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1877
1878 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001879 * Broadcast Action: External media is no longer being shared via USB mass storage.
1880 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1881 *
1882 * @hide
1883 */
1884 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1885
1886 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001887 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1888 * The path to the mount point for the removed media is contained in the Intent.mData field.
1889 */
1890 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1891 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1892
1893 /**
1894 * Broadcast Action: External media is present but cannot be mounted.
1895 * The path to the mount point for the removed media is contained in the Intent.mData field.
1896 */
1897 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1898 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1899
1900 /**
1901 * Broadcast Action: User has expressed the desire to remove the external storage media.
1902 * Applications should close all files they have open within the mount point when they receive this intent.
1903 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1904 */
1905 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1906 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1907
1908 /**
1909 * Broadcast Action: The media scanner has started scanning a directory.
1910 * The path to the directory being scanned is contained in the Intent.mData field.
1911 */
1912 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1913 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1914
1915 /**
1916 * Broadcast Action: The media scanner has finished scanning a directory.
1917 * The path to the scanned directory is contained in the Intent.mData field.
1918 */
1919 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1920 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1921
1922 /**
1923 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1924 * The path to the file is contained in the Intent.mData field.
1925 */
1926 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1927 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1928
1929 /**
1930 * Broadcast Action: The "Media Button" was pressed. Includes a single
1931 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1932 * caused the broadcast.
1933 */
1934 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1935 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1936
1937 /**
1938 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1939 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1940 * caused the broadcast.
1941 */
1942 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1943 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1944
1945 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1946 // location; they are not general-purpose actions.
1947
1948 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001949 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001950 */
1951 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1952 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1953 "android.intent.action.GTALK_CONNECTED";
1954
1955 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001956 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001957 */
1958 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1959 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1960 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001961
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001962 /**
1963 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001964 */
1965 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1966 public static final String ACTION_INPUT_METHOD_CHANGED =
1967 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001968
1969 /**
1970 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1971 * more radios have been turned off or on. The intent will have the following extra value:</p>
1972 * <ul>
1973 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1974 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1975 * turned off</li>
1976 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001977 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001978 * <p class="note">This is a protected intent that can only be sent
1979 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001980 */
1981 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1982 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1983
1984 /**
1985 * Broadcast Action: Some content providers have parts of their namespace
1986 * where they publish new events or items that the user may be especially
1987 * interested in. For these things, they may broadcast this action when the
1988 * set of interesting items change.
1989 *
1990 * For example, GmailProvider sends this notification when the set of unread
1991 * mail in the inbox changes.
1992 *
1993 * <p>The data of the intent identifies which part of which provider
1994 * changed. When queried through the content resolver, the data URI will
1995 * return the data set in question.
1996 *
1997 * <p>The intent will have the following extra values:
1998 * <ul>
1999 * <li><em>count</em> - The number of items in the data set. This is the
2000 * same as the number of items in the cursor returned by querying the
2001 * data URI. </li>
2002 * </ul>
2003 *
2004 * This intent will be sent at boot (if the count is non-zero) and when the
2005 * data set changes. It is possible for the data set to change without the
2006 * count changing (for example, if a new unread message arrives in the same
2007 * sync operation in which a message is archived). The phone should still
2008 * ring/vibrate/etc as normal in this case.
2009 */
2010 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2011 public static final String ACTION_PROVIDER_CHANGED =
2012 "android.intent.action.PROVIDER_CHANGED";
2013
2014 /**
2015 * Broadcast Action: Wired Headset plugged in or unplugged.
2016 *
2017 * <p>The intent will have the following extra values:
2018 * <ul>
2019 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2020 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002021 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002022 * </ul>
2023 * </ul>
2024 */
2025 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2026 public static final String ACTION_HEADSET_PLUG =
2027 "android.intent.action.HEADSET_PLUG";
2028
2029 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002030 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2031 *
2032 * <p>The intent will have the following extra values:
2033 * <ul>
2034 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2035 * <li><em>name</em> - Headset type, human readable string </li>
2036 * </ul>
2037 * </ul>
2038 * @hide
2039 */
2040 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002041 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2042 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002043
2044 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002045 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002046 *
2047 * <p>The intent will have the following extra values:
2048 * <ul>
2049 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2050 * <li><em>name</em> - Headset type, human readable string </li>
2051 * </ul>
2052 * </ul>
2053 * @hide
2054 */
2055 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002056 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2057 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002058
2059 /**
2060 * Broadcast Action: A HMDI cable was plugged or unplugged
2061 *
2062 * <p>The intent will have the following extra values:
2063 * <ul>
2064 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2065 * <li><em>name</em> - HDMI cable, human readable string </li>
2066 * </ul>
2067 * </ul>
2068 * @hide
2069 */
2070 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2071 public static final String ACTION_HDMI_AUDIO_PLUG =
2072 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002073
2074 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002075 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2076 *
2077 * <p>The intent will have the following extra values:
2078 * <ul>
2079 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2080 * <li><em>card</em> - ALSA card number (integer) </li>
2081 * <li><em>device</em> - ALSA device number (integer) </li>
2082 * </ul>
2083 * </ul>
2084 * @hide
2085 */
2086 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2087 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2088 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2089
2090 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002091 * Broadcast Action: A USB audio device was plugged in or unplugged.
2092 *
2093 * <p>The intent will have the following extra values:
2094 * <ul>
2095 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2096 * <li><em>card</em> - ALSA card number (integer) </li>
2097 * <li><em>device</em> - ALSA device number (integer) </li>
2098 * </ul>
2099 * </ul>
2100 * @hide
2101 */
2102 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2103 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2104 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2105
2106 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002107 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2108 * <ul>
2109 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2110 * </ul>
2111 *
2112 * <p class="note">This is a protected intent that can only be sent
2113 * by the system.
2114 *
2115 * @hide
2116 */
2117 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2118 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2119 = "android.intent.action.ADVANCED_SETTINGS";
2120
2121 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002122 * Broadcast Action: An outgoing call is about to be placed.
2123 *
2124 * <p>The Intent will have the following extra value:
2125 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002126 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002127 * the phone number originally intended to be dialed.</li>
2128 * </ul>
2129 * <p>Once the broadcast is finished, the resultData is used as the actual
2130 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002131 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002132 * outgoing call in turn: for example, a parental control application
2133 * might verify that the user is authorized to place the call at that
2134 * time, then a number-rewriting application might add an area code if
2135 * one was not specified.</p>
2136 * <p>For consistency, any receiver whose purpose is to prohibit phone
2137 * calls should have a priority of 0, to ensure it will see the final
2138 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002139 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002140 * should have a positive priority.
2141 * Negative priorities are reserved for the system for this broadcast;
2142 * using them may cause problems.</p>
2143 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2144 * abort the broadcast.</p>
2145 * <p>Emergency calls cannot be intercepted using this mechanism, and
2146 * other calls cannot be modified to call emergency numbers using this
2147 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002148 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002149 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2150 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002151 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002152 * <p class="note">This is a protected intent that can only be sent
2153 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002154 */
2155 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2156 public static final String ACTION_NEW_OUTGOING_CALL =
2157 "android.intent.action.NEW_OUTGOING_CALL";
2158
2159 /**
2160 * Broadcast Action: Have the device reboot. This is only for use by
2161 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002162 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002163 * <p class="note">This is a protected intent that can only be sent
2164 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002165 */
2166 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2167 public static final String ACTION_REBOOT =
2168 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002169
Wei Huang97ecc9c2009-05-11 17:44:20 -07002170 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002171 * Broadcast Action: A sticky broadcast for changes in the physical
2172 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002173 *
2174 * <p>The intent will have the following extra values:
2175 * <ul>
2176 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002177 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002178 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002179 * <p>This is intended for monitoring the current physical dock state.
2180 * See {@link android.app.UiModeManager} for the normal API dealing with
2181 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002182 */
2183 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2184 public static final String ACTION_DOCK_EVENT =
2185 "android.intent.action.DOCK_EVENT";
2186
2187 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002188 * Broadcast Action: a remote intent is to be broadcasted.
2189 *
2190 * A remote intent is used for remote RPC between devices. The remote intent
2191 * is serialized and sent from one device to another device. The receiving
2192 * device parses the remote intent and broadcasts it. Note that anyone can
2193 * broadcast a remote intent. However, if the intent receiver of the remote intent
2194 * does not trust intent broadcasts from arbitrary intent senders, it should require
2195 * the sender to hold certain permissions so only trusted sender's broadcast will be
2196 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002197 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002198 */
2199 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002200 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002201
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002202 /**
2203 * Broadcast Action: hook for permforming cleanup after a system update.
2204 *
2205 * The broadcast is sent when the system is booting, before the
2206 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2207 * image. A receiver for this should do its work and then disable itself
2208 * so that it does not get run again at the next boot.
2209 * @hide
2210 */
2211 public static final String ACTION_PRE_BOOT_COMPLETED =
2212 "android.intent.action.PRE_BOOT_COMPLETED";
2213
Amith Yamasani13593602012-03-22 16:16:17 -07002214 /**
2215 * Broadcast sent to the system when a user is added. Carries an extra EXTRA_USERID that has the
2216 * userid of the new user.
2217 * @hide
2218 */
2219 public static final String ACTION_USER_ADDED =
2220 "android.intent.action.USER_ADDED";
2221
2222 /**
2223 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USERID that has
2224 * the userid of the user.
2225 * @hide
2226 */
2227 public static final String ACTION_USER_REMOVED =
2228 "android.intent.action.USER_REMOVED";
2229
2230 /**
2231 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USERID that has
2232 * the userid of the user to become the current one.
2233 * @hide
2234 */
2235 public static final String ACTION_USER_SWITCHED =
2236 "android.intent.action.USER_SWITCHED";
2237
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002238 // ---------------------------------------------------------------------
2239 // ---------------------------------------------------------------------
2240 // Standard intent categories (see addCategory()).
2241
2242 /**
2243 * Set if the activity should be an option for the default action
2244 * (center press) to perform on a piece of data. Setting this will
2245 * hide from the user any activities without it set when performing an
2246 * action on some data. Note that this is normal -not- set in the
2247 * Intent when initiating an action -- it is for use in intent filters
2248 * specified in packages.
2249 */
2250 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2251 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2252 /**
2253 * Activities that can be safely invoked from a browser must support this
2254 * category. For example, if the user is viewing a web page or an e-mail
2255 * and clicks on a link in the text, the Intent generated execute that
2256 * link will require the BROWSABLE category, so that only activities
2257 * supporting this category will be considered as possible actions. By
2258 * supporting this category, you are promising that there is nothing
2259 * damaging (without user intervention) that can happen by invoking any
2260 * matching Intent.
2261 */
2262 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2263 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2264 /**
2265 * Set if the activity should be considered as an alternative action to
2266 * the data the user is currently viewing. See also
2267 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2268 * applies to the selection in a list of items.
2269 *
2270 * <p>Supporting this category means that you would like your activity to be
2271 * displayed in the set of alternative things the user can do, usually as
2272 * part of the current activity's options menu. You will usually want to
2273 * include a specific label in the &lt;intent-filter&gt; of this action
2274 * describing to the user what it does.
2275 *
2276 * <p>The action of IntentFilter with this category is important in that it
2277 * describes the specific action the target will perform. This generally
2278 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2279 * a specific name such as "com.android.camera.action.CROP. Only one
2280 * alternative of any particular action will be shown to the user, so using
2281 * a specific action like this makes sure that your alternative will be
2282 * displayed while also allowing other applications to provide their own
2283 * overrides of that particular action.
2284 */
2285 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2286 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2287 /**
2288 * Set if the activity should be considered as an alternative selection
2289 * action to the data the user has currently selected. This is like
2290 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2291 * of items from which the user can select, giving them alternatives to the
2292 * default action that will be performed on it.
2293 */
2294 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2295 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2296 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002297 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002298 */
2299 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2300 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2301 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002302 * Should be displayed in the top-level launcher.
2303 */
2304 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2305 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2306 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002307 * Provides information about the package it is in; typically used if
2308 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2309 * a front-door to the user without having to be shown in the all apps list.
2310 */
2311 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2312 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2313 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002314 * This is the home activity, that is the first activity that is displayed
2315 * when the device boots.
2316 */
2317 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2318 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2319 /**
2320 * This activity is a preference panel.
2321 */
2322 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2323 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2324 /**
2325 * This activity is a development preference panel.
2326 */
2327 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2328 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2329 /**
2330 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002331 */
2332 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2333 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2334 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002335 * This activity allows the user to browse and download new applications.
2336 */
2337 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2338 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2339 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002340 * This activity may be exercised by the monkey or other automated test tools.
2341 */
2342 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2343 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2344 /**
2345 * To be used as a test (not part of the normal user experience).
2346 */
2347 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2348 /**
2349 * To be used as a unit test (run through the Test Harness).
2350 */
2351 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2352 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002353 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002354 * experience).
2355 */
2356 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2357 /**
2358 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2359 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2360 * when queried, though it is allowable for those columns to be blank.
2361 */
2362 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2363 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2364
2365 /**
2366 * To be used as code under test for framework instrumentation tests.
2367 */
2368 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2369 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002370 /**
2371 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002372 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2373 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002374 */
2375 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2376 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2377 /**
2378 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002379 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2380 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002381 */
2382 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2383 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002384 /**
2385 * An activity to run when device is inserted into a analog (low end) dock.
2386 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2387 * information, see {@link android.app.UiModeManager}.
2388 */
2389 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2390 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2391
2392 /**
2393 * An activity to run when device is inserted into a digital (high end) dock.
2394 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2395 * information, see {@link android.app.UiModeManager}.
2396 */
2397 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2398 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002399
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002400 /**
2401 * Used to indicate that the activity can be used in a car environment.
2402 */
2403 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2404 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2405
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002406 // ---------------------------------------------------------------------
2407 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002408 // Application launch intent categories (see addCategory()).
2409
2410 /**
2411 * Used with {@link #ACTION_MAIN} to launch the browser application.
2412 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002413 * <p>NOTE: This should not be used as the primary key of an Intent,
2414 * since it will not result in the app launching with the correct
2415 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002416 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002417 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002418 */
2419 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2420 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2421
2422 /**
2423 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2424 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002425 * <p>NOTE: This should not be used as the primary key of an Intent,
2426 * since it will not result in the app launching with the correct
2427 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002428 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002429 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002430 */
2431 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2432 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2433
2434 /**
2435 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2436 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002437 * <p>NOTE: This should not be used as the primary key of an Intent,
2438 * since it will not result in the app launching with the correct
2439 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002440 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002441 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002442 */
2443 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2444 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2445
2446 /**
2447 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2448 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002449 * <p>NOTE: This should not be used as the primary key of an Intent,
2450 * since it will not result in the app launching with the correct
2451 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002452 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002453 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002454 */
2455 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2456 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2457
2458 /**
2459 * Used with {@link #ACTION_MAIN} to launch the email application.
2460 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002461 * <p>NOTE: This should not be used as the primary key of an Intent,
2462 * since it will not result in the app launching with the correct
2463 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002464 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002465 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002466 */
2467 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2468 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2469
2470 /**
2471 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2472 * The activity should be able to view and manipulate image and video files
2473 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002474 * <p>NOTE: This should not be used as the primary key of an Intent,
2475 * since it will not result in the app launching with the correct
2476 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002477 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002478 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002479 */
2480 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2481 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2482
2483 /**
2484 * Used with {@link #ACTION_MAIN} to launch the maps application.
2485 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002486 * <p>NOTE: This should not be used as the primary key of an Intent,
2487 * since it will not result in the app launching with the correct
2488 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002489 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002490 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002491 */
2492 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2493 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2494
2495 /**
2496 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2497 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002498 * <p>NOTE: This should not be used as the primary key of an Intent,
2499 * since it will not result in the app launching with the correct
2500 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002501 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002502 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002503 */
2504 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2505 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2506
2507 /**
2508 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002509 * The activity should be able to play, browse, or manipulate music files
2510 * stored on the device.
2511 * <p>NOTE: This should not be used as the primary key of an Intent,
2512 * since it will not result in the app launching with the correct
2513 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002514 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002515 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002516 */
2517 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2518 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2519
2520 // ---------------------------------------------------------------------
2521 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002522 // Standard extra data keys.
2523
2524 /**
2525 * The initial data to place in a newly created record. Use with
2526 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2527 * fields as would be given to the underlying ContentProvider.insert()
2528 * call.
2529 */
2530 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2531
2532 /**
2533 * A constant CharSequence that is associated with the Intent, used with
2534 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2535 * this may be a styled CharSequence, so you must use
2536 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2537 * retrieve it.
2538 */
2539 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2540
2541 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002542 * A constant String that is associated with the Intent, used with
2543 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2544 * as HTML formatted text. Note that you <em>must</em> also supply
2545 * {@link #EXTRA_TEXT}.
2546 */
2547 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2548
2549 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002550 * A content: URI holding a stream of data associated with the Intent,
2551 * used with {@link #ACTION_SEND} to supply the data being sent.
2552 */
2553 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2554
2555 /**
2556 * A String[] holding e-mail addresses that should be delivered to.
2557 */
2558 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2559
2560 /**
2561 * A String[] holding e-mail addresses that should be carbon copied.
2562 */
2563 public static final String EXTRA_CC = "android.intent.extra.CC";
2564
2565 /**
2566 * A String[] holding e-mail addresses that should be blind carbon copied.
2567 */
2568 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2569
2570 /**
2571 * A constant string holding the desired subject line of a message.
2572 */
2573 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2574
2575 /**
2576 * An Intent describing the choices you would like shown with
2577 * {@link #ACTION_PICK_ACTIVITY}.
2578 */
2579 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2580
2581 /**
2582 * A CharSequence dialog title to provide to the user when used with a
2583 * {@link #ACTION_CHOOSER}.
2584 */
2585 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2586
2587 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002588 * A Parcelable[] of {@link Intent} or
2589 * {@link android.content.pm.LabeledIntent} objects as set with
2590 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2591 * a the front of the list of choices, when shown to the user with a
2592 * {@link #ACTION_CHOOSER}.
2593 */
2594 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2595
2596 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002597 * A {@link android.view.KeyEvent} object containing the event that
2598 * triggered the creation of the Intent it is in.
2599 */
2600 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2601
2602 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002603 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2604 * before shutting down.
2605 *
2606 * {@hide}
2607 */
2608 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2609
2610 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002611 * 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 -07002612 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2613 * of restarting the application.
2614 */
2615 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2616
2617 /**
2618 * A String holding the phone number originally entered in
2619 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2620 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2621 */
2622 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002624 /**
2625 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2626 * intents to supply the uid the package had been assigned. Also an optional
2627 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2628 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2629 * purpose.
2630 */
2631 public static final String EXTRA_UID = "android.intent.extra.UID";
2632
2633 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002634 * @hide String array of package names.
2635 */
2636 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2637
2638 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002639 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2640 * intents to indicate whether this represents a full uninstall (removing
2641 * both the code and its data) or a partial uninstall (leaving its data,
2642 * implying that this is an update).
2643 */
2644 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002645
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002646 /**
2647 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2648 * intents to indicate that this is a replacement of the package, so this
2649 * broadcast will immediately be followed by an add broadcast for a
2650 * different version of the same package.
2651 */
2652 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002653
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002654 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002655 * Used as an int extra field in {@link android.app.AlarmManager} intents
2656 * to tell the application being invoked how many pending alarms are being
2657 * delievered with the intent. For one-shot alarms this will always be 1.
2658 * For recurring alarms, this might be greater than 1 if the device was
2659 * asleep or powered off at the time an earlier alarm would have been
2660 * delivered.
2661 */
2662 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002663
Jacek Surazski86b6c532009-05-13 14:38:28 +02002664 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002665 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2666 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002667 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2668 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002669 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2670 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2671 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002672 */
2673 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2674
2675 /**
2676 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2677 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002678 */
2679 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2680
2681 /**
2682 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2683 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002684 */
2685 public static final int EXTRA_DOCK_STATE_DESK = 1;
2686
2687 /**
2688 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2689 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002690 */
2691 public static final int EXTRA_DOCK_STATE_CAR = 2;
2692
2693 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002694 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2695 * to represent that the phone is in a analog (low end) dock.
2696 */
2697 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2698
2699 /**
2700 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2701 * to represent that the phone is in a digital (high end) dock.
2702 */
2703 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2704
2705 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002706 * Boolean that can be supplied as meta-data with a dock activity, to
2707 * indicate that the dock should take over the home key when it is active.
2708 */
2709 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002710
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002711 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002712 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2713 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002714 */
2715 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2716
2717 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002718 * Used in the extra field in the remote intent. It's astring token passed with the
2719 * remote intent.
2720 */
2721 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2722 "android.intent.extra.remote_intent_token";
2723
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002724 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002725 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002726 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002727 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002728 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002729 "android.intent.extra.changed_component_name";
2730
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002731 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002732 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002733 * and contains a string array of all of the components that have changed.
2734 */
2735 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2736 "android.intent.extra.changed_component_name_list";
2737
2738 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002739 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002740 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2741 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002742 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002743 */
2744 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2745 "android.intent.extra.changed_package_list";
2746
2747 /**
2748 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002749 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2750 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002751 * and contains an integer array of uids of all of the components
2752 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002753 */
2754 public static final String EXTRA_CHANGED_UID_LIST =
2755 "android.intent.extra.changed_uid_list";
2756
2757 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002758 * @hide
2759 * Magic extra system code can use when binding, to give a label for
2760 * who it is that has bound to a service. This is an integer giving
2761 * a framework string resource that can be displayed to the user.
2762 */
2763 public static final String EXTRA_CLIENT_LABEL =
2764 "android.intent.extra.client_label";
2765
2766 /**
2767 * @hide
2768 * Magic extra system code can use when binding, to give a PendingIntent object
2769 * that can be launched for the user to disable the system's use of this
2770 * service.
2771 */
2772 public static final String EXTRA_CLIENT_INTENT =
2773 "android.intent.extra.client_intent";
2774
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002775 /**
2776 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2777 * data that is on the local device. This is a boolean extra; the default
2778 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2779 * the user to select media that is already on the device, not requiring it
2780 * be downloaded from a remote service when opened. Another way to look
2781 * at it is that such content should generally have a "_data" column to the
2782 * path of the content on local external storage.
2783 */
2784 public static final String EXTRA_LOCAL_ONLY =
2785 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07002786
Amith Yamasani13593602012-03-22 16:16:17 -07002787 /**
2788 * The userid carried with broadcast intents related to addition, removal and switching of users
2789 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
2790 * @hide
2791 */
2792 public static final String EXTRA_USERID =
2793 "android.intent.extra.user_id";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002794 // ---------------------------------------------------------------------
2795 // ---------------------------------------------------------------------
2796 // Intent flags (see mFlags variable).
2797
2798 /**
2799 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002800 * perform read operations on the Uri in the Intent's data and any URIs
2801 * specified in its ClipData. When applying to an Intent's ClipData,
2802 * all URIs as well as recursive traversals through data or other ClipData
2803 * in Intent items will be granted; only the grant flags of the top-level
2804 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002805 */
2806 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2807 /**
2808 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002809 * perform write operations on the Uri in the Intent's data and any URIs
2810 * specified in its ClipData. When applying to an Intent's ClipData,
2811 * all URIs as well as recursive traversals through data or other ClipData
2812 * in Intent items will be granted; only the grant flags of the top-level
2813 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002814 */
2815 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2816 /**
2817 * Can be set by the caller to indicate that this Intent is coming from
2818 * a background operation, not from direct user interaction.
2819 */
2820 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2821 /**
2822 * A flag you can enable for debugging: when set, log messages will be
2823 * printed during the resolution of this intent to show you what has
2824 * been found to create the final resolved list.
2825 */
2826 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002827 /**
2828 * If set, this intent will not match any components in packages that
2829 * are currently stopped. If this is not set, then the default behavior
2830 * is to include such applications in the result.
2831 */
2832 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2833 /**
2834 * If set, this intent will always match any components in packages that
2835 * are currently stopped. This is the default behavior when
2836 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2837 * flags are set, this one wins (it allows overriding of exclude for
2838 * places where the framework may automatically set the exclude flag).
2839 */
2840 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002841
2842 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002843 * If set, the new activity is not kept in the history stack. As soon as
2844 * the user navigates away from it, the activity is finished. This may also
2845 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2846 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002847 */
2848 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2849 /**
2850 * If set, the activity will not be launched if it is already running
2851 * at the top of the history stack.
2852 */
2853 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2854 /**
2855 * If set, this activity will become the start of a new task on this
2856 * history stack. A task (from the activity that started it to the
2857 * next task activity) defines an atomic group of activities that the
2858 * user can move to. Tasks can be moved to the foreground and background;
2859 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002860 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002861 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2862 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002863 *
2864 * <p>This flag is generally used by activities that want
2865 * to present a "launcher" style behavior: they give the user a list of
2866 * separate things that can be done, which otherwise run completely
2867 * independently of the activity launching them.
2868 *
2869 * <p>When using this flag, if a task is already running for the activity
2870 * you are now starting, then a new activity will not be started; instead,
2871 * the current task will simply be brought to the front of the screen with
2872 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2873 * to disable this behavior.
2874 *
2875 * <p>This flag can not be used when the caller is requesting a result from
2876 * the activity being launched.
2877 */
2878 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2879 /**
2880 * <strong>Do not use this flag unless you are implementing your own
2881 * top-level application launcher.</strong> Used in conjunction with
2882 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2883 * behavior of bringing an existing task to the foreground. When set,
2884 * a new task is <em>always</em> started to host the Activity for the
2885 * Intent, regardless of whether there is already an existing task running
2886 * the same thing.
2887 *
2888 * <p><strong>Because the default system does not include graphical task management,
2889 * you should not use this flag unless you provide some way for a user to
2890 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002891 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002892 * <p>This flag is ignored if
2893 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2894 *
Scott Main7aee61f2011-02-08 11:25:01 -08002895 * <p>See
2896 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2897 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002898 */
2899 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2900 /**
2901 * If set, and the activity being launched is already running in the
2902 * current task, then instead of launching a new instance of that activity,
2903 * all of the other activities on top of it will be closed and this Intent
2904 * will be delivered to the (now on top) old activity as a new Intent.
2905 *
2906 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2907 * If D calls startActivity() with an Intent that resolves to the component
2908 * of activity B, then C and D will be finished and B receive the given
2909 * Intent, resulting in the stack now being: A, B.
2910 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002911 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002912 * either receive the new intent you are starting here in its
2913 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002914 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002915 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2916 * the same intent, then it will be finished and re-created; for all other
2917 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2918 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002919 *
2920 * <p>This launch mode can also be used to good effect in conjunction with
2921 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2922 * of a task, it will bring any currently running instance of that task
2923 * to the foreground, and then clear it to its root state. This is
2924 * especially useful, for example, when launching an activity from the
2925 * notification manager.
2926 *
Scott Main7aee61f2011-02-08 11:25:01 -08002927 * <p>See
2928 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2929 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002930 */
2931 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2932 /**
2933 * If set and this intent is being used to launch a new activity from an
2934 * existing one, then the reply target of the existing activity will be
2935 * transfered to the new activity. This way the new activity can call
2936 * {@link android.app.Activity#setResult} and have that result sent back to
2937 * the reply target of the original activity.
2938 */
2939 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2940 /**
2941 * If set and this intent is being used to launch a new activity from an
2942 * existing one, the current activity will not be counted as the top
2943 * activity for deciding whether the new intent should be delivered to
2944 * the top instead of starting a new one. The previous activity will
2945 * be used as the top, with the assumption being that the current activity
2946 * will finish itself immediately.
2947 */
2948 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2949 /**
2950 * If set, the new activity is not kept in the list of recently launched
2951 * activities.
2952 */
2953 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2954 /**
2955 * This flag is not normally set by application code, but set for you by
2956 * the system as described in the
2957 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2958 * launchMode} documentation for the singleTask mode.
2959 */
2960 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2961 /**
2962 * If set, and this activity is either being started in a new task or
2963 * bringing to the top an existing task, then it will be launched as
2964 * the front door of the task. This will result in the application of
2965 * any affinities needed to have that task in the proper state (either
2966 * moving activities to or from it), or simply resetting that task to
2967 * its initial state if needed.
2968 */
2969 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2970 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002971 * This flag is not normally set by application code, but set for you by
2972 * the system if this activity is being launched from history
2973 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002974 */
2975 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002976 /**
2977 * If set, this marks a point in the task's activity stack that should
2978 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002979 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002980 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2981 * the user re-launching it from home), this activity and all on top of
2982 * it will be finished so that the user does not return to them, but
2983 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002984 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002985 * <p>This is useful for cases where you have a logical break in your
2986 * application. For example, an e-mail application may have a command
2987 * to view an attachment, which launches an image view activity to
2988 * display it. This activity should be part of the e-mail application's
2989 * task, since it is a part of the task the user is involved in. However,
2990 * if the user leaves that task, and later selects the e-mail app from
2991 * home, we may like them to return to the conversation they were
2992 * viewing, not the picture attachment, since that is confusing. By
2993 * setting this flag when launching the image viewer, that viewer and
2994 * any activities it starts will be removed the next time the user returns
2995 * to mail.
2996 */
2997 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002998 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002999 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003000 * callback from occurring on the current frontmost activity before it is
3001 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003002 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003003 * <p>Typically, an activity can rely on that callback to indicate that an
3004 * explicit user action has caused their activity to be moved out of the
3005 * foreground. The callback marks an appropriate point in the activity's
3006 * lifecycle for it to dismiss any notifications that it intends to display
3007 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003008 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003009 * <p>If an activity is ever started via any non-user-driven events such as
3010 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3011 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003012 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003013 */
3014 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003015 /**
3016 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3017 * this flag will cause the launched activity to be brought to the front of its
3018 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003019 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003020 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3021 * If D calls startActivity() with an Intent that resolves to the component
3022 * of activity B, then B will be brought to the front of the history stack,
3023 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003024 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003025 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003026 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003027 */
3028 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003029 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003030 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3031 * this flag will prevent the system from applying an activity transition
3032 * animation to go to the next activity state. This doesn't mean an
3033 * animation will never run -- if another activity change happens that doesn't
3034 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003035 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003036 * when you are going to do a series of activity operations but the
3037 * animation seen by the user shouldn't be driven by the first activity
3038 * change but rather a later one.
3039 */
3040 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3041 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003042 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3043 * this flag will cause any existing task that would be associated with the
3044 * activity to be cleared before the activity is started. That is, the activity
3045 * becomes the new root of an otherwise empty task, and any old activities
3046 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3047 */
3048 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3049 /**
3050 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3051 * this flag will cause a newly launching task to be placed on top of the current
3052 * home activity task (if there is one). That is, pressing back from the task
3053 * will always return the user to home even if that was not the last activity they
3054 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3055 */
3056 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3057 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003058 * If set, when sending a broadcast only registered receivers will be
3059 * called -- no BroadcastReceiver components will be launched.
3060 */
3061 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003062 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003063 * If set, when sending a broadcast the new broadcast will replace
3064 * any existing pending broadcast that matches it. Matching is defined
3065 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3066 * true for the intents of the two broadcasts. When a match is found,
3067 * the new broadcast (and receivers associated with it) will replace the
3068 * existing one in the pending broadcast list, remaining at the same
3069 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003070 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003071 * <p>This flag is most typically used with sticky broadcasts, which
3072 * only care about delivering the most recent values of the broadcast
3073 * to their receivers.
3074 */
3075 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3076 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003077 * If set, when sending a broadcast the recipient is allowed to run at
3078 * foreground priority, with a shorter timeout interval. During normal
3079 * broadcasts the receivers are not automatically hoisted out of the
3080 * background priority class.
3081 */
3082 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3083 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003084 * If set, when sending a broadcast <i>before boot has completed</i> only
3085 * registered receivers will be called -- no BroadcastReceiver components
3086 * will be launched. Sticky intent state will be recorded properly even
3087 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3088 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003089 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003090 * <p>This flag is only for use by system sevices as a convenience to
3091 * avoid having to implement a more complex mechanism around detection
3092 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003093 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003094 * @hide
3095 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003096 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003097 /**
3098 * Set when this broadcast is for a boot upgrade, a special mode that
3099 * allows the broadcast to be sent before the system is ready and launches
3100 * the app process with no providers running in it.
3101 * @hide
3102 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003103 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003104
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003105 /**
3106 * @hide Flags that can't be changed with PendingIntent.
3107 */
3108 public static final int IMMUTABLE_FLAGS =
3109 FLAG_GRANT_READ_URI_PERMISSION
3110 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003111
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003112 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003113 // ---------------------------------------------------------------------
3114 // toUri() and parseUri() options.
3115
3116 /**
3117 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3118 * always has the "intent:" scheme. This syntax can be used when you want
3119 * to later disambiguate between URIs that are intended to describe an
3120 * Intent vs. all others that should be treated as raw URIs. When used
3121 * with {@link #parseUri}, any other scheme will result in a generic
3122 * VIEW action for that raw URI.
3123 */
3124 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003125
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003126 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003127
3128 private String mAction;
3129 private Uri mData;
3130 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003131 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003132 private ComponentName mComponent;
3133 private int mFlags;
3134 private HashSet<String> mCategories;
3135 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003136 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003137 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003138 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003139
3140 // ---------------------------------------------------------------------
3141
3142 /**
3143 * Create an empty intent.
3144 */
3145 public Intent() {
3146 }
3147
3148 /**
3149 * Copy constructor.
3150 */
3151 public Intent(Intent o) {
3152 this.mAction = o.mAction;
3153 this.mData = o.mData;
3154 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003155 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003156 this.mComponent = o.mComponent;
3157 this.mFlags = o.mFlags;
3158 if (o.mCategories != null) {
3159 this.mCategories = new HashSet<String>(o.mCategories);
3160 }
3161 if (o.mExtras != null) {
3162 this.mExtras = new Bundle(o.mExtras);
3163 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003164 if (o.mSourceBounds != null) {
3165 this.mSourceBounds = new Rect(o.mSourceBounds);
3166 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003167 if (o.mSelector != null) {
3168 this.mSelector = new Intent(o.mSelector);
3169 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003170 if (o.mClipData != null) {
3171 this.mClipData = new ClipData(o.mClipData);
3172 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003173 }
3174
3175 @Override
3176 public Object clone() {
3177 return new Intent(this);
3178 }
3179
3180 private Intent(Intent o, boolean all) {
3181 this.mAction = o.mAction;
3182 this.mData = o.mData;
3183 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003184 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003185 this.mComponent = o.mComponent;
3186 if (o.mCategories != null) {
3187 this.mCategories = new HashSet<String>(o.mCategories);
3188 }
3189 }
3190
3191 /**
3192 * Make a clone of only the parts of the Intent that are relevant for
3193 * filter matching: the action, data, type, component, and categories.
3194 */
3195 public Intent cloneFilter() {
3196 return new Intent(this, false);
3197 }
3198
3199 /**
3200 * Create an intent with a given action. All other fields (data, type,
3201 * class) are null. Note that the action <em>must</em> be in a
3202 * namespace because Intents are used globally in the system -- for
3203 * example the system VIEW action is android.intent.action.VIEW; an
3204 * application's custom action would be something like
3205 * com.google.app.myapp.CUSTOM_ACTION.
3206 *
3207 * @param action The Intent action, such as ACTION_VIEW.
3208 */
3209 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003210 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003211 }
3212
3213 /**
3214 * Create an intent with a given action and for a given data url. Note
3215 * that the action <em>must</em> be in a namespace because Intents are
3216 * used globally in the system -- for example the system VIEW action is
3217 * android.intent.action.VIEW; an application's custom action would be
3218 * something like com.google.app.myapp.CUSTOM_ACTION.
3219 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003220 * <p><em>Note: scheme and host name matching in the Android framework is
3221 * case-sensitive, unlike the formal RFC. As a result,
3222 * you should always ensure that you write your Uri with these elements
3223 * using lower case letters, and normalize any Uris you receive from
3224 * outside of Android to ensure the scheme and host is lower case.</em></p>
3225 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003226 * @param action The Intent action, such as ACTION_VIEW.
3227 * @param uri The Intent data URI.
3228 */
3229 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003230 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003231 mData = uri;
3232 }
3233
3234 /**
3235 * Create an intent for a specific component. All other fields (action, data,
3236 * type, class) are null, though they can be modified later with explicit
3237 * calls. This provides a convenient way to create an intent that is
3238 * intended to execute a hard-coded class name, rather than relying on the
3239 * system to find an appropriate class for you; see {@link #setComponent}
3240 * for more information on the repercussions of this.
3241 *
3242 * @param packageContext A Context of the application package implementing
3243 * this class.
3244 * @param cls The component class that is to be used for the intent.
3245 *
3246 * @see #setClass
3247 * @see #setComponent
3248 * @see #Intent(String, android.net.Uri , Context, Class)
3249 */
3250 public Intent(Context packageContext, Class<?> cls) {
3251 mComponent = new ComponentName(packageContext, cls);
3252 }
3253
3254 /**
3255 * Create an intent for a specific component with a specified action and data.
3256 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3257 * construct the Intent and then calling {@link #setClass} to set its
3258 * class.
3259 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003260 * <p><em>Note: scheme and host name matching in the Android framework is
3261 * case-sensitive, unlike the formal RFC. As a result,
3262 * you should always ensure that you write your Uri with these elements
3263 * using lower case letters, and normalize any Uris you receive from
3264 * outside of Android to ensure the scheme and host is lower case.</em></p>
3265 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003266 * @param action The Intent action, such as ACTION_VIEW.
3267 * @param uri The Intent data URI.
3268 * @param packageContext A Context of the application package implementing
3269 * this class.
3270 * @param cls The component class that is to be used for the intent.
3271 *
3272 * @see #Intent(String, android.net.Uri)
3273 * @see #Intent(Context, Class)
3274 * @see #setClass
3275 * @see #setComponent
3276 */
3277 public Intent(String action, Uri uri,
3278 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003279 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003280 mData = uri;
3281 mComponent = new ComponentName(packageContext, cls);
3282 }
3283
3284 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003285 * Create an intent to launch the main (root) activity of a task. This
3286 * is the Intent that is started when the application's is launched from
3287 * Home. For anything else that wants to launch an application in the
3288 * same way, it is important that they use an Intent structured the same
3289 * way, and can use this function to ensure this is the case.
3290 *
3291 * <p>The returned Intent has the given Activity component as its explicit
3292 * component, {@link #ACTION_MAIN} as its action, and includes the
3293 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3294 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3295 * to do that through {@link #addFlags(int)} on the returned Intent.
3296 *
3297 * @param mainActivity The main activity component that this Intent will
3298 * launch.
3299 * @return Returns a newly created Intent that can be used to launch the
3300 * activity as a main application entry.
3301 *
3302 * @see #setClass
3303 * @see #setComponent
3304 */
3305 public static Intent makeMainActivity(ComponentName mainActivity) {
3306 Intent intent = new Intent(ACTION_MAIN);
3307 intent.setComponent(mainActivity);
3308 intent.addCategory(CATEGORY_LAUNCHER);
3309 return intent;
3310 }
3311
3312 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003313 * Make an Intent for the main activity of an application, without
3314 * specifying a specific activity to run but giving a selector to find
3315 * the activity. This results in a final Intent that is structured
3316 * the same as when the application is launched from
3317 * Home. For anything else that wants to launch an application in the
3318 * same way, it is important that they use an Intent structured the same
3319 * way, and can use this function to ensure this is the case.
3320 *
3321 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3322 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3323 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3324 * to do that through {@link #addFlags(int)} on the returned Intent.
3325 *
3326 * @param selectorAction The action name of the Intent's selector.
3327 * @param selectorCategory The name of a category to add to the Intent's
3328 * selector.
3329 * @return Returns a newly created Intent that can be used to launch the
3330 * activity as a main application entry.
3331 *
3332 * @see #setSelector(Intent)
3333 */
3334 public static Intent makeMainSelectorActivity(String selectorAction,
3335 String selectorCategory) {
3336 Intent intent = new Intent(ACTION_MAIN);
3337 intent.addCategory(CATEGORY_LAUNCHER);
3338 Intent selector = new Intent();
3339 selector.setAction(selectorAction);
3340 selector.addCategory(selectorCategory);
3341 intent.setSelector(selector);
3342 return intent;
3343 }
3344
3345 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003346 * Make an Intent that can be used to re-launch an application's task
3347 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3348 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3349 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3350 *
3351 * @param mainActivity The activity component that is the root of the
3352 * task; this is the activity that has been published in the application's
3353 * manifest as the main launcher icon.
3354 *
3355 * @return Returns a newly created Intent that can be used to relaunch the
3356 * activity's task in its root state.
3357 */
3358 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3359 Intent intent = makeMainActivity(mainActivity);
3360 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3361 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3362 return intent;
3363 }
3364
3365 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003366 * Call {@link #parseUri} with 0 flags.
3367 * @deprecated Use {@link #parseUri} instead.
3368 */
3369 @Deprecated
3370 public static Intent getIntent(String uri) throws URISyntaxException {
3371 return parseUri(uri, 0);
3372 }
Tom Taylord4a47292009-12-21 13:59:18 -08003373
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003374 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003375 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003376 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003377 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003378 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003379 *
3380 * <p>The URI given here must not be relative -- that is, it must include
3381 * the scheme and full path.
3382 *
3383 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003384 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003385 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003386 *
3387 * @return Intent The newly created Intent object.
3388 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003389 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3390 * it bad (as parsed by the Uri class) or the Intent data within the
3391 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003392 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003393 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003394 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003395 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003396 int i = 0;
3397 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003398 // Validate intent scheme for if requested.
3399 if ((flags&URI_INTENT_SCHEME) != 0) {
3400 if (!uri.startsWith("intent:")) {
3401 Intent intent = new Intent(ACTION_VIEW);
3402 try {
3403 intent.setData(Uri.parse(uri));
3404 } catch (IllegalArgumentException e) {
3405 throw new URISyntaxException(uri, e.getMessage());
3406 }
3407 return intent;
3408 }
3409 }
Tom Taylord4a47292009-12-21 13:59:18 -08003410
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003411 // simple case
3412 i = uri.lastIndexOf("#");
3413 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3414
3415 // old format Intent URI
3416 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003417
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003418 // new format
3419 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003420 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003421
3422 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003423 String data = i >= 0 ? uri.substring(0, i) : null;
3424 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003425 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003426
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003427 // loop over contents of Intent, all name=value;
3428 while (!uri.startsWith("end", i)) {
3429 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003430 if (eq < 0) eq = i-1;
3431 int semi = uri.indexOf(';', i);
3432 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003433
3434 // action
3435 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003436 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003437 }
3438
3439 // categories
3440 else if (uri.startsWith("category=", i)) {
3441 intent.addCategory(value);
3442 }
3443
3444 // type
3445 else if (uri.startsWith("type=", i)) {
3446 intent.mType = value;
3447 }
3448
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003449 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003450 else if (uri.startsWith("launchFlags=", i)) {
3451 intent.mFlags = Integer.decode(value).intValue();
3452 }
3453
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003454 // package
3455 else if (uri.startsWith("package=", i)) {
3456 intent.mPackage = value;
3457 }
3458
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003459 // component
3460 else if (uri.startsWith("component=", i)) {
3461 intent.mComponent = ComponentName.unflattenFromString(value);
3462 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003463
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003464 // scheme
3465 else if (uri.startsWith("scheme=", i)) {
3466 scheme = value;
3467 }
3468
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003469 // source bounds
3470 else if (uri.startsWith("sourceBounds=", i)) {
3471 intent.mSourceBounds = Rect.unflattenFromString(value);
3472 }
3473
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003474 // selector
3475 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3476 intent = new Intent();
3477 }
3478
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003479 // extra
3480 else {
3481 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003482 // create Bundle if it doesn't already exist
3483 if (intent.mExtras == null) intent.mExtras = new Bundle();
3484 Bundle b = intent.mExtras;
3485 // add EXTRA
3486 if (uri.startsWith("S.", i)) b.putString(key, value);
3487 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3488 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3489 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3490 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3491 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3492 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3493 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3494 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3495 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3496 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003497
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003498 // move to the next item
3499 i = semi + 1;
3500 }
3501
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003502 if (intent != baseIntent) {
3503 // The Intent had a selector; fix it up.
3504 baseIntent.setSelector(intent);
3505 intent = baseIntent;
3506 }
3507
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003508 if (data != null) {
3509 if (data.startsWith("intent:")) {
3510 data = data.substring(7);
3511 if (scheme != null) {
3512 data = scheme + ':' + data;
3513 }
3514 }
Tom Taylord4a47292009-12-21 13:59:18 -08003515
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003516 if (data.length() > 0) {
3517 try {
3518 intent.mData = Uri.parse(data);
3519 } catch (IllegalArgumentException e) {
3520 throw new URISyntaxException(uri, e.getMessage());
3521 }
3522 }
3523 }
Tom Taylord4a47292009-12-21 13:59:18 -08003524
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003525 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003526
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003527 } catch (IndexOutOfBoundsException e) {
3528 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3529 }
3530 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003531
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003532 public static Intent getIntentOld(String uri) throws URISyntaxException {
3533 Intent intent;
3534
3535 int i = uri.lastIndexOf('#');
3536 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003537 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003538 final int intentFragmentStart = i;
3539 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003540
3541 i++;
3542
3543 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003544 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003545 i += 7;
3546 int j = uri.indexOf(')', i);
3547 action = uri.substring(i, j);
3548 i = j + 1;
3549 }
3550
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003551 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003552
3553 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003554 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003555 i += 11;
3556 int j = uri.indexOf(')', i);
3557 while (i < j) {
3558 int sep = uri.indexOf('!', i);
3559 if (sep < 0) sep = j;
3560 if (i < sep) {
3561 intent.addCategory(uri.substring(i, sep));
3562 }
3563 i = sep + 1;
3564 }
3565 i = j + 1;
3566 }
3567
3568 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003569 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003570 i += 5;
3571 int j = uri.indexOf(')', i);
3572 intent.mType = uri.substring(i, j);
3573 i = j + 1;
3574 }
3575
3576 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003577 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003578 i += 12;
3579 int j = uri.indexOf(')', i);
3580 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3581 i = j + 1;
3582 }
3583
3584 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003585 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003586 i += 10;
3587 int j = uri.indexOf(')', i);
3588 int sep = uri.indexOf('!', i);
3589 if (sep >= 0 && sep < j) {
3590 String pkg = uri.substring(i, sep);
3591 String cls = uri.substring(sep + 1, j);
3592 intent.mComponent = new ComponentName(pkg, cls);
3593 }
3594 i = j + 1;
3595 }
3596
3597 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003598 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003599 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003600
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003601 final int closeParen = uri.indexOf(')', i);
3602 if (closeParen == -1) throw new URISyntaxException(uri,
3603 "EXTRA missing trailing ')'", i);
3604
3605 while (i < closeParen) {
3606 // fetch the key value
3607 int j = uri.indexOf('=', i);
3608 if (j <= i + 1 || i >= closeParen) {
3609 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3610 }
3611 char type = uri.charAt(i);
3612 i++;
3613 String key = uri.substring(i, j);
3614 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003615
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003616 // get type-value
3617 j = uri.indexOf('!', i);
3618 if (j == -1 || j >= closeParen) j = closeParen;
3619 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3620 String value = uri.substring(i, j);
3621 i = j;
3622
3623 // create Bundle if it doesn't already exist
3624 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003625
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003626 // add item to bundle
3627 try {
3628 switch (type) {
3629 case 'S':
3630 intent.mExtras.putString(key, Uri.decode(value));
3631 break;
3632 case 'B':
3633 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3634 break;
3635 case 'b':
3636 intent.mExtras.putByte(key, Byte.parseByte(value));
3637 break;
3638 case 'c':
3639 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3640 break;
3641 case 'd':
3642 intent.mExtras.putDouble(key, Double.parseDouble(value));
3643 break;
3644 case 'f':
3645 intent.mExtras.putFloat(key, Float.parseFloat(value));
3646 break;
3647 case 'i':
3648 intent.mExtras.putInt(key, Integer.parseInt(value));
3649 break;
3650 case 'l':
3651 intent.mExtras.putLong(key, Long.parseLong(value));
3652 break;
3653 case 's':
3654 intent.mExtras.putShort(key, Short.parseShort(value));
3655 break;
3656 default:
3657 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3658 }
3659 } catch (NumberFormatException e) {
3660 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3661 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003662
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003663 char ch = uri.charAt(i);
3664 if (ch == ')') break;
3665 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3666 i++;
3667 }
3668 }
3669
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003670 if (isIntentFragment) {
3671 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3672 } else {
3673 intent.mData = Uri.parse(uri);
3674 }
Tom Taylord4a47292009-12-21 13:59:18 -08003675
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003676 if (intent.mAction == null) {
3677 // By default, if no action is specified, then use VIEW.
3678 intent.mAction = ACTION_VIEW;
3679 }
3680
3681 } else {
3682 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3683 }
3684
3685 return intent;
3686 }
3687
3688 /**
3689 * Retrieve the general action to be performed, such as
3690 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3691 * the information in the intent should be interpreted -- most importantly,
3692 * what to do with the data returned by {@link #getData}.
3693 *
3694 * @return The action of this intent or null if none is specified.
3695 *
3696 * @see #setAction
3697 */
3698 public String getAction() {
3699 return mAction;
3700 }
3701
3702 /**
3703 * Retrieve data this intent is operating on. This URI specifies the name
3704 * of the data; often it uses the content: scheme, specifying data in a
3705 * content provider. Other schemes may be handled by specific activities,
3706 * such as http: by the web browser.
3707 *
3708 * @return The URI of the data this intent is targeting or null.
3709 *
3710 * @see #getScheme
3711 * @see #setData
3712 */
3713 public Uri getData() {
3714 return mData;
3715 }
3716
3717 /**
3718 * The same as {@link #getData()}, but returns the URI as an encoded
3719 * String.
3720 */
3721 public String getDataString() {
3722 return mData != null ? mData.toString() : null;
3723 }
3724
3725 /**
3726 * Return the scheme portion of the intent's data. If the data is null or
3727 * does not include a scheme, null is returned. Otherwise, the scheme
3728 * prefix without the final ':' is returned, i.e. "http".
3729 *
3730 * <p>This is the same as calling getData().getScheme() (and checking for
3731 * null data).
3732 *
3733 * @return The scheme of this intent.
3734 *
3735 * @see #getData
3736 */
3737 public String getScheme() {
3738 return mData != null ? mData.getScheme() : null;
3739 }
3740
3741 /**
3742 * Retrieve any explicit MIME type included in the intent. This is usually
3743 * null, as the type is determined by the intent data.
3744 *
3745 * @return If a type was manually set, it is returned; else null is
3746 * returned.
3747 *
3748 * @see #resolveType(ContentResolver)
3749 * @see #setType
3750 */
3751 public String getType() {
3752 return mType;
3753 }
3754
3755 /**
3756 * Return the MIME data type of this intent. If the type field is
3757 * explicitly set, that is simply returned. Otherwise, if the data is set,
3758 * the type of that data is returned. If neither fields are set, a null is
3759 * returned.
3760 *
3761 * @return The MIME type of this intent.
3762 *
3763 * @see #getType
3764 * @see #resolveType(ContentResolver)
3765 */
3766 public String resolveType(Context context) {
3767 return resolveType(context.getContentResolver());
3768 }
3769
3770 /**
3771 * Return the MIME data type of this intent. If the type field is
3772 * explicitly set, that is simply returned. Otherwise, if the data is set,
3773 * the type of that data is returned. If neither fields are set, a null is
3774 * returned.
3775 *
3776 * @param resolver A ContentResolver that can be used to determine the MIME
3777 * type of the intent's data.
3778 *
3779 * @return The MIME type of this intent.
3780 *
3781 * @see #getType
3782 * @see #resolveType(Context)
3783 */
3784 public String resolveType(ContentResolver resolver) {
3785 if (mType != null) {
3786 return mType;
3787 }
3788 if (mData != null) {
3789 if ("content".equals(mData.getScheme())) {
3790 return resolver.getType(mData);
3791 }
3792 }
3793 return null;
3794 }
3795
3796 /**
3797 * Return the MIME data type of this intent, only if it will be needed for
3798 * intent resolution. This is not generally useful for application code;
3799 * it is used by the frameworks for communicating with back-end system
3800 * services.
3801 *
3802 * @param resolver A ContentResolver that can be used to determine the MIME
3803 * type of the intent's data.
3804 *
3805 * @return The MIME type of this intent, or null if it is unknown or not
3806 * needed.
3807 */
3808 public String resolveTypeIfNeeded(ContentResolver resolver) {
3809 if (mComponent != null) {
3810 return mType;
3811 }
3812 return resolveType(resolver);
3813 }
3814
3815 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003816 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003817 *
3818 * @param category The category to check.
3819 *
3820 * @return boolean True if the intent contains the category, else false.
3821 *
3822 * @see #getCategories
3823 * @see #addCategory
3824 */
3825 public boolean hasCategory(String category) {
3826 return mCategories != null && mCategories.contains(category);
3827 }
3828
3829 /**
3830 * Return the set of all categories in the intent. If there are no categories,
3831 * returns NULL.
3832 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003833 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003834 *
3835 * @see #hasCategory
3836 * @see #addCategory
3837 */
3838 public Set<String> getCategories() {
3839 return mCategories;
3840 }
3841
3842 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003843 * Return the specific selector associated with this Intent. If there is
3844 * none, returns null. See {@link #setSelector} for more information.
3845 *
3846 * @see #setSelector
3847 */
3848 public Intent getSelector() {
3849 return mSelector;
3850 }
3851
3852 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003853 * Return the {@link ClipData} associated with this Intent. If there is
3854 * none, returns null. See {@link #setClipData} for more information.
3855 *
3856 * @see #setClipData;
3857 */
3858 public ClipData getClipData() {
3859 return mClipData;
3860 }
3861
3862 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003863 * Sets the ClassLoader that will be used when unmarshalling
3864 * any Parcelable values from the extras of this Intent.
3865 *
3866 * @param loader a ClassLoader, or null to use the default loader
3867 * at the time of unmarshalling.
3868 */
3869 public void setExtrasClassLoader(ClassLoader loader) {
3870 if (mExtras != null) {
3871 mExtras.setClassLoader(loader);
3872 }
3873 }
3874
3875 /**
3876 * Returns true if an extra value is associated with the given name.
3877 * @param name the extra's name
3878 * @return true if the given extra is present.
3879 */
3880 public boolean hasExtra(String name) {
3881 return mExtras != null && mExtras.containsKey(name);
3882 }
3883
3884 /**
3885 * Returns true if the Intent's extras contain a parcelled file descriptor.
3886 * @return true if the Intent contains a parcelled file descriptor.
3887 */
3888 public boolean hasFileDescriptors() {
3889 return mExtras != null && mExtras.hasFileDescriptors();
3890 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003891
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003892 /** @hide */
3893 public void setAllowFds(boolean allowFds) {
3894 if (mExtras != null) {
3895 mExtras.setAllowFds(allowFds);
3896 }
3897 }
3898
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003899 /**
3900 * Retrieve extended data from the intent.
3901 *
3902 * @param name The name of the desired item.
3903 *
3904 * @return the value of an item that previously added with putExtra()
3905 * or null if none was found.
3906 *
3907 * @deprecated
3908 * @hide
3909 */
3910 @Deprecated
3911 public Object getExtra(String name) {
3912 return getExtra(name, null);
3913 }
3914
3915 /**
3916 * Retrieve extended data from the intent.
3917 *
3918 * @param name The name of the desired item.
3919 * @param defaultValue the value to be returned if no value of the desired
3920 * type is stored with the given name.
3921 *
3922 * @return the value of an item that previously added with putExtra()
3923 * or the default value if none was found.
3924 *
3925 * @see #putExtra(String, boolean)
3926 */
3927 public boolean getBooleanExtra(String name, boolean defaultValue) {
3928 return mExtras == null ? defaultValue :
3929 mExtras.getBoolean(name, defaultValue);
3930 }
3931
3932 /**
3933 * Retrieve extended data from the intent.
3934 *
3935 * @param name The name of the desired item.
3936 * @param defaultValue the value to be returned if no value of the desired
3937 * type is stored with the given name.
3938 *
3939 * @return the value of an item that previously added with putExtra()
3940 * or the default value if none was found.
3941 *
3942 * @see #putExtra(String, byte)
3943 */
3944 public byte getByteExtra(String name, byte defaultValue) {
3945 return mExtras == null ? defaultValue :
3946 mExtras.getByte(name, defaultValue);
3947 }
3948
3949 /**
3950 * Retrieve extended data from the intent.
3951 *
3952 * @param name The name of the desired item.
3953 * @param defaultValue the value to be returned if no value of the desired
3954 * type is stored with the given name.
3955 *
3956 * @return the value of an item that previously added with putExtra()
3957 * or the default value if none was found.
3958 *
3959 * @see #putExtra(String, short)
3960 */
3961 public short getShortExtra(String name, short defaultValue) {
3962 return mExtras == null ? defaultValue :
3963 mExtras.getShort(name, defaultValue);
3964 }
3965
3966 /**
3967 * Retrieve extended data from the intent.
3968 *
3969 * @param name The name of the desired item.
3970 * @param defaultValue the value to be returned if no value of the desired
3971 * type is stored with the given name.
3972 *
3973 * @return the value of an item that previously added with putExtra()
3974 * or the default value if none was found.
3975 *
3976 * @see #putExtra(String, char)
3977 */
3978 public char getCharExtra(String name, char defaultValue) {
3979 return mExtras == null ? defaultValue :
3980 mExtras.getChar(name, defaultValue);
3981 }
3982
3983 /**
3984 * Retrieve extended data from the intent.
3985 *
3986 * @param name The name of the desired item.
3987 * @param defaultValue the value to be returned if no value of the desired
3988 * type is stored with the given name.
3989 *
3990 * @return the value of an item that previously added with putExtra()
3991 * or the default value if none was found.
3992 *
3993 * @see #putExtra(String, int)
3994 */
3995 public int getIntExtra(String name, int defaultValue) {
3996 return mExtras == null ? defaultValue :
3997 mExtras.getInt(name, defaultValue);
3998 }
3999
4000 /**
4001 * Retrieve extended data from the intent.
4002 *
4003 * @param name The name of the desired item.
4004 * @param defaultValue the value to be returned if no value of the desired
4005 * type is stored with the given name.
4006 *
4007 * @return the value of an item that previously added with putExtra()
4008 * or the default value if none was found.
4009 *
4010 * @see #putExtra(String, long)
4011 */
4012 public long getLongExtra(String name, long defaultValue) {
4013 return mExtras == null ? defaultValue :
4014 mExtras.getLong(name, defaultValue);
4015 }
4016
4017 /**
4018 * Retrieve extended data from the intent.
4019 *
4020 * @param name The name of the desired item.
4021 * @param defaultValue the value to be returned if no value of the desired
4022 * type is stored with the given name.
4023 *
4024 * @return the value of an item that previously added with putExtra(),
4025 * or the default value if no such item is present
4026 *
4027 * @see #putExtra(String, float)
4028 */
4029 public float getFloatExtra(String name, float defaultValue) {
4030 return mExtras == null ? defaultValue :
4031 mExtras.getFloat(name, defaultValue);
4032 }
4033
4034 /**
4035 * Retrieve extended data from the intent.
4036 *
4037 * @param name The name of the desired item.
4038 * @param defaultValue the value to be returned if no value of the desired
4039 * type is stored with the given name.
4040 *
4041 * @return the value of an item that previously added with putExtra()
4042 * or the default value if none was found.
4043 *
4044 * @see #putExtra(String, double)
4045 */
4046 public double getDoubleExtra(String name, double defaultValue) {
4047 return mExtras == null ? defaultValue :
4048 mExtras.getDouble(name, defaultValue);
4049 }
4050
4051 /**
4052 * Retrieve extended data from the intent.
4053 *
4054 * @param name The name of the desired item.
4055 *
4056 * @return the value of an item that previously added with putExtra()
4057 * or null if no String value was found.
4058 *
4059 * @see #putExtra(String, String)
4060 */
4061 public String getStringExtra(String name) {
4062 return mExtras == null ? null : mExtras.getString(name);
4063 }
4064
4065 /**
4066 * Retrieve extended data from the intent.
4067 *
4068 * @param name The name of the desired item.
4069 *
4070 * @return the value of an item that previously added with putExtra()
4071 * or null if no CharSequence value was found.
4072 *
4073 * @see #putExtra(String, CharSequence)
4074 */
4075 public CharSequence getCharSequenceExtra(String name) {
4076 return mExtras == null ? null : mExtras.getCharSequence(name);
4077 }
4078
4079 /**
4080 * Retrieve extended data from the intent.
4081 *
4082 * @param name The name of the desired item.
4083 *
4084 * @return the value of an item that previously added with putExtra()
4085 * or null if no Parcelable value was found.
4086 *
4087 * @see #putExtra(String, Parcelable)
4088 */
4089 public <T extends Parcelable> T getParcelableExtra(String name) {
4090 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4091 }
4092
4093 /**
4094 * Retrieve extended data from the intent.
4095 *
4096 * @param name The name of the desired item.
4097 *
4098 * @return the value of an item that previously added with putExtra()
4099 * or null if no Parcelable[] value was found.
4100 *
4101 * @see #putExtra(String, Parcelable[])
4102 */
4103 public Parcelable[] getParcelableArrayExtra(String name) {
4104 return mExtras == null ? null : mExtras.getParcelableArray(name);
4105 }
4106
4107 /**
4108 * Retrieve extended data from the intent.
4109 *
4110 * @param name The name of the desired item.
4111 *
4112 * @return the value of an item that previously added with putExtra()
4113 * or null if no ArrayList<Parcelable> value was found.
4114 *
4115 * @see #putParcelableArrayListExtra(String, ArrayList)
4116 */
4117 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4118 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4119 }
4120
4121 /**
4122 * Retrieve extended data from the intent.
4123 *
4124 * @param name The name of the desired item.
4125 *
4126 * @return the value of an item that previously added with putExtra()
4127 * or null if no Serializable value was found.
4128 *
4129 * @see #putExtra(String, Serializable)
4130 */
4131 public Serializable getSerializableExtra(String name) {
4132 return mExtras == null ? null : mExtras.getSerializable(name);
4133 }
4134
4135 /**
4136 * Retrieve extended data from the intent.
4137 *
4138 * @param name The name of the desired item.
4139 *
4140 * @return the value of an item that previously added with putExtra()
4141 * or null if no ArrayList<Integer> value was found.
4142 *
4143 * @see #putIntegerArrayListExtra(String, ArrayList)
4144 */
4145 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4146 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4147 }
4148
4149 /**
4150 * Retrieve extended data from the intent.
4151 *
4152 * @param name The name of the desired item.
4153 *
4154 * @return the value of an item that previously added with putExtra()
4155 * or null if no ArrayList<String> value was found.
4156 *
4157 * @see #putStringArrayListExtra(String, ArrayList)
4158 */
4159 public ArrayList<String> getStringArrayListExtra(String name) {
4160 return mExtras == null ? null : mExtras.getStringArrayList(name);
4161 }
4162
4163 /**
4164 * Retrieve extended data from the intent.
4165 *
4166 * @param name The name of the desired item.
4167 *
4168 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004169 * or null if no ArrayList<CharSequence> value was found.
4170 *
4171 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4172 */
4173 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4174 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4175 }
4176
4177 /**
4178 * Retrieve extended data from the intent.
4179 *
4180 * @param name The name of the desired item.
4181 *
4182 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004183 * or null if no boolean array value was found.
4184 *
4185 * @see #putExtra(String, boolean[])
4186 */
4187 public boolean[] getBooleanArrayExtra(String name) {
4188 return mExtras == null ? null : mExtras.getBooleanArray(name);
4189 }
4190
4191 /**
4192 * Retrieve extended data from the intent.
4193 *
4194 * @param name The name of the desired item.
4195 *
4196 * @return the value of an item that previously added with putExtra()
4197 * or null if no byte array value was found.
4198 *
4199 * @see #putExtra(String, byte[])
4200 */
4201 public byte[] getByteArrayExtra(String name) {
4202 return mExtras == null ? null : mExtras.getByteArray(name);
4203 }
4204
4205 /**
4206 * Retrieve extended data from the intent.
4207 *
4208 * @param name The name of the desired item.
4209 *
4210 * @return the value of an item that previously added with putExtra()
4211 * or null if no short array value was found.
4212 *
4213 * @see #putExtra(String, short[])
4214 */
4215 public short[] getShortArrayExtra(String name) {
4216 return mExtras == null ? null : mExtras.getShortArray(name);
4217 }
4218
4219 /**
4220 * Retrieve extended data from the intent.
4221 *
4222 * @param name The name of the desired item.
4223 *
4224 * @return the value of an item that previously added with putExtra()
4225 * or null if no char array value was found.
4226 *
4227 * @see #putExtra(String, char[])
4228 */
4229 public char[] getCharArrayExtra(String name) {
4230 return mExtras == null ? null : mExtras.getCharArray(name);
4231 }
4232
4233 /**
4234 * Retrieve extended data from the intent.
4235 *
4236 * @param name The name of the desired item.
4237 *
4238 * @return the value of an item that previously added with putExtra()
4239 * or null if no int array value was found.
4240 *
4241 * @see #putExtra(String, int[])
4242 */
4243 public int[] getIntArrayExtra(String name) {
4244 return mExtras == null ? null : mExtras.getIntArray(name);
4245 }
4246
4247 /**
4248 * Retrieve extended data from the intent.
4249 *
4250 * @param name The name of the desired item.
4251 *
4252 * @return the value of an item that previously added with putExtra()
4253 * or null if no long array value was found.
4254 *
4255 * @see #putExtra(String, long[])
4256 */
4257 public long[] getLongArrayExtra(String name) {
4258 return mExtras == null ? null : mExtras.getLongArray(name);
4259 }
4260
4261 /**
4262 * Retrieve extended data from the intent.
4263 *
4264 * @param name The name of the desired item.
4265 *
4266 * @return the value of an item that previously added with putExtra()
4267 * or null if no float array value was found.
4268 *
4269 * @see #putExtra(String, float[])
4270 */
4271 public float[] getFloatArrayExtra(String name) {
4272 return mExtras == null ? null : mExtras.getFloatArray(name);
4273 }
4274
4275 /**
4276 * Retrieve extended data from the intent.
4277 *
4278 * @param name The name of the desired item.
4279 *
4280 * @return the value of an item that previously added with putExtra()
4281 * or null if no double array value was found.
4282 *
4283 * @see #putExtra(String, double[])
4284 */
4285 public double[] getDoubleArrayExtra(String name) {
4286 return mExtras == null ? null : mExtras.getDoubleArray(name);
4287 }
4288
4289 /**
4290 * Retrieve extended data from the intent.
4291 *
4292 * @param name The name of the desired item.
4293 *
4294 * @return the value of an item that previously added with putExtra()
4295 * or null if no String array value was found.
4296 *
4297 * @see #putExtra(String, String[])
4298 */
4299 public String[] getStringArrayExtra(String name) {
4300 return mExtras == null ? null : mExtras.getStringArray(name);
4301 }
4302
4303 /**
4304 * Retrieve extended data from the intent.
4305 *
4306 * @param name The name of the desired item.
4307 *
4308 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004309 * or null if no CharSequence array value was found.
4310 *
4311 * @see #putExtra(String, CharSequence[])
4312 */
4313 public CharSequence[] getCharSequenceArrayExtra(String name) {
4314 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4315 }
4316
4317 /**
4318 * Retrieve extended data from the intent.
4319 *
4320 * @param name The name of the desired item.
4321 *
4322 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004323 * or null if no Bundle value was found.
4324 *
4325 * @see #putExtra(String, Bundle)
4326 */
4327 public Bundle getBundleExtra(String name) {
4328 return mExtras == null ? null : mExtras.getBundle(name);
4329 }
4330
4331 /**
4332 * Retrieve extended data from the intent.
4333 *
4334 * @param name The name of the desired item.
4335 *
4336 * @return the value of an item that previously added with putExtra()
4337 * or null if no IBinder value was found.
4338 *
4339 * @see #putExtra(String, IBinder)
4340 *
4341 * @deprecated
4342 * @hide
4343 */
4344 @Deprecated
4345 public IBinder getIBinderExtra(String name) {
4346 return mExtras == null ? null : mExtras.getIBinder(name);
4347 }
4348
4349 /**
4350 * Retrieve extended data from the intent.
4351 *
4352 * @param name The name of the desired item.
4353 * @param defaultValue The default value to return in case no item is
4354 * associated with the key 'name'
4355 *
4356 * @return the value of an item that previously added with putExtra()
4357 * or defaultValue if none was found.
4358 *
4359 * @see #putExtra
4360 *
4361 * @deprecated
4362 * @hide
4363 */
4364 @Deprecated
4365 public Object getExtra(String name, Object defaultValue) {
4366 Object result = defaultValue;
4367 if (mExtras != null) {
4368 Object result2 = mExtras.get(name);
4369 if (result2 != null) {
4370 result = result2;
4371 }
4372 }
4373
4374 return result;
4375 }
4376
4377 /**
4378 * Retrieves a map of extended data from the intent.
4379 *
4380 * @return the map of all extras previously added with putExtra(),
4381 * or null if none have been added.
4382 */
4383 public Bundle getExtras() {
4384 return (mExtras != null)
4385 ? new Bundle(mExtras)
4386 : null;
4387 }
4388
4389 /**
4390 * Retrieve any special flags associated with this intent. You will
4391 * normally just set them with {@link #setFlags} and let the system
4392 * take the appropriate action with them.
4393 *
4394 * @return int The currently set flags.
4395 *
4396 * @see #setFlags
4397 */
4398 public int getFlags() {
4399 return mFlags;
4400 }
4401
Dianne Hackborne7f97212011-02-24 14:40:20 -08004402 /** @hide */
4403 public boolean isExcludingStopped() {
4404 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4405 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4406 }
4407
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004408 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004409 * Retrieve the application package name this Intent is limited to. When
4410 * resolving an Intent, if non-null this limits the resolution to only
4411 * components in the given application package.
4412 *
4413 * @return The name of the application package for the Intent.
4414 *
4415 * @see #resolveActivity
4416 * @see #setPackage
4417 */
4418 public String getPackage() {
4419 return mPackage;
4420 }
4421
4422 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004423 * Retrieve the concrete component associated with the intent. When receiving
4424 * an intent, this is the component that was found to best handle it (that is,
4425 * yourself) and will always be non-null; in all other cases it will be
4426 * null unless explicitly set.
4427 *
4428 * @return The name of the application component to handle the intent.
4429 *
4430 * @see #resolveActivity
4431 * @see #setComponent
4432 */
4433 public ComponentName getComponent() {
4434 return mComponent;
4435 }
4436
4437 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004438 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4439 * used as a hint to the receiver for animations and the like. Null means that there
4440 * is no source bounds.
4441 */
4442 public Rect getSourceBounds() {
4443 return mSourceBounds;
4444 }
4445
4446 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004447 * Return the Activity component that should be used to handle this intent.
4448 * The appropriate component is determined based on the information in the
4449 * intent, evaluated as follows:
4450 *
4451 * <p>If {@link #getComponent} returns an explicit class, that is returned
4452 * without any further consideration.
4453 *
4454 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4455 * category to be considered.
4456 *
4457 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4458 * action.
4459 *
4460 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4461 * this type.
4462 *
4463 * <p>If {@link #addCategory} has added any categories, the activity must
4464 * handle ALL of the categories specified.
4465 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004466 * <p>If {@link #getPackage} is non-NULL, only activity components in
4467 * that application package will be considered.
4468 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004469 * <p>If there are no activities that satisfy all of these conditions, a
4470 * null string is returned.
4471 *
4472 * <p>If multiple activities are found to satisfy the intent, the one with
4473 * the highest priority will be used. If there are multiple activities
4474 * with the same priority, the system will either pick the best activity
4475 * based on user preference, or resolve to a system class that will allow
4476 * the user to pick an activity and forward from there.
4477 *
4478 * <p>This method is implemented simply by calling
4479 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4480 * true.</p>
4481 * <p> This API is called for you as part of starting an activity from an
4482 * intent. You do not normally need to call it yourself.</p>
4483 *
4484 * @param pm The package manager with which to resolve the Intent.
4485 *
4486 * @return Name of the component implementing an activity that can
4487 * display the intent.
4488 *
4489 * @see #setComponent
4490 * @see #getComponent
4491 * @see #resolveActivityInfo
4492 */
4493 public ComponentName resolveActivity(PackageManager pm) {
4494 if (mComponent != null) {
4495 return mComponent;
4496 }
4497
4498 ResolveInfo info = pm.resolveActivity(
4499 this, PackageManager.MATCH_DEFAULT_ONLY);
4500 if (info != null) {
4501 return new ComponentName(
4502 info.activityInfo.applicationInfo.packageName,
4503 info.activityInfo.name);
4504 }
4505
4506 return null;
4507 }
4508
4509 /**
4510 * Resolve the Intent into an {@link ActivityInfo}
4511 * describing the activity that should execute the intent. Resolution
4512 * follows the same rules as described for {@link #resolveActivity}, but
4513 * you get back the completely information about the resolved activity
4514 * instead of just its class name.
4515 *
4516 * @param pm The package manager with which to resolve the Intent.
4517 * @param flags Addition information to retrieve as per
4518 * {@link PackageManager#getActivityInfo(ComponentName, int)
4519 * PackageManager.getActivityInfo()}.
4520 *
4521 * @return PackageManager.ActivityInfo
4522 *
4523 * @see #resolveActivity
4524 */
4525 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4526 ActivityInfo ai = null;
4527 if (mComponent != null) {
4528 try {
4529 ai = pm.getActivityInfo(mComponent, flags);
4530 } catch (PackageManager.NameNotFoundException e) {
4531 // ignore
4532 }
4533 } else {
4534 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004535 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004536 if (info != null) {
4537 ai = info.activityInfo;
4538 }
4539 }
4540
4541 return ai;
4542 }
4543
4544 /**
4545 * Set the general action to be performed.
4546 *
4547 * @param action An action name, such as ACTION_VIEW. Application-specific
4548 * actions should be prefixed with the vendor's package name.
4549 *
4550 * @return Returns the same Intent object, for chaining multiple calls
4551 * into a single statement.
4552 *
4553 * @see #getAction
4554 */
4555 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004556 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004557 return this;
4558 }
4559
4560 /**
4561 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004562 * clears any type that was previously set by {@link #setType} or
4563 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004564 *
Nick Pellyccae4122012-01-09 14:12:58 -08004565 * <p><em>Note: scheme matching in the Android framework is
4566 * case-sensitive, unlike the formal RFC. As a result,
4567 * you should always write your Uri with a lower case scheme,
4568 * or use {@link Uri#normalize} or
4569 * {@link #setDataAndNormalize}
4570 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004571 *
Nick Pellyccae4122012-01-09 14:12:58 -08004572 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004573 *
4574 * @return Returns the same Intent object, for chaining multiple calls
4575 * into a single statement.
4576 *
4577 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004578 * @see #setDataAndNormalize
4579 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004580 */
4581 public Intent setData(Uri data) {
4582 mData = data;
4583 mType = null;
4584 return this;
4585 }
4586
4587 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004588 * Normalize and set the data this intent is operating on.
4589 *
4590 * <p>This method automatically clears any type that was
4591 * previously set (for example, by {@link #setType}).
4592 *
4593 * <p>The data Uri is normalized using
4594 * {@link android.net.Uri#normalize} before it is set,
4595 * so really this is just a convenience method for
4596 * <pre>
4597 * setData(data.normalize())
4598 * </pre>
4599 *
4600 * @param data The Uri of the data this intent is now targeting.
4601 *
4602 * @return Returns the same Intent object, for chaining multiple calls
4603 * into a single statement.
4604 *
4605 * @see #getData
4606 * @see #setType
4607 * @see android.net.Uri#normalize
4608 */
4609 public Intent setDataAndNormalize(Uri data) {
4610 return setData(data.normalize());
4611 }
4612
4613 /**
4614 * Set an explicit MIME data type.
4615 *
4616 * <p>This is used to create intents that only specify a type and not data,
4617 * for example to indicate the type of data to return.
4618 *
4619 * <p>This method automatically clears any data that was
4620 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004621 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004622 * <p><em>Note: MIME type matching in the Android framework is
4623 * case-sensitive, unlike formal RFC MIME types. As a result,
4624 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004625 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4626 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004627 *
4628 * @param type The MIME type of the data being handled by this intent.
4629 *
4630 * @return Returns the same Intent object, for chaining multiple calls
4631 * into a single statement.
4632 *
4633 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004634 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004635 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004636 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004637 */
4638 public Intent setType(String type) {
4639 mData = null;
4640 mType = type;
4641 return this;
4642 }
4643
4644 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004645 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004646 *
Nick Pellyccae4122012-01-09 14:12:58 -08004647 * <p>This is used to create intents that only specify a type and not data,
4648 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004649 *
Nick Pellyccae4122012-01-09 14:12:58 -08004650 * <p>This method automatically clears any data that was
4651 * previously set (for example by {@link #setData}).
4652 *
4653 * <p>The MIME type is normalized using
4654 * {@link #normalizeMimeType} before it is set,
4655 * so really this is just a convenience method for
4656 * <pre>
4657 * setType(Intent.normalizeMimeType(type))
4658 * </pre>
4659 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004660 * @param type The MIME type of the data being handled by this intent.
4661 *
4662 * @return Returns the same Intent object, for chaining multiple calls
4663 * into a single statement.
4664 *
Nick Pellyccae4122012-01-09 14:12:58 -08004665 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004666 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004667 * @see #normalizeMimeType
4668 */
4669 public Intent setTypeAndNormalize(String type) {
4670 return setType(normalizeMimeType(type));
4671 }
4672
4673 /**
4674 * (Usually optional) Set the data for the intent along with an explicit
4675 * MIME data type. This method should very rarely be used -- it allows you
4676 * to override the MIME type that would ordinarily be inferred from the
4677 * data with your own type given here.
4678 *
4679 * <p><em>Note: MIME type and Uri scheme matching in the
4680 * Android framework is case-sensitive, unlike the formal RFC definitions.
4681 * As a result, you should always write these elements with lower case letters,
4682 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalize} or
4683 * {@link #setDataAndTypeAndNormalize}
4684 * to ensure that they are converted to lower case.</em>
4685 *
4686 * @param data The Uri of the data this intent is now targeting.
4687 * @param type The MIME type of the data being handled by this intent.
4688 *
4689 * @return Returns the same Intent object, for chaining multiple calls
4690 * into a single statement.
4691 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004692 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004693 * @see #setData
4694 * @see #normalizeMimeType
4695 * @see android.net.Uri#normalize
4696 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004697 */
4698 public Intent setDataAndType(Uri data, String type) {
4699 mData = data;
4700 mType = type;
4701 return this;
4702 }
4703
4704 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004705 * (Usually optional) Normalize and set both the data Uri and an explicit
4706 * MIME data type. This method should very rarely be used -- it allows you
4707 * to override the MIME type that would ordinarily be inferred from the
4708 * data with your own type given here.
4709 *
4710 * <p>The data Uri and the MIME type are normalize using
4711 * {@link android.net.Uri#normalize} and {@link #normalizeMimeType}
4712 * before they are set, so really this is just a convenience method for
4713 * <pre>
4714 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4715 * </pre>
4716 *
4717 * @param data The Uri of the data this intent is now targeting.
4718 * @param type The MIME type of the data being handled by this intent.
4719 *
4720 * @return Returns the same Intent object, for chaining multiple calls
4721 * into a single statement.
4722 *
4723 * @see #setType
4724 * @see #setData
4725 * @see #setDataAndType
4726 * @see #normalizeMimeType
4727 * @see android.net.Uri#normalize
4728 */
4729 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
4730 return setDataAndType(data.normalize(), normalizeMimeType(type));
4731 }
4732
4733 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004734 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004735 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004736 * activities that provide <em>all</em> of the requested categories will be
4737 * used.
4738 *
4739 * @param category The desired category. This can be either one of the
4740 * predefined Intent categories, or a custom category in your own
4741 * namespace.
4742 *
4743 * @return Returns the same Intent object, for chaining multiple calls
4744 * into a single statement.
4745 *
4746 * @see #hasCategory
4747 * @see #removeCategory
4748 */
4749 public Intent addCategory(String category) {
4750 if (mCategories == null) {
4751 mCategories = new HashSet<String>();
4752 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004753 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004754 return this;
4755 }
4756
4757 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004758 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004759 *
4760 * @param category The category to remove.
4761 *
4762 * @see #addCategory
4763 */
4764 public void removeCategory(String category) {
4765 if (mCategories != null) {
4766 mCategories.remove(category);
4767 if (mCategories.size() == 0) {
4768 mCategories = null;
4769 }
4770 }
4771 }
4772
4773 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004774 * Set a selector for this Intent. This is a modification to the kinds of
4775 * things the Intent will match. If the selector is set, it will be used
4776 * when trying to find entities that can handle the Intent, instead of the
4777 * main contents of the Intent. This allows you build an Intent containing
4778 * a generic protocol while targeting it more specifically.
4779 *
4780 * <p>An example of where this may be used is with things like
4781 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
4782 * Intent that will launch the Browser application. However, the correct
4783 * main entry point of an application is actually {@link #ACTION_MAIN}
4784 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
4785 * used to specify the actual Activity to launch. If you launch the browser
4786 * with something different, undesired behavior may happen if the user has
4787 * previously or later launches it the normal way, since they do not match.
4788 * Instead, you can build an Intent with the MAIN action (but no ComponentName
4789 * yet specified) and set a selector with {@link #ACTION_MAIN} and
4790 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
4791 *
4792 * <p>Setting a selector does not impact the behavior of
4793 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
4794 * desired behavior of a selector -- it does not impact the base meaning
4795 * of the Intent, just what kinds of things will be matched against it
4796 * when determining who can handle it.</p>
4797 *
4798 * <p>You can not use both a selector and {@link #setPackage(String)} on
4799 * the same base Intent.</p>
4800 *
4801 * @param selector The desired selector Intent; set to null to not use
4802 * a special selector.
4803 */
4804 public void setSelector(Intent selector) {
4805 if (selector == this) {
4806 throw new IllegalArgumentException(
4807 "Intent being set as a selector of itself");
4808 }
4809 if (selector != null && mPackage != null) {
4810 throw new IllegalArgumentException(
4811 "Can't set selector when package name is already set");
4812 }
4813 mSelector = selector;
4814 }
4815
4816 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004817 * Set a {@link ClipData} associated with this Intent. This replaces any
4818 * previously set ClipData.
4819 *
4820 * <p>The ClipData in an intent is not used for Intent matching or other
4821 * such operations. Semantically it is like extras, used to transmit
4822 * additional data with the Intent. The main feature of using this over
4823 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
4824 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
4825 * items included in the clip data. This is useful, in particular, if
4826 * you want to transmit an Intent containing multiple <code>content:</code>
4827 * URIs for which the recipient may not have global permission to access the
4828 * content provider.
4829 *
4830 * <p>If the ClipData contains items that are themselves Intents, any
4831 * grant flags in those Intents will be ignored. Only the top-level flags
4832 * of the main Intent are respected, and will be applied to all Uri or
4833 * Intent items in the clip (or sub-items of the clip).
4834 *
4835 * <p>The MIME type, label, and icon in the ClipData object are not
4836 * directly used by Intent. Applications should generally rely on the
4837 * MIME type of the Intent itself, not what it may find in the ClipData.
4838 * A common practice is to construct a ClipData for use with an Intent
4839 * with a MIME type of "*\/*".
4840 *
4841 * @param clip The new clip to set. May be null to clear the current clip.
4842 */
4843 public void setClipData(ClipData clip) {
4844 mClipData = clip;
4845 }
4846
4847 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004848 * Add extended data to the intent. The name must include a package
4849 * prefix, for example the app com.android.contacts would use names
4850 * like "com.android.contacts.ShowAll".
4851 *
4852 * @param name The name of the extra data, with package prefix.
4853 * @param value The boolean data value.
4854 *
4855 * @return Returns the same Intent object, for chaining multiple calls
4856 * into a single statement.
4857 *
4858 * @see #putExtras
4859 * @see #removeExtra
4860 * @see #getBooleanExtra(String, boolean)
4861 */
4862 public Intent putExtra(String name, boolean value) {
4863 if (mExtras == null) {
4864 mExtras = new Bundle();
4865 }
4866 mExtras.putBoolean(name, value);
4867 return this;
4868 }
4869
4870 /**
4871 * Add extended data to the intent. The name must include a package
4872 * prefix, for example the app com.android.contacts would use names
4873 * like "com.android.contacts.ShowAll".
4874 *
4875 * @param name The name of the extra data, with package prefix.
4876 * @param value The byte data value.
4877 *
4878 * @return Returns the same Intent object, for chaining multiple calls
4879 * into a single statement.
4880 *
4881 * @see #putExtras
4882 * @see #removeExtra
4883 * @see #getByteExtra(String, byte)
4884 */
4885 public Intent putExtra(String name, byte value) {
4886 if (mExtras == null) {
4887 mExtras = new Bundle();
4888 }
4889 mExtras.putByte(name, value);
4890 return this;
4891 }
4892
4893 /**
4894 * Add extended data to the intent. The name must include a package
4895 * prefix, for example the app com.android.contacts would use names
4896 * like "com.android.contacts.ShowAll".
4897 *
4898 * @param name The name of the extra data, with package prefix.
4899 * @param value The char data value.
4900 *
4901 * @return Returns the same Intent object, for chaining multiple calls
4902 * into a single statement.
4903 *
4904 * @see #putExtras
4905 * @see #removeExtra
4906 * @see #getCharExtra(String, char)
4907 */
4908 public Intent putExtra(String name, char value) {
4909 if (mExtras == null) {
4910 mExtras = new Bundle();
4911 }
4912 mExtras.putChar(name, value);
4913 return this;
4914 }
4915
4916 /**
4917 * Add extended data to the intent. The name must include a package
4918 * prefix, for example the app com.android.contacts would use names
4919 * like "com.android.contacts.ShowAll".
4920 *
4921 * @param name The name of the extra data, with package prefix.
4922 * @param value The short data value.
4923 *
4924 * @return Returns the same Intent object, for chaining multiple calls
4925 * into a single statement.
4926 *
4927 * @see #putExtras
4928 * @see #removeExtra
4929 * @see #getShortExtra(String, short)
4930 */
4931 public Intent putExtra(String name, short value) {
4932 if (mExtras == null) {
4933 mExtras = new Bundle();
4934 }
4935 mExtras.putShort(name, value);
4936 return this;
4937 }
4938
4939 /**
4940 * Add extended data to the intent. The name must include a package
4941 * prefix, for example the app com.android.contacts would use names
4942 * like "com.android.contacts.ShowAll".
4943 *
4944 * @param name The name of the extra data, with package prefix.
4945 * @param value The integer data value.
4946 *
4947 * @return Returns the same Intent object, for chaining multiple calls
4948 * into a single statement.
4949 *
4950 * @see #putExtras
4951 * @see #removeExtra
4952 * @see #getIntExtra(String, int)
4953 */
4954 public Intent putExtra(String name, int value) {
4955 if (mExtras == null) {
4956 mExtras = new Bundle();
4957 }
4958 mExtras.putInt(name, value);
4959 return this;
4960 }
4961
4962 /**
4963 * Add extended data to the intent. The name must include a package
4964 * prefix, for example the app com.android.contacts would use names
4965 * like "com.android.contacts.ShowAll".
4966 *
4967 * @param name The name of the extra data, with package prefix.
4968 * @param value The long data value.
4969 *
4970 * @return Returns the same Intent object, for chaining multiple calls
4971 * into a single statement.
4972 *
4973 * @see #putExtras
4974 * @see #removeExtra
4975 * @see #getLongExtra(String, long)
4976 */
4977 public Intent putExtra(String name, long value) {
4978 if (mExtras == null) {
4979 mExtras = new Bundle();
4980 }
4981 mExtras.putLong(name, value);
4982 return this;
4983 }
4984
4985 /**
4986 * Add extended data to the intent. The name must include a package
4987 * prefix, for example the app com.android.contacts would use names
4988 * like "com.android.contacts.ShowAll".
4989 *
4990 * @param name The name of the extra data, with package prefix.
4991 * @param value The float data value.
4992 *
4993 * @return Returns the same Intent object, for chaining multiple calls
4994 * into a single statement.
4995 *
4996 * @see #putExtras
4997 * @see #removeExtra
4998 * @see #getFloatExtra(String, float)
4999 */
5000 public Intent putExtra(String name, float value) {
5001 if (mExtras == null) {
5002 mExtras = new Bundle();
5003 }
5004 mExtras.putFloat(name, value);
5005 return this;
5006 }
5007
5008 /**
5009 * Add extended data to the intent. The name must include a package
5010 * prefix, for example the app com.android.contacts would use names
5011 * like "com.android.contacts.ShowAll".
5012 *
5013 * @param name The name of the extra data, with package prefix.
5014 * @param value The double data value.
5015 *
5016 * @return Returns the same Intent object, for chaining multiple calls
5017 * into a single statement.
5018 *
5019 * @see #putExtras
5020 * @see #removeExtra
5021 * @see #getDoubleExtra(String, double)
5022 */
5023 public Intent putExtra(String name, double value) {
5024 if (mExtras == null) {
5025 mExtras = new Bundle();
5026 }
5027 mExtras.putDouble(name, value);
5028 return this;
5029 }
5030
5031 /**
5032 * Add extended data to the intent. The name must include a package
5033 * prefix, for example the app com.android.contacts would use names
5034 * like "com.android.contacts.ShowAll".
5035 *
5036 * @param name The name of the extra data, with package prefix.
5037 * @param value The String data value.
5038 *
5039 * @return Returns the same Intent object, for chaining multiple calls
5040 * into a single statement.
5041 *
5042 * @see #putExtras
5043 * @see #removeExtra
5044 * @see #getStringExtra(String)
5045 */
5046 public Intent putExtra(String name, String value) {
5047 if (mExtras == null) {
5048 mExtras = new Bundle();
5049 }
5050 mExtras.putString(name, value);
5051 return this;
5052 }
5053
5054 /**
5055 * Add extended data to the intent. The name must include a package
5056 * prefix, for example the app com.android.contacts would use names
5057 * like "com.android.contacts.ShowAll".
5058 *
5059 * @param name The name of the extra data, with package prefix.
5060 * @param value The CharSequence data value.
5061 *
5062 * @return Returns the same Intent object, for chaining multiple calls
5063 * into a single statement.
5064 *
5065 * @see #putExtras
5066 * @see #removeExtra
5067 * @see #getCharSequenceExtra(String)
5068 */
5069 public Intent putExtra(String name, CharSequence value) {
5070 if (mExtras == null) {
5071 mExtras = new Bundle();
5072 }
5073 mExtras.putCharSequence(name, value);
5074 return this;
5075 }
5076
5077 /**
5078 * Add extended data to the intent. The name must include a package
5079 * prefix, for example the app com.android.contacts would use names
5080 * like "com.android.contacts.ShowAll".
5081 *
5082 * @param name The name of the extra data, with package prefix.
5083 * @param value The Parcelable data value.
5084 *
5085 * @return Returns the same Intent object, for chaining multiple calls
5086 * into a single statement.
5087 *
5088 * @see #putExtras
5089 * @see #removeExtra
5090 * @see #getParcelableExtra(String)
5091 */
5092 public Intent putExtra(String name, Parcelable value) {
5093 if (mExtras == null) {
5094 mExtras = new Bundle();
5095 }
5096 mExtras.putParcelable(name, value);
5097 return this;
5098 }
5099
5100 /**
5101 * Add extended data to the intent. The name must include a package
5102 * prefix, for example the app com.android.contacts would use names
5103 * like "com.android.contacts.ShowAll".
5104 *
5105 * @param name The name of the extra data, with package prefix.
5106 * @param value The Parcelable[] data value.
5107 *
5108 * @return Returns the same Intent object, for chaining multiple calls
5109 * into a single statement.
5110 *
5111 * @see #putExtras
5112 * @see #removeExtra
5113 * @see #getParcelableArrayExtra(String)
5114 */
5115 public Intent putExtra(String name, Parcelable[] value) {
5116 if (mExtras == null) {
5117 mExtras = new Bundle();
5118 }
5119 mExtras.putParcelableArray(name, value);
5120 return this;
5121 }
5122
5123 /**
5124 * Add extended data to the intent. The name must include a package
5125 * prefix, for example the app com.android.contacts would use names
5126 * like "com.android.contacts.ShowAll".
5127 *
5128 * @param name The name of the extra data, with package prefix.
5129 * @param value The ArrayList<Parcelable> data value.
5130 *
5131 * @return Returns the same Intent object, for chaining multiple calls
5132 * into a single statement.
5133 *
5134 * @see #putExtras
5135 * @see #removeExtra
5136 * @see #getParcelableArrayListExtra(String)
5137 */
5138 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5139 if (mExtras == null) {
5140 mExtras = new Bundle();
5141 }
5142 mExtras.putParcelableArrayList(name, value);
5143 return this;
5144 }
5145
5146 /**
5147 * Add extended data to the intent. The name must include a package
5148 * prefix, for example the app com.android.contacts would use names
5149 * like "com.android.contacts.ShowAll".
5150 *
5151 * @param name The name of the extra data, with package prefix.
5152 * @param value The ArrayList<Integer> data value.
5153 *
5154 * @return Returns the same Intent object, for chaining multiple calls
5155 * into a single statement.
5156 *
5157 * @see #putExtras
5158 * @see #removeExtra
5159 * @see #getIntegerArrayListExtra(String)
5160 */
5161 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5162 if (mExtras == null) {
5163 mExtras = new Bundle();
5164 }
5165 mExtras.putIntegerArrayList(name, value);
5166 return this;
5167 }
5168
5169 /**
5170 * Add extended data to the intent. The name must include a package
5171 * prefix, for example the app com.android.contacts would use names
5172 * like "com.android.contacts.ShowAll".
5173 *
5174 * @param name The name of the extra data, with package prefix.
5175 * @param value The ArrayList<String> data value.
5176 *
5177 * @return Returns the same Intent object, for chaining multiple calls
5178 * into a single statement.
5179 *
5180 * @see #putExtras
5181 * @see #removeExtra
5182 * @see #getStringArrayListExtra(String)
5183 */
5184 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5185 if (mExtras == null) {
5186 mExtras = new Bundle();
5187 }
5188 mExtras.putStringArrayList(name, value);
5189 return this;
5190 }
5191
5192 /**
5193 * Add extended data to the intent. The name must include a package
5194 * prefix, for example the app com.android.contacts would use names
5195 * like "com.android.contacts.ShowAll".
5196 *
5197 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005198 * @param value The ArrayList<CharSequence> data value.
5199 *
5200 * @return Returns the same Intent object, for chaining multiple calls
5201 * into a single statement.
5202 *
5203 * @see #putExtras
5204 * @see #removeExtra
5205 * @see #getCharSequenceArrayListExtra(String)
5206 */
5207 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5208 if (mExtras == null) {
5209 mExtras = new Bundle();
5210 }
5211 mExtras.putCharSequenceArrayList(name, value);
5212 return this;
5213 }
5214
5215 /**
5216 * Add extended data to the intent. The name must include a package
5217 * prefix, for example the app com.android.contacts would use names
5218 * like "com.android.contacts.ShowAll".
5219 *
5220 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005221 * @param value The Serializable data value.
5222 *
5223 * @return Returns the same Intent object, for chaining multiple calls
5224 * into a single statement.
5225 *
5226 * @see #putExtras
5227 * @see #removeExtra
5228 * @see #getSerializableExtra(String)
5229 */
5230 public Intent putExtra(String name, Serializable value) {
5231 if (mExtras == null) {
5232 mExtras = new Bundle();
5233 }
5234 mExtras.putSerializable(name, value);
5235 return this;
5236 }
5237
5238 /**
5239 * Add extended data to the intent. The name must include a package
5240 * prefix, for example the app com.android.contacts would use names
5241 * like "com.android.contacts.ShowAll".
5242 *
5243 * @param name The name of the extra data, with package prefix.
5244 * @param value The boolean array data value.
5245 *
5246 * @return Returns the same Intent object, for chaining multiple calls
5247 * into a single statement.
5248 *
5249 * @see #putExtras
5250 * @see #removeExtra
5251 * @see #getBooleanArrayExtra(String)
5252 */
5253 public Intent putExtra(String name, boolean[] value) {
5254 if (mExtras == null) {
5255 mExtras = new Bundle();
5256 }
5257 mExtras.putBooleanArray(name, value);
5258 return this;
5259 }
5260
5261 /**
5262 * Add extended data to the intent. The name must include a package
5263 * prefix, for example the app com.android.contacts would use names
5264 * like "com.android.contacts.ShowAll".
5265 *
5266 * @param name The name of the extra data, with package prefix.
5267 * @param value The byte array data value.
5268 *
5269 * @return Returns the same Intent object, for chaining multiple calls
5270 * into a single statement.
5271 *
5272 * @see #putExtras
5273 * @see #removeExtra
5274 * @see #getByteArrayExtra(String)
5275 */
5276 public Intent putExtra(String name, byte[] value) {
5277 if (mExtras == null) {
5278 mExtras = new Bundle();
5279 }
5280 mExtras.putByteArray(name, value);
5281 return this;
5282 }
5283
5284 /**
5285 * Add extended data to the intent. The name must include a package
5286 * prefix, for example the app com.android.contacts would use names
5287 * like "com.android.contacts.ShowAll".
5288 *
5289 * @param name The name of the extra data, with package prefix.
5290 * @param value The short array data value.
5291 *
5292 * @return Returns the same Intent object, for chaining multiple calls
5293 * into a single statement.
5294 *
5295 * @see #putExtras
5296 * @see #removeExtra
5297 * @see #getShortArrayExtra(String)
5298 */
5299 public Intent putExtra(String name, short[] value) {
5300 if (mExtras == null) {
5301 mExtras = new Bundle();
5302 }
5303 mExtras.putShortArray(name, value);
5304 return this;
5305 }
5306
5307 /**
5308 * Add extended data to the intent. The name must include a package
5309 * prefix, for example the app com.android.contacts would use names
5310 * like "com.android.contacts.ShowAll".
5311 *
5312 * @param name The name of the extra data, with package prefix.
5313 * @param value The char array data value.
5314 *
5315 * @return Returns the same Intent object, for chaining multiple calls
5316 * into a single statement.
5317 *
5318 * @see #putExtras
5319 * @see #removeExtra
5320 * @see #getCharArrayExtra(String)
5321 */
5322 public Intent putExtra(String name, char[] value) {
5323 if (mExtras == null) {
5324 mExtras = new Bundle();
5325 }
5326 mExtras.putCharArray(name, value);
5327 return this;
5328 }
5329
5330 /**
5331 * Add extended data to the intent. The name must include a package
5332 * prefix, for example the app com.android.contacts would use names
5333 * like "com.android.contacts.ShowAll".
5334 *
5335 * @param name The name of the extra data, with package prefix.
5336 * @param value The int array data value.
5337 *
5338 * @return Returns the same Intent object, for chaining multiple calls
5339 * into a single statement.
5340 *
5341 * @see #putExtras
5342 * @see #removeExtra
5343 * @see #getIntArrayExtra(String)
5344 */
5345 public Intent putExtra(String name, int[] value) {
5346 if (mExtras == null) {
5347 mExtras = new Bundle();
5348 }
5349 mExtras.putIntArray(name, value);
5350 return this;
5351 }
5352
5353 /**
5354 * Add extended data to the intent. The name must include a package
5355 * prefix, for example the app com.android.contacts would use names
5356 * like "com.android.contacts.ShowAll".
5357 *
5358 * @param name The name of the extra data, with package prefix.
5359 * @param value The byte array data value.
5360 *
5361 * @return Returns the same Intent object, for chaining multiple calls
5362 * into a single statement.
5363 *
5364 * @see #putExtras
5365 * @see #removeExtra
5366 * @see #getLongArrayExtra(String)
5367 */
5368 public Intent putExtra(String name, long[] value) {
5369 if (mExtras == null) {
5370 mExtras = new Bundle();
5371 }
5372 mExtras.putLongArray(name, value);
5373 return this;
5374 }
5375
5376 /**
5377 * Add extended data to the intent. The name must include a package
5378 * prefix, for example the app com.android.contacts would use names
5379 * like "com.android.contacts.ShowAll".
5380 *
5381 * @param name The name of the extra data, with package prefix.
5382 * @param value The float array data value.
5383 *
5384 * @return Returns the same Intent object, for chaining multiple calls
5385 * into a single statement.
5386 *
5387 * @see #putExtras
5388 * @see #removeExtra
5389 * @see #getFloatArrayExtra(String)
5390 */
5391 public Intent putExtra(String name, float[] value) {
5392 if (mExtras == null) {
5393 mExtras = new Bundle();
5394 }
5395 mExtras.putFloatArray(name, value);
5396 return this;
5397 }
5398
5399 /**
5400 * Add extended data to the intent. The name must include a package
5401 * prefix, for example the app com.android.contacts would use names
5402 * like "com.android.contacts.ShowAll".
5403 *
5404 * @param name The name of the extra data, with package prefix.
5405 * @param value The double array data value.
5406 *
5407 * @return Returns the same Intent object, for chaining multiple calls
5408 * into a single statement.
5409 *
5410 * @see #putExtras
5411 * @see #removeExtra
5412 * @see #getDoubleArrayExtra(String)
5413 */
5414 public Intent putExtra(String name, double[] value) {
5415 if (mExtras == null) {
5416 mExtras = new Bundle();
5417 }
5418 mExtras.putDoubleArray(name, value);
5419 return this;
5420 }
5421
5422 /**
5423 * Add extended data to the intent. The name must include a package
5424 * prefix, for example the app com.android.contacts would use names
5425 * like "com.android.contacts.ShowAll".
5426 *
5427 * @param name The name of the extra data, with package prefix.
5428 * @param value The String array data value.
5429 *
5430 * @return Returns the same Intent object, for chaining multiple calls
5431 * into a single statement.
5432 *
5433 * @see #putExtras
5434 * @see #removeExtra
5435 * @see #getStringArrayExtra(String)
5436 */
5437 public Intent putExtra(String name, String[] value) {
5438 if (mExtras == null) {
5439 mExtras = new Bundle();
5440 }
5441 mExtras.putStringArray(name, value);
5442 return this;
5443 }
5444
5445 /**
5446 * Add extended data to the intent. The name must include a package
5447 * prefix, for example the app com.android.contacts would use names
5448 * like "com.android.contacts.ShowAll".
5449 *
5450 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005451 * @param value The CharSequence array data value.
5452 *
5453 * @return Returns the same Intent object, for chaining multiple calls
5454 * into a single statement.
5455 *
5456 * @see #putExtras
5457 * @see #removeExtra
5458 * @see #getCharSequenceArrayExtra(String)
5459 */
5460 public Intent putExtra(String name, CharSequence[] value) {
5461 if (mExtras == null) {
5462 mExtras = new Bundle();
5463 }
5464 mExtras.putCharSequenceArray(name, value);
5465 return this;
5466 }
5467
5468 /**
5469 * Add extended data to the intent. The name must include a package
5470 * prefix, for example the app com.android.contacts would use names
5471 * like "com.android.contacts.ShowAll".
5472 *
5473 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005474 * @param value The Bundle data value.
5475 *
5476 * @return Returns the same Intent object, for chaining multiple calls
5477 * into a single statement.
5478 *
5479 * @see #putExtras
5480 * @see #removeExtra
5481 * @see #getBundleExtra(String)
5482 */
5483 public Intent putExtra(String name, Bundle value) {
5484 if (mExtras == null) {
5485 mExtras = new Bundle();
5486 }
5487 mExtras.putBundle(name, value);
5488 return this;
5489 }
5490
5491 /**
5492 * Add extended data to the intent. The name must include a package
5493 * prefix, for example the app com.android.contacts would use names
5494 * like "com.android.contacts.ShowAll".
5495 *
5496 * @param name The name of the extra data, with package prefix.
5497 * @param value The IBinder data value.
5498 *
5499 * @return Returns the same Intent object, for chaining multiple calls
5500 * into a single statement.
5501 *
5502 * @see #putExtras
5503 * @see #removeExtra
5504 * @see #getIBinderExtra(String)
5505 *
5506 * @deprecated
5507 * @hide
5508 */
5509 @Deprecated
5510 public Intent putExtra(String name, IBinder value) {
5511 if (mExtras == null) {
5512 mExtras = new Bundle();
5513 }
5514 mExtras.putIBinder(name, value);
5515 return this;
5516 }
5517
5518 /**
5519 * Copy all extras in 'src' in to this intent.
5520 *
5521 * @param src Contains the extras to copy.
5522 *
5523 * @see #putExtra
5524 */
5525 public Intent putExtras(Intent src) {
5526 if (src.mExtras != null) {
5527 if (mExtras == null) {
5528 mExtras = new Bundle(src.mExtras);
5529 } else {
5530 mExtras.putAll(src.mExtras);
5531 }
5532 }
5533 return this;
5534 }
5535
5536 /**
5537 * Add a set of extended data to the intent. The keys must include a package
5538 * prefix, for example the app com.android.contacts would use names
5539 * like "com.android.contacts.ShowAll".
5540 *
5541 * @param extras The Bundle of extras to add to this intent.
5542 *
5543 * @see #putExtra
5544 * @see #removeExtra
5545 */
5546 public Intent putExtras(Bundle extras) {
5547 if (mExtras == null) {
5548 mExtras = new Bundle();
5549 }
5550 mExtras.putAll(extras);
5551 return this;
5552 }
5553
5554 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005555 * Completely replace the extras in the Intent with the extras in the
5556 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005557 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005558 * @param src The exact extras contained in this Intent are copied
5559 * into the target intent, replacing any that were previously there.
5560 */
5561 public Intent replaceExtras(Intent src) {
5562 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5563 return this;
5564 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005565
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005566 /**
5567 * Completely replace the extras in the Intent with the given Bundle of
5568 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005569 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005570 * @param extras The new set of extras in the Intent, or null to erase
5571 * all extras.
5572 */
5573 public Intent replaceExtras(Bundle extras) {
5574 mExtras = extras != null ? new Bundle(extras) : null;
5575 return this;
5576 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005577
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005578 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005579 * Remove extended data from the intent.
5580 *
5581 * @see #putExtra
5582 */
5583 public void removeExtra(String name) {
5584 if (mExtras != null) {
5585 mExtras.remove(name);
5586 if (mExtras.size() == 0) {
5587 mExtras = null;
5588 }
5589 }
5590 }
5591
5592 /**
5593 * Set special flags controlling how this intent is handled. Most values
5594 * here depend on the type of component being executed by the Intent,
5595 * specifically the FLAG_ACTIVITY_* flags are all for use with
5596 * {@link Context#startActivity Context.startActivity()} and the
5597 * FLAG_RECEIVER_* flags are all for use with
5598 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5599 *
Scott Main7aee61f2011-02-08 11:25:01 -08005600 * <p>See the
5601 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5602 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005603 * the behavior of your application.
5604 *
5605 * @param flags The desired flags.
5606 *
5607 * @return Returns the same Intent object, for chaining multiple calls
5608 * into a single statement.
5609 *
5610 * @see #getFlags
5611 * @see #addFlags
5612 *
5613 * @see #FLAG_GRANT_READ_URI_PERMISSION
5614 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5615 * @see #FLAG_DEBUG_LOG_RESOLUTION
5616 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005617 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005618 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005619 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005620 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005621 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5622 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005623 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005624 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5625 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005626 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005627 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005628 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005629 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5630 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005631 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005632 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005633 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005634 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5635 */
5636 public Intent setFlags(int flags) {
5637 mFlags = flags;
5638 return this;
5639 }
5640
5641 /**
5642 * Add additional flags to the intent (or with existing flags
5643 * value).
5644 *
5645 * @param flags The new flags to set.
5646 *
5647 * @return Returns the same Intent object, for chaining multiple calls
5648 * into a single statement.
5649 *
5650 * @see #setFlags
5651 */
5652 public Intent addFlags(int flags) {
5653 mFlags |= flags;
5654 return this;
5655 }
5656
5657 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005658 * (Usually optional) Set an explicit application package name that limits
5659 * the components this Intent will resolve to. If left to the default
5660 * value of null, all components in all applications will considered.
5661 * If non-null, the Intent can only match the components in the given
5662 * application package.
5663 *
5664 * @param packageName The name of the application package to handle the
5665 * intent, or null to allow any application package.
5666 *
5667 * @return Returns the same Intent object, for chaining multiple calls
5668 * into a single statement.
5669 *
5670 * @see #getPackage
5671 * @see #resolveActivity
5672 */
5673 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005674 if (packageName != null && mSelector != null) {
5675 throw new IllegalArgumentException(
5676 "Can't set package name when selector is already set");
5677 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005678 mPackage = packageName;
5679 return this;
5680 }
5681
5682 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005683 * (Usually optional) Explicitly set the component to handle the intent.
5684 * If left with the default value of null, the system will determine the
5685 * appropriate class to use based on the other fields (action, data,
5686 * type, categories) in the Intent. If this class is defined, the
5687 * specified class will always be used regardless of the other fields. You
5688 * should only set this value when you know you absolutely want a specific
5689 * class to be used; otherwise it is better to let the system find the
5690 * appropriate class so that you will respect the installed applications
5691 * and user preferences.
5692 *
5693 * @param component The name of the application component to handle the
5694 * intent, or null to let the system find one for you.
5695 *
5696 * @return Returns the same Intent object, for chaining multiple calls
5697 * into a single statement.
5698 *
5699 * @see #setClass
5700 * @see #setClassName(Context, String)
5701 * @see #setClassName(String, String)
5702 * @see #getComponent
5703 * @see #resolveActivity
5704 */
5705 public Intent setComponent(ComponentName component) {
5706 mComponent = component;
5707 return this;
5708 }
5709
5710 /**
5711 * Convenience for calling {@link #setComponent} with an
5712 * explicit class name.
5713 *
5714 * @param packageContext A Context of the application package implementing
5715 * this class.
5716 * @param className The name of a class inside of the application package
5717 * that will be used as the component for this Intent.
5718 *
5719 * @return Returns the same Intent object, for chaining multiple calls
5720 * into a single statement.
5721 *
5722 * @see #setComponent
5723 * @see #setClass
5724 */
5725 public Intent setClassName(Context packageContext, String className) {
5726 mComponent = new ComponentName(packageContext, className);
5727 return this;
5728 }
5729
5730 /**
5731 * Convenience for calling {@link #setComponent} with an
5732 * explicit application package name and class name.
5733 *
5734 * @param packageName The name of the package implementing the desired
5735 * component.
5736 * @param className The name of a class inside of the application package
5737 * that will be used as the component for this Intent.
5738 *
5739 * @return Returns the same Intent object, for chaining multiple calls
5740 * into a single statement.
5741 *
5742 * @see #setComponent
5743 * @see #setClass
5744 */
5745 public Intent setClassName(String packageName, String className) {
5746 mComponent = new ComponentName(packageName, className);
5747 return this;
5748 }
5749
5750 /**
5751 * Convenience for calling {@link #setComponent(ComponentName)} with the
5752 * name returned by a {@link Class} object.
5753 *
5754 * @param packageContext A Context of the application package implementing
5755 * this class.
5756 * @param cls The class name to set, equivalent to
5757 * <code>setClassName(context, cls.getName())</code>.
5758 *
5759 * @return Returns the same Intent object, for chaining multiple calls
5760 * into a single statement.
5761 *
5762 * @see #setComponent
5763 */
5764 public Intent setClass(Context packageContext, Class<?> cls) {
5765 mComponent = new ComponentName(packageContext, cls);
5766 return this;
5767 }
5768
5769 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005770 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5771 * used as a hint to the receiver for animations and the like. Null means that there
5772 * is no source bounds.
5773 */
5774 public void setSourceBounds(Rect r) {
5775 if (r != null) {
5776 mSourceBounds = new Rect(r);
5777 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005778 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005779 }
5780 }
5781
5782 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005783 * Use with {@link #fillIn} to allow the current action value to be
5784 * overwritten, even if it is already set.
5785 */
5786 public static final int FILL_IN_ACTION = 1<<0;
5787
5788 /**
5789 * Use with {@link #fillIn} to allow the current data or type value
5790 * overwritten, even if it is already set.
5791 */
5792 public static final int FILL_IN_DATA = 1<<1;
5793
5794 /**
5795 * Use with {@link #fillIn} to allow the current categories to be
5796 * overwritten, even if they are already set.
5797 */
5798 public static final int FILL_IN_CATEGORIES = 1<<2;
5799
5800 /**
5801 * Use with {@link #fillIn} to allow the current component value to be
5802 * overwritten, even if it is already set.
5803 */
5804 public static final int FILL_IN_COMPONENT = 1<<3;
5805
5806 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005807 * Use with {@link #fillIn} to allow the current package value to be
5808 * overwritten, even if it is already set.
5809 */
5810 public static final int FILL_IN_PACKAGE = 1<<4;
5811
5812 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005813 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005814 * overwritten, even if it is already set.
5815 */
5816 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5817
5818 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005819 * Use with {@link #fillIn} to allow the current selector to be
5820 * overwritten, even if it is already set.
5821 */
5822 public static final int FILL_IN_SELECTOR = 1<<6;
5823
5824 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005825 * Use with {@link #fillIn} to allow the current ClipData to be
5826 * overwritten, even if it is already set.
5827 */
5828 public static final int FILL_IN_CLIP_DATA = 1<<7;
5829
5830 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005831 * Copy the contents of <var>other</var> in to this object, but only
5832 * where fields are not defined by this object. For purposes of a field
5833 * being defined, the following pieces of data in the Intent are
5834 * considered to be separate fields:
5835 *
5836 * <ul>
5837 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08005838 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005839 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5840 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005841 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005842 * <li> component, as set by {@link #setComponent(ComponentName)} or
5843 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005844 * <li> source bounds, as set by {@link #setSourceBounds}.
5845 * <li> selector, as set by {@link #setSelector(Intent)}.
5846 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005847 * <li> each top-level name in the associated extras.
5848 * </ul>
5849 *
5850 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005851 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005852 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
5853 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
5854 * the restriction where the corresponding field will not be replaced if
5855 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005856 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005857 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
5858 * is explicitly specified. The selector will only be copied if
5859 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07005860 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005861 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5862 * and Intent B with {action="gotit", data-type="some/thing",
5863 * categories="one","two"}.
5864 *
5865 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5866 * containing: {action="gotit", data-type="some/thing",
5867 * categories="bar"}.
5868 *
5869 * @param other Another Intent whose values are to be used to fill in
5870 * the current one.
5871 * @param flags Options to control which fields can be filled in.
5872 *
5873 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005874 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005875 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
5876 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005877 */
5878 public int fillIn(Intent other, int flags) {
5879 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005880 if (other.mAction != null
5881 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005882 mAction = other.mAction;
5883 changes |= FILL_IN_ACTION;
5884 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005885 if ((other.mData != null || other.mType != null)
5886 && ((mData == null && mType == null)
5887 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005888 mData = other.mData;
5889 mType = other.mType;
5890 changes |= FILL_IN_DATA;
5891 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005892 if (other.mCategories != null
5893 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005894 if (other.mCategories != null) {
5895 mCategories = new HashSet<String>(other.mCategories);
5896 }
5897 changes |= FILL_IN_CATEGORIES;
5898 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005899 if (other.mPackage != null
5900 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005901 // Only do this if mSelector is not set.
5902 if (mSelector == null) {
5903 mPackage = other.mPackage;
5904 changes |= FILL_IN_PACKAGE;
5905 }
5906 }
5907 // Selector is special: it can only be set if explicitly allowed,
5908 // for the same reason as the component name.
5909 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
5910 if (mPackage == null) {
5911 mSelector = new Intent(other.mSelector);
5912 mPackage = null;
5913 changes |= FILL_IN_SELECTOR;
5914 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005915 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005916 if (other.mClipData != null
5917 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
5918 mClipData = other.mClipData;
5919 changes |= FILL_IN_CLIP_DATA;
5920 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005921 // Component is special: it can -only- be set if explicitly allowed,
5922 // since otherwise the sender could force the intent somewhere the
5923 // originator didn't intend.
5924 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005925 mComponent = other.mComponent;
5926 changes |= FILL_IN_COMPONENT;
5927 }
5928 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005929 if (other.mSourceBounds != null
5930 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5931 mSourceBounds = new Rect(other.mSourceBounds);
5932 changes |= FILL_IN_SOURCE_BOUNDS;
5933 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005934 if (mExtras == null) {
5935 if (other.mExtras != null) {
5936 mExtras = new Bundle(other.mExtras);
5937 }
5938 } else if (other.mExtras != null) {
5939 try {
5940 Bundle newb = new Bundle(other.mExtras);
5941 newb.putAll(mExtras);
5942 mExtras = newb;
5943 } catch (RuntimeException e) {
5944 // Modifying the extras can cause us to unparcel the contents
5945 // of the bundle, and if we do this in the system process that
5946 // may fail. We really should handle this (i.e., the Bundle
5947 // impl shouldn't be on top of a plain map), but for now just
5948 // ignore it and keep the original contents. :(
5949 Log.w("Intent", "Failure filling in extras", e);
5950 }
5951 }
5952 return changes;
5953 }
5954
5955 /**
5956 * Wrapper class holding an Intent and implementing comparisons on it for
5957 * the purpose of filtering. The class implements its
5958 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5959 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5960 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5961 * on the wrapped Intent.
5962 */
5963 public static final class FilterComparison {
5964 private final Intent mIntent;
5965 private final int mHashCode;
5966
5967 public FilterComparison(Intent intent) {
5968 mIntent = intent;
5969 mHashCode = intent.filterHashCode();
5970 }
5971
5972 /**
5973 * Return the Intent that this FilterComparison represents.
5974 * @return Returns the Intent held by the FilterComparison. Do
5975 * not modify!
5976 */
5977 public Intent getIntent() {
5978 return mIntent;
5979 }
5980
5981 @Override
5982 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005983 if (obj instanceof FilterComparison) {
5984 Intent other = ((FilterComparison)obj).mIntent;
5985 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005986 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005987 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005988 }
5989
5990 @Override
5991 public int hashCode() {
5992 return mHashCode;
5993 }
5994 }
5995
5996 /**
5997 * Determine if two intents are the same for the purposes of intent
5998 * resolution (filtering). That is, if their action, data, type,
5999 * class, and categories are the same. This does <em>not</em> compare
6000 * any extra data included in the intents.
6001 *
6002 * @param other The other Intent to compare against.
6003 *
6004 * @return Returns true if action, data, type, class, and categories
6005 * are the same.
6006 */
6007 public boolean filterEquals(Intent other) {
6008 if (other == null) {
6009 return false;
6010 }
6011 if (mAction != other.mAction) {
6012 if (mAction != null) {
6013 if (!mAction.equals(other.mAction)) {
6014 return false;
6015 }
6016 } else {
6017 if (!other.mAction.equals(mAction)) {
6018 return false;
6019 }
6020 }
6021 }
6022 if (mData != other.mData) {
6023 if (mData != null) {
6024 if (!mData.equals(other.mData)) {
6025 return false;
6026 }
6027 } else {
6028 if (!other.mData.equals(mData)) {
6029 return false;
6030 }
6031 }
6032 }
6033 if (mType != other.mType) {
6034 if (mType != null) {
6035 if (!mType.equals(other.mType)) {
6036 return false;
6037 }
6038 } else {
6039 if (!other.mType.equals(mType)) {
6040 return false;
6041 }
6042 }
6043 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006044 if (mPackage != other.mPackage) {
6045 if (mPackage != null) {
6046 if (!mPackage.equals(other.mPackage)) {
6047 return false;
6048 }
6049 } else {
6050 if (!other.mPackage.equals(mPackage)) {
6051 return false;
6052 }
6053 }
6054 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006055 if (mComponent != other.mComponent) {
6056 if (mComponent != null) {
6057 if (!mComponent.equals(other.mComponent)) {
6058 return false;
6059 }
6060 } else {
6061 if (!other.mComponent.equals(mComponent)) {
6062 return false;
6063 }
6064 }
6065 }
6066 if (mCategories != other.mCategories) {
6067 if (mCategories != null) {
6068 if (!mCategories.equals(other.mCategories)) {
6069 return false;
6070 }
6071 } else {
6072 if (!other.mCategories.equals(mCategories)) {
6073 return false;
6074 }
6075 }
6076 }
6077
6078 return true;
6079 }
6080
6081 /**
6082 * Generate hash code that matches semantics of filterEquals().
6083 *
6084 * @return Returns the hash value of the action, data, type, class, and
6085 * categories.
6086 *
6087 * @see #filterEquals
6088 */
6089 public int filterHashCode() {
6090 int code = 0;
6091 if (mAction != null) {
6092 code += mAction.hashCode();
6093 }
6094 if (mData != null) {
6095 code += mData.hashCode();
6096 }
6097 if (mType != null) {
6098 code += mType.hashCode();
6099 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006100 if (mPackage != null) {
6101 code += mPackage.hashCode();
6102 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006103 if (mComponent != null) {
6104 code += mComponent.hashCode();
6105 }
6106 if (mCategories != null) {
6107 code += mCategories.hashCode();
6108 }
6109 return code;
6110 }
6111
6112 @Override
6113 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006114 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006115
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006116 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006117 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006118 b.append(" }");
6119
6120 return b.toString();
6121 }
6122
6123 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006124 public String toInsecureString() {
6125 StringBuilder b = new StringBuilder(128);
6126
6127 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006128 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006129 b.append(" }");
6130
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006131 return b.toString();
6132 }
Romain Guy4969af72009-06-17 10:53:19 -07006133
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006134 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006135 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006136 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006137
6138 b.append("Intent { ");
6139 toShortString(b, false, true, true, true);
6140 b.append(" }");
6141
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006142 return b.toString();
6143 }
6144
6145 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006146 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6147 StringBuilder b = new StringBuilder(128);
6148 toShortString(b, secure, comp, extras, clip);
6149 return b.toString();
6150 }
6151
6152 /** @hide */
6153 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6154 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006155 boolean first = true;
6156 if (mAction != null) {
6157 b.append("act=").append(mAction);
6158 first = false;
6159 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006160 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006161 if (!first) {
6162 b.append(' ');
6163 }
6164 first = false;
6165 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006166 Iterator<String> i = mCategories.iterator();
6167 boolean didone = false;
6168 while (i.hasNext()) {
6169 if (didone) b.append(",");
6170 didone = true;
6171 b.append(i.next());
6172 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006173 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006174 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006175 if (mData != null) {
6176 if (!first) {
6177 b.append(' ');
6178 }
6179 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006180 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006181 if (secure) {
6182 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006183 } else {
6184 b.append(mData);
6185 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006186 }
6187 if (mType != null) {
6188 if (!first) {
6189 b.append(' ');
6190 }
6191 first = false;
6192 b.append("typ=").append(mType);
6193 }
6194 if (mFlags != 0) {
6195 if (!first) {
6196 b.append(' ');
6197 }
6198 first = false;
6199 b.append("flg=0x").append(Integer.toHexString(mFlags));
6200 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006201 if (mPackage != null) {
6202 if (!first) {
6203 b.append(' ');
6204 }
6205 first = false;
6206 b.append("pkg=").append(mPackage);
6207 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006208 if (comp && mComponent != null) {
6209 if (!first) {
6210 b.append(' ');
6211 }
6212 first = false;
6213 b.append("cmp=").append(mComponent.flattenToShortString());
6214 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006215 if (mSourceBounds != null) {
6216 if (!first) {
6217 b.append(' ');
6218 }
6219 first = false;
6220 b.append("bnds=").append(mSourceBounds.toShortString());
6221 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006222 if (mClipData != null) {
6223 if (!first) {
6224 b.append(' ');
6225 }
6226 first = false;
6227 if (clip) {
6228 b.append("clip={");
6229 mClipData.toShortString(b);
6230 b.append('}');
6231 } else {
6232 b.append("(has clip)");
6233 }
6234 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006235 if (extras && mExtras != null) {
6236 if (!first) {
6237 b.append(' ');
6238 }
6239 first = false;
6240 b.append("(has extras)");
6241 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006242 if (mSelector != null) {
6243 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006244 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006245 b.append("}");
6246 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006247 }
6248
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006249 /**
6250 * Call {@link #toUri} with 0 flags.
6251 * @deprecated Use {@link #toUri} instead.
6252 */
6253 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006254 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006255 return toUri(0);
6256 }
6257
6258 /**
6259 * Convert this Intent into a String holding a URI representation of it.
6260 * The returned URI string has been properly URI encoded, so it can be
6261 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6262 * Intent's data as the base URI, with an additional fragment describing
6263 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006264 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006265 * <p>You can convert the returned string back to an Intent with
6266 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006267 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006268 * @param flags Additional operating flags. Either 0 or
6269 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006270 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006271 * @return Returns a URI encoding URI string describing the entire contents
6272 * of the Intent.
6273 */
6274 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006275 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006276 String scheme = null;
6277 if (mData != null) {
6278 String data = mData.toString();
6279 if ((flags&URI_INTENT_SCHEME) != 0) {
6280 final int N = data.length();
6281 for (int i=0; i<N; i++) {
6282 char c = data.charAt(i);
6283 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6284 || c == '.' || c == '-') {
6285 continue;
6286 }
6287 if (c == ':' && i > 0) {
6288 // Valid scheme.
6289 scheme = data.substring(0, i);
6290 uri.append("intent:");
6291 data = data.substring(i+1);
6292 break;
6293 }
Tom Taylord4a47292009-12-21 13:59:18 -08006294
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006295 // No scheme.
6296 break;
6297 }
6298 }
6299 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006300
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006301 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6302 uri.append("intent:");
6303 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006304
6305 uri.append("#Intent;");
6306
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006307 toUriInner(uri, scheme, flags);
6308 if (mSelector != null) {
6309 uri.append("SEL;");
6310 // Note that for now we are not going to try to handle the
6311 // data part; not clear how to represent this as a URI, and
6312 // not much utility in it.
6313 mSelector.toUriInner(uri, null, flags);
6314 }
6315
6316 uri.append("end");
6317
6318 return uri.toString();
6319 }
6320
6321 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006322 if (scheme != null) {
6323 uri.append("scheme=").append(scheme).append(';');
6324 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006325 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006326 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006327 }
6328 if (mCategories != null) {
6329 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006330 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006331 }
6332 }
6333 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006334 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006335 }
6336 if (mFlags != 0) {
6337 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6338 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006339 if (mPackage != null) {
6340 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6341 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006342 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006343 uri.append("component=").append(Uri.encode(
6344 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006345 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006346 if (mSourceBounds != null) {
6347 uri.append("sourceBounds=")
6348 .append(Uri.encode(mSourceBounds.flattenToString()))
6349 .append(';');
6350 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006351 if (mExtras != null) {
6352 for (String key : mExtras.keySet()) {
6353 final Object value = mExtras.get(key);
6354 char entryType =
6355 value instanceof String ? 'S' :
6356 value instanceof Boolean ? 'B' :
6357 value instanceof Byte ? 'b' :
6358 value instanceof Character ? 'c' :
6359 value instanceof Double ? 'd' :
6360 value instanceof Float ? 'f' :
6361 value instanceof Integer ? 'i' :
6362 value instanceof Long ? 'l' :
6363 value instanceof Short ? 's' :
6364 '\0';
6365
6366 if (entryType != '\0') {
6367 uri.append(entryType);
6368 uri.append('.');
6369 uri.append(Uri.encode(key));
6370 uri.append('=');
6371 uri.append(Uri.encode(value.toString()));
6372 uri.append(';');
6373 }
6374 }
6375 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006376 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006377
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006378 public int describeContents() {
6379 return (mExtras != null) ? mExtras.describeContents() : 0;
6380 }
6381
6382 public void writeToParcel(Parcel out, int flags) {
6383 out.writeString(mAction);
6384 Uri.writeToParcel(out, mData);
6385 out.writeString(mType);
6386 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006387 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006388 ComponentName.writeToParcel(mComponent, out);
6389
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006390 if (mSourceBounds != null) {
6391 out.writeInt(1);
6392 mSourceBounds.writeToParcel(out, flags);
6393 } else {
6394 out.writeInt(0);
6395 }
6396
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006397 if (mCategories != null) {
6398 out.writeInt(mCategories.size());
6399 for (String category : mCategories) {
6400 out.writeString(category);
6401 }
6402 } else {
6403 out.writeInt(0);
6404 }
6405
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006406 if (mSelector != null) {
6407 out.writeInt(1);
6408 mSelector.writeToParcel(out, flags);
6409 } else {
6410 out.writeInt(0);
6411 }
6412
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006413 if (mClipData != null) {
6414 out.writeInt(1);
6415 mClipData.writeToParcel(out, flags);
6416 } else {
6417 out.writeInt(0);
6418 }
6419
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006420 out.writeBundle(mExtras);
6421 }
6422
6423 public static final Parcelable.Creator<Intent> CREATOR
6424 = new Parcelable.Creator<Intent>() {
6425 public Intent createFromParcel(Parcel in) {
6426 return new Intent(in);
6427 }
6428 public Intent[] newArray(int size) {
6429 return new Intent[size];
6430 }
6431 };
6432
Dianne Hackborneb034652009-09-07 00:49:58 -07006433 /** @hide */
6434 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006435 readFromParcel(in);
6436 }
6437
6438 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006439 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006440 mData = Uri.CREATOR.createFromParcel(in);
6441 mType = in.readString();
6442 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006443 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006444 mComponent = ComponentName.readFromParcel(in);
6445
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006446 if (in.readInt() != 0) {
6447 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6448 }
6449
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006450 int N = in.readInt();
6451 if (N > 0) {
6452 mCategories = new HashSet<String>();
6453 int i;
6454 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006455 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006456 }
6457 } else {
6458 mCategories = null;
6459 }
6460
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006461 if (in.readInt() != 0) {
6462 mSelector = new Intent(in);
6463 }
6464
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006465 if (in.readInt() != 0) {
6466 mClipData = new ClipData(in);
6467 }
6468
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006469 mExtras = in.readBundle();
6470 }
6471
6472 /**
6473 * Parses the "intent" element (and its children) from XML and instantiates
6474 * an Intent object. The given XML parser should be located at the tag
6475 * where parsing should start (often named "intent"), from which the
6476 * basic action, data, type, and package and class name will be
6477 * retrieved. The function will then parse in to any child elements,
6478 * looking for <category android:name="xxx"> tags to add categories and
6479 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6480 * to the intent.
6481 *
6482 * @param resources The Resources to use when inflating resources.
6483 * @param parser The XML parser pointing at an "intent" tag.
6484 * @param attrs The AttributeSet interface for retrieving extended
6485 * attribute data at the current <var>parser</var> location.
6486 * @return An Intent object matching the XML data.
6487 * @throws XmlPullParserException If there was an XML parsing error.
6488 * @throws IOException If there was an I/O error.
6489 */
6490 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6491 throws XmlPullParserException, IOException {
6492 Intent intent = new Intent();
6493
6494 TypedArray sa = resources.obtainAttributes(attrs,
6495 com.android.internal.R.styleable.Intent);
6496
6497 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6498
6499 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6500 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6501 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6502
6503 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6504 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6505 if (packageName != null && className != null) {
6506 intent.setComponent(new ComponentName(packageName, className));
6507 }
6508
6509 sa.recycle();
6510
6511 int outerDepth = parser.getDepth();
6512 int type;
6513 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6514 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6515 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6516 continue;
6517 }
6518
6519 String nodeName = parser.getName();
6520 if (nodeName.equals("category")) {
6521 sa = resources.obtainAttributes(attrs,
6522 com.android.internal.R.styleable.IntentCategory);
6523 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6524 sa.recycle();
6525
6526 if (cat != null) {
6527 intent.addCategory(cat);
6528 }
6529 XmlUtils.skipCurrentTag(parser);
6530
6531 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006532 if (intent.mExtras == null) {
6533 intent.mExtras = new Bundle();
6534 }
6535 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6536 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006537
6538 } else {
6539 XmlUtils.skipCurrentTag(parser);
6540 }
6541 }
6542
6543 return intent;
6544 }
Nick Pellyccae4122012-01-09 14:12:58 -08006545
6546 /**
6547 * Normalize a MIME data type.
6548 *
6549 * <p>A normalized MIME type has white-space trimmed,
6550 * content-type parameters removed, and is lower-case.
6551 * This aligns the type with Android best practices for
6552 * intent filtering.
6553 *
6554 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6555 * "text/x-vCard" becomes "text/x-vcard".
6556 *
6557 * <p>All MIME types received from outside Android (such as user input,
6558 * or external sources like Bluetooth, NFC, or the Internet) should
6559 * be normalized before they are used to create an Intent.
6560 *
6561 * @param type MIME data type to normalize
6562 * @return normalized MIME data type, or null if the input was null
6563 * @see {@link #setType}
6564 * @see {@link #setTypeAndNormalize}
6565 */
6566 public static String normalizeMimeType(String type) {
6567 if (type == null) {
6568 return null;
6569 }
6570
6571 type = type.trim().toLowerCase(Locale.US);
6572
6573 final int semicolonIndex = type.indexOf(';');
6574 if (semicolonIndex != -1) {
6575 type = type.substring(0, semicolonIndex);
6576 }
6577 return type;
6578 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006579
6580 /**
6581 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
6582 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}.
6583 *
6584 * @hide
6585 */
6586 public void migrateExtraStreamToClipData() {
6587 // Refuse to touch if extras already parcelled
6588 if (mExtras != null && mExtras.isParcelled()) return;
6589
6590 // Bail when someone already gave us ClipData
6591 if (getClipData() != null) return;
6592
6593 final String action = getAction();
6594 if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006595 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006596 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6597 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6598 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6599 if (stream != null || text != null || htmlText != null) {
6600 final ClipData clipData = new ClipData(
6601 null, new String[] { getType() },
6602 new ClipData.Item(text, htmlText, null, stream));
6603 setClipData(clipData);
6604 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
6605 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006606 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006607 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006608
6609 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006610 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006611 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6612 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6613 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6614 int num = -1;
6615 if (streams != null) {
6616 num = streams.size();
6617 }
6618 if (texts != null) {
6619 if (num >= 0 && num != texts.size()) {
6620 // Wha...! F- you.
6621 return;
6622 }
6623 num = texts.size();
6624 }
6625 if (htmlTexts != null) {
6626 if (num >= 0 && num != htmlTexts.size()) {
6627 // Wha...! F- you.
6628 return;
6629 }
6630 num = htmlTexts.size();
6631 }
6632 if (num > 0) {
6633 final ClipData clipData = new ClipData(
6634 null, new String[] { getType() },
6635 makeClipItem(streams, texts, htmlTexts, 0));
6636
6637 for (int i = 1; i < num; i++) {
6638 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6639 }
6640
6641 setClipData(clipData);
6642 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
6643 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006644 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006645 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006646 }
6647 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006648
6649 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6650 ArrayList<String> htmlTexts, int which) {
6651 Uri uri = streams != null ? streams.get(which) : null;
6652 CharSequence text = texts != null ? texts.get(which) : null;
6653 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6654 return new ClipData.Item(text, htmlText, null, uri);
6655 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006656}