blob: b4669a78951f481fa7b96183291e53bf7215b8e0 [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.
1243 */
1244 public static final String EXTRA_ALLOW_REPLACE
1245 = "android.intent.extra.ALLOW_REPLACE";
1246
1247 /**
1248 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1249 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1250 * return to the application the result code of the install/uninstall. The returned result
1251 * code will be {@link android.app.Activity#RESULT_OK} on success or
1252 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1253 */
1254 public static final String EXTRA_RETURN_RESULT
1255 = "android.intent.extra.RETURN_RESULT";
1256
1257 /**
1258 * Package manager install result code. @hide because result codes are not
1259 * yet ready to be exposed.
1260 */
1261 public static final String EXTRA_INSTALL_RESULT
1262 = "android.intent.extra.INSTALL_RESULT";
1263
1264 /**
1265 * Activity Action: Launch application uninstaller.
1266 * <p>
1267 * Input: The data must be a package: URI whose scheme specific part is
1268 * the package name of the current installed package to be uninstalled.
1269 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1270 * <p>
1271 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1272 * succeeded.
1273 */
1274 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1275 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1276
1277 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001278 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1279 * describing the last run version of the platform that was setup.
1280 * @hide
1281 */
1282 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1283
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001284 // ---------------------------------------------------------------------
1285 // ---------------------------------------------------------------------
1286 // Standard intent broadcast actions (see action variable).
1287
1288 /**
1289 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001290 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001291 * <p class="note">This is a protected intent that can only be sent
1292 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001293 */
1294 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1295 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1296 /**
1297 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001298 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001299 * <p class="note">This is a protected intent that can only be sent
1300 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001301 */
1302 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1303 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001304
1305 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001306 * 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 -07001307 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001308 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001309 * <p class="note">This is a protected intent that can only be sent
1310 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001311 */
1312 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001313 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001314
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001315 /**
1316 * Broadcast Action: The current time has changed. Sent every
1317 * minute. You can <em>not</em> receive this through components declared
1318 * in manifests, only by exlicitly registering for it with
1319 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1320 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001321 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001322 * <p class="note">This is a protected intent that can only be sent
1323 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001324 */
1325 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1326 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1327 /**
1328 * Broadcast Action: The time was set.
1329 */
1330 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1331 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1332 /**
1333 * Broadcast Action: The date has changed.
1334 */
1335 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1336 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1337 /**
1338 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1339 * <ul>
1340 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1341 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001342 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001343 * <p class="note">This is a protected intent that can only be sent
1344 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001345 */
1346 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1347 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1348 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001349 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1350 * DNS entries should be tossed.
1351 * @hide
1352 */
1353 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1354 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1355 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001356 * Alarm Changed Action: This is broadcast when the AlarmClock
1357 * application's alarm is set or unset. It is used by the
1358 * AlarmClock application and the StatusBar service.
1359 * @hide
1360 */
1361 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1362 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1363 /**
1364 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1365 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1366 * @hide
1367 */
1368 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1369 public static final String ACTION_SYNC_STATE_CHANGED
1370 = "android.intent.action.SYNC_STATE_CHANGED";
1371 /**
1372 * Broadcast Action: This is broadcast once, after the system has finished
1373 * booting. It can be used to perform application-specific initialization,
1374 * such as installing alarms. You must hold the
1375 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1376 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001377 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001378 * <p class="note">This is a protected intent that can only be sent
1379 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001380 */
1381 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1382 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1383 /**
1384 * Broadcast Action: This is broadcast when a user action should request a
1385 * temporary system dialog to dismiss. Some examples of temporary system
1386 * dialogs are the notification window-shade and the recent tasks dialog.
1387 */
1388 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1389 /**
1390 * Broadcast Action: Trigger the download and eventual installation
1391 * of a package.
1392 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001393 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001394 * <p class="note">This is a protected intent that can only be sent
1395 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001396 *
1397 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001398 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001399 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001400 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1401 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1402 /**
1403 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001404 * device. The data contains the name of the package. Note that the
1405 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001406 * <p>My include the following extras:
1407 * <ul>
1408 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1409 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1410 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1411 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001412 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001413 * <p class="note">This is a protected intent that can only be sent
1414 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001415 */
1416 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1417 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1418 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001419 * Broadcast Action: A new version of an application package has been
1420 * installed, replacing an existing version that was previously installed.
1421 * The data contains the name of the package.
1422 * <p>My include the following extras:
1423 * <ul>
1424 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1425 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001426 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001427 * <p class="note">This is a protected intent that can only be sent
1428 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001429 */
1430 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1431 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1432 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001433 * Broadcast Action: A new version of your application has been installed
1434 * over an existing one. This is only sent to the application that was
1435 * replaced. It does not contain any additional data; to receive it, just
1436 * use an intent filter for this action.
1437 *
1438 * <p class="note">This is a protected intent that can only be sent
1439 * by the system.
1440 */
1441 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1442 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1443 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001444 * Broadcast Action: An existing application package has been removed from
1445 * the device. The data contains the name of the package. The package
1446 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001447 * <ul>
1448 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1449 * to the package.
1450 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1451 * application -- data and code -- is being removed.
1452 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1453 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1454 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001455 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001456 * <p class="note">This is a protected intent that can only be sent
1457 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001458 */
1459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1460 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1461 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001462 * Broadcast Action: An existing application package has been completely
1463 * removed from the device. The data contains the name of the package.
1464 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1465 * {@link #EXTRA_DATA_REMOVED} is true and
1466 * {@link #EXTRA_REPLACING} is false of that broadcast.
1467 *
1468 * <ul>
1469 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1470 * to the package.
1471 * </ul>
1472 *
1473 * <p class="note">This is a protected intent that can only be sent
1474 * by the system.
1475 */
1476 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1477 public static final String ACTION_PACKAGE_FULLY_REMOVED
1478 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1479 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001480 * Broadcast Action: An existing application package has been changed (e.g.
1481 * a component has been enabled or disabled). The data contains the name of
1482 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001483 * <ul>
1484 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001485 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1486 * of the changed components.
1487 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1488 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001489 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001490 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001491 * <p class="note">This is a protected intent that can only be sent
1492 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001493 */
1494 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1495 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1496 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001497 * @hide
1498 * Broadcast Action: Ask system services if there is any reason to
1499 * restart the given package. The data contains the name of the
1500 * package.
1501 * <ul>
1502 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1503 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1504 * </ul>
1505 *
1506 * <p class="note">This is a protected intent that can only be sent
1507 * by the system.
1508 */
1509 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1510 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1511 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001512 * Broadcast Action: The user has restarted a package, and all of its
1513 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001514 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001515 * be removed. Note that the restarted package does <em>not</em>
1516 * receive this broadcast.
1517 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001518 * <ul>
1519 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1520 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001521 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001522 * <p class="note">This is a protected intent that can only be sent
1523 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001524 */
1525 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1526 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1527 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001528 * Broadcast Action: The user has cleared the data of a package. This should
1529 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001530 * its persistent data is erased and this broadcast sent.
1531 * Note that the cleared package does <em>not</em>
1532 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001533 * <ul>
1534 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1535 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001536 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001537 * <p class="note">This is a protected intent that can only be sent
1538 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001539 */
1540 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1541 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1542 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001543 * Broadcast Action: A user ID has been removed from the system. The user
1544 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001545 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001546 * <p class="note">This is a protected intent that can only be sent
1547 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001548 */
1549 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1550 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001551
1552 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001553 * Broadcast Action: Sent to the installer package of an application
1554 * when that application is first launched (that is the first time it
1555 * is moved out of the stopped state). The data contains the name of the package.
1556 *
1557 * <p class="note">This is a protected intent that can only be sent
1558 * by the system.
1559 */
1560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1561 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1562
1563 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001564 * Broadcast Action: Sent to the system package verifier when a package
1565 * needs to be verified. The data contains the package URI.
1566 * <p class="note">
1567 * This is a protected intent that can only be sent by the system.
1568 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001569 */
1570 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1571 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1572
1573 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001574 * Broadcast Action: Resources for a set of packages (which were
1575 * previously unavailable) are currently
1576 * available since the media on which they exist is available.
1577 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1578 * list of packages whose availability changed.
1579 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1580 * list of uids of packages whose availability changed.
1581 * Note that the
1582 * packages in this list do <em>not</em> receive this broadcast.
1583 * The specified set of packages are now available on the system.
1584 * <p>Includes the following extras:
1585 * <ul>
1586 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1587 * whose resources(were previously unavailable) are currently available.
1588 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1589 * packages whose resources(were previously unavailable)
1590 * are currently available.
1591 * </ul>
1592 *
1593 * <p class="note">This is a protected intent that can only be sent
1594 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001595 */
1596 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001597 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1598 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001599
1600 /**
1601 * Broadcast Action: Resources for a set of packages are currently
1602 * unavailable since the media on which they exist is unavailable.
1603 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1604 * list of packages whose availability changed.
1605 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1606 * list of uids of packages whose availability changed.
1607 * The specified set of packages can no longer be
1608 * launched and are practically unavailable on the system.
1609 * <p>Inclues the following extras:
1610 * <ul>
1611 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1612 * whose resources are no longer available.
1613 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1614 * whose resources are no longer available.
1615 * </ul>
1616 *
1617 * <p class="note">This is a protected intent that can only be sent
1618 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001619 */
1620 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001621 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001622 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001624 /**
1625 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001626 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001627 * This should <em>only</em> be used to determine when the wallpaper
1628 * has changed to show the new wallpaper to the user. You should certainly
1629 * never, in response to this, change the wallpaper or other attributes of
1630 * it such as the suggested size. That would be crazy, right? You'd cause
1631 * all kinds of loops, especially if other apps are doing similar things,
1632 * right? Of course. So please don't do this.
1633 *
1634 * @deprecated Modern applications should use
1635 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1636 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1637 * shown behind their UI, rather than watching for this broadcast and
1638 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001639 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001640 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001641 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1642 /**
1643 * Broadcast Action: The current device {@link android.content.res.Configuration}
1644 * (orientation, locale, etc) has changed. When such a change happens, the
1645 * UIs (view hierarchy) will need to be rebuilt based on this new
1646 * information; for the most part, applications don't need to worry about
1647 * this, because the system will take care of stopping and restarting the
1648 * application to make sure it sees the new changes. Some system code that
1649 * can not be restarted will need to watch for this action and handle it
1650 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001651 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001652 * <p class="note">
1653 * You can <em>not</em> receive this through components declared
1654 * in manifests, only by explicitly registering for it with
1655 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1656 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001657 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001658 * <p class="note">This is a protected intent that can only be sent
1659 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001660 *
1661 * @see android.content.res.Configuration
1662 */
1663 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1664 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1665 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001666 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001667 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001668 * <p class="note">This is a protected intent that can only be sent
1669 * by the system.
1670 */
1671 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1672 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1673 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001674 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1675 * charging state, level, and other information about the battery.
1676 * See {@link android.os.BatteryManager} for documentation on the
1677 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001678 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001679 * <p class="note">
1680 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001681 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001682 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001683 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1684 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1685 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1686 * broadcasts that are sent and can be received through manifest
1687 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001688 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001689 * <p class="note">This is a protected intent that can only be sent
1690 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001691 */
1692 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1693 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1694 /**
1695 * Broadcast Action: Indicates low battery condition on the device.
1696 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001697 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001698 * <p class="note">This is a protected intent that can only be sent
1699 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001700 */
1701 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1702 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1703 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001704 * Broadcast Action: Indicates the battery is now okay after being low.
1705 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1706 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001707 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001708 * <p class="note">This is a protected intent that can only be sent
1709 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001710 */
1711 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1712 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1713 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001714 * Broadcast Action: External power has been connected to the device.
1715 * This is intended for applications that wish to register specifically to this notification.
1716 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1717 * stay active to receive this notification. This action can be used to implement actions
1718 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001719 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001720 * <p class="note">This is a protected intent that can only be sent
1721 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001722 */
1723 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001724 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001725 /**
1726 * Broadcast Action: External power has been removed from the device.
1727 * This is intended for applications that wish to register specifically to this notification.
1728 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1729 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001730 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001731 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001732 * <p class="note">This is a protected intent that can only be sent
1733 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001734 */
1735 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001736 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001737 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001738 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001739 * Broadcast Action: Device is shutting down.
1740 * This is broadcast when the device is being shut down (completely turned
1741 * off, not sleeping). Once the broadcast is complete, the final shutdown
1742 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001743 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001744 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001745 * <p class="note">This is a protected intent that can only be sent
1746 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001747 */
1748 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001749 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001750 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001751 * Activity Action: Start this activity to request system shutdown.
1752 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1753 * to request confirmation from the user before shutting down.
1754 *
1755 * <p class="note">This is a protected intent that can only be sent
1756 * by the system.
1757 *
1758 * {@hide}
1759 */
1760 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1761 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001762 * Broadcast Action: A sticky broadcast that indicates low memory
1763 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001764 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001765 * <p class="note">This is a protected intent that can only be sent
1766 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001767 */
1768 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1769 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1770 /**
1771 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001772 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001773 * <p class="note">This is a protected intent that can only be sent
1774 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001775 */
1776 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1777 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1778 /**
Jake Hambybb371632010-08-23 18:16:48 -07001779 * Broadcast Action: A sticky broadcast that indicates a memory full
1780 * condition on the device. This is intended for activities that want
1781 * to be able to fill the data partition completely, leaving only
1782 * enough free space to prevent system-wide SQLite failures.
1783 *
1784 * <p class="note">This is a protected intent that can only be sent
1785 * by the system.
1786 *
1787 * {@hide}
1788 */
1789 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1790 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1791 /**
1792 * Broadcast Action: Indicates memory full condition on the device
1793 * no longer exists.
1794 *
1795 * <p class="note">This is a protected intent that can only be sent
1796 * by the system.
1797 *
1798 * {@hide}
1799 */
1800 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1801 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1802 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001803 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1804 * and package management should be started.
1805 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1806 * notification.
1807 */
1808 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1809 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1810 /**
1811 * Broadcast Action: The device has entered USB Mass Storage mode.
1812 * This is used mainly for the USB Settings panel.
1813 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1814 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001815 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001816 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001817 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001818 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1819
1820 /**
1821 * Broadcast Action: The device has exited USB Mass Storage mode.
1822 * This is used mainly for the USB Settings panel.
1823 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1824 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001825 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001826 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001827 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001828 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1829
1830 /**
1831 * Broadcast Action: External media has been removed.
1832 * The path to the mount point for the removed media is contained in the Intent.mData field.
1833 */
1834 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1835 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1836
1837 /**
1838 * Broadcast Action: External media is present, but not mounted at its mount point.
1839 * The path to the mount point for the removed media is contained in the Intent.mData field.
1840 */
1841 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1842 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1843
1844 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001845 * Broadcast Action: External media is present, and being disk-checked
1846 * 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 -08001847 */
1848 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1849 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1850
1851 /**
1852 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1853 * 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 -08001854 */
1855 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1856 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1857
1858 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001859 * Broadcast Action: External media is present and mounted at its mount point.
1860 * The path to the mount point for the removed media is contained in the Intent.mData field.
1861 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1862 * media was mounted read only.
1863 */
1864 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1865 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1866
1867 /**
1868 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001869 * 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 -07001870 */
1871 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1872 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1873
1874 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001875 * Broadcast Action: External media is no longer being shared via USB mass storage.
1876 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1877 *
1878 * @hide
1879 */
1880 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1881
1882 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001883 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1884 * The path to the mount point for the removed media is contained in the Intent.mData field.
1885 */
1886 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1887 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1888
1889 /**
1890 * Broadcast Action: External media is present but cannot be mounted.
1891 * The path to the mount point for the removed media is contained in the Intent.mData field.
1892 */
1893 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1894 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1895
1896 /**
1897 * Broadcast Action: User has expressed the desire to remove the external storage media.
1898 * Applications should close all files they have open within the mount point when they receive this intent.
1899 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1900 */
1901 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1902 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1903
1904 /**
1905 * Broadcast Action: The media scanner has started scanning a directory.
1906 * The path to the directory being scanned is contained in the Intent.mData field.
1907 */
1908 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1909 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1910
1911 /**
1912 * Broadcast Action: The media scanner has finished scanning a directory.
1913 * The path to the scanned directory is contained in the Intent.mData field.
1914 */
1915 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1916 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1917
1918 /**
1919 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1920 * The path to the file is contained in the Intent.mData field.
1921 */
1922 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1923 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1924
1925 /**
1926 * Broadcast Action: The "Media Button" was pressed. Includes a single
1927 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1928 * caused the broadcast.
1929 */
1930 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1931 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1932
1933 /**
1934 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1935 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1936 * caused the broadcast.
1937 */
1938 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1939 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1940
1941 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1942 // location; they are not general-purpose actions.
1943
1944 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001945 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001946 */
1947 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1948 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1949 "android.intent.action.GTALK_CONNECTED";
1950
1951 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001952 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001953 */
1954 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1955 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1956 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001957
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001958 /**
1959 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001960 */
1961 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1962 public static final String ACTION_INPUT_METHOD_CHANGED =
1963 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001964
1965 /**
1966 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1967 * more radios have been turned off or on. The intent will have the following extra value:</p>
1968 * <ul>
1969 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1970 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1971 * turned off</li>
1972 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001973 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001974 * <p class="note">This is a protected intent that can only be sent
1975 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001976 */
1977 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1978 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1979
1980 /**
1981 * Broadcast Action: Some content providers have parts of their namespace
1982 * where they publish new events or items that the user may be especially
1983 * interested in. For these things, they may broadcast this action when the
1984 * set of interesting items change.
1985 *
1986 * For example, GmailProvider sends this notification when the set of unread
1987 * mail in the inbox changes.
1988 *
1989 * <p>The data of the intent identifies which part of which provider
1990 * changed. When queried through the content resolver, the data URI will
1991 * return the data set in question.
1992 *
1993 * <p>The intent will have the following extra values:
1994 * <ul>
1995 * <li><em>count</em> - The number of items in the data set. This is the
1996 * same as the number of items in the cursor returned by querying the
1997 * data URI. </li>
1998 * </ul>
1999 *
2000 * This intent will be sent at boot (if the count is non-zero) and when the
2001 * data set changes. It is possible for the data set to change without the
2002 * count changing (for example, if a new unread message arrives in the same
2003 * sync operation in which a message is archived). The phone should still
2004 * ring/vibrate/etc as normal in this case.
2005 */
2006 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2007 public static final String ACTION_PROVIDER_CHANGED =
2008 "android.intent.action.PROVIDER_CHANGED";
2009
2010 /**
2011 * Broadcast Action: Wired Headset plugged in or unplugged.
2012 *
2013 * <p>The intent will have the following extra values:
2014 * <ul>
2015 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2016 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002017 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002018 * </ul>
2019 * </ul>
2020 */
2021 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2022 public static final String ACTION_HEADSET_PLUG =
2023 "android.intent.action.HEADSET_PLUG";
2024
2025 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002026 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2027 *
2028 * <p>The intent will have the following extra values:
2029 * <ul>
2030 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2031 * <li><em>name</em> - Headset type, human readable string </li>
2032 * </ul>
2033 * </ul>
2034 * @hide
2035 */
2036 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002037 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2038 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002039
2040 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002041 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002042 *
2043 * <p>The intent will have the following extra values:
2044 * <ul>
2045 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2046 * <li><em>name</em> - Headset type, human readable string </li>
2047 * </ul>
2048 * </ul>
2049 * @hide
2050 */
2051 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002052 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2053 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002054
2055 /**
2056 * Broadcast Action: A HMDI cable was plugged or unplugged
2057 *
2058 * <p>The intent will have the following extra values:
2059 * <ul>
2060 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2061 * <li><em>name</em> - HDMI cable, human readable string </li>
2062 * </ul>
2063 * </ul>
2064 * @hide
2065 */
2066 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2067 public static final String ACTION_HDMI_AUDIO_PLUG =
2068 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002069
2070 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002071 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2072 *
2073 * <p>The intent will have the following extra values:
2074 * <ul>
2075 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2076 * <li><em>card</em> - ALSA card number (integer) </li>
2077 * <li><em>device</em> - ALSA device number (integer) </li>
2078 * </ul>
2079 * </ul>
2080 * @hide
2081 */
2082 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2083 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2084 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2085
2086 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002087 * Broadcast Action: A USB audio device was plugged in or unplugged.
2088 *
2089 * <p>The intent will have the following extra values:
2090 * <ul>
2091 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2092 * <li><em>card</em> - ALSA card number (integer) </li>
2093 * <li><em>device</em> - ALSA device number (integer) </li>
2094 * </ul>
2095 * </ul>
2096 * @hide
2097 */
2098 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2099 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2100 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2101
2102 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002103 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2104 * <ul>
2105 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2106 * </ul>
2107 *
2108 * <p class="note">This is a protected intent that can only be sent
2109 * by the system.
2110 *
2111 * @hide
2112 */
2113 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2114 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2115 = "android.intent.action.ADVANCED_SETTINGS";
2116
2117 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002118 * Broadcast Action: An outgoing call is about to be placed.
2119 *
2120 * <p>The Intent will have the following extra value:
2121 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002122 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002123 * the phone number originally intended to be dialed.</li>
2124 * </ul>
2125 * <p>Once the broadcast is finished, the resultData is used as the actual
2126 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002127 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002128 * outgoing call in turn: for example, a parental control application
2129 * might verify that the user is authorized to place the call at that
2130 * time, then a number-rewriting application might add an area code if
2131 * one was not specified.</p>
2132 * <p>For consistency, any receiver whose purpose is to prohibit phone
2133 * calls should have a priority of 0, to ensure it will see the final
2134 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002135 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002136 * should have a positive priority.
2137 * Negative priorities are reserved for the system for this broadcast;
2138 * using them may cause problems.</p>
2139 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2140 * abort the broadcast.</p>
2141 * <p>Emergency calls cannot be intercepted using this mechanism, and
2142 * other calls cannot be modified to call emergency numbers using this
2143 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002144 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002145 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2146 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002147 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002148 * <p class="note">This is a protected intent that can only be sent
2149 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002150 */
2151 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2152 public static final String ACTION_NEW_OUTGOING_CALL =
2153 "android.intent.action.NEW_OUTGOING_CALL";
2154
2155 /**
2156 * Broadcast Action: Have the device reboot. This is only for use by
2157 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002158 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002159 * <p class="note">This is a protected intent that can only be sent
2160 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002161 */
2162 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2163 public static final String ACTION_REBOOT =
2164 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002165
Wei Huang97ecc9c2009-05-11 17:44:20 -07002166 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002167 * Broadcast Action: A sticky broadcast for changes in the physical
2168 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002169 *
2170 * <p>The intent will have the following extra values:
2171 * <ul>
2172 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002173 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002174 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002175 * <p>This is intended for monitoring the current physical dock state.
2176 * See {@link android.app.UiModeManager} for the normal API dealing with
2177 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002178 */
2179 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2180 public static final String ACTION_DOCK_EVENT =
2181 "android.intent.action.DOCK_EVENT";
2182
2183 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002184 * Broadcast Action: a remote intent is to be broadcasted.
2185 *
2186 * A remote intent is used for remote RPC between devices. The remote intent
2187 * is serialized and sent from one device to another device. The receiving
2188 * device parses the remote intent and broadcasts it. Note that anyone can
2189 * broadcast a remote intent. However, if the intent receiver of the remote intent
2190 * does not trust intent broadcasts from arbitrary intent senders, it should require
2191 * the sender to hold certain permissions so only trusted sender's broadcast will be
2192 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002193 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002194 */
2195 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002196 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002197
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002198 /**
2199 * Broadcast Action: hook for permforming cleanup after a system update.
2200 *
2201 * The broadcast is sent when the system is booting, before the
2202 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2203 * image. A receiver for this should do its work and then disable itself
2204 * so that it does not get run again at the next boot.
2205 * @hide
2206 */
2207 public static final String ACTION_PRE_BOOT_COMPLETED =
2208 "android.intent.action.PRE_BOOT_COMPLETED";
2209
Amith Yamasani13593602012-03-22 16:16:17 -07002210 /**
2211 * Broadcast sent to the system when a user is added. Carries an extra EXTRA_USERID that has the
2212 * userid of the new user.
2213 * @hide
2214 */
2215 public static final String ACTION_USER_ADDED =
2216 "android.intent.action.USER_ADDED";
2217
2218 /**
2219 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USERID that has
2220 * the userid of the user.
2221 * @hide
2222 */
2223 public static final String ACTION_USER_REMOVED =
2224 "android.intent.action.USER_REMOVED";
2225
2226 /**
2227 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USERID that has
2228 * the userid of the user to become the current one.
2229 * @hide
2230 */
2231 public static final String ACTION_USER_SWITCHED =
2232 "android.intent.action.USER_SWITCHED";
2233
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002234 // ---------------------------------------------------------------------
2235 // ---------------------------------------------------------------------
2236 // Standard intent categories (see addCategory()).
2237
2238 /**
2239 * Set if the activity should be an option for the default action
2240 * (center press) to perform on a piece of data. Setting this will
2241 * hide from the user any activities without it set when performing an
2242 * action on some data. Note that this is normal -not- set in the
2243 * Intent when initiating an action -- it is for use in intent filters
2244 * specified in packages.
2245 */
2246 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2247 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2248 /**
2249 * Activities that can be safely invoked from a browser must support this
2250 * category. For example, if the user is viewing a web page or an e-mail
2251 * and clicks on a link in the text, the Intent generated execute that
2252 * link will require the BROWSABLE category, so that only activities
2253 * supporting this category will be considered as possible actions. By
2254 * supporting this category, you are promising that there is nothing
2255 * damaging (without user intervention) that can happen by invoking any
2256 * matching Intent.
2257 */
2258 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2259 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2260 /**
2261 * Set if the activity should be considered as an alternative action to
2262 * the data the user is currently viewing. See also
2263 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2264 * applies to the selection in a list of items.
2265 *
2266 * <p>Supporting this category means that you would like your activity to be
2267 * displayed in the set of alternative things the user can do, usually as
2268 * part of the current activity's options menu. You will usually want to
2269 * include a specific label in the &lt;intent-filter&gt; of this action
2270 * describing to the user what it does.
2271 *
2272 * <p>The action of IntentFilter with this category is important in that it
2273 * describes the specific action the target will perform. This generally
2274 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2275 * a specific name such as "com.android.camera.action.CROP. Only one
2276 * alternative of any particular action will be shown to the user, so using
2277 * a specific action like this makes sure that your alternative will be
2278 * displayed while also allowing other applications to provide their own
2279 * overrides of that particular action.
2280 */
2281 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2282 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2283 /**
2284 * Set if the activity should be considered as an alternative selection
2285 * action to the data the user has currently selected. This is like
2286 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2287 * of items from which the user can select, giving them alternatives to the
2288 * default action that will be performed on it.
2289 */
2290 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2291 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2292 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002293 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002294 */
2295 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2296 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2297 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002298 * Should be displayed in the top-level launcher.
2299 */
2300 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2301 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2302 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002303 * Provides information about the package it is in; typically used if
2304 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2305 * a front-door to the user without having to be shown in the all apps list.
2306 */
2307 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2308 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2309 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002310 * This is the home activity, that is the first activity that is displayed
2311 * when the device boots.
2312 */
2313 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2314 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2315 /**
2316 * This activity is a preference panel.
2317 */
2318 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2319 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2320 /**
2321 * This activity is a development preference panel.
2322 */
2323 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2324 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2325 /**
2326 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002327 */
2328 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2329 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2330 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002331 * This activity allows the user to browse and download new applications.
2332 */
2333 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2334 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2335 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002336 * This activity may be exercised by the monkey or other automated test tools.
2337 */
2338 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2339 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2340 /**
2341 * To be used as a test (not part of the normal user experience).
2342 */
2343 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2344 /**
2345 * To be used as a unit test (run through the Test Harness).
2346 */
2347 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2348 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002349 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002350 * experience).
2351 */
2352 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2353 /**
2354 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2355 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2356 * when queried, though it is allowable for those columns to be blank.
2357 */
2358 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2359 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2360
2361 /**
2362 * To be used as code under test for framework instrumentation tests.
2363 */
2364 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2365 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002366 /**
2367 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002368 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2369 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002370 */
2371 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2372 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2373 /**
2374 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002375 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2376 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002377 */
2378 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2379 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002380 /**
2381 * An activity to run when device is inserted into a analog (low end) dock.
2382 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2383 * information, see {@link android.app.UiModeManager}.
2384 */
2385 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2386 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2387
2388 /**
2389 * An activity to run when device is inserted into a digital (high end) dock.
2390 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2391 * information, see {@link android.app.UiModeManager}.
2392 */
2393 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2394 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002395
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002396 /**
2397 * Used to indicate that the activity can be used in a car environment.
2398 */
2399 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2400 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2401
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002402 // ---------------------------------------------------------------------
2403 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002404 // Application launch intent categories (see addCategory()).
2405
2406 /**
2407 * Used with {@link #ACTION_MAIN} to launch the browser application.
2408 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002409 * <p>NOTE: This should not be used as the primary key of an Intent,
2410 * since it will not result in the app launching with the correct
2411 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002412 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002413 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002414 */
2415 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2416 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2417
2418 /**
2419 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2420 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002421 * <p>NOTE: This should not be used as the primary key of an Intent,
2422 * since it will not result in the app launching with the correct
2423 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002424 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002425 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002426 */
2427 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2428 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2429
2430 /**
2431 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2432 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002433 * <p>NOTE: This should not be used as the primary key of an Intent,
2434 * since it will not result in the app launching with the correct
2435 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002436 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002437 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002438 */
2439 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2440 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2441
2442 /**
2443 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2444 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002445 * <p>NOTE: This should not be used as the primary key of an Intent,
2446 * since it will not result in the app launching with the correct
2447 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002448 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002449 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002450 */
2451 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2452 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2453
2454 /**
2455 * Used with {@link #ACTION_MAIN} to launch the email application.
2456 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002457 * <p>NOTE: This should not be used as the primary key of an Intent,
2458 * since it will not result in the app launching with the correct
2459 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002460 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002461 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002462 */
2463 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2464 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2465
2466 /**
2467 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2468 * The activity should be able to view and manipulate image and video files
2469 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002470 * <p>NOTE: This should not be used as the primary key of an Intent,
2471 * since it will not result in the app launching with the correct
2472 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002473 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002474 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002475 */
2476 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2477 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2478
2479 /**
2480 * Used with {@link #ACTION_MAIN} to launch the maps application.
2481 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002482 * <p>NOTE: This should not be used as the primary key of an Intent,
2483 * since it will not result in the app launching with the correct
2484 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002485 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002486 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002487 */
2488 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2489 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2490
2491 /**
2492 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2493 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002494 * <p>NOTE: This should not be used as the primary key of an Intent,
2495 * since it will not result in the app launching with the correct
2496 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002497 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002498 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002499 */
2500 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2501 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2502
2503 /**
2504 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002505 * The activity should be able to play, browse, or manipulate music files
2506 * stored on the device.
2507 * <p>NOTE: This should not be used as the primary key of an Intent,
2508 * since it will not result in the app launching with the correct
2509 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002510 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002511 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002512 */
2513 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2514 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2515
2516 // ---------------------------------------------------------------------
2517 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002518 // Standard extra data keys.
2519
2520 /**
2521 * The initial data to place in a newly created record. Use with
2522 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2523 * fields as would be given to the underlying ContentProvider.insert()
2524 * call.
2525 */
2526 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2527
2528 /**
2529 * A constant CharSequence that is associated with the Intent, used with
2530 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2531 * this may be a styled CharSequence, so you must use
2532 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2533 * retrieve it.
2534 */
2535 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2536
2537 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002538 * A constant String that is associated with the Intent, used with
2539 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2540 * as HTML formatted text. Note that you <em>must</em> also supply
2541 * {@link #EXTRA_TEXT}.
2542 */
2543 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2544
2545 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002546 * A content: URI holding a stream of data associated with the Intent,
2547 * used with {@link #ACTION_SEND} to supply the data being sent.
2548 */
2549 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2550
2551 /**
2552 * A String[] holding e-mail addresses that should be delivered to.
2553 */
2554 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2555
2556 /**
2557 * A String[] holding e-mail addresses that should be carbon copied.
2558 */
2559 public static final String EXTRA_CC = "android.intent.extra.CC";
2560
2561 /**
2562 * A String[] holding e-mail addresses that should be blind carbon copied.
2563 */
2564 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2565
2566 /**
2567 * A constant string holding the desired subject line of a message.
2568 */
2569 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2570
2571 /**
2572 * An Intent describing the choices you would like shown with
2573 * {@link #ACTION_PICK_ACTIVITY}.
2574 */
2575 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2576
2577 /**
2578 * A CharSequence dialog title to provide to the user when used with a
2579 * {@link #ACTION_CHOOSER}.
2580 */
2581 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2582
2583 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002584 * A Parcelable[] of {@link Intent} or
2585 * {@link android.content.pm.LabeledIntent} objects as set with
2586 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2587 * a the front of the list of choices, when shown to the user with a
2588 * {@link #ACTION_CHOOSER}.
2589 */
2590 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2591
2592 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002593 * A {@link android.view.KeyEvent} object containing the event that
2594 * triggered the creation of the Intent it is in.
2595 */
2596 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2597
2598 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002599 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2600 * before shutting down.
2601 *
2602 * {@hide}
2603 */
2604 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2605
2606 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002607 * 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 -07002608 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2609 * of restarting the application.
2610 */
2611 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2612
2613 /**
2614 * A String holding the phone number originally entered in
2615 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2616 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2617 */
2618 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002619
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002620 /**
2621 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2622 * intents to supply the uid the package had been assigned. Also an optional
2623 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2624 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2625 * purpose.
2626 */
2627 public static final String EXTRA_UID = "android.intent.extra.UID";
2628
2629 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002630 * @hide String array of package names.
2631 */
2632 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2633
2634 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002635 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2636 * intents to indicate whether this represents a full uninstall (removing
2637 * both the code and its data) or a partial uninstall (leaving its data,
2638 * implying that this is an update).
2639 */
2640 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002641
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002642 /**
2643 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2644 * intents to indicate that this is a replacement of the package, so this
2645 * broadcast will immediately be followed by an add broadcast for a
2646 * different version of the same package.
2647 */
2648 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002649
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002650 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002651 * Used as an int extra field in {@link android.app.AlarmManager} intents
2652 * to tell the application being invoked how many pending alarms are being
2653 * delievered with the intent. For one-shot alarms this will always be 1.
2654 * For recurring alarms, this might be greater than 1 if the device was
2655 * asleep or powered off at the time an earlier alarm would have been
2656 * delivered.
2657 */
2658 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002659
Jacek Surazski86b6c532009-05-13 14:38:28 +02002660 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002661 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2662 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002663 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2664 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002665 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2666 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2667 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002668 */
2669 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2670
2671 /**
2672 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2673 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002674 */
2675 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2676
2677 /**
2678 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2679 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002680 */
2681 public static final int EXTRA_DOCK_STATE_DESK = 1;
2682
2683 /**
2684 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2685 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002686 */
2687 public static final int EXTRA_DOCK_STATE_CAR = 2;
2688
2689 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002690 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2691 * to represent that the phone is in a analog (low end) dock.
2692 */
2693 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2694
2695 /**
2696 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2697 * to represent that the phone is in a digital (high end) dock.
2698 */
2699 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2700
2701 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002702 * Boolean that can be supplied as meta-data with a dock activity, to
2703 * indicate that the dock should take over the home key when it is active.
2704 */
2705 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002706
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002707 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002708 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2709 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002710 */
2711 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2712
2713 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002714 * Used in the extra field in the remote intent. It's astring token passed with the
2715 * remote intent.
2716 */
2717 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2718 "android.intent.extra.remote_intent_token";
2719
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002720 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002721 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002722 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002723 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002724 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002725 "android.intent.extra.changed_component_name";
2726
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002727 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002728 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002729 * and contains a string array of all of the components that have changed.
2730 */
2731 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2732 "android.intent.extra.changed_component_name_list";
2733
2734 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002735 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002736 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2737 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002738 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002739 */
2740 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2741 "android.intent.extra.changed_package_list";
2742
2743 /**
2744 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002745 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2746 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002747 * and contains an integer array of uids of all of the components
2748 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002749 */
2750 public static final String EXTRA_CHANGED_UID_LIST =
2751 "android.intent.extra.changed_uid_list";
2752
2753 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002754 * @hide
2755 * Magic extra system code can use when binding, to give a label for
2756 * who it is that has bound to a service. This is an integer giving
2757 * a framework string resource that can be displayed to the user.
2758 */
2759 public static final String EXTRA_CLIENT_LABEL =
2760 "android.intent.extra.client_label";
2761
2762 /**
2763 * @hide
2764 * Magic extra system code can use when binding, to give a PendingIntent object
2765 * that can be launched for the user to disable the system's use of this
2766 * service.
2767 */
2768 public static final String EXTRA_CLIENT_INTENT =
2769 "android.intent.extra.client_intent";
2770
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002771 /**
2772 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2773 * data that is on the local device. This is a boolean extra; the default
2774 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2775 * the user to select media that is already on the device, not requiring it
2776 * be downloaded from a remote service when opened. Another way to look
2777 * at it is that such content should generally have a "_data" column to the
2778 * path of the content on local external storage.
2779 */
2780 public static final String EXTRA_LOCAL_ONLY =
2781 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07002782
Amith Yamasani13593602012-03-22 16:16:17 -07002783 /**
2784 * The userid carried with broadcast intents related to addition, removal and switching of users
2785 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
2786 * @hide
2787 */
2788 public static final String EXTRA_USERID =
2789 "android.intent.extra.user_id";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002790 // ---------------------------------------------------------------------
2791 // ---------------------------------------------------------------------
2792 // Intent flags (see mFlags variable).
2793
2794 /**
2795 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002796 * perform read operations on the Uri in the Intent's data and any URIs
2797 * specified in its ClipData. When applying to an Intent's ClipData,
2798 * all URIs as well as recursive traversals through data or other ClipData
2799 * in Intent items will be granted; only the grant flags of the top-level
2800 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002801 */
2802 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2803 /**
2804 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002805 * perform write operations on the Uri in the Intent's data and any URIs
2806 * specified in its ClipData. When applying to an Intent's ClipData,
2807 * all URIs as well as recursive traversals through data or other ClipData
2808 * in Intent items will be granted; only the grant flags of the top-level
2809 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002810 */
2811 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2812 /**
2813 * Can be set by the caller to indicate that this Intent is coming from
2814 * a background operation, not from direct user interaction.
2815 */
2816 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2817 /**
2818 * A flag you can enable for debugging: when set, log messages will be
2819 * printed during the resolution of this intent to show you what has
2820 * been found to create the final resolved list.
2821 */
2822 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002823 /**
2824 * If set, this intent will not match any components in packages that
2825 * are currently stopped. If this is not set, then the default behavior
2826 * is to include such applications in the result.
2827 */
2828 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2829 /**
2830 * If set, this intent will always match any components in packages that
2831 * are currently stopped. This is the default behavior when
2832 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2833 * flags are set, this one wins (it allows overriding of exclude for
2834 * places where the framework may automatically set the exclude flag).
2835 */
2836 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002837
2838 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002839 * If set, the new activity is not kept in the history stack. As soon as
2840 * the user navigates away from it, the activity is finished. This may also
2841 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2842 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002843 */
2844 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2845 /**
2846 * If set, the activity will not be launched if it is already running
2847 * at the top of the history stack.
2848 */
2849 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2850 /**
2851 * If set, this activity will become the start of a new task on this
2852 * history stack. A task (from the activity that started it to the
2853 * next task activity) defines an atomic group of activities that the
2854 * user can move to. Tasks can be moved to the foreground and background;
2855 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002856 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002857 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2858 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002859 *
2860 * <p>This flag is generally used by activities that want
2861 * to present a "launcher" style behavior: they give the user a list of
2862 * separate things that can be done, which otherwise run completely
2863 * independently of the activity launching them.
2864 *
2865 * <p>When using this flag, if a task is already running for the activity
2866 * you are now starting, then a new activity will not be started; instead,
2867 * the current task will simply be brought to the front of the screen with
2868 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2869 * to disable this behavior.
2870 *
2871 * <p>This flag can not be used when the caller is requesting a result from
2872 * the activity being launched.
2873 */
2874 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2875 /**
2876 * <strong>Do not use this flag unless you are implementing your own
2877 * top-level application launcher.</strong> Used in conjunction with
2878 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2879 * behavior of bringing an existing task to the foreground. When set,
2880 * a new task is <em>always</em> started to host the Activity for the
2881 * Intent, regardless of whether there is already an existing task running
2882 * the same thing.
2883 *
2884 * <p><strong>Because the default system does not include graphical task management,
2885 * you should not use this flag unless you provide some way for a user to
2886 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002887 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002888 * <p>This flag is ignored if
2889 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2890 *
Scott Main7aee61f2011-02-08 11:25:01 -08002891 * <p>See
2892 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2893 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002894 */
2895 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2896 /**
2897 * If set, and the activity being launched is already running in the
2898 * current task, then instead of launching a new instance of that activity,
2899 * all of the other activities on top of it will be closed and this Intent
2900 * will be delivered to the (now on top) old activity as a new Intent.
2901 *
2902 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2903 * If D calls startActivity() with an Intent that resolves to the component
2904 * of activity B, then C and D will be finished and B receive the given
2905 * Intent, resulting in the stack now being: A, B.
2906 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002907 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002908 * either receive the new intent you are starting here in its
2909 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002910 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002911 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2912 * the same intent, then it will be finished and re-created; for all other
2913 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2914 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002915 *
2916 * <p>This launch mode can also be used to good effect in conjunction with
2917 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2918 * of a task, it will bring any currently running instance of that task
2919 * to the foreground, and then clear it to its root state. This is
2920 * especially useful, for example, when launching an activity from the
2921 * notification manager.
2922 *
Scott Main7aee61f2011-02-08 11:25:01 -08002923 * <p>See
2924 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2925 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002926 */
2927 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2928 /**
2929 * If set and this intent is being used to launch a new activity from an
2930 * existing one, then the reply target of the existing activity will be
2931 * transfered to the new activity. This way the new activity can call
2932 * {@link android.app.Activity#setResult} and have that result sent back to
2933 * the reply target of the original activity.
2934 */
2935 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2936 /**
2937 * If set and this intent is being used to launch a new activity from an
2938 * existing one, the current activity will not be counted as the top
2939 * activity for deciding whether the new intent should be delivered to
2940 * the top instead of starting a new one. The previous activity will
2941 * be used as the top, with the assumption being that the current activity
2942 * will finish itself immediately.
2943 */
2944 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2945 /**
2946 * If set, the new activity is not kept in the list of recently launched
2947 * activities.
2948 */
2949 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2950 /**
2951 * This flag is not normally set by application code, but set for you by
2952 * the system as described in the
2953 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2954 * launchMode} documentation for the singleTask mode.
2955 */
2956 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2957 /**
2958 * If set, and this activity is either being started in a new task or
2959 * bringing to the top an existing task, then it will be launched as
2960 * the front door of the task. This will result in the application of
2961 * any affinities needed to have that task in the proper state (either
2962 * moving activities to or from it), or simply resetting that task to
2963 * its initial state if needed.
2964 */
2965 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2966 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002967 * This flag is not normally set by application code, but set for you by
2968 * the system if this activity is being launched from history
2969 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002970 */
2971 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002972 /**
2973 * If set, this marks a point in the task's activity stack that should
2974 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002975 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002976 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2977 * the user re-launching it from home), this activity and all on top of
2978 * it will be finished so that the user does not return to them, but
2979 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002980 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002981 * <p>This is useful for cases where you have a logical break in your
2982 * application. For example, an e-mail application may have a command
2983 * to view an attachment, which launches an image view activity to
2984 * display it. This activity should be part of the e-mail application's
2985 * task, since it is a part of the task the user is involved in. However,
2986 * if the user leaves that task, and later selects the e-mail app from
2987 * home, we may like them to return to the conversation they were
2988 * viewing, not the picture attachment, since that is confusing. By
2989 * setting this flag when launching the image viewer, that viewer and
2990 * any activities it starts will be removed the next time the user returns
2991 * to mail.
2992 */
2993 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002994 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002995 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002996 * callback from occurring on the current frontmost activity before it is
2997 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002998 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002999 * <p>Typically, an activity can rely on that callback to indicate that an
3000 * explicit user action has caused their activity to be moved out of the
3001 * foreground. The callback marks an appropriate point in the activity's
3002 * lifecycle for it to dismiss any notifications that it intends to display
3003 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003004 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003005 * <p>If an activity is ever started via any non-user-driven events such as
3006 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3007 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003008 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003009 */
3010 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003011 /**
3012 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3013 * this flag will cause the launched activity to be brought to the front of its
3014 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003015 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003016 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3017 * If D calls startActivity() with an Intent that resolves to the component
3018 * of activity B, then B will be brought to the front of the history stack,
3019 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003020 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003021 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003022 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003023 */
3024 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003025 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003026 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3027 * this flag will prevent the system from applying an activity transition
3028 * animation to go to the next activity state. This doesn't mean an
3029 * animation will never run -- if another activity change happens that doesn't
3030 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003031 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003032 * when you are going to do a series of activity operations but the
3033 * animation seen by the user shouldn't be driven by the first activity
3034 * change but rather a later one.
3035 */
3036 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3037 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003038 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3039 * this flag will cause any existing task that would be associated with the
3040 * activity to be cleared before the activity is started. That is, the activity
3041 * becomes the new root of an otherwise empty task, and any old activities
3042 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3043 */
3044 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3045 /**
3046 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3047 * this flag will cause a newly launching task to be placed on top of the current
3048 * home activity task (if there is one). That is, pressing back from the task
3049 * will always return the user to home even if that was not the last activity they
3050 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3051 */
3052 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3053 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003054 * If set, when sending a broadcast only registered receivers will be
3055 * called -- no BroadcastReceiver components will be launched.
3056 */
3057 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003058 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003059 * If set, when sending a broadcast the new broadcast will replace
3060 * any existing pending broadcast that matches it. Matching is defined
3061 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3062 * true for the intents of the two broadcasts. When a match is found,
3063 * the new broadcast (and receivers associated with it) will replace the
3064 * existing one in the pending broadcast list, remaining at the same
3065 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003066 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003067 * <p>This flag is most typically used with sticky broadcasts, which
3068 * only care about delivering the most recent values of the broadcast
3069 * to their receivers.
3070 */
3071 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3072 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003073 * If set, when sending a broadcast the recipient is allowed to run at
3074 * foreground priority, with a shorter timeout interval. During normal
3075 * broadcasts the receivers are not automatically hoisted out of the
3076 * background priority class.
3077 */
3078 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3079 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003080 * If set, when sending a broadcast <i>before boot has completed</i> only
3081 * registered receivers will be called -- no BroadcastReceiver components
3082 * will be launched. Sticky intent state will be recorded properly even
3083 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3084 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003085 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003086 * <p>This flag is only for use by system sevices as a convenience to
3087 * avoid having to implement a more complex mechanism around detection
3088 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003089 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003090 * @hide
3091 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003092 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003093 /**
3094 * Set when this broadcast is for a boot upgrade, a special mode that
3095 * allows the broadcast to be sent before the system is ready and launches
3096 * the app process with no providers running in it.
3097 * @hide
3098 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003099 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003100
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003101 /**
3102 * @hide Flags that can't be changed with PendingIntent.
3103 */
3104 public static final int IMMUTABLE_FLAGS =
3105 FLAG_GRANT_READ_URI_PERMISSION
3106 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003107
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003108 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003109 // ---------------------------------------------------------------------
3110 // toUri() and parseUri() options.
3111
3112 /**
3113 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3114 * always has the "intent:" scheme. This syntax can be used when you want
3115 * to later disambiguate between URIs that are intended to describe an
3116 * Intent vs. all others that should be treated as raw URIs. When used
3117 * with {@link #parseUri}, any other scheme will result in a generic
3118 * VIEW action for that raw URI.
3119 */
3120 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003121
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003122 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003123
3124 private String mAction;
3125 private Uri mData;
3126 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003127 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003128 private ComponentName mComponent;
3129 private int mFlags;
3130 private HashSet<String> mCategories;
3131 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003132 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003133 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003134 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003135
3136 // ---------------------------------------------------------------------
3137
3138 /**
3139 * Create an empty intent.
3140 */
3141 public Intent() {
3142 }
3143
3144 /**
3145 * Copy constructor.
3146 */
3147 public Intent(Intent o) {
3148 this.mAction = o.mAction;
3149 this.mData = o.mData;
3150 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003151 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003152 this.mComponent = o.mComponent;
3153 this.mFlags = o.mFlags;
3154 if (o.mCategories != null) {
3155 this.mCategories = new HashSet<String>(o.mCategories);
3156 }
3157 if (o.mExtras != null) {
3158 this.mExtras = new Bundle(o.mExtras);
3159 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003160 if (o.mSourceBounds != null) {
3161 this.mSourceBounds = new Rect(o.mSourceBounds);
3162 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003163 if (o.mSelector != null) {
3164 this.mSelector = new Intent(o.mSelector);
3165 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003166 if (o.mClipData != null) {
3167 this.mClipData = new ClipData(o.mClipData);
3168 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003169 }
3170
3171 @Override
3172 public Object clone() {
3173 return new Intent(this);
3174 }
3175
3176 private Intent(Intent o, boolean all) {
3177 this.mAction = o.mAction;
3178 this.mData = o.mData;
3179 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003180 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003181 this.mComponent = o.mComponent;
3182 if (o.mCategories != null) {
3183 this.mCategories = new HashSet<String>(o.mCategories);
3184 }
3185 }
3186
3187 /**
3188 * Make a clone of only the parts of the Intent that are relevant for
3189 * filter matching: the action, data, type, component, and categories.
3190 */
3191 public Intent cloneFilter() {
3192 return new Intent(this, false);
3193 }
3194
3195 /**
3196 * Create an intent with a given action. All other fields (data, type,
3197 * class) are null. Note that the action <em>must</em> be in a
3198 * namespace because Intents are used globally in the system -- for
3199 * example the system VIEW action is android.intent.action.VIEW; an
3200 * application's custom action would be something like
3201 * com.google.app.myapp.CUSTOM_ACTION.
3202 *
3203 * @param action The Intent action, such as ACTION_VIEW.
3204 */
3205 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003206 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003207 }
3208
3209 /**
3210 * Create an intent with a given action and for a given data url. Note
3211 * that the action <em>must</em> be in a namespace because Intents are
3212 * used globally in the system -- for example the system VIEW action is
3213 * android.intent.action.VIEW; an application's custom action would be
3214 * something like com.google.app.myapp.CUSTOM_ACTION.
3215 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003216 * <p><em>Note: scheme and host name matching in the Android framework is
3217 * case-sensitive, unlike the formal RFC. As a result,
3218 * you should always ensure that you write your Uri with these elements
3219 * using lower case letters, and normalize any Uris you receive from
3220 * outside of Android to ensure the scheme and host is lower case.</em></p>
3221 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003222 * @param action The Intent action, such as ACTION_VIEW.
3223 * @param uri The Intent data URI.
3224 */
3225 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003226 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003227 mData = uri;
3228 }
3229
3230 /**
3231 * Create an intent for a specific component. All other fields (action, data,
3232 * type, class) are null, though they can be modified later with explicit
3233 * calls. This provides a convenient way to create an intent that is
3234 * intended to execute a hard-coded class name, rather than relying on the
3235 * system to find an appropriate class for you; see {@link #setComponent}
3236 * for more information on the repercussions of this.
3237 *
3238 * @param packageContext A Context of the application package implementing
3239 * this class.
3240 * @param cls The component class that is to be used for the intent.
3241 *
3242 * @see #setClass
3243 * @see #setComponent
3244 * @see #Intent(String, android.net.Uri , Context, Class)
3245 */
3246 public Intent(Context packageContext, Class<?> cls) {
3247 mComponent = new ComponentName(packageContext, cls);
3248 }
3249
3250 /**
3251 * Create an intent for a specific component with a specified action and data.
3252 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3253 * construct the Intent and then calling {@link #setClass} to set its
3254 * class.
3255 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003256 * <p><em>Note: scheme and host name matching in the Android framework is
3257 * case-sensitive, unlike the formal RFC. As a result,
3258 * you should always ensure that you write your Uri with these elements
3259 * using lower case letters, and normalize any Uris you receive from
3260 * outside of Android to ensure the scheme and host is lower case.</em></p>
3261 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003262 * @param action The Intent action, such as ACTION_VIEW.
3263 * @param uri The Intent data URI.
3264 * @param packageContext A Context of the application package implementing
3265 * this class.
3266 * @param cls The component class that is to be used for the intent.
3267 *
3268 * @see #Intent(String, android.net.Uri)
3269 * @see #Intent(Context, Class)
3270 * @see #setClass
3271 * @see #setComponent
3272 */
3273 public Intent(String action, Uri uri,
3274 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003275 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003276 mData = uri;
3277 mComponent = new ComponentName(packageContext, cls);
3278 }
3279
3280 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003281 * Create an intent to launch the main (root) activity of a task. This
3282 * is the Intent that is started when the application's is launched from
3283 * Home. For anything else that wants to launch an application in the
3284 * same way, it is important that they use an Intent structured the same
3285 * way, and can use this function to ensure this is the case.
3286 *
3287 * <p>The returned Intent has the given Activity component as its explicit
3288 * component, {@link #ACTION_MAIN} as its action, and includes the
3289 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3290 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3291 * to do that through {@link #addFlags(int)} on the returned Intent.
3292 *
3293 * @param mainActivity The main activity component that this Intent will
3294 * launch.
3295 * @return Returns a newly created Intent that can be used to launch the
3296 * activity as a main application entry.
3297 *
3298 * @see #setClass
3299 * @see #setComponent
3300 */
3301 public static Intent makeMainActivity(ComponentName mainActivity) {
3302 Intent intent = new Intent(ACTION_MAIN);
3303 intent.setComponent(mainActivity);
3304 intent.addCategory(CATEGORY_LAUNCHER);
3305 return intent;
3306 }
3307
3308 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003309 * Make an Intent for the main activity of an application, without
3310 * specifying a specific activity to run but giving a selector to find
3311 * the activity. This results in a final Intent that is structured
3312 * the same as when the application is launched from
3313 * Home. For anything else that wants to launch an application in the
3314 * same way, it is important that they use an Intent structured the same
3315 * way, and can use this function to ensure this is the case.
3316 *
3317 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3318 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3319 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3320 * to do that through {@link #addFlags(int)} on the returned Intent.
3321 *
3322 * @param selectorAction The action name of the Intent's selector.
3323 * @param selectorCategory The name of a category to add to the Intent's
3324 * selector.
3325 * @return Returns a newly created Intent that can be used to launch the
3326 * activity as a main application entry.
3327 *
3328 * @see #setSelector(Intent)
3329 */
3330 public static Intent makeMainSelectorActivity(String selectorAction,
3331 String selectorCategory) {
3332 Intent intent = new Intent(ACTION_MAIN);
3333 intent.addCategory(CATEGORY_LAUNCHER);
3334 Intent selector = new Intent();
3335 selector.setAction(selectorAction);
3336 selector.addCategory(selectorCategory);
3337 intent.setSelector(selector);
3338 return intent;
3339 }
3340
3341 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003342 * Make an Intent that can be used to re-launch an application's task
3343 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3344 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3345 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3346 *
3347 * @param mainActivity The activity component that is the root of the
3348 * task; this is the activity that has been published in the application's
3349 * manifest as the main launcher icon.
3350 *
3351 * @return Returns a newly created Intent that can be used to relaunch the
3352 * activity's task in its root state.
3353 */
3354 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3355 Intent intent = makeMainActivity(mainActivity);
3356 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3357 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3358 return intent;
3359 }
3360
3361 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003362 * Call {@link #parseUri} with 0 flags.
3363 * @deprecated Use {@link #parseUri} instead.
3364 */
3365 @Deprecated
3366 public static Intent getIntent(String uri) throws URISyntaxException {
3367 return parseUri(uri, 0);
3368 }
Tom Taylord4a47292009-12-21 13:59:18 -08003369
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003370 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003371 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003372 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003373 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003374 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003375 *
3376 * <p>The URI given here must not be relative -- that is, it must include
3377 * the scheme and full path.
3378 *
3379 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003380 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003381 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003382 *
3383 * @return Intent The newly created Intent object.
3384 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003385 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3386 * it bad (as parsed by the Uri class) or the Intent data within the
3387 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003388 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003389 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003390 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003391 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003392 int i = 0;
3393 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003394 // Validate intent scheme for if requested.
3395 if ((flags&URI_INTENT_SCHEME) != 0) {
3396 if (!uri.startsWith("intent:")) {
3397 Intent intent = new Intent(ACTION_VIEW);
3398 try {
3399 intent.setData(Uri.parse(uri));
3400 } catch (IllegalArgumentException e) {
3401 throw new URISyntaxException(uri, e.getMessage());
3402 }
3403 return intent;
3404 }
3405 }
Tom Taylord4a47292009-12-21 13:59:18 -08003406
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003407 // simple case
3408 i = uri.lastIndexOf("#");
3409 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3410
3411 // old format Intent URI
3412 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003413
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003414 // new format
3415 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003416 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003417
3418 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003419 String data = i >= 0 ? uri.substring(0, i) : null;
3420 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003421 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003422
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003423 // loop over contents of Intent, all name=value;
3424 while (!uri.startsWith("end", i)) {
3425 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003426 if (eq < 0) eq = i-1;
3427 int semi = uri.indexOf(';', i);
3428 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003429
3430 // action
3431 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003432 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003433 }
3434
3435 // categories
3436 else if (uri.startsWith("category=", i)) {
3437 intent.addCategory(value);
3438 }
3439
3440 // type
3441 else if (uri.startsWith("type=", i)) {
3442 intent.mType = value;
3443 }
3444
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003445 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003446 else if (uri.startsWith("launchFlags=", i)) {
3447 intent.mFlags = Integer.decode(value).intValue();
3448 }
3449
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003450 // package
3451 else if (uri.startsWith("package=", i)) {
3452 intent.mPackage = value;
3453 }
3454
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003455 // component
3456 else if (uri.startsWith("component=", i)) {
3457 intent.mComponent = ComponentName.unflattenFromString(value);
3458 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003459
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003460 // scheme
3461 else if (uri.startsWith("scheme=", i)) {
3462 scheme = value;
3463 }
3464
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003465 // source bounds
3466 else if (uri.startsWith("sourceBounds=", i)) {
3467 intent.mSourceBounds = Rect.unflattenFromString(value);
3468 }
3469
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003470 // selector
3471 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3472 intent = new Intent();
3473 }
3474
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003475 // extra
3476 else {
3477 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003478 // create Bundle if it doesn't already exist
3479 if (intent.mExtras == null) intent.mExtras = new Bundle();
3480 Bundle b = intent.mExtras;
3481 // add EXTRA
3482 if (uri.startsWith("S.", i)) b.putString(key, value);
3483 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3484 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3485 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3486 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3487 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3488 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3489 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3490 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3491 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3492 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003493
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003494 // move to the next item
3495 i = semi + 1;
3496 }
3497
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003498 if (intent != baseIntent) {
3499 // The Intent had a selector; fix it up.
3500 baseIntent.setSelector(intent);
3501 intent = baseIntent;
3502 }
3503
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003504 if (data != null) {
3505 if (data.startsWith("intent:")) {
3506 data = data.substring(7);
3507 if (scheme != null) {
3508 data = scheme + ':' + data;
3509 }
3510 }
Tom Taylord4a47292009-12-21 13:59:18 -08003511
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003512 if (data.length() > 0) {
3513 try {
3514 intent.mData = Uri.parse(data);
3515 } catch (IllegalArgumentException e) {
3516 throw new URISyntaxException(uri, e.getMessage());
3517 }
3518 }
3519 }
Tom Taylord4a47292009-12-21 13:59:18 -08003520
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003521 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003522
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003523 } catch (IndexOutOfBoundsException e) {
3524 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3525 }
3526 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003527
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003528 public static Intent getIntentOld(String uri) throws URISyntaxException {
3529 Intent intent;
3530
3531 int i = uri.lastIndexOf('#');
3532 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003533 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003534 final int intentFragmentStart = i;
3535 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003536
3537 i++;
3538
3539 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003540 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003541 i += 7;
3542 int j = uri.indexOf(')', i);
3543 action = uri.substring(i, j);
3544 i = j + 1;
3545 }
3546
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003547 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003548
3549 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003550 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003551 i += 11;
3552 int j = uri.indexOf(')', i);
3553 while (i < j) {
3554 int sep = uri.indexOf('!', i);
3555 if (sep < 0) sep = j;
3556 if (i < sep) {
3557 intent.addCategory(uri.substring(i, sep));
3558 }
3559 i = sep + 1;
3560 }
3561 i = j + 1;
3562 }
3563
3564 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003565 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003566 i += 5;
3567 int j = uri.indexOf(')', i);
3568 intent.mType = uri.substring(i, j);
3569 i = j + 1;
3570 }
3571
3572 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003573 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003574 i += 12;
3575 int j = uri.indexOf(')', i);
3576 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3577 i = j + 1;
3578 }
3579
3580 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003581 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003582 i += 10;
3583 int j = uri.indexOf(')', i);
3584 int sep = uri.indexOf('!', i);
3585 if (sep >= 0 && sep < j) {
3586 String pkg = uri.substring(i, sep);
3587 String cls = uri.substring(sep + 1, j);
3588 intent.mComponent = new ComponentName(pkg, cls);
3589 }
3590 i = j + 1;
3591 }
3592
3593 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003594 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003595 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003596
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003597 final int closeParen = uri.indexOf(')', i);
3598 if (closeParen == -1) throw new URISyntaxException(uri,
3599 "EXTRA missing trailing ')'", i);
3600
3601 while (i < closeParen) {
3602 // fetch the key value
3603 int j = uri.indexOf('=', i);
3604 if (j <= i + 1 || i >= closeParen) {
3605 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3606 }
3607 char type = uri.charAt(i);
3608 i++;
3609 String key = uri.substring(i, j);
3610 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003611
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003612 // get type-value
3613 j = uri.indexOf('!', i);
3614 if (j == -1 || j >= closeParen) j = closeParen;
3615 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3616 String value = uri.substring(i, j);
3617 i = j;
3618
3619 // create Bundle if it doesn't already exist
3620 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003621
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003622 // add item to bundle
3623 try {
3624 switch (type) {
3625 case 'S':
3626 intent.mExtras.putString(key, Uri.decode(value));
3627 break;
3628 case 'B':
3629 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3630 break;
3631 case 'b':
3632 intent.mExtras.putByte(key, Byte.parseByte(value));
3633 break;
3634 case 'c':
3635 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3636 break;
3637 case 'd':
3638 intent.mExtras.putDouble(key, Double.parseDouble(value));
3639 break;
3640 case 'f':
3641 intent.mExtras.putFloat(key, Float.parseFloat(value));
3642 break;
3643 case 'i':
3644 intent.mExtras.putInt(key, Integer.parseInt(value));
3645 break;
3646 case 'l':
3647 intent.mExtras.putLong(key, Long.parseLong(value));
3648 break;
3649 case 's':
3650 intent.mExtras.putShort(key, Short.parseShort(value));
3651 break;
3652 default:
3653 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3654 }
3655 } catch (NumberFormatException e) {
3656 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3657 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003658
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003659 char ch = uri.charAt(i);
3660 if (ch == ')') break;
3661 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3662 i++;
3663 }
3664 }
3665
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003666 if (isIntentFragment) {
3667 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3668 } else {
3669 intent.mData = Uri.parse(uri);
3670 }
Tom Taylord4a47292009-12-21 13:59:18 -08003671
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003672 if (intent.mAction == null) {
3673 // By default, if no action is specified, then use VIEW.
3674 intent.mAction = ACTION_VIEW;
3675 }
3676
3677 } else {
3678 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3679 }
3680
3681 return intent;
3682 }
3683
3684 /**
3685 * Retrieve the general action to be performed, such as
3686 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3687 * the information in the intent should be interpreted -- most importantly,
3688 * what to do with the data returned by {@link #getData}.
3689 *
3690 * @return The action of this intent or null if none is specified.
3691 *
3692 * @see #setAction
3693 */
3694 public String getAction() {
3695 return mAction;
3696 }
3697
3698 /**
3699 * Retrieve data this intent is operating on. This URI specifies the name
3700 * of the data; often it uses the content: scheme, specifying data in a
3701 * content provider. Other schemes may be handled by specific activities,
3702 * such as http: by the web browser.
3703 *
3704 * @return The URI of the data this intent is targeting or null.
3705 *
3706 * @see #getScheme
3707 * @see #setData
3708 */
3709 public Uri getData() {
3710 return mData;
3711 }
3712
3713 /**
3714 * The same as {@link #getData()}, but returns the URI as an encoded
3715 * String.
3716 */
3717 public String getDataString() {
3718 return mData != null ? mData.toString() : null;
3719 }
3720
3721 /**
3722 * Return the scheme portion of the intent's data. If the data is null or
3723 * does not include a scheme, null is returned. Otherwise, the scheme
3724 * prefix without the final ':' is returned, i.e. "http".
3725 *
3726 * <p>This is the same as calling getData().getScheme() (and checking for
3727 * null data).
3728 *
3729 * @return The scheme of this intent.
3730 *
3731 * @see #getData
3732 */
3733 public String getScheme() {
3734 return mData != null ? mData.getScheme() : null;
3735 }
3736
3737 /**
3738 * Retrieve any explicit MIME type included in the intent. This is usually
3739 * null, as the type is determined by the intent data.
3740 *
3741 * @return If a type was manually set, it is returned; else null is
3742 * returned.
3743 *
3744 * @see #resolveType(ContentResolver)
3745 * @see #setType
3746 */
3747 public String getType() {
3748 return mType;
3749 }
3750
3751 /**
3752 * Return the MIME data type of this intent. If the type field is
3753 * explicitly set, that is simply returned. Otherwise, if the data is set,
3754 * the type of that data is returned. If neither fields are set, a null is
3755 * returned.
3756 *
3757 * @return The MIME type of this intent.
3758 *
3759 * @see #getType
3760 * @see #resolveType(ContentResolver)
3761 */
3762 public String resolveType(Context context) {
3763 return resolveType(context.getContentResolver());
3764 }
3765
3766 /**
3767 * Return the MIME data type of this intent. If the type field is
3768 * explicitly set, that is simply returned. Otherwise, if the data is set,
3769 * the type of that data is returned. If neither fields are set, a null is
3770 * returned.
3771 *
3772 * @param resolver A ContentResolver that can be used to determine the MIME
3773 * type of the intent's data.
3774 *
3775 * @return The MIME type of this intent.
3776 *
3777 * @see #getType
3778 * @see #resolveType(Context)
3779 */
3780 public String resolveType(ContentResolver resolver) {
3781 if (mType != null) {
3782 return mType;
3783 }
3784 if (mData != null) {
3785 if ("content".equals(mData.getScheme())) {
3786 return resolver.getType(mData);
3787 }
3788 }
3789 return null;
3790 }
3791
3792 /**
3793 * Return the MIME data type of this intent, only if it will be needed for
3794 * intent resolution. This is not generally useful for application code;
3795 * it is used by the frameworks for communicating with back-end system
3796 * services.
3797 *
3798 * @param resolver A ContentResolver that can be used to determine the MIME
3799 * type of the intent's data.
3800 *
3801 * @return The MIME type of this intent, or null if it is unknown or not
3802 * needed.
3803 */
3804 public String resolveTypeIfNeeded(ContentResolver resolver) {
3805 if (mComponent != null) {
3806 return mType;
3807 }
3808 return resolveType(resolver);
3809 }
3810
3811 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003812 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003813 *
3814 * @param category The category to check.
3815 *
3816 * @return boolean True if the intent contains the category, else false.
3817 *
3818 * @see #getCategories
3819 * @see #addCategory
3820 */
3821 public boolean hasCategory(String category) {
3822 return mCategories != null && mCategories.contains(category);
3823 }
3824
3825 /**
3826 * Return the set of all categories in the intent. If there are no categories,
3827 * returns NULL.
3828 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003829 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003830 *
3831 * @see #hasCategory
3832 * @see #addCategory
3833 */
3834 public Set<String> getCategories() {
3835 return mCategories;
3836 }
3837
3838 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003839 * Return the specific selector associated with this Intent. If there is
3840 * none, returns null. See {@link #setSelector} for more information.
3841 *
3842 * @see #setSelector
3843 */
3844 public Intent getSelector() {
3845 return mSelector;
3846 }
3847
3848 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003849 * Return the {@link ClipData} associated with this Intent. If there is
3850 * none, returns null. See {@link #setClipData} for more information.
3851 *
3852 * @see #setClipData;
3853 */
3854 public ClipData getClipData() {
3855 return mClipData;
3856 }
3857
3858 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003859 * Sets the ClassLoader that will be used when unmarshalling
3860 * any Parcelable values from the extras of this Intent.
3861 *
3862 * @param loader a ClassLoader, or null to use the default loader
3863 * at the time of unmarshalling.
3864 */
3865 public void setExtrasClassLoader(ClassLoader loader) {
3866 if (mExtras != null) {
3867 mExtras.setClassLoader(loader);
3868 }
3869 }
3870
3871 /**
3872 * Returns true if an extra value is associated with the given name.
3873 * @param name the extra's name
3874 * @return true if the given extra is present.
3875 */
3876 public boolean hasExtra(String name) {
3877 return mExtras != null && mExtras.containsKey(name);
3878 }
3879
3880 /**
3881 * Returns true if the Intent's extras contain a parcelled file descriptor.
3882 * @return true if the Intent contains a parcelled file descriptor.
3883 */
3884 public boolean hasFileDescriptors() {
3885 return mExtras != null && mExtras.hasFileDescriptors();
3886 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003887
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003888 /** @hide */
3889 public void setAllowFds(boolean allowFds) {
3890 if (mExtras != null) {
3891 mExtras.setAllowFds(allowFds);
3892 }
3893 }
3894
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003895 /**
3896 * Retrieve extended data from the intent.
3897 *
3898 * @param name The name of the desired item.
3899 *
3900 * @return the value of an item that previously added with putExtra()
3901 * or null if none was found.
3902 *
3903 * @deprecated
3904 * @hide
3905 */
3906 @Deprecated
3907 public Object getExtra(String name) {
3908 return getExtra(name, null);
3909 }
3910
3911 /**
3912 * Retrieve extended data from the intent.
3913 *
3914 * @param name The name of the desired item.
3915 * @param defaultValue the value to be returned if no value of the desired
3916 * type is stored with the given name.
3917 *
3918 * @return the value of an item that previously added with putExtra()
3919 * or the default value if none was found.
3920 *
3921 * @see #putExtra(String, boolean)
3922 */
3923 public boolean getBooleanExtra(String name, boolean defaultValue) {
3924 return mExtras == null ? defaultValue :
3925 mExtras.getBoolean(name, defaultValue);
3926 }
3927
3928 /**
3929 * Retrieve extended data from the intent.
3930 *
3931 * @param name The name of the desired item.
3932 * @param defaultValue the value to be returned if no value of the desired
3933 * type is stored with the given name.
3934 *
3935 * @return the value of an item that previously added with putExtra()
3936 * or the default value if none was found.
3937 *
3938 * @see #putExtra(String, byte)
3939 */
3940 public byte getByteExtra(String name, byte defaultValue) {
3941 return mExtras == null ? defaultValue :
3942 mExtras.getByte(name, defaultValue);
3943 }
3944
3945 /**
3946 * Retrieve extended data from the intent.
3947 *
3948 * @param name The name of the desired item.
3949 * @param defaultValue the value to be returned if no value of the desired
3950 * type is stored with the given name.
3951 *
3952 * @return the value of an item that previously added with putExtra()
3953 * or the default value if none was found.
3954 *
3955 * @see #putExtra(String, short)
3956 */
3957 public short getShortExtra(String name, short defaultValue) {
3958 return mExtras == null ? defaultValue :
3959 mExtras.getShort(name, defaultValue);
3960 }
3961
3962 /**
3963 * Retrieve extended data from the intent.
3964 *
3965 * @param name The name of the desired item.
3966 * @param defaultValue the value to be returned if no value of the desired
3967 * type is stored with the given name.
3968 *
3969 * @return the value of an item that previously added with putExtra()
3970 * or the default value if none was found.
3971 *
3972 * @see #putExtra(String, char)
3973 */
3974 public char getCharExtra(String name, char defaultValue) {
3975 return mExtras == null ? defaultValue :
3976 mExtras.getChar(name, defaultValue);
3977 }
3978
3979 /**
3980 * Retrieve extended data from the intent.
3981 *
3982 * @param name The name of the desired item.
3983 * @param defaultValue the value to be returned if no value of the desired
3984 * type is stored with the given name.
3985 *
3986 * @return the value of an item that previously added with putExtra()
3987 * or the default value if none was found.
3988 *
3989 * @see #putExtra(String, int)
3990 */
3991 public int getIntExtra(String name, int defaultValue) {
3992 return mExtras == null ? defaultValue :
3993 mExtras.getInt(name, defaultValue);
3994 }
3995
3996 /**
3997 * Retrieve extended data from the intent.
3998 *
3999 * @param name The name of the desired item.
4000 * @param defaultValue the value to be returned if no value of the desired
4001 * type is stored with the given name.
4002 *
4003 * @return the value of an item that previously added with putExtra()
4004 * or the default value if none was found.
4005 *
4006 * @see #putExtra(String, long)
4007 */
4008 public long getLongExtra(String name, long defaultValue) {
4009 return mExtras == null ? defaultValue :
4010 mExtras.getLong(name, defaultValue);
4011 }
4012
4013 /**
4014 * Retrieve extended data from the intent.
4015 *
4016 * @param name The name of the desired item.
4017 * @param defaultValue the value to be returned if no value of the desired
4018 * type is stored with the given name.
4019 *
4020 * @return the value of an item that previously added with putExtra(),
4021 * or the default value if no such item is present
4022 *
4023 * @see #putExtra(String, float)
4024 */
4025 public float getFloatExtra(String name, float defaultValue) {
4026 return mExtras == null ? defaultValue :
4027 mExtras.getFloat(name, defaultValue);
4028 }
4029
4030 /**
4031 * Retrieve extended data from the intent.
4032 *
4033 * @param name The name of the desired item.
4034 * @param defaultValue the value to be returned if no value of the desired
4035 * type is stored with the given name.
4036 *
4037 * @return the value of an item that previously added with putExtra()
4038 * or the default value if none was found.
4039 *
4040 * @see #putExtra(String, double)
4041 */
4042 public double getDoubleExtra(String name, double defaultValue) {
4043 return mExtras == null ? defaultValue :
4044 mExtras.getDouble(name, defaultValue);
4045 }
4046
4047 /**
4048 * Retrieve extended data from the intent.
4049 *
4050 * @param name The name of the desired item.
4051 *
4052 * @return the value of an item that previously added with putExtra()
4053 * or null if no String value was found.
4054 *
4055 * @see #putExtra(String, String)
4056 */
4057 public String getStringExtra(String name) {
4058 return mExtras == null ? null : mExtras.getString(name);
4059 }
4060
4061 /**
4062 * Retrieve extended data from the intent.
4063 *
4064 * @param name The name of the desired item.
4065 *
4066 * @return the value of an item that previously added with putExtra()
4067 * or null if no CharSequence value was found.
4068 *
4069 * @see #putExtra(String, CharSequence)
4070 */
4071 public CharSequence getCharSequenceExtra(String name) {
4072 return mExtras == null ? null : mExtras.getCharSequence(name);
4073 }
4074
4075 /**
4076 * Retrieve extended data from the intent.
4077 *
4078 * @param name The name of the desired item.
4079 *
4080 * @return the value of an item that previously added with putExtra()
4081 * or null if no Parcelable value was found.
4082 *
4083 * @see #putExtra(String, Parcelable)
4084 */
4085 public <T extends Parcelable> T getParcelableExtra(String name) {
4086 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4087 }
4088
4089 /**
4090 * Retrieve extended data from the intent.
4091 *
4092 * @param name The name of the desired item.
4093 *
4094 * @return the value of an item that previously added with putExtra()
4095 * or null if no Parcelable[] value was found.
4096 *
4097 * @see #putExtra(String, Parcelable[])
4098 */
4099 public Parcelable[] getParcelableArrayExtra(String name) {
4100 return mExtras == null ? null : mExtras.getParcelableArray(name);
4101 }
4102
4103 /**
4104 * Retrieve extended data from the intent.
4105 *
4106 * @param name The name of the desired item.
4107 *
4108 * @return the value of an item that previously added with putExtra()
4109 * or null if no ArrayList<Parcelable> value was found.
4110 *
4111 * @see #putParcelableArrayListExtra(String, ArrayList)
4112 */
4113 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4114 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4115 }
4116
4117 /**
4118 * Retrieve extended data from the intent.
4119 *
4120 * @param name The name of the desired item.
4121 *
4122 * @return the value of an item that previously added with putExtra()
4123 * or null if no Serializable value was found.
4124 *
4125 * @see #putExtra(String, Serializable)
4126 */
4127 public Serializable getSerializableExtra(String name) {
4128 return mExtras == null ? null : mExtras.getSerializable(name);
4129 }
4130
4131 /**
4132 * Retrieve extended data from the intent.
4133 *
4134 * @param name The name of the desired item.
4135 *
4136 * @return the value of an item that previously added with putExtra()
4137 * or null if no ArrayList<Integer> value was found.
4138 *
4139 * @see #putIntegerArrayListExtra(String, ArrayList)
4140 */
4141 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4142 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4143 }
4144
4145 /**
4146 * Retrieve extended data from the intent.
4147 *
4148 * @param name The name of the desired item.
4149 *
4150 * @return the value of an item that previously added with putExtra()
4151 * or null if no ArrayList<String> value was found.
4152 *
4153 * @see #putStringArrayListExtra(String, ArrayList)
4154 */
4155 public ArrayList<String> getStringArrayListExtra(String name) {
4156 return mExtras == null ? null : mExtras.getStringArrayList(name);
4157 }
4158
4159 /**
4160 * Retrieve extended data from the intent.
4161 *
4162 * @param name The name of the desired item.
4163 *
4164 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004165 * or null if no ArrayList<CharSequence> value was found.
4166 *
4167 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4168 */
4169 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4170 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4171 }
4172
4173 /**
4174 * Retrieve extended data from the intent.
4175 *
4176 * @param name The name of the desired item.
4177 *
4178 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004179 * or null if no boolean array value was found.
4180 *
4181 * @see #putExtra(String, boolean[])
4182 */
4183 public boolean[] getBooleanArrayExtra(String name) {
4184 return mExtras == null ? null : mExtras.getBooleanArray(name);
4185 }
4186
4187 /**
4188 * Retrieve extended data from the intent.
4189 *
4190 * @param name The name of the desired item.
4191 *
4192 * @return the value of an item that previously added with putExtra()
4193 * or null if no byte array value was found.
4194 *
4195 * @see #putExtra(String, byte[])
4196 */
4197 public byte[] getByteArrayExtra(String name) {
4198 return mExtras == null ? null : mExtras.getByteArray(name);
4199 }
4200
4201 /**
4202 * Retrieve extended data from the intent.
4203 *
4204 * @param name The name of the desired item.
4205 *
4206 * @return the value of an item that previously added with putExtra()
4207 * or null if no short array value was found.
4208 *
4209 * @see #putExtra(String, short[])
4210 */
4211 public short[] getShortArrayExtra(String name) {
4212 return mExtras == null ? null : mExtras.getShortArray(name);
4213 }
4214
4215 /**
4216 * Retrieve extended data from the intent.
4217 *
4218 * @param name The name of the desired item.
4219 *
4220 * @return the value of an item that previously added with putExtra()
4221 * or null if no char array value was found.
4222 *
4223 * @see #putExtra(String, char[])
4224 */
4225 public char[] getCharArrayExtra(String name) {
4226 return mExtras == null ? null : mExtras.getCharArray(name);
4227 }
4228
4229 /**
4230 * Retrieve extended data from the intent.
4231 *
4232 * @param name The name of the desired item.
4233 *
4234 * @return the value of an item that previously added with putExtra()
4235 * or null if no int array value was found.
4236 *
4237 * @see #putExtra(String, int[])
4238 */
4239 public int[] getIntArrayExtra(String name) {
4240 return mExtras == null ? null : mExtras.getIntArray(name);
4241 }
4242
4243 /**
4244 * Retrieve extended data from the intent.
4245 *
4246 * @param name The name of the desired item.
4247 *
4248 * @return the value of an item that previously added with putExtra()
4249 * or null if no long array value was found.
4250 *
4251 * @see #putExtra(String, long[])
4252 */
4253 public long[] getLongArrayExtra(String name) {
4254 return mExtras == null ? null : mExtras.getLongArray(name);
4255 }
4256
4257 /**
4258 * Retrieve extended data from the intent.
4259 *
4260 * @param name The name of the desired item.
4261 *
4262 * @return the value of an item that previously added with putExtra()
4263 * or null if no float array value was found.
4264 *
4265 * @see #putExtra(String, float[])
4266 */
4267 public float[] getFloatArrayExtra(String name) {
4268 return mExtras == null ? null : mExtras.getFloatArray(name);
4269 }
4270
4271 /**
4272 * Retrieve extended data from the intent.
4273 *
4274 * @param name The name of the desired item.
4275 *
4276 * @return the value of an item that previously added with putExtra()
4277 * or null if no double array value was found.
4278 *
4279 * @see #putExtra(String, double[])
4280 */
4281 public double[] getDoubleArrayExtra(String name) {
4282 return mExtras == null ? null : mExtras.getDoubleArray(name);
4283 }
4284
4285 /**
4286 * Retrieve extended data from the intent.
4287 *
4288 * @param name The name of the desired item.
4289 *
4290 * @return the value of an item that previously added with putExtra()
4291 * or null if no String array value was found.
4292 *
4293 * @see #putExtra(String, String[])
4294 */
4295 public String[] getStringArrayExtra(String name) {
4296 return mExtras == null ? null : mExtras.getStringArray(name);
4297 }
4298
4299 /**
4300 * Retrieve extended data from the intent.
4301 *
4302 * @param name The name of the desired item.
4303 *
4304 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004305 * or null if no CharSequence array value was found.
4306 *
4307 * @see #putExtra(String, CharSequence[])
4308 */
4309 public CharSequence[] getCharSequenceArrayExtra(String name) {
4310 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4311 }
4312
4313 /**
4314 * Retrieve extended data from the intent.
4315 *
4316 * @param name The name of the desired item.
4317 *
4318 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004319 * or null if no Bundle value was found.
4320 *
4321 * @see #putExtra(String, Bundle)
4322 */
4323 public Bundle getBundleExtra(String name) {
4324 return mExtras == null ? null : mExtras.getBundle(name);
4325 }
4326
4327 /**
4328 * Retrieve extended data from the intent.
4329 *
4330 * @param name The name of the desired item.
4331 *
4332 * @return the value of an item that previously added with putExtra()
4333 * or null if no IBinder value was found.
4334 *
4335 * @see #putExtra(String, IBinder)
4336 *
4337 * @deprecated
4338 * @hide
4339 */
4340 @Deprecated
4341 public IBinder getIBinderExtra(String name) {
4342 return mExtras == null ? null : mExtras.getIBinder(name);
4343 }
4344
4345 /**
4346 * Retrieve extended data from the intent.
4347 *
4348 * @param name The name of the desired item.
4349 * @param defaultValue The default value to return in case no item is
4350 * associated with the key 'name'
4351 *
4352 * @return the value of an item that previously added with putExtra()
4353 * or defaultValue if none was found.
4354 *
4355 * @see #putExtra
4356 *
4357 * @deprecated
4358 * @hide
4359 */
4360 @Deprecated
4361 public Object getExtra(String name, Object defaultValue) {
4362 Object result = defaultValue;
4363 if (mExtras != null) {
4364 Object result2 = mExtras.get(name);
4365 if (result2 != null) {
4366 result = result2;
4367 }
4368 }
4369
4370 return result;
4371 }
4372
4373 /**
4374 * Retrieves a map of extended data from the intent.
4375 *
4376 * @return the map of all extras previously added with putExtra(),
4377 * or null if none have been added.
4378 */
4379 public Bundle getExtras() {
4380 return (mExtras != null)
4381 ? new Bundle(mExtras)
4382 : null;
4383 }
4384
4385 /**
4386 * Retrieve any special flags associated with this intent. You will
4387 * normally just set them with {@link #setFlags} and let the system
4388 * take the appropriate action with them.
4389 *
4390 * @return int The currently set flags.
4391 *
4392 * @see #setFlags
4393 */
4394 public int getFlags() {
4395 return mFlags;
4396 }
4397
Dianne Hackborne7f97212011-02-24 14:40:20 -08004398 /** @hide */
4399 public boolean isExcludingStopped() {
4400 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4401 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4402 }
4403
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004404 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004405 * Retrieve the application package name this Intent is limited to. When
4406 * resolving an Intent, if non-null this limits the resolution to only
4407 * components in the given application package.
4408 *
4409 * @return The name of the application package for the Intent.
4410 *
4411 * @see #resolveActivity
4412 * @see #setPackage
4413 */
4414 public String getPackage() {
4415 return mPackage;
4416 }
4417
4418 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004419 * Retrieve the concrete component associated with the intent. When receiving
4420 * an intent, this is the component that was found to best handle it (that is,
4421 * yourself) and will always be non-null; in all other cases it will be
4422 * null unless explicitly set.
4423 *
4424 * @return The name of the application component to handle the intent.
4425 *
4426 * @see #resolveActivity
4427 * @see #setComponent
4428 */
4429 public ComponentName getComponent() {
4430 return mComponent;
4431 }
4432
4433 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004434 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4435 * used as a hint to the receiver for animations and the like. Null means that there
4436 * is no source bounds.
4437 */
4438 public Rect getSourceBounds() {
4439 return mSourceBounds;
4440 }
4441
4442 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004443 * Return the Activity component that should be used to handle this intent.
4444 * The appropriate component is determined based on the information in the
4445 * intent, evaluated as follows:
4446 *
4447 * <p>If {@link #getComponent} returns an explicit class, that is returned
4448 * without any further consideration.
4449 *
4450 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4451 * category to be considered.
4452 *
4453 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4454 * action.
4455 *
4456 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4457 * this type.
4458 *
4459 * <p>If {@link #addCategory} has added any categories, the activity must
4460 * handle ALL of the categories specified.
4461 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004462 * <p>If {@link #getPackage} is non-NULL, only activity components in
4463 * that application package will be considered.
4464 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004465 * <p>If there are no activities that satisfy all of these conditions, a
4466 * null string is returned.
4467 *
4468 * <p>If multiple activities are found to satisfy the intent, the one with
4469 * the highest priority will be used. If there are multiple activities
4470 * with the same priority, the system will either pick the best activity
4471 * based on user preference, or resolve to a system class that will allow
4472 * the user to pick an activity and forward from there.
4473 *
4474 * <p>This method is implemented simply by calling
4475 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4476 * true.</p>
4477 * <p> This API is called for you as part of starting an activity from an
4478 * intent. You do not normally need to call it yourself.</p>
4479 *
4480 * @param pm The package manager with which to resolve the Intent.
4481 *
4482 * @return Name of the component implementing an activity that can
4483 * display the intent.
4484 *
4485 * @see #setComponent
4486 * @see #getComponent
4487 * @see #resolveActivityInfo
4488 */
4489 public ComponentName resolveActivity(PackageManager pm) {
4490 if (mComponent != null) {
4491 return mComponent;
4492 }
4493
4494 ResolveInfo info = pm.resolveActivity(
4495 this, PackageManager.MATCH_DEFAULT_ONLY);
4496 if (info != null) {
4497 return new ComponentName(
4498 info.activityInfo.applicationInfo.packageName,
4499 info.activityInfo.name);
4500 }
4501
4502 return null;
4503 }
4504
4505 /**
4506 * Resolve the Intent into an {@link ActivityInfo}
4507 * describing the activity that should execute the intent. Resolution
4508 * follows the same rules as described for {@link #resolveActivity}, but
4509 * you get back the completely information about the resolved activity
4510 * instead of just its class name.
4511 *
4512 * @param pm The package manager with which to resolve the Intent.
4513 * @param flags Addition information to retrieve as per
4514 * {@link PackageManager#getActivityInfo(ComponentName, int)
4515 * PackageManager.getActivityInfo()}.
4516 *
4517 * @return PackageManager.ActivityInfo
4518 *
4519 * @see #resolveActivity
4520 */
4521 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4522 ActivityInfo ai = null;
4523 if (mComponent != null) {
4524 try {
4525 ai = pm.getActivityInfo(mComponent, flags);
4526 } catch (PackageManager.NameNotFoundException e) {
4527 // ignore
4528 }
4529 } else {
4530 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004531 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004532 if (info != null) {
4533 ai = info.activityInfo;
4534 }
4535 }
4536
4537 return ai;
4538 }
4539
4540 /**
4541 * Set the general action to be performed.
4542 *
4543 * @param action An action name, such as ACTION_VIEW. Application-specific
4544 * actions should be prefixed with the vendor's package name.
4545 *
4546 * @return Returns the same Intent object, for chaining multiple calls
4547 * into a single statement.
4548 *
4549 * @see #getAction
4550 */
4551 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004552 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004553 return this;
4554 }
4555
4556 /**
4557 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004558 * clears any type that was previously set by {@link #setType} or
4559 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004560 *
Nick Pellyccae4122012-01-09 14:12:58 -08004561 * <p><em>Note: scheme matching in the Android framework is
4562 * case-sensitive, unlike the formal RFC. As a result,
4563 * you should always write your Uri with a lower case scheme,
4564 * or use {@link Uri#normalize} or
4565 * {@link #setDataAndNormalize}
4566 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004567 *
Nick Pellyccae4122012-01-09 14:12:58 -08004568 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004569 *
4570 * @return Returns the same Intent object, for chaining multiple calls
4571 * into a single statement.
4572 *
4573 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004574 * @see #setDataAndNormalize
4575 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004576 */
4577 public Intent setData(Uri data) {
4578 mData = data;
4579 mType = null;
4580 return this;
4581 }
4582
4583 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004584 * Normalize and set the data this intent is operating on.
4585 *
4586 * <p>This method automatically clears any type that was
4587 * previously set (for example, by {@link #setType}).
4588 *
4589 * <p>The data Uri is normalized using
4590 * {@link android.net.Uri#normalize} before it is set,
4591 * so really this is just a convenience method for
4592 * <pre>
4593 * setData(data.normalize())
4594 * </pre>
4595 *
4596 * @param data The Uri of the data this intent is now targeting.
4597 *
4598 * @return Returns the same Intent object, for chaining multiple calls
4599 * into a single statement.
4600 *
4601 * @see #getData
4602 * @see #setType
4603 * @see android.net.Uri#normalize
4604 */
4605 public Intent setDataAndNormalize(Uri data) {
4606 return setData(data.normalize());
4607 }
4608
4609 /**
4610 * Set an explicit MIME data type.
4611 *
4612 * <p>This is used to create intents that only specify a type and not data,
4613 * for example to indicate the type of data to return.
4614 *
4615 * <p>This method automatically clears any data that was
4616 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004617 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004618 * <p><em>Note: MIME type matching in the Android framework is
4619 * case-sensitive, unlike formal RFC MIME types. As a result,
4620 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004621 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4622 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004623 *
4624 * @param type The MIME type of the data being handled by this intent.
4625 *
4626 * @return Returns the same Intent object, for chaining multiple calls
4627 * into a single statement.
4628 *
4629 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004630 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004631 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004632 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004633 */
4634 public Intent setType(String type) {
4635 mData = null;
4636 mType = type;
4637 return this;
4638 }
4639
4640 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004641 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004642 *
Nick Pellyccae4122012-01-09 14:12:58 -08004643 * <p>This is used to create intents that only specify a type and not data,
4644 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004645 *
Nick Pellyccae4122012-01-09 14:12:58 -08004646 * <p>This method automatically clears any data that was
4647 * previously set (for example by {@link #setData}).
4648 *
4649 * <p>The MIME type is normalized using
4650 * {@link #normalizeMimeType} before it is set,
4651 * so really this is just a convenience method for
4652 * <pre>
4653 * setType(Intent.normalizeMimeType(type))
4654 * </pre>
4655 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004656 * @param type The MIME type of the data being handled by this intent.
4657 *
4658 * @return Returns the same Intent object, for chaining multiple calls
4659 * into a single statement.
4660 *
Nick Pellyccae4122012-01-09 14:12:58 -08004661 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004662 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004663 * @see #normalizeMimeType
4664 */
4665 public Intent setTypeAndNormalize(String type) {
4666 return setType(normalizeMimeType(type));
4667 }
4668
4669 /**
4670 * (Usually optional) Set the data for the intent along with an explicit
4671 * MIME data type. This method should very rarely be used -- it allows you
4672 * to override the MIME type that would ordinarily be inferred from the
4673 * data with your own type given here.
4674 *
4675 * <p><em>Note: MIME type and Uri scheme matching in the
4676 * Android framework is case-sensitive, unlike the formal RFC definitions.
4677 * As a result, you should always write these elements with lower case letters,
4678 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalize} or
4679 * {@link #setDataAndTypeAndNormalize}
4680 * to ensure that they are converted to lower case.</em>
4681 *
4682 * @param data The Uri of the data this intent is now targeting.
4683 * @param type The MIME type of the data being handled by this intent.
4684 *
4685 * @return Returns the same Intent object, for chaining multiple calls
4686 * into a single statement.
4687 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004688 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004689 * @see #setData
4690 * @see #normalizeMimeType
4691 * @see android.net.Uri#normalize
4692 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004693 */
4694 public Intent setDataAndType(Uri data, String type) {
4695 mData = data;
4696 mType = type;
4697 return this;
4698 }
4699
4700 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004701 * (Usually optional) Normalize and set both the data Uri and an explicit
4702 * MIME data type. This method should very rarely be used -- it allows you
4703 * to override the MIME type that would ordinarily be inferred from the
4704 * data with your own type given here.
4705 *
4706 * <p>The data Uri and the MIME type are normalize using
4707 * {@link android.net.Uri#normalize} and {@link #normalizeMimeType}
4708 * before they are set, so really this is just a convenience method for
4709 * <pre>
4710 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4711 * </pre>
4712 *
4713 * @param data The Uri of the data this intent is now targeting.
4714 * @param type The MIME type of the data being handled by this intent.
4715 *
4716 * @return Returns the same Intent object, for chaining multiple calls
4717 * into a single statement.
4718 *
4719 * @see #setType
4720 * @see #setData
4721 * @see #setDataAndType
4722 * @see #normalizeMimeType
4723 * @see android.net.Uri#normalize
4724 */
4725 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
4726 return setDataAndType(data.normalize(), normalizeMimeType(type));
4727 }
4728
4729 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004730 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004731 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004732 * activities that provide <em>all</em> of the requested categories will be
4733 * used.
4734 *
4735 * @param category The desired category. This can be either one of the
4736 * predefined Intent categories, or a custom category in your own
4737 * namespace.
4738 *
4739 * @return Returns the same Intent object, for chaining multiple calls
4740 * into a single statement.
4741 *
4742 * @see #hasCategory
4743 * @see #removeCategory
4744 */
4745 public Intent addCategory(String category) {
4746 if (mCategories == null) {
4747 mCategories = new HashSet<String>();
4748 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004749 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004750 return this;
4751 }
4752
4753 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004754 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004755 *
4756 * @param category The category to remove.
4757 *
4758 * @see #addCategory
4759 */
4760 public void removeCategory(String category) {
4761 if (mCategories != null) {
4762 mCategories.remove(category);
4763 if (mCategories.size() == 0) {
4764 mCategories = null;
4765 }
4766 }
4767 }
4768
4769 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004770 * Set a selector for this Intent. This is a modification to the kinds of
4771 * things the Intent will match. If the selector is set, it will be used
4772 * when trying to find entities that can handle the Intent, instead of the
4773 * main contents of the Intent. This allows you build an Intent containing
4774 * a generic protocol while targeting it more specifically.
4775 *
4776 * <p>An example of where this may be used is with things like
4777 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
4778 * Intent that will launch the Browser application. However, the correct
4779 * main entry point of an application is actually {@link #ACTION_MAIN}
4780 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
4781 * used to specify the actual Activity to launch. If you launch the browser
4782 * with something different, undesired behavior may happen if the user has
4783 * previously or later launches it the normal way, since they do not match.
4784 * Instead, you can build an Intent with the MAIN action (but no ComponentName
4785 * yet specified) and set a selector with {@link #ACTION_MAIN} and
4786 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
4787 *
4788 * <p>Setting a selector does not impact the behavior of
4789 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
4790 * desired behavior of a selector -- it does not impact the base meaning
4791 * of the Intent, just what kinds of things will be matched against it
4792 * when determining who can handle it.</p>
4793 *
4794 * <p>You can not use both a selector and {@link #setPackage(String)} on
4795 * the same base Intent.</p>
4796 *
4797 * @param selector The desired selector Intent; set to null to not use
4798 * a special selector.
4799 */
4800 public void setSelector(Intent selector) {
4801 if (selector == this) {
4802 throw new IllegalArgumentException(
4803 "Intent being set as a selector of itself");
4804 }
4805 if (selector != null && mPackage != null) {
4806 throw new IllegalArgumentException(
4807 "Can't set selector when package name is already set");
4808 }
4809 mSelector = selector;
4810 }
4811
4812 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004813 * Set a {@link ClipData} associated with this Intent. This replaces any
4814 * previously set ClipData.
4815 *
4816 * <p>The ClipData in an intent is not used for Intent matching or other
4817 * such operations. Semantically it is like extras, used to transmit
4818 * additional data with the Intent. The main feature of using this over
4819 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
4820 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
4821 * items included in the clip data. This is useful, in particular, if
4822 * you want to transmit an Intent containing multiple <code>content:</code>
4823 * URIs for which the recipient may not have global permission to access the
4824 * content provider.
4825 *
4826 * <p>If the ClipData contains items that are themselves Intents, any
4827 * grant flags in those Intents will be ignored. Only the top-level flags
4828 * of the main Intent are respected, and will be applied to all Uri or
4829 * Intent items in the clip (or sub-items of the clip).
4830 *
4831 * <p>The MIME type, label, and icon in the ClipData object are not
4832 * directly used by Intent. Applications should generally rely on the
4833 * MIME type of the Intent itself, not what it may find in the ClipData.
4834 * A common practice is to construct a ClipData for use with an Intent
4835 * with a MIME type of "*\/*".
4836 *
4837 * @param clip The new clip to set. May be null to clear the current clip.
4838 */
4839 public void setClipData(ClipData clip) {
4840 mClipData = clip;
4841 }
4842
4843 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004844 * Add extended data to the intent. The name must include a package
4845 * prefix, for example the app com.android.contacts would use names
4846 * like "com.android.contacts.ShowAll".
4847 *
4848 * @param name The name of the extra data, with package prefix.
4849 * @param value The boolean data value.
4850 *
4851 * @return Returns the same Intent object, for chaining multiple calls
4852 * into a single statement.
4853 *
4854 * @see #putExtras
4855 * @see #removeExtra
4856 * @see #getBooleanExtra(String, boolean)
4857 */
4858 public Intent putExtra(String name, boolean value) {
4859 if (mExtras == null) {
4860 mExtras = new Bundle();
4861 }
4862 mExtras.putBoolean(name, value);
4863 return this;
4864 }
4865
4866 /**
4867 * Add extended data to the intent. The name must include a package
4868 * prefix, for example the app com.android.contacts would use names
4869 * like "com.android.contacts.ShowAll".
4870 *
4871 * @param name The name of the extra data, with package prefix.
4872 * @param value The byte data value.
4873 *
4874 * @return Returns the same Intent object, for chaining multiple calls
4875 * into a single statement.
4876 *
4877 * @see #putExtras
4878 * @see #removeExtra
4879 * @see #getByteExtra(String, byte)
4880 */
4881 public Intent putExtra(String name, byte value) {
4882 if (mExtras == null) {
4883 mExtras = new Bundle();
4884 }
4885 mExtras.putByte(name, value);
4886 return this;
4887 }
4888
4889 /**
4890 * Add extended data to the intent. The name must include a package
4891 * prefix, for example the app com.android.contacts would use names
4892 * like "com.android.contacts.ShowAll".
4893 *
4894 * @param name The name of the extra data, with package prefix.
4895 * @param value The char data value.
4896 *
4897 * @return Returns the same Intent object, for chaining multiple calls
4898 * into a single statement.
4899 *
4900 * @see #putExtras
4901 * @see #removeExtra
4902 * @see #getCharExtra(String, char)
4903 */
4904 public Intent putExtra(String name, char value) {
4905 if (mExtras == null) {
4906 mExtras = new Bundle();
4907 }
4908 mExtras.putChar(name, value);
4909 return this;
4910 }
4911
4912 /**
4913 * Add extended data to the intent. The name must include a package
4914 * prefix, for example the app com.android.contacts would use names
4915 * like "com.android.contacts.ShowAll".
4916 *
4917 * @param name The name of the extra data, with package prefix.
4918 * @param value The short data value.
4919 *
4920 * @return Returns the same Intent object, for chaining multiple calls
4921 * into a single statement.
4922 *
4923 * @see #putExtras
4924 * @see #removeExtra
4925 * @see #getShortExtra(String, short)
4926 */
4927 public Intent putExtra(String name, short value) {
4928 if (mExtras == null) {
4929 mExtras = new Bundle();
4930 }
4931 mExtras.putShort(name, value);
4932 return this;
4933 }
4934
4935 /**
4936 * Add extended data to the intent. The name must include a package
4937 * prefix, for example the app com.android.contacts would use names
4938 * like "com.android.contacts.ShowAll".
4939 *
4940 * @param name The name of the extra data, with package prefix.
4941 * @param value The integer data value.
4942 *
4943 * @return Returns the same Intent object, for chaining multiple calls
4944 * into a single statement.
4945 *
4946 * @see #putExtras
4947 * @see #removeExtra
4948 * @see #getIntExtra(String, int)
4949 */
4950 public Intent putExtra(String name, int value) {
4951 if (mExtras == null) {
4952 mExtras = new Bundle();
4953 }
4954 mExtras.putInt(name, value);
4955 return this;
4956 }
4957
4958 /**
4959 * Add extended data to the intent. The name must include a package
4960 * prefix, for example the app com.android.contacts would use names
4961 * like "com.android.contacts.ShowAll".
4962 *
4963 * @param name The name of the extra data, with package prefix.
4964 * @param value The long data value.
4965 *
4966 * @return Returns the same Intent object, for chaining multiple calls
4967 * into a single statement.
4968 *
4969 * @see #putExtras
4970 * @see #removeExtra
4971 * @see #getLongExtra(String, long)
4972 */
4973 public Intent putExtra(String name, long value) {
4974 if (mExtras == null) {
4975 mExtras = new Bundle();
4976 }
4977 mExtras.putLong(name, value);
4978 return this;
4979 }
4980
4981 /**
4982 * Add extended data to the intent. The name must include a package
4983 * prefix, for example the app com.android.contacts would use names
4984 * like "com.android.contacts.ShowAll".
4985 *
4986 * @param name The name of the extra data, with package prefix.
4987 * @param value The float data value.
4988 *
4989 * @return Returns the same Intent object, for chaining multiple calls
4990 * into a single statement.
4991 *
4992 * @see #putExtras
4993 * @see #removeExtra
4994 * @see #getFloatExtra(String, float)
4995 */
4996 public Intent putExtra(String name, float value) {
4997 if (mExtras == null) {
4998 mExtras = new Bundle();
4999 }
5000 mExtras.putFloat(name, value);
5001 return this;
5002 }
5003
5004 /**
5005 * Add extended data to the intent. The name must include a package
5006 * prefix, for example the app com.android.contacts would use names
5007 * like "com.android.contacts.ShowAll".
5008 *
5009 * @param name The name of the extra data, with package prefix.
5010 * @param value The double data value.
5011 *
5012 * @return Returns the same Intent object, for chaining multiple calls
5013 * into a single statement.
5014 *
5015 * @see #putExtras
5016 * @see #removeExtra
5017 * @see #getDoubleExtra(String, double)
5018 */
5019 public Intent putExtra(String name, double value) {
5020 if (mExtras == null) {
5021 mExtras = new Bundle();
5022 }
5023 mExtras.putDouble(name, value);
5024 return this;
5025 }
5026
5027 /**
5028 * Add extended data to the intent. The name must include a package
5029 * prefix, for example the app com.android.contacts would use names
5030 * like "com.android.contacts.ShowAll".
5031 *
5032 * @param name The name of the extra data, with package prefix.
5033 * @param value The String data value.
5034 *
5035 * @return Returns the same Intent object, for chaining multiple calls
5036 * into a single statement.
5037 *
5038 * @see #putExtras
5039 * @see #removeExtra
5040 * @see #getStringExtra(String)
5041 */
5042 public Intent putExtra(String name, String value) {
5043 if (mExtras == null) {
5044 mExtras = new Bundle();
5045 }
5046 mExtras.putString(name, value);
5047 return this;
5048 }
5049
5050 /**
5051 * Add extended data to the intent. The name must include a package
5052 * prefix, for example the app com.android.contacts would use names
5053 * like "com.android.contacts.ShowAll".
5054 *
5055 * @param name The name of the extra data, with package prefix.
5056 * @param value The CharSequence data value.
5057 *
5058 * @return Returns the same Intent object, for chaining multiple calls
5059 * into a single statement.
5060 *
5061 * @see #putExtras
5062 * @see #removeExtra
5063 * @see #getCharSequenceExtra(String)
5064 */
5065 public Intent putExtra(String name, CharSequence value) {
5066 if (mExtras == null) {
5067 mExtras = new Bundle();
5068 }
5069 mExtras.putCharSequence(name, value);
5070 return this;
5071 }
5072
5073 /**
5074 * Add extended data to the intent. The name must include a package
5075 * prefix, for example the app com.android.contacts would use names
5076 * like "com.android.contacts.ShowAll".
5077 *
5078 * @param name The name of the extra data, with package prefix.
5079 * @param value The Parcelable data value.
5080 *
5081 * @return Returns the same Intent object, for chaining multiple calls
5082 * into a single statement.
5083 *
5084 * @see #putExtras
5085 * @see #removeExtra
5086 * @see #getParcelableExtra(String)
5087 */
5088 public Intent putExtra(String name, Parcelable value) {
5089 if (mExtras == null) {
5090 mExtras = new Bundle();
5091 }
5092 mExtras.putParcelable(name, value);
5093 return this;
5094 }
5095
5096 /**
5097 * Add extended data to the intent. The name must include a package
5098 * prefix, for example the app com.android.contacts would use names
5099 * like "com.android.contacts.ShowAll".
5100 *
5101 * @param name The name of the extra data, with package prefix.
5102 * @param value The Parcelable[] data value.
5103 *
5104 * @return Returns the same Intent object, for chaining multiple calls
5105 * into a single statement.
5106 *
5107 * @see #putExtras
5108 * @see #removeExtra
5109 * @see #getParcelableArrayExtra(String)
5110 */
5111 public Intent putExtra(String name, Parcelable[] value) {
5112 if (mExtras == null) {
5113 mExtras = new Bundle();
5114 }
5115 mExtras.putParcelableArray(name, value);
5116 return this;
5117 }
5118
5119 /**
5120 * Add extended data to the intent. The name must include a package
5121 * prefix, for example the app com.android.contacts would use names
5122 * like "com.android.contacts.ShowAll".
5123 *
5124 * @param name The name of the extra data, with package prefix.
5125 * @param value The ArrayList<Parcelable> data value.
5126 *
5127 * @return Returns the same Intent object, for chaining multiple calls
5128 * into a single statement.
5129 *
5130 * @see #putExtras
5131 * @see #removeExtra
5132 * @see #getParcelableArrayListExtra(String)
5133 */
5134 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5135 if (mExtras == null) {
5136 mExtras = new Bundle();
5137 }
5138 mExtras.putParcelableArrayList(name, value);
5139 return this;
5140 }
5141
5142 /**
5143 * Add extended data to the intent. The name must include a package
5144 * prefix, for example the app com.android.contacts would use names
5145 * like "com.android.contacts.ShowAll".
5146 *
5147 * @param name The name of the extra data, with package prefix.
5148 * @param value The ArrayList<Integer> data value.
5149 *
5150 * @return Returns the same Intent object, for chaining multiple calls
5151 * into a single statement.
5152 *
5153 * @see #putExtras
5154 * @see #removeExtra
5155 * @see #getIntegerArrayListExtra(String)
5156 */
5157 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5158 if (mExtras == null) {
5159 mExtras = new Bundle();
5160 }
5161 mExtras.putIntegerArrayList(name, value);
5162 return this;
5163 }
5164
5165 /**
5166 * Add extended data to the intent. The name must include a package
5167 * prefix, for example the app com.android.contacts would use names
5168 * like "com.android.contacts.ShowAll".
5169 *
5170 * @param name The name of the extra data, with package prefix.
5171 * @param value The ArrayList<String> data value.
5172 *
5173 * @return Returns the same Intent object, for chaining multiple calls
5174 * into a single statement.
5175 *
5176 * @see #putExtras
5177 * @see #removeExtra
5178 * @see #getStringArrayListExtra(String)
5179 */
5180 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5181 if (mExtras == null) {
5182 mExtras = new Bundle();
5183 }
5184 mExtras.putStringArrayList(name, value);
5185 return this;
5186 }
5187
5188 /**
5189 * Add extended data to the intent. The name must include a package
5190 * prefix, for example the app com.android.contacts would use names
5191 * like "com.android.contacts.ShowAll".
5192 *
5193 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005194 * @param value The ArrayList<CharSequence> data value.
5195 *
5196 * @return Returns the same Intent object, for chaining multiple calls
5197 * into a single statement.
5198 *
5199 * @see #putExtras
5200 * @see #removeExtra
5201 * @see #getCharSequenceArrayListExtra(String)
5202 */
5203 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5204 if (mExtras == null) {
5205 mExtras = new Bundle();
5206 }
5207 mExtras.putCharSequenceArrayList(name, value);
5208 return this;
5209 }
5210
5211 /**
5212 * Add extended data to the intent. The name must include a package
5213 * prefix, for example the app com.android.contacts would use names
5214 * like "com.android.contacts.ShowAll".
5215 *
5216 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005217 * @param value The Serializable data value.
5218 *
5219 * @return Returns the same Intent object, for chaining multiple calls
5220 * into a single statement.
5221 *
5222 * @see #putExtras
5223 * @see #removeExtra
5224 * @see #getSerializableExtra(String)
5225 */
5226 public Intent putExtra(String name, Serializable value) {
5227 if (mExtras == null) {
5228 mExtras = new Bundle();
5229 }
5230 mExtras.putSerializable(name, value);
5231 return this;
5232 }
5233
5234 /**
5235 * Add extended data to the intent. The name must include a package
5236 * prefix, for example the app com.android.contacts would use names
5237 * like "com.android.contacts.ShowAll".
5238 *
5239 * @param name The name of the extra data, with package prefix.
5240 * @param value The boolean array data value.
5241 *
5242 * @return Returns the same Intent object, for chaining multiple calls
5243 * into a single statement.
5244 *
5245 * @see #putExtras
5246 * @see #removeExtra
5247 * @see #getBooleanArrayExtra(String)
5248 */
5249 public Intent putExtra(String name, boolean[] value) {
5250 if (mExtras == null) {
5251 mExtras = new Bundle();
5252 }
5253 mExtras.putBooleanArray(name, value);
5254 return this;
5255 }
5256
5257 /**
5258 * Add extended data to the intent. The name must include a package
5259 * prefix, for example the app com.android.contacts would use names
5260 * like "com.android.contacts.ShowAll".
5261 *
5262 * @param name The name of the extra data, with package prefix.
5263 * @param value The byte array data value.
5264 *
5265 * @return Returns the same Intent object, for chaining multiple calls
5266 * into a single statement.
5267 *
5268 * @see #putExtras
5269 * @see #removeExtra
5270 * @see #getByteArrayExtra(String)
5271 */
5272 public Intent putExtra(String name, byte[] value) {
5273 if (mExtras == null) {
5274 mExtras = new Bundle();
5275 }
5276 mExtras.putByteArray(name, value);
5277 return this;
5278 }
5279
5280 /**
5281 * Add extended data to the intent. The name must include a package
5282 * prefix, for example the app com.android.contacts would use names
5283 * like "com.android.contacts.ShowAll".
5284 *
5285 * @param name The name of the extra data, with package prefix.
5286 * @param value The short array data value.
5287 *
5288 * @return Returns the same Intent object, for chaining multiple calls
5289 * into a single statement.
5290 *
5291 * @see #putExtras
5292 * @see #removeExtra
5293 * @see #getShortArrayExtra(String)
5294 */
5295 public Intent putExtra(String name, short[] value) {
5296 if (mExtras == null) {
5297 mExtras = new Bundle();
5298 }
5299 mExtras.putShortArray(name, value);
5300 return this;
5301 }
5302
5303 /**
5304 * Add extended data to the intent. The name must include a package
5305 * prefix, for example the app com.android.contacts would use names
5306 * like "com.android.contacts.ShowAll".
5307 *
5308 * @param name The name of the extra data, with package prefix.
5309 * @param value The char array data value.
5310 *
5311 * @return Returns the same Intent object, for chaining multiple calls
5312 * into a single statement.
5313 *
5314 * @see #putExtras
5315 * @see #removeExtra
5316 * @see #getCharArrayExtra(String)
5317 */
5318 public Intent putExtra(String name, char[] value) {
5319 if (mExtras == null) {
5320 mExtras = new Bundle();
5321 }
5322 mExtras.putCharArray(name, value);
5323 return this;
5324 }
5325
5326 /**
5327 * Add extended data to the intent. The name must include a package
5328 * prefix, for example the app com.android.contacts would use names
5329 * like "com.android.contacts.ShowAll".
5330 *
5331 * @param name The name of the extra data, with package prefix.
5332 * @param value The int array data value.
5333 *
5334 * @return Returns the same Intent object, for chaining multiple calls
5335 * into a single statement.
5336 *
5337 * @see #putExtras
5338 * @see #removeExtra
5339 * @see #getIntArrayExtra(String)
5340 */
5341 public Intent putExtra(String name, int[] value) {
5342 if (mExtras == null) {
5343 mExtras = new Bundle();
5344 }
5345 mExtras.putIntArray(name, value);
5346 return this;
5347 }
5348
5349 /**
5350 * Add extended data to the intent. The name must include a package
5351 * prefix, for example the app com.android.contacts would use names
5352 * like "com.android.contacts.ShowAll".
5353 *
5354 * @param name The name of the extra data, with package prefix.
5355 * @param value The byte array data value.
5356 *
5357 * @return Returns the same Intent object, for chaining multiple calls
5358 * into a single statement.
5359 *
5360 * @see #putExtras
5361 * @see #removeExtra
5362 * @see #getLongArrayExtra(String)
5363 */
5364 public Intent putExtra(String name, long[] value) {
5365 if (mExtras == null) {
5366 mExtras = new Bundle();
5367 }
5368 mExtras.putLongArray(name, value);
5369 return this;
5370 }
5371
5372 /**
5373 * Add extended data to the intent. The name must include a package
5374 * prefix, for example the app com.android.contacts would use names
5375 * like "com.android.contacts.ShowAll".
5376 *
5377 * @param name The name of the extra data, with package prefix.
5378 * @param value The float array data value.
5379 *
5380 * @return Returns the same Intent object, for chaining multiple calls
5381 * into a single statement.
5382 *
5383 * @see #putExtras
5384 * @see #removeExtra
5385 * @see #getFloatArrayExtra(String)
5386 */
5387 public Intent putExtra(String name, float[] value) {
5388 if (mExtras == null) {
5389 mExtras = new Bundle();
5390 }
5391 mExtras.putFloatArray(name, value);
5392 return this;
5393 }
5394
5395 /**
5396 * Add extended data to the intent. The name must include a package
5397 * prefix, for example the app com.android.contacts would use names
5398 * like "com.android.contacts.ShowAll".
5399 *
5400 * @param name The name of the extra data, with package prefix.
5401 * @param value The double array data value.
5402 *
5403 * @return Returns the same Intent object, for chaining multiple calls
5404 * into a single statement.
5405 *
5406 * @see #putExtras
5407 * @see #removeExtra
5408 * @see #getDoubleArrayExtra(String)
5409 */
5410 public Intent putExtra(String name, double[] value) {
5411 if (mExtras == null) {
5412 mExtras = new Bundle();
5413 }
5414 mExtras.putDoubleArray(name, value);
5415 return this;
5416 }
5417
5418 /**
5419 * Add extended data to the intent. The name must include a package
5420 * prefix, for example the app com.android.contacts would use names
5421 * like "com.android.contacts.ShowAll".
5422 *
5423 * @param name The name of the extra data, with package prefix.
5424 * @param value The String array data value.
5425 *
5426 * @return Returns the same Intent object, for chaining multiple calls
5427 * into a single statement.
5428 *
5429 * @see #putExtras
5430 * @see #removeExtra
5431 * @see #getStringArrayExtra(String)
5432 */
5433 public Intent putExtra(String name, String[] value) {
5434 if (mExtras == null) {
5435 mExtras = new Bundle();
5436 }
5437 mExtras.putStringArray(name, value);
5438 return this;
5439 }
5440
5441 /**
5442 * Add extended data to the intent. The name must include a package
5443 * prefix, for example the app com.android.contacts would use names
5444 * like "com.android.contacts.ShowAll".
5445 *
5446 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005447 * @param value The CharSequence array data value.
5448 *
5449 * @return Returns the same Intent object, for chaining multiple calls
5450 * into a single statement.
5451 *
5452 * @see #putExtras
5453 * @see #removeExtra
5454 * @see #getCharSequenceArrayExtra(String)
5455 */
5456 public Intent putExtra(String name, CharSequence[] value) {
5457 if (mExtras == null) {
5458 mExtras = new Bundle();
5459 }
5460 mExtras.putCharSequenceArray(name, value);
5461 return this;
5462 }
5463
5464 /**
5465 * Add extended data to the intent. The name must include a package
5466 * prefix, for example the app com.android.contacts would use names
5467 * like "com.android.contacts.ShowAll".
5468 *
5469 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005470 * @param value The Bundle data value.
5471 *
5472 * @return Returns the same Intent object, for chaining multiple calls
5473 * into a single statement.
5474 *
5475 * @see #putExtras
5476 * @see #removeExtra
5477 * @see #getBundleExtra(String)
5478 */
5479 public Intent putExtra(String name, Bundle value) {
5480 if (mExtras == null) {
5481 mExtras = new Bundle();
5482 }
5483 mExtras.putBundle(name, value);
5484 return this;
5485 }
5486
5487 /**
5488 * Add extended data to the intent. The name must include a package
5489 * prefix, for example the app com.android.contacts would use names
5490 * like "com.android.contacts.ShowAll".
5491 *
5492 * @param name The name of the extra data, with package prefix.
5493 * @param value The IBinder data value.
5494 *
5495 * @return Returns the same Intent object, for chaining multiple calls
5496 * into a single statement.
5497 *
5498 * @see #putExtras
5499 * @see #removeExtra
5500 * @see #getIBinderExtra(String)
5501 *
5502 * @deprecated
5503 * @hide
5504 */
5505 @Deprecated
5506 public Intent putExtra(String name, IBinder value) {
5507 if (mExtras == null) {
5508 mExtras = new Bundle();
5509 }
5510 mExtras.putIBinder(name, value);
5511 return this;
5512 }
5513
5514 /**
5515 * Copy all extras in 'src' in to this intent.
5516 *
5517 * @param src Contains the extras to copy.
5518 *
5519 * @see #putExtra
5520 */
5521 public Intent putExtras(Intent src) {
5522 if (src.mExtras != null) {
5523 if (mExtras == null) {
5524 mExtras = new Bundle(src.mExtras);
5525 } else {
5526 mExtras.putAll(src.mExtras);
5527 }
5528 }
5529 return this;
5530 }
5531
5532 /**
5533 * Add a set of extended data to the intent. The keys must include a package
5534 * prefix, for example the app com.android.contacts would use names
5535 * like "com.android.contacts.ShowAll".
5536 *
5537 * @param extras The Bundle of extras to add to this intent.
5538 *
5539 * @see #putExtra
5540 * @see #removeExtra
5541 */
5542 public Intent putExtras(Bundle extras) {
5543 if (mExtras == null) {
5544 mExtras = new Bundle();
5545 }
5546 mExtras.putAll(extras);
5547 return this;
5548 }
5549
5550 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005551 * Completely replace the extras in the Intent with the extras in the
5552 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005553 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005554 * @param src The exact extras contained in this Intent are copied
5555 * into the target intent, replacing any that were previously there.
5556 */
5557 public Intent replaceExtras(Intent src) {
5558 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5559 return this;
5560 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005561
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005562 /**
5563 * Completely replace the extras in the Intent with the given Bundle of
5564 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005565 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005566 * @param extras The new set of extras in the Intent, or null to erase
5567 * all extras.
5568 */
5569 public Intent replaceExtras(Bundle extras) {
5570 mExtras = extras != null ? new Bundle(extras) : null;
5571 return this;
5572 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005573
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005574 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005575 * Remove extended data from the intent.
5576 *
5577 * @see #putExtra
5578 */
5579 public void removeExtra(String name) {
5580 if (mExtras != null) {
5581 mExtras.remove(name);
5582 if (mExtras.size() == 0) {
5583 mExtras = null;
5584 }
5585 }
5586 }
5587
5588 /**
5589 * Set special flags controlling how this intent is handled. Most values
5590 * here depend on the type of component being executed by the Intent,
5591 * specifically the FLAG_ACTIVITY_* flags are all for use with
5592 * {@link Context#startActivity Context.startActivity()} and the
5593 * FLAG_RECEIVER_* flags are all for use with
5594 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5595 *
Scott Main7aee61f2011-02-08 11:25:01 -08005596 * <p>See the
5597 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5598 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005599 * the behavior of your application.
5600 *
5601 * @param flags The desired flags.
5602 *
5603 * @return Returns the same Intent object, for chaining multiple calls
5604 * into a single statement.
5605 *
5606 * @see #getFlags
5607 * @see #addFlags
5608 *
5609 * @see #FLAG_GRANT_READ_URI_PERMISSION
5610 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5611 * @see #FLAG_DEBUG_LOG_RESOLUTION
5612 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005613 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005614 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005615 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005616 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005617 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5618 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005619 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005620 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5621 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005622 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005623 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005624 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005625 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5626 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005627 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005628 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005629 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005630 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5631 */
5632 public Intent setFlags(int flags) {
5633 mFlags = flags;
5634 return this;
5635 }
5636
5637 /**
5638 * Add additional flags to the intent (or with existing flags
5639 * value).
5640 *
5641 * @param flags The new flags to set.
5642 *
5643 * @return Returns the same Intent object, for chaining multiple calls
5644 * into a single statement.
5645 *
5646 * @see #setFlags
5647 */
5648 public Intent addFlags(int flags) {
5649 mFlags |= flags;
5650 return this;
5651 }
5652
5653 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005654 * (Usually optional) Set an explicit application package name that limits
5655 * the components this Intent will resolve to. If left to the default
5656 * value of null, all components in all applications will considered.
5657 * If non-null, the Intent can only match the components in the given
5658 * application package.
5659 *
5660 * @param packageName The name of the application package to handle the
5661 * intent, or null to allow any application package.
5662 *
5663 * @return Returns the same Intent object, for chaining multiple calls
5664 * into a single statement.
5665 *
5666 * @see #getPackage
5667 * @see #resolveActivity
5668 */
5669 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005670 if (packageName != null && mSelector != null) {
5671 throw new IllegalArgumentException(
5672 "Can't set package name when selector is already set");
5673 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005674 mPackage = packageName;
5675 return this;
5676 }
5677
5678 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005679 * (Usually optional) Explicitly set the component to handle the intent.
5680 * If left with the default value of null, the system will determine the
5681 * appropriate class to use based on the other fields (action, data,
5682 * type, categories) in the Intent. If this class is defined, the
5683 * specified class will always be used regardless of the other fields. You
5684 * should only set this value when you know you absolutely want a specific
5685 * class to be used; otherwise it is better to let the system find the
5686 * appropriate class so that you will respect the installed applications
5687 * and user preferences.
5688 *
5689 * @param component The name of the application component to handle the
5690 * intent, or null to let the system find one for you.
5691 *
5692 * @return Returns the same Intent object, for chaining multiple calls
5693 * into a single statement.
5694 *
5695 * @see #setClass
5696 * @see #setClassName(Context, String)
5697 * @see #setClassName(String, String)
5698 * @see #getComponent
5699 * @see #resolveActivity
5700 */
5701 public Intent setComponent(ComponentName component) {
5702 mComponent = component;
5703 return this;
5704 }
5705
5706 /**
5707 * Convenience for calling {@link #setComponent} with an
5708 * explicit class name.
5709 *
5710 * @param packageContext A Context of the application package implementing
5711 * this class.
5712 * @param className The name of a class inside of the application package
5713 * that will be used as the component for this Intent.
5714 *
5715 * @return Returns the same Intent object, for chaining multiple calls
5716 * into a single statement.
5717 *
5718 * @see #setComponent
5719 * @see #setClass
5720 */
5721 public Intent setClassName(Context packageContext, String className) {
5722 mComponent = new ComponentName(packageContext, className);
5723 return this;
5724 }
5725
5726 /**
5727 * Convenience for calling {@link #setComponent} with an
5728 * explicit application package name and class name.
5729 *
5730 * @param packageName The name of the package implementing the desired
5731 * component.
5732 * @param className The name of a class inside of the application package
5733 * that will be used as the component for this Intent.
5734 *
5735 * @return Returns the same Intent object, for chaining multiple calls
5736 * into a single statement.
5737 *
5738 * @see #setComponent
5739 * @see #setClass
5740 */
5741 public Intent setClassName(String packageName, String className) {
5742 mComponent = new ComponentName(packageName, className);
5743 return this;
5744 }
5745
5746 /**
5747 * Convenience for calling {@link #setComponent(ComponentName)} with the
5748 * name returned by a {@link Class} object.
5749 *
5750 * @param packageContext A Context of the application package implementing
5751 * this class.
5752 * @param cls The class name to set, equivalent to
5753 * <code>setClassName(context, cls.getName())</code>.
5754 *
5755 * @return Returns the same Intent object, for chaining multiple calls
5756 * into a single statement.
5757 *
5758 * @see #setComponent
5759 */
5760 public Intent setClass(Context packageContext, Class<?> cls) {
5761 mComponent = new ComponentName(packageContext, cls);
5762 return this;
5763 }
5764
5765 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005766 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5767 * used as a hint to the receiver for animations and the like. Null means that there
5768 * is no source bounds.
5769 */
5770 public void setSourceBounds(Rect r) {
5771 if (r != null) {
5772 mSourceBounds = new Rect(r);
5773 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005774 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005775 }
5776 }
5777
5778 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005779 * Use with {@link #fillIn} to allow the current action value to be
5780 * overwritten, even if it is already set.
5781 */
5782 public static final int FILL_IN_ACTION = 1<<0;
5783
5784 /**
5785 * Use with {@link #fillIn} to allow the current data or type value
5786 * overwritten, even if it is already set.
5787 */
5788 public static final int FILL_IN_DATA = 1<<1;
5789
5790 /**
5791 * Use with {@link #fillIn} to allow the current categories to be
5792 * overwritten, even if they are already set.
5793 */
5794 public static final int FILL_IN_CATEGORIES = 1<<2;
5795
5796 /**
5797 * Use with {@link #fillIn} to allow the current component value to be
5798 * overwritten, even if it is already set.
5799 */
5800 public static final int FILL_IN_COMPONENT = 1<<3;
5801
5802 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005803 * Use with {@link #fillIn} to allow the current package value to be
5804 * overwritten, even if it is already set.
5805 */
5806 public static final int FILL_IN_PACKAGE = 1<<4;
5807
5808 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005809 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005810 * overwritten, even if it is already set.
5811 */
5812 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5813
5814 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005815 * Use with {@link #fillIn} to allow the current selector to be
5816 * overwritten, even if it is already set.
5817 */
5818 public static final int FILL_IN_SELECTOR = 1<<6;
5819
5820 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005821 * Use with {@link #fillIn} to allow the current ClipData to be
5822 * overwritten, even if it is already set.
5823 */
5824 public static final int FILL_IN_CLIP_DATA = 1<<7;
5825
5826 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005827 * Copy the contents of <var>other</var> in to this object, but only
5828 * where fields are not defined by this object. For purposes of a field
5829 * being defined, the following pieces of data in the Intent are
5830 * considered to be separate fields:
5831 *
5832 * <ul>
5833 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08005834 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005835 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5836 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005837 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005838 * <li> component, as set by {@link #setComponent(ComponentName)} or
5839 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005840 * <li> source bounds, as set by {@link #setSourceBounds}.
5841 * <li> selector, as set by {@link #setSelector(Intent)}.
5842 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005843 * <li> each top-level name in the associated extras.
5844 * </ul>
5845 *
5846 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005847 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005848 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
5849 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
5850 * the restriction where the corresponding field will not be replaced if
5851 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005852 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005853 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
5854 * is explicitly specified. The selector will only be copied if
5855 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07005856 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005857 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5858 * and Intent B with {action="gotit", data-type="some/thing",
5859 * categories="one","two"}.
5860 *
5861 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5862 * containing: {action="gotit", data-type="some/thing",
5863 * categories="bar"}.
5864 *
5865 * @param other Another Intent whose values are to be used to fill in
5866 * the current one.
5867 * @param flags Options to control which fields can be filled in.
5868 *
5869 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005870 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005871 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
5872 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005873 */
5874 public int fillIn(Intent other, int flags) {
5875 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005876 if (other.mAction != null
5877 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005878 mAction = other.mAction;
5879 changes |= FILL_IN_ACTION;
5880 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005881 if ((other.mData != null || other.mType != null)
5882 && ((mData == null && mType == null)
5883 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005884 mData = other.mData;
5885 mType = other.mType;
5886 changes |= FILL_IN_DATA;
5887 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005888 if (other.mCategories != null
5889 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005890 if (other.mCategories != null) {
5891 mCategories = new HashSet<String>(other.mCategories);
5892 }
5893 changes |= FILL_IN_CATEGORIES;
5894 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005895 if (other.mPackage != null
5896 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005897 // Only do this if mSelector is not set.
5898 if (mSelector == null) {
5899 mPackage = other.mPackage;
5900 changes |= FILL_IN_PACKAGE;
5901 }
5902 }
5903 // Selector is special: it can only be set if explicitly allowed,
5904 // for the same reason as the component name.
5905 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
5906 if (mPackage == null) {
5907 mSelector = new Intent(other.mSelector);
5908 mPackage = null;
5909 changes |= FILL_IN_SELECTOR;
5910 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005911 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005912 if (other.mClipData != null
5913 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
5914 mClipData = other.mClipData;
5915 changes |= FILL_IN_CLIP_DATA;
5916 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005917 // Component is special: it can -only- be set if explicitly allowed,
5918 // since otherwise the sender could force the intent somewhere the
5919 // originator didn't intend.
5920 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005921 mComponent = other.mComponent;
5922 changes |= FILL_IN_COMPONENT;
5923 }
5924 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005925 if (other.mSourceBounds != null
5926 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5927 mSourceBounds = new Rect(other.mSourceBounds);
5928 changes |= FILL_IN_SOURCE_BOUNDS;
5929 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005930 if (mExtras == null) {
5931 if (other.mExtras != null) {
5932 mExtras = new Bundle(other.mExtras);
5933 }
5934 } else if (other.mExtras != null) {
5935 try {
5936 Bundle newb = new Bundle(other.mExtras);
5937 newb.putAll(mExtras);
5938 mExtras = newb;
5939 } catch (RuntimeException e) {
5940 // Modifying the extras can cause us to unparcel the contents
5941 // of the bundle, and if we do this in the system process that
5942 // may fail. We really should handle this (i.e., the Bundle
5943 // impl shouldn't be on top of a plain map), but for now just
5944 // ignore it and keep the original contents. :(
5945 Log.w("Intent", "Failure filling in extras", e);
5946 }
5947 }
5948 return changes;
5949 }
5950
5951 /**
5952 * Wrapper class holding an Intent and implementing comparisons on it for
5953 * the purpose of filtering. The class implements its
5954 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5955 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5956 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5957 * on the wrapped Intent.
5958 */
5959 public static final class FilterComparison {
5960 private final Intent mIntent;
5961 private final int mHashCode;
5962
5963 public FilterComparison(Intent intent) {
5964 mIntent = intent;
5965 mHashCode = intent.filterHashCode();
5966 }
5967
5968 /**
5969 * Return the Intent that this FilterComparison represents.
5970 * @return Returns the Intent held by the FilterComparison. Do
5971 * not modify!
5972 */
5973 public Intent getIntent() {
5974 return mIntent;
5975 }
5976
5977 @Override
5978 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005979 if (obj instanceof FilterComparison) {
5980 Intent other = ((FilterComparison)obj).mIntent;
5981 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005982 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005983 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005984 }
5985
5986 @Override
5987 public int hashCode() {
5988 return mHashCode;
5989 }
5990 }
5991
5992 /**
5993 * Determine if two intents are the same for the purposes of intent
5994 * resolution (filtering). That is, if their action, data, type,
5995 * class, and categories are the same. This does <em>not</em> compare
5996 * any extra data included in the intents.
5997 *
5998 * @param other The other Intent to compare against.
5999 *
6000 * @return Returns true if action, data, type, class, and categories
6001 * are the same.
6002 */
6003 public boolean filterEquals(Intent other) {
6004 if (other == null) {
6005 return false;
6006 }
6007 if (mAction != other.mAction) {
6008 if (mAction != null) {
6009 if (!mAction.equals(other.mAction)) {
6010 return false;
6011 }
6012 } else {
6013 if (!other.mAction.equals(mAction)) {
6014 return false;
6015 }
6016 }
6017 }
6018 if (mData != other.mData) {
6019 if (mData != null) {
6020 if (!mData.equals(other.mData)) {
6021 return false;
6022 }
6023 } else {
6024 if (!other.mData.equals(mData)) {
6025 return false;
6026 }
6027 }
6028 }
6029 if (mType != other.mType) {
6030 if (mType != null) {
6031 if (!mType.equals(other.mType)) {
6032 return false;
6033 }
6034 } else {
6035 if (!other.mType.equals(mType)) {
6036 return false;
6037 }
6038 }
6039 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006040 if (mPackage != other.mPackage) {
6041 if (mPackage != null) {
6042 if (!mPackage.equals(other.mPackage)) {
6043 return false;
6044 }
6045 } else {
6046 if (!other.mPackage.equals(mPackage)) {
6047 return false;
6048 }
6049 }
6050 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006051 if (mComponent != other.mComponent) {
6052 if (mComponent != null) {
6053 if (!mComponent.equals(other.mComponent)) {
6054 return false;
6055 }
6056 } else {
6057 if (!other.mComponent.equals(mComponent)) {
6058 return false;
6059 }
6060 }
6061 }
6062 if (mCategories != other.mCategories) {
6063 if (mCategories != null) {
6064 if (!mCategories.equals(other.mCategories)) {
6065 return false;
6066 }
6067 } else {
6068 if (!other.mCategories.equals(mCategories)) {
6069 return false;
6070 }
6071 }
6072 }
6073
6074 return true;
6075 }
6076
6077 /**
6078 * Generate hash code that matches semantics of filterEquals().
6079 *
6080 * @return Returns the hash value of the action, data, type, class, and
6081 * categories.
6082 *
6083 * @see #filterEquals
6084 */
6085 public int filterHashCode() {
6086 int code = 0;
6087 if (mAction != null) {
6088 code += mAction.hashCode();
6089 }
6090 if (mData != null) {
6091 code += mData.hashCode();
6092 }
6093 if (mType != null) {
6094 code += mType.hashCode();
6095 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006096 if (mPackage != null) {
6097 code += mPackage.hashCode();
6098 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006099 if (mComponent != null) {
6100 code += mComponent.hashCode();
6101 }
6102 if (mCategories != null) {
6103 code += mCategories.hashCode();
6104 }
6105 return code;
6106 }
6107
6108 @Override
6109 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006110 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006111
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006112 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006113 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006114 b.append(" }");
6115
6116 return b.toString();
6117 }
6118
6119 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006120 public String toInsecureString() {
6121 StringBuilder b = new StringBuilder(128);
6122
6123 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006124 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006125 b.append(" }");
6126
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006127 return b.toString();
6128 }
Romain Guy4969af72009-06-17 10:53:19 -07006129
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006130 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006131 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006132 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006133
6134 b.append("Intent { ");
6135 toShortString(b, false, true, true, true);
6136 b.append(" }");
6137
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006138 return b.toString();
6139 }
6140
6141 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006142 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6143 StringBuilder b = new StringBuilder(128);
6144 toShortString(b, secure, comp, extras, clip);
6145 return b.toString();
6146 }
6147
6148 /** @hide */
6149 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6150 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006151 boolean first = true;
6152 if (mAction != null) {
6153 b.append("act=").append(mAction);
6154 first = false;
6155 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006156 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006157 if (!first) {
6158 b.append(' ');
6159 }
6160 first = false;
6161 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006162 Iterator<String> i = mCategories.iterator();
6163 boolean didone = false;
6164 while (i.hasNext()) {
6165 if (didone) b.append(",");
6166 didone = true;
6167 b.append(i.next());
6168 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006169 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006170 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006171 if (mData != null) {
6172 if (!first) {
6173 b.append(' ');
6174 }
6175 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006176 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006177 if (secure) {
6178 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006179 } else {
6180 b.append(mData);
6181 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006182 }
6183 if (mType != null) {
6184 if (!first) {
6185 b.append(' ');
6186 }
6187 first = false;
6188 b.append("typ=").append(mType);
6189 }
6190 if (mFlags != 0) {
6191 if (!first) {
6192 b.append(' ');
6193 }
6194 first = false;
6195 b.append("flg=0x").append(Integer.toHexString(mFlags));
6196 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006197 if (mPackage != null) {
6198 if (!first) {
6199 b.append(' ');
6200 }
6201 first = false;
6202 b.append("pkg=").append(mPackage);
6203 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006204 if (comp && mComponent != null) {
6205 if (!first) {
6206 b.append(' ');
6207 }
6208 first = false;
6209 b.append("cmp=").append(mComponent.flattenToShortString());
6210 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006211 if (mSourceBounds != null) {
6212 if (!first) {
6213 b.append(' ');
6214 }
6215 first = false;
6216 b.append("bnds=").append(mSourceBounds.toShortString());
6217 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006218 if (mClipData != null) {
6219 if (!first) {
6220 b.append(' ');
6221 }
6222 first = false;
6223 if (clip) {
6224 b.append("clip={");
6225 mClipData.toShortString(b);
6226 b.append('}');
6227 } else {
6228 b.append("(has clip)");
6229 }
6230 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006231 if (extras && mExtras != null) {
6232 if (!first) {
6233 b.append(' ');
6234 }
6235 first = false;
6236 b.append("(has extras)");
6237 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006238 if (mSelector != null) {
6239 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006240 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006241 b.append("}");
6242 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006243 }
6244
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006245 /**
6246 * Call {@link #toUri} with 0 flags.
6247 * @deprecated Use {@link #toUri} instead.
6248 */
6249 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006250 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006251 return toUri(0);
6252 }
6253
6254 /**
6255 * Convert this Intent into a String holding a URI representation of it.
6256 * The returned URI string has been properly URI encoded, so it can be
6257 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6258 * Intent's data as the base URI, with an additional fragment describing
6259 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006260 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006261 * <p>You can convert the returned string back to an Intent with
6262 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006263 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006264 * @param flags Additional operating flags. Either 0 or
6265 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006266 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006267 * @return Returns a URI encoding URI string describing the entire contents
6268 * of the Intent.
6269 */
6270 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006271 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006272 String scheme = null;
6273 if (mData != null) {
6274 String data = mData.toString();
6275 if ((flags&URI_INTENT_SCHEME) != 0) {
6276 final int N = data.length();
6277 for (int i=0; i<N; i++) {
6278 char c = data.charAt(i);
6279 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6280 || c == '.' || c == '-') {
6281 continue;
6282 }
6283 if (c == ':' && i > 0) {
6284 // Valid scheme.
6285 scheme = data.substring(0, i);
6286 uri.append("intent:");
6287 data = data.substring(i+1);
6288 break;
6289 }
Tom Taylord4a47292009-12-21 13:59:18 -08006290
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006291 // No scheme.
6292 break;
6293 }
6294 }
6295 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006296
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006297 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6298 uri.append("intent:");
6299 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006300
6301 uri.append("#Intent;");
6302
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006303 toUriInner(uri, scheme, flags);
6304 if (mSelector != null) {
6305 uri.append("SEL;");
6306 // Note that for now we are not going to try to handle the
6307 // data part; not clear how to represent this as a URI, and
6308 // not much utility in it.
6309 mSelector.toUriInner(uri, null, flags);
6310 }
6311
6312 uri.append("end");
6313
6314 return uri.toString();
6315 }
6316
6317 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006318 if (scheme != null) {
6319 uri.append("scheme=").append(scheme).append(';');
6320 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006321 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006322 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006323 }
6324 if (mCategories != null) {
6325 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006326 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006327 }
6328 }
6329 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006330 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006331 }
6332 if (mFlags != 0) {
6333 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6334 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006335 if (mPackage != null) {
6336 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6337 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006338 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006339 uri.append("component=").append(Uri.encode(
6340 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006341 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006342 if (mSourceBounds != null) {
6343 uri.append("sourceBounds=")
6344 .append(Uri.encode(mSourceBounds.flattenToString()))
6345 .append(';');
6346 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006347 if (mExtras != null) {
6348 for (String key : mExtras.keySet()) {
6349 final Object value = mExtras.get(key);
6350 char entryType =
6351 value instanceof String ? 'S' :
6352 value instanceof Boolean ? 'B' :
6353 value instanceof Byte ? 'b' :
6354 value instanceof Character ? 'c' :
6355 value instanceof Double ? 'd' :
6356 value instanceof Float ? 'f' :
6357 value instanceof Integer ? 'i' :
6358 value instanceof Long ? 'l' :
6359 value instanceof Short ? 's' :
6360 '\0';
6361
6362 if (entryType != '\0') {
6363 uri.append(entryType);
6364 uri.append('.');
6365 uri.append(Uri.encode(key));
6366 uri.append('=');
6367 uri.append(Uri.encode(value.toString()));
6368 uri.append(';');
6369 }
6370 }
6371 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006372 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006373
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006374 public int describeContents() {
6375 return (mExtras != null) ? mExtras.describeContents() : 0;
6376 }
6377
6378 public void writeToParcel(Parcel out, int flags) {
6379 out.writeString(mAction);
6380 Uri.writeToParcel(out, mData);
6381 out.writeString(mType);
6382 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006383 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006384 ComponentName.writeToParcel(mComponent, out);
6385
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006386 if (mSourceBounds != null) {
6387 out.writeInt(1);
6388 mSourceBounds.writeToParcel(out, flags);
6389 } else {
6390 out.writeInt(0);
6391 }
6392
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006393 if (mCategories != null) {
6394 out.writeInt(mCategories.size());
6395 for (String category : mCategories) {
6396 out.writeString(category);
6397 }
6398 } else {
6399 out.writeInt(0);
6400 }
6401
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006402 if (mSelector != null) {
6403 out.writeInt(1);
6404 mSelector.writeToParcel(out, flags);
6405 } else {
6406 out.writeInt(0);
6407 }
6408
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006409 if (mClipData != null) {
6410 out.writeInt(1);
6411 mClipData.writeToParcel(out, flags);
6412 } else {
6413 out.writeInt(0);
6414 }
6415
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006416 out.writeBundle(mExtras);
6417 }
6418
6419 public static final Parcelable.Creator<Intent> CREATOR
6420 = new Parcelable.Creator<Intent>() {
6421 public Intent createFromParcel(Parcel in) {
6422 return new Intent(in);
6423 }
6424 public Intent[] newArray(int size) {
6425 return new Intent[size];
6426 }
6427 };
6428
Dianne Hackborneb034652009-09-07 00:49:58 -07006429 /** @hide */
6430 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006431 readFromParcel(in);
6432 }
6433
6434 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006435 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006436 mData = Uri.CREATOR.createFromParcel(in);
6437 mType = in.readString();
6438 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006439 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006440 mComponent = ComponentName.readFromParcel(in);
6441
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006442 if (in.readInt() != 0) {
6443 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6444 }
6445
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006446 int N = in.readInt();
6447 if (N > 0) {
6448 mCategories = new HashSet<String>();
6449 int i;
6450 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006451 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006452 }
6453 } else {
6454 mCategories = null;
6455 }
6456
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006457 if (in.readInt() != 0) {
6458 mSelector = new Intent(in);
6459 }
6460
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006461 if (in.readInt() != 0) {
6462 mClipData = new ClipData(in);
6463 }
6464
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006465 mExtras = in.readBundle();
6466 }
6467
6468 /**
6469 * Parses the "intent" element (and its children) from XML and instantiates
6470 * an Intent object. The given XML parser should be located at the tag
6471 * where parsing should start (often named "intent"), from which the
6472 * basic action, data, type, and package and class name will be
6473 * retrieved. The function will then parse in to any child elements,
6474 * looking for <category android:name="xxx"> tags to add categories and
6475 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6476 * to the intent.
6477 *
6478 * @param resources The Resources to use when inflating resources.
6479 * @param parser The XML parser pointing at an "intent" tag.
6480 * @param attrs The AttributeSet interface for retrieving extended
6481 * attribute data at the current <var>parser</var> location.
6482 * @return An Intent object matching the XML data.
6483 * @throws XmlPullParserException If there was an XML parsing error.
6484 * @throws IOException If there was an I/O error.
6485 */
6486 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6487 throws XmlPullParserException, IOException {
6488 Intent intent = new Intent();
6489
6490 TypedArray sa = resources.obtainAttributes(attrs,
6491 com.android.internal.R.styleable.Intent);
6492
6493 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6494
6495 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6496 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6497 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6498
6499 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6500 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6501 if (packageName != null && className != null) {
6502 intent.setComponent(new ComponentName(packageName, className));
6503 }
6504
6505 sa.recycle();
6506
6507 int outerDepth = parser.getDepth();
6508 int type;
6509 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6510 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6511 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6512 continue;
6513 }
6514
6515 String nodeName = parser.getName();
6516 if (nodeName.equals("category")) {
6517 sa = resources.obtainAttributes(attrs,
6518 com.android.internal.R.styleable.IntentCategory);
6519 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6520 sa.recycle();
6521
6522 if (cat != null) {
6523 intent.addCategory(cat);
6524 }
6525 XmlUtils.skipCurrentTag(parser);
6526
6527 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006528 if (intent.mExtras == null) {
6529 intent.mExtras = new Bundle();
6530 }
6531 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6532 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006533
6534 } else {
6535 XmlUtils.skipCurrentTag(parser);
6536 }
6537 }
6538
6539 return intent;
6540 }
Nick Pellyccae4122012-01-09 14:12:58 -08006541
6542 /**
6543 * Normalize a MIME data type.
6544 *
6545 * <p>A normalized MIME type has white-space trimmed,
6546 * content-type parameters removed, and is lower-case.
6547 * This aligns the type with Android best practices for
6548 * intent filtering.
6549 *
6550 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6551 * "text/x-vCard" becomes "text/x-vcard".
6552 *
6553 * <p>All MIME types received from outside Android (such as user input,
6554 * or external sources like Bluetooth, NFC, or the Internet) should
6555 * be normalized before they are used to create an Intent.
6556 *
6557 * @param type MIME data type to normalize
6558 * @return normalized MIME data type, or null if the input was null
6559 * @see {@link #setType}
6560 * @see {@link #setTypeAndNormalize}
6561 */
6562 public static String normalizeMimeType(String type) {
6563 if (type == null) {
6564 return null;
6565 }
6566
6567 type = type.trim().toLowerCase(Locale.US);
6568
6569 final int semicolonIndex = type.indexOf(';');
6570 if (semicolonIndex != -1) {
6571 type = type.substring(0, semicolonIndex);
6572 }
6573 return type;
6574 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006575
6576 /**
6577 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
6578 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}.
6579 *
6580 * @hide
6581 */
6582 public void migrateExtraStreamToClipData() {
6583 // Refuse to touch if extras already parcelled
6584 if (mExtras != null && mExtras.isParcelled()) return;
6585
6586 // Bail when someone already gave us ClipData
6587 if (getClipData() != null) return;
6588
6589 final String action = getAction();
6590 if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006591 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006592 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6593 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6594 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6595 if (stream != null || text != null || htmlText != null) {
6596 final ClipData clipData = new ClipData(
6597 null, new String[] { getType() },
6598 new ClipData.Item(text, htmlText, null, stream));
6599 setClipData(clipData);
6600 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
6601 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006602 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006603 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006604
6605 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006606 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006607 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6608 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6609 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6610 int num = -1;
6611 if (streams != null) {
6612 num = streams.size();
6613 }
6614 if (texts != null) {
6615 if (num >= 0 && num != texts.size()) {
6616 // Wha...! F- you.
6617 return;
6618 }
6619 num = texts.size();
6620 }
6621 if (htmlTexts != null) {
6622 if (num >= 0 && num != htmlTexts.size()) {
6623 // Wha...! F- you.
6624 return;
6625 }
6626 num = htmlTexts.size();
6627 }
6628 if (num > 0) {
6629 final ClipData clipData = new ClipData(
6630 null, new String[] { getType() },
6631 makeClipItem(streams, texts, htmlTexts, 0));
6632
6633 for (int i = 1; i < num; i++) {
6634 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6635 }
6636
6637 setClipData(clipData);
6638 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
6639 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006640 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006641 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006642 }
6643 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006644
6645 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6646 ArrayList<String> htmlTexts, int which) {
6647 Uri uri = streams != null ? streams.get(which) : null;
6648 CharSequence text = texts != null ? texts.get(which) : null;
6649 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6650 return new ClipData.Item(text, htmlText, null, uri);
6651 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006652}