blob: e8507bc0b5fcfac8e3f415709ec5353d5b696d88 [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
19import org.xmlpull.v1.XmlPullParser;
20import org.xmlpull.v1.XmlPullParserException;
21
22import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
24import android.content.pm.ActivityInfo;
25import android.content.pm.PackageManager;
26import android.content.pm.ResolveInfo;
27import android.content.res.Resources;
28import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080029import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.net.Uri;
31import android.os.Bundle;
32import android.os.IBinder;
33import android.os.Parcel;
34import android.os.Parcelable;
35import android.util.AttributeSet;
36import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080037
38import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039
40import java.io.IOException;
41import java.io.Serializable;
42import java.net.URISyntaxException;
43import java.util.ArrayList;
44import java.util.HashSet;
45import java.util.Iterator;
Nick Pellyccae4122012-01-09 14:12:58 -080046import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070047import java.util.Set;
48
49/**
50 * An intent is an abstract description of an operation to be performed. It
51 * can be used with {@link Context#startActivity(Intent) startActivity} to
52 * launch an {@link android.app.Activity},
53 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
54 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
55 * and {@link android.content.Context#startService} or
56 * {@link android.content.Context#bindService} to communicate with a
57 * background {@link android.app.Service}.
58 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070059 * <p>An Intent provides a facility for performing late runtime binding between the code in
60 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070061 * can be thought of as the glue between activities. It is basically a passive data structure
62 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070063 *
64 * <div class="special reference">
65 * <h3>Developer Guides</h3>
66 * <p>For information about how to create and resolve intents, read the
67 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
68 * developer guide.</p>
69 * </div>
70 *
71 * <a name="IntentStructure"></a>
72 * <h3>Intent Structure</h3>
73 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070074 *
75 * <ul>
76 * <li> <p><b>action</b> -- The general action to be performed, such as
77 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
78 * etc.</p>
79 * </li>
80 * <li> <p><b>data</b> -- The data to operate on, such as a person record
81 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
82 * </li>
83 * </ul>
84 *
85 *
86 * <p>Some examples of action/data pairs are:</p>
87 *
88 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070089 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070090 * information about the person whose identifier is "1".</p>
91 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * the phone dialer with the person filled in.</p>
94 * </li>
95 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
96 * the phone dialer with the given number filled in. Note how the
97 * VIEW action does what what is considered the most reasonable thing for
98 * a particular URI.</p>
99 * </li>
100 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
101 * the phone dialer with the given number filled in.</p>
102 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700103 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700104 * information about the person whose identifier is "1".</p>
105 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700106 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700107 * a list of people, which the user can browse through. This example is a
108 * typical top-level entry into the Contacts application, showing you the
109 * list of people. Selecting a particular person to view would result in a
110 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
111 * being used to start an activity to display that person.</p>
112 * </li>
113 * </ul>
114 *
115 * <p>In addition to these primary attributes, there are a number of secondary
116 * attributes that you can also include with an intent:</p>
117 *
118 * <ul>
119 * <li> <p><b>category</b> -- Gives additional information about the action
120 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
121 * appear in the Launcher as a top-level application, while
122 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
123 * of alternative actions the user can perform on a piece of data.</p>
124 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
125 * intent data. Normally the type is inferred from the data itself.
126 * By setting this attribute, you disable that evaluation and force
127 * an explicit type.</p>
128 * <li> <p><b>component</b> -- Specifies an explicit name of a component
129 * class to use for the intent. Normally this is determined by looking
130 * at the other information in the intent (the action, data/type, and
131 * categories) and matching that with a component that can handle it.
132 * If this attribute is set then none of the evaluation is performed,
133 * and this component is used exactly as is. By specifying this attribute,
134 * all of the other Intent attributes become optional.</p>
135 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
136 * This can be used to provide extended information to the component.
137 * For example, if we have a action to send an e-mail message, we could
138 * also include extra pieces of data here to supply a subject, body,
139 * etc.</p>
140 * </ul>
141 *
142 * <p>Here are some examples of other operations you can specify as intents
143 * using these additional parameters:</p>
144 *
145 * <ul>
146 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
147 * Launch the home screen.</p>
148 * </li>
149 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
150 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
151 * vnd.android.cursor.item/phone}</i></b>
152 * -- Display the list of people's phone numbers, allowing the user to
153 * browse through them and pick one and return it to the parent activity.</p>
154 * </li>
155 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
156 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
157 * -- Display all pickers for data that can be opened with
158 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
159 * allowing the user to pick one of them and then some data inside of it
160 * and returning the resulting URI to the caller. This can be used,
161 * for example, in an e-mail application to allow the user to pick some
162 * data to include as an attachment.</p>
163 * </li>
164 * </ul>
165 *
166 * <p>There are a variety of standard Intent action and category constants
167 * defined in the Intent class, but applications can also define their own.
168 * These strings use java style scoping, to ensure they are unique -- for
169 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700170 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700171 *
172 * <p>Put together, the set of actions, data types, categories, and extra data
173 * defines a language for the system allowing for the expression of phrases
174 * such as "call john smith's cell". As applications are added to the system,
175 * they can extend this language by adding new actions, types, and categories, or
176 * they can modify the behavior of existing phrases by supplying their own
177 * activities that handle them.</p>
178 *
179 * <a name="IntentResolution"></a>
180 * <h3>Intent Resolution</h3>
181 *
182 * <p>There are two primary forms of intents you will use.
183 *
184 * <ul>
185 * <li> <p><b>Explicit Intents</b> have specified a component (via
186 * {@link #setComponent} or {@link #setClass}), which provides the exact
187 * class to be run. Often these will not include any other information,
188 * simply being a way for an application to launch various internal
189 * activities it has as the user interacts with the application.
190 *
191 * <li> <p><b>Implicit Intents</b> have not specified a component;
192 * instead, they must include enough information for the system to
193 * determine which of the available components is best to run for that
194 * intent.
195 * </ul>
196 *
197 * <p>When using implicit intents, given such an arbitrary intent we need to
198 * know what to do with it. This is handled by the process of <em>Intent
199 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
200 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
201 * more activities/receivers) that can handle it.</p>
202 *
203 * <p>The intent resolution mechanism basically revolves around matching an
204 * Intent against all of the &lt;intent-filter&gt; descriptions in the
205 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
206 * objects explicitly registered with {@link Context#registerReceiver}.) More
207 * details on this can be found in the documentation on the {@link
208 * IntentFilter} class.</p>
209 *
210 * <p>There are three pieces of information in the Intent that are used for
211 * resolution: the action, type, and category. Using this information, a query
212 * is done on the {@link PackageManager} for a component that can handle the
213 * intent. The appropriate component is determined based on the intent
214 * information supplied in the <code>AndroidManifest.xml</code> file as
215 * follows:</p>
216 *
217 * <ul>
218 * <li> <p>The <b>action</b>, if given, must be listed by the component as
219 * one it handles.</p>
220 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
221 * already supplied in the Intent. Like the action, if a type is
222 * included in the intent (either explicitly or implicitly in its
223 * data), then this must be listed by the component as one it handles.</p>
224 * <li> For data that is not a <code>content:</code> URI and where no explicit
225 * type is included in the Intent, instead the <b>scheme</b> of the
226 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
227 * considered. Again like the action, if we are matching a scheme it
228 * must be listed by the component as one it can handle.
229 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
230 * by the activity as categories it handles. That is, if you include
231 * the categories {@link #CATEGORY_LAUNCHER} and
232 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
233 * with an intent that lists <em>both</em> of those categories.
234 * Activities will very often need to support the
235 * {@link #CATEGORY_DEFAULT} so that they can be found by
236 * {@link Context#startActivity Context.startActivity()}.</p>
237 * </ul>
238 *
239 * <p>For example, consider the Note Pad sample application that
240 * allows user to browse through a list of notes data and view details about
241 * individual items. Text in italics indicate places were you would replace a
242 * name with one specific to your own package.</p>
243 *
244 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
245 * package="<i>com.android.notepad</i>"&gt;
246 * &lt;application android:icon="@drawable/app_notes"
247 * android:label="@string/app_name"&gt;
248 *
249 * &lt;provider class=".NotePadProvider"
250 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
251 *
252 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
253 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700254 * &lt;action android:name="android.intent.action.MAIN" /&gt;
255 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700256 * &lt;/intent-filter&gt;
257 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700258 * &lt;action android:name="android.intent.action.VIEW" /&gt;
259 * &lt;action android:name="android.intent.action.EDIT" /&gt;
260 * &lt;action android:name="android.intent.action.PICK" /&gt;
261 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
262 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700263 * &lt;/intent-filter&gt;
264 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700265 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
266 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
267 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700268 * &lt;/intent-filter&gt;
269 * &lt;/activity&gt;
270 *
271 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
272 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700273 * &lt;action android:name="android.intent.action.VIEW" /&gt;
274 * &lt;action android:name="android.intent.action.EDIT" /&gt;
275 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
276 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 *
279 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700280 * &lt;action android:name="android.intent.action.INSERT" /&gt;
281 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
282 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700283 * &lt;/intent-filter&gt;
284 *
285 * &lt;/activity&gt;
286 *
287 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
288 * android:theme="@android:style/Theme.Dialog"&gt;
289 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
293 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 * &lt;/activity&gt;
297 *
298 * &lt;/application&gt;
299 * &lt;/manifest&gt;</pre>
300 *
301 * <p>The first activity,
302 * <code>com.android.notepad.NotesList</code>, serves as our main
303 * entry into the app. It can do three things as described by its three intent
304 * templates:
305 * <ol>
306 * <li><pre>
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
309 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700310 * &lt;/intent-filter&gt;</pre>
311 * <p>This provides a top-level entry into the NotePad application: the standard
312 * MAIN action is a main entry point (not requiring any other information in
313 * the Intent), and the LAUNCHER category says that this entry point should be
314 * listed in the application launcher.</p>
315 * <li><pre>
316 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700317 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
318 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
319 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
320 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
321 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700322 * &lt;/intent-filter&gt;</pre>
323 * <p>This declares the things that the activity can do on a directory of
324 * notes. The type being supported is given with the &lt;type&gt; tag, where
325 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
326 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
327 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
328 * The activity allows the user to view or edit the directory of data (via
329 * the VIEW and EDIT actions), or to pick a particular note and return it
330 * to the caller (via the PICK action). Note also the DEFAULT category
331 * supplied here: this is <em>required</em> for the
332 * {@link Context#startActivity Context.startActivity} method to resolve your
333 * activity when its component name is not explicitly specified.</p>
334 * <li><pre>
335 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700336 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
337 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
338 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700339 * &lt;/intent-filter&gt;</pre>
340 * <p>This filter describes the ability return to the caller a note selected by
341 * the user without needing to know where it came from. The data type
342 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
343 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
344 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
345 * The GET_CONTENT action is similar to the PICK action, where the activity
346 * will return to its caller a piece of data selected by the user. Here,
347 * however, the caller specifies the type of data they desire instead of
348 * the type of data the user will be picking from.</p>
349 * </ol>
350 *
351 * <p>Given these capabilities, the following intents will resolve to the
352 * NotesList activity:</p>
353 *
354 * <ul>
355 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
356 * activities that can be used as top-level entry points into an
357 * application.</p>
358 * <li> <p><b>{ action=android.app.action.MAIN,
359 * category=android.app.category.LAUNCHER }</b> is the actual intent
360 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700361 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * data=content://com.google.provider.NotePad/notes }</b>
363 * displays a list of all the notes under
364 * "content://com.google.provider.NotePad/notes", which
365 * the user can browse through and see the details on.</p>
366 * <li> <p><b>{ action=android.app.action.PICK
367 * data=content://com.google.provider.NotePad/notes }</b>
368 * provides a list of the notes under
369 * "content://com.google.provider.NotePad/notes", from which
370 * the user can pick a note whose data URL is returned back to the caller.</p>
371 * <li> <p><b>{ action=android.app.action.GET_CONTENT
372 * type=vnd.android.cursor.item/vnd.google.note }</b>
373 * is similar to the pick action, but allows the caller to specify the
374 * kind of data they want back so that the system can find the appropriate
375 * activity to pick something of that data type.</p>
376 * </ul>
377 *
378 * <p>The second activity,
379 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
380 * note entry and allows them to edit it. It can do two things as described
381 * by its two intent templates:
382 * <ol>
383 * <li><pre>
384 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700385 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
386 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
387 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
388 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700389 * &lt;/intent-filter&gt;</pre>
390 * <p>The first, primary, purpose of this activity is to let the user interact
391 * with a single note, as decribed by the MIME type
392 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
393 * either VIEW a note or allow the user to EDIT it. Again we support the
394 * DEFAULT category to allow the activity to be launched without explicitly
395 * specifying its component.</p>
396 * <li><pre>
397 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700398 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
399 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
400 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700401 * &lt;/intent-filter&gt;</pre>
402 * <p>The secondary use of this activity is to insert a new note entry into
403 * an existing directory of notes. This is used when the user creates a new
404 * note: the INSERT action is executed on the directory of notes, causing
405 * this activity to run and have the user create the new note data which
406 * it then adds to the content provider.</p>
407 * </ol>
408 *
409 * <p>Given these capabilities, the following intents will resolve to the
410 * NoteEditor activity:</p>
411 *
412 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700413 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700414 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
415 * shows the user the content of note <var>{ID}</var>.</p>
416 * <li> <p><b>{ action=android.app.action.EDIT
417 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
418 * allows the user to edit the content of note <var>{ID}</var>.</p>
419 * <li> <p><b>{ action=android.app.action.INSERT
420 * data=content://com.google.provider.NotePad/notes }</b>
421 * creates a new, empty note in the notes list at
422 * "content://com.google.provider.NotePad/notes"
423 * and allows the user to edit it. If they keep their changes, the URI
424 * of the newly created note is returned to the caller.</p>
425 * </ul>
426 *
427 * <p>The last activity,
428 * <code>com.android.notepad.TitleEditor</code>, allows the user to
429 * edit the title of a note. This could be implemented as a class that the
430 * application directly invokes (by explicitly setting its component in
431 * the Intent), but here we show a way you can publish alternative
432 * operations on existing data:</p>
433 *
434 * <pre>
435 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700436 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
437 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
438 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
439 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
440 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700441 * &lt;/intent-filter&gt;</pre>
442 *
443 * <p>In the single intent template here, we
444 * have created our own private action called
445 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
446 * edit the title of a note. It must be invoked on a specific note
447 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
448 * view and edit actions, but here displays and edits the title contained
449 * in the note data.
450 *
451 * <p>In addition to supporting the default category as usual, our title editor
452 * also supports two other standard categories: ALTERNATIVE and
453 * SELECTED_ALTERNATIVE. Implementing
454 * these categories allows others to find the special action it provides
455 * without directly knowing about it, through the
456 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
457 * more often to build dynamic menu items with
458 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
459 * template here was also supply an explicit name for the template
460 * (via <code>android:label="@string/resolve_title"</code>) to better control
461 * what the user sees when presented with this activity as an alternative
462 * action to the data they are viewing.
463 *
464 * <p>Given these capabilities, the following intent will resolve to the
465 * TitleEditor activity:</p>
466 *
467 * <ul>
468 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
469 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
470 * displays and allows the user to edit the title associated
471 * with note <var>{ID}</var>.</p>
472 * </ul>
473 *
474 * <h3>Standard Activity Actions</h3>
475 *
476 * <p>These are the current standard actions that Intent defines for launching
477 * activities (usually through {@link Context#startActivity}. The most
478 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
479 * {@link #ACTION_EDIT}.
480 *
481 * <ul>
482 * <li> {@link #ACTION_MAIN}
483 * <li> {@link #ACTION_VIEW}
484 * <li> {@link #ACTION_ATTACH_DATA}
485 * <li> {@link #ACTION_EDIT}
486 * <li> {@link #ACTION_PICK}
487 * <li> {@link #ACTION_CHOOSER}
488 * <li> {@link #ACTION_GET_CONTENT}
489 * <li> {@link #ACTION_DIAL}
490 * <li> {@link #ACTION_CALL}
491 * <li> {@link #ACTION_SEND}
492 * <li> {@link #ACTION_SENDTO}
493 * <li> {@link #ACTION_ANSWER}
494 * <li> {@link #ACTION_INSERT}
495 * <li> {@link #ACTION_DELETE}
496 * <li> {@link #ACTION_RUN}
497 * <li> {@link #ACTION_SYNC}
498 * <li> {@link #ACTION_PICK_ACTIVITY}
499 * <li> {@link #ACTION_SEARCH}
500 * <li> {@link #ACTION_WEB_SEARCH}
501 * <li> {@link #ACTION_FACTORY_TEST}
502 * </ul>
503 *
504 * <h3>Standard Broadcast Actions</h3>
505 *
506 * <p>These are the current standard actions that Intent defines for receiving
507 * broadcasts (usually through {@link Context#registerReceiver} or a
508 * &lt;receiver&gt; tag in a manifest).
509 *
510 * <ul>
511 * <li> {@link #ACTION_TIME_TICK}
512 * <li> {@link #ACTION_TIME_CHANGED}
513 * <li> {@link #ACTION_TIMEZONE_CHANGED}
514 * <li> {@link #ACTION_BOOT_COMPLETED}
515 * <li> {@link #ACTION_PACKAGE_ADDED}
516 * <li> {@link #ACTION_PACKAGE_CHANGED}
517 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800518 * <li> {@link #ACTION_PACKAGE_RESTARTED}
519 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700520 * <li> {@link #ACTION_UID_REMOVED}
521 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700522 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700523 * <li> {@link #ACTION_POWER_DISCONNECTED}
524 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700525 * </ul>
526 *
527 * <h3>Standard Categories</h3>
528 *
529 * <p>These are the current standard categories that can be used to further
530 * clarify an Intent via {@link #addCategory}.
531 *
532 * <ul>
533 * <li> {@link #CATEGORY_DEFAULT}
534 * <li> {@link #CATEGORY_BROWSABLE}
535 * <li> {@link #CATEGORY_TAB}
536 * <li> {@link #CATEGORY_ALTERNATIVE}
537 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
538 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700540 * <li> {@link #CATEGORY_HOME}
541 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700542 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400543 * <li> {@link #CATEGORY_CAR_DOCK}
544 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500545 * <li> {@link #CATEGORY_LE_DESK_DOCK}
546 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200547 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700548 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * </ul>
550 *
551 * <h3>Standard Extra Data</h3>
552 *
553 * <p>These are the current standard fields that can be used as extra data via
554 * {@link #putExtra}.
555 *
556 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800557 * <li> {@link #EXTRA_ALARM_COUNT}
558 * <li> {@link #EXTRA_BCC}
559 * <li> {@link #EXTRA_CC}
560 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
561 * <li> {@link #EXTRA_DATA_REMOVED}
562 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500563 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
564 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800565 * <li> {@link #EXTRA_DOCK_STATE_CAR}
566 * <li> {@link #EXTRA_DOCK_STATE_DESK}
567 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
568 * <li> {@link #EXTRA_DONT_KILL_APP}
569 * <li> {@link #EXTRA_EMAIL}
570 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800572 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700573 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800574 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700575 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800576 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
577 * <li> {@link #EXTRA_REPLACING}
578 * <li> {@link #EXTRA_SHORTCUT_ICON}
579 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
580 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700581 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800582 * <li> {@link #EXTRA_SHORTCUT_NAME}
583 * <li> {@link #EXTRA_SUBJECT}
584 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700585 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800586 * <li> {@link #EXTRA_TITLE}
587 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700588 * </ul>
589 *
590 * <h3>Flags</h3>
591 *
592 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800593 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
594 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800596public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700597 // ---------------------------------------------------------------------
598 // ---------------------------------------------------------------------
599 // Standard intent activity actions (see action variable).
600
601 /**
602 * Activity Action: Start as a main entry point, does not expect to
603 * receive data.
604 * <p>Input: nothing
605 * <p>Output: nothing
606 */
607 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
608 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800609
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700610 /**
611 * Activity Action: Display the data to the user. This is the most common
612 * action performed on data -- it is the generic action you can use on
613 * a piece of data to get the most reasonable thing to occur. For example,
614 * when used on a contacts entry it will view the entry; when used on a
615 * mailto: URI it will bring up a compose window filled with the information
616 * supplied by the URI; when used with a tel: URI it will invoke the
617 * dialer.
618 * <p>Input: {@link #getData} is URI from which to retrieve data.
619 * <p>Output: nothing.
620 */
621 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
622 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700624 /**
625 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
626 * performed on a piece of data.
627 */
628 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 /**
631 * Used to indicate that some piece of data should be attached to some other
632 * place. For example, image data could be attached to a contact. It is up
633 * to the recipient to decide where the data should be attached; the intent
634 * does not specify the ultimate destination.
635 * <p>Input: {@link #getData} is URI of data to be attached.
636 * <p>Output: nothing.
637 */
638 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
639 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800640
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700641 /**
642 * Activity Action: Provide explicit editable access to the given data.
643 * <p>Input: {@link #getData} is URI of data to be edited.
644 * <p>Output: nothing.
645 */
646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
647 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700649 /**
650 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
651 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
652 * The extras can contain type specific data to pass through to the editing/creating
653 * activity.
654 * <p>Output: The URI of the item that was picked. This must be a content:
655 * URI so that any receiver can access it.
656 */
657 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
658 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700660 /**
661 * Activity Action: Pick an item from the data, returning what was selected.
662 * <p>Input: {@link #getData} is URI containing a directory of data
663 * (vnd.android.cursor.dir/*) from which to pick an item.
664 * <p>Output: The URI of the item that was picked.
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700669 /**
670 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800671 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700672 * <p>Output: An Intent representing the shortcut. The intent must contain three
673 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
674 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800675 * (value: ShortcutIconResource).</p>
676 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 * @see #EXTRA_SHORTCUT_INTENT
678 * @see #EXTRA_SHORTCUT_NAME
679 * @see #EXTRA_SHORTCUT_ICON
680 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
681 * @see android.content.Intent.ShortcutIconResource
682 */
683 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
684 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
685
686 /**
687 * The name of the extra used to define the Intent of a shortcut.
688 *
689 * @see #ACTION_CREATE_SHORTCUT
690 */
691 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
692 /**
693 * The name of the extra used to define the name of a shortcut.
694 *
695 * @see #ACTION_CREATE_SHORTCUT
696 */
697 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
698 /**
699 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
700 *
701 * @see #ACTION_CREATE_SHORTCUT
702 */
703 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
704 /**
705 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
706 *
707 * @see #ACTION_CREATE_SHORTCUT
708 * @see android.content.Intent.ShortcutIconResource
709 */
710 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
711 "android.intent.extra.shortcut.ICON_RESOURCE";
712
713 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 *
716 * @see Intent#ACTION_CREATE_SHORTCUT
717 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800718 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
719 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700720 */
721 public static class ShortcutIconResource implements Parcelable {
722 /**
723 * The package name of the application containing the icon.
724 */
725 public String packageName;
726
727 /**
728 * The resource name of the icon, including package, name and type.
729 */
730 public String resourceName;
731
732 /**
733 * Creates a new ShortcutIconResource for the specified context and resource
734 * identifier.
735 *
736 * @param context The context of the application.
737 * @param resourceId The resource idenfitier for the icon.
738 * @return A new ShortcutIconResource with the specified's context package name
739 * and icon resource idenfitier.
740 */
741 public static ShortcutIconResource fromContext(Context context, int resourceId) {
742 ShortcutIconResource icon = new ShortcutIconResource();
743 icon.packageName = context.getPackageName();
744 icon.resourceName = context.getResources().getResourceName(resourceId);
745 return icon;
746 }
747
748 /**
749 * Used to read a ShortcutIconResource from a Parcel.
750 */
751 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
752 new Parcelable.Creator<ShortcutIconResource>() {
753
754 public ShortcutIconResource createFromParcel(Parcel source) {
755 ShortcutIconResource icon = new ShortcutIconResource();
756 icon.packageName = source.readString();
757 icon.resourceName = source.readString();
758 return icon;
759 }
760
761 public ShortcutIconResource[] newArray(int size) {
762 return new ShortcutIconResource[size];
763 }
764 };
765
766 /**
767 * No special parcel contents.
768 */
769 public int describeContents() {
770 return 0;
771 }
772
773 public void writeToParcel(Parcel dest, int flags) {
774 dest.writeString(packageName);
775 dest.writeString(resourceName);
776 }
777
778 @Override
779 public String toString() {
780 return resourceName;
781 }
782 }
783
784 /**
785 * Activity Action: Display an activity chooser, allowing the user to pick
786 * what they want to before proceeding. This can be used as an alternative
787 * to the standard activity picker that is displayed by the system when
788 * you try to start an activity with multiple possible matches, with these
789 * differences in behavior:
790 * <ul>
791 * <li>You can specify the title that will appear in the activity chooser.
792 * <li>The user does not have the option to make one of the matching
793 * activities a preferred activity, and all possible activities will
794 * always be shown even if one of them is currently marked as the
795 * preferred activity.
796 * </ul>
797 * <p>
798 * This action should be used when the user will naturally expect to
799 * select an activity in order to proceed. An example if when not to use
800 * it is when the user clicks on a "mailto:" link. They would naturally
801 * expect to go directly to their mail app, so startActivity() should be
802 * called directly: it will
803 * either launch the current preferred app, or put up a dialog allowing the
804 * user to pick an app to use and optionally marking that as preferred.
805 * <p>
806 * In contrast, if the user is selecting a menu item to send a picture
807 * they are viewing to someone else, there are many different things they
808 * may want to do at this point: send it through e-mail, upload it to a
809 * web service, etc. In this case the CHOOSER action should be used, to
810 * always present to the user a list of the things they can do, with a
811 * nice title given by the caller such as "Send this photo with:".
812 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700813 * If you need to grant URI permissions through a chooser, you must specify
814 * the permissions to be granted on the ACTION_CHOOSER Intent
815 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
816 * {@link #setClipData} to specify the URIs to be granted as well as
817 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
818 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
819 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700820 * As a convenience, an Intent of this form can be created with the
821 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700822 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700823 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700824 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
825 * and can optionally have a {@link #EXTRA_TITLE} field containing the
826 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700827 * <p>
828 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700829 */
830 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
831 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
832
833 /**
834 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
835 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700836 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
837 * target intent, also optionally supplying a title. If the target
838 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
839 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
840 * set in the returned chooser intent, with its ClipData set appropriately:
841 * either a direct reflection of {@link #getClipData()} if that is non-null,
842 * or a new ClipData build from {@link #getData()}.
843 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700844 * @param target The Intent that the user will be selecting an activity
845 * to perform.
846 * @param title Optional title that will be displayed in the chooser.
847 * @return Return a new Intent object that you can hand to
848 * {@link Context#startActivity(Intent) Context.startActivity()} and
849 * related methods.
850 */
851 public static Intent createChooser(Intent target, CharSequence title) {
852 Intent intent = new Intent(ACTION_CHOOSER);
853 intent.putExtra(EXTRA_INTENT, target);
854 if (title != null) {
855 intent.putExtra(EXTRA_TITLE, title);
856 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700857
858 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700859 int permFlags = target.getFlags()
860 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
861 if (permFlags != 0) {
862 ClipData targetClipData = target.getClipData();
863 if (targetClipData == null && target.getData() != null) {
864 ClipData.Item item = new ClipData.Item(target.getData());
865 String[] mimeTypes;
866 if (target.getType() != null) {
867 mimeTypes = new String[] { target.getType() };
868 } else {
869 mimeTypes = new String[] { };
870 }
871 targetClipData = new ClipData(null, mimeTypes, item);
872 }
873 if (targetClipData != null) {
874 intent.setClipData(targetClipData);
875 intent.addFlags(permFlags);
876 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700877 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700878
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700879 return intent;
880 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700881
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700882 /**
883 * Activity Action: Allow the user to select a particular kind of data and
884 * return it. This is different than {@link #ACTION_PICK} in that here we
885 * just say what kind of data is desired, not a URI of existing data from
886 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
887 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900888 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700889 * etc.
890 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900891 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700892 * of data, such as a person contact, you set the MIME type to the kind of
893 * data you want and launch it with {@link Context#startActivity(Intent)}.
894 * The system will then launch the best application to select that kind
895 * of data for you.
896 * <p>
897 * You may also be interested in any of a set of types of content the user
898 * can pick. For example, an e-mail application that wants to allow the
899 * user to add an attachment to an e-mail message can use this action to
900 * bring up a list of all of the types of content the user can attach.
901 * <p>
902 * In this case, you should wrap the GET_CONTENT intent with a chooser
903 * (through {@link #createChooser}), which will give the proper interface
904 * for the user to pick how to send your data and allow you to specify
905 * a prompt indicating what they are doing. You will usually specify a
906 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
907 * broad range of content types the user can select from.
908 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900909 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700910 * only pick from data that can be represented as a stream. This is
911 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
912 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800913 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900914 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800915 * is locally available on the device. For example, if this extra is set
916 * to true then an image picker should not show any pictures that are available
917 * from a remote server but not already on the local device (thus requiring
918 * they be downloaded when opened).
919 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700920 * Input: {@link #getType} is the desired MIME type to retrieve. Note
921 * that no URI is supplied in the intent, as there are no constraints on
922 * where the returned data originally comes from. You may also include the
923 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800924 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
925 * selection to local data.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700926 * <p>
927 * Output: The URI of the item that was picked. This must be a content:
928 * URI so that any receiver can access it.
929 */
930 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
931 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
932 /**
933 * Activity Action: Dial a number as specified by the data. This shows a
934 * UI with the number being dialed, allowing the user to explicitly
935 * initiate the call.
936 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
937 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
938 * number.
939 * <p>Output: nothing.
940 */
941 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
942 public static final String ACTION_DIAL = "android.intent.action.DIAL";
943 /**
944 * Activity Action: Perform a call to someone specified by the data.
945 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
946 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
947 * number.
948 * <p>Output: nothing.
949 *
950 * <p>Note: there will be restrictions on which applications can initiate a
951 * call; most applications should use the {@link #ACTION_DIAL}.
952 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
953 * numbers. Applications can <strong>dial</strong> emergency numbers using
954 * {@link #ACTION_DIAL}, however.
955 */
956 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
957 public static final String ACTION_CALL = "android.intent.action.CALL";
958 /**
959 * Activity Action: Perform a call to an emergency number specified by the
960 * data.
961 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
962 * tel: URI of an explicit phone number.
963 * <p>Output: nothing.
964 * @hide
965 */
966 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
967 /**
968 * Activity action: Perform a call to any number (emergency or not)
969 * specified by the data.
970 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
971 * tel: URI of an explicit phone number.
972 * <p>Output: nothing.
973 * @hide
974 */
975 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
976 /**
977 * Activity Action: Send a message to someone specified by the data.
978 * <p>Input: {@link #getData} is URI describing the target.
979 * <p>Output: nothing.
980 */
981 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
982 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
983 /**
984 * Activity Action: Deliver some data to someone else. Who the data is
985 * being delivered to is not specified; it is up to the receiver of this
986 * action to ask the user where the data should be sent.
987 * <p>
988 * When launching a SEND intent, you should usually wrap it in a chooser
989 * (through {@link #createChooser}), which will give the proper interface
990 * for the user to pick how to send your data and allow you to specify
991 * a prompt indicating what they are doing.
992 * <p>
993 * Input: {@link #getType} is the MIME type of the data being sent.
994 * get*Extra can have either a {@link #EXTRA_TEXT}
995 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
996 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
997 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
998 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700999 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1000 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1001 * your text with HTML formatting.
1002 * <p>
1003 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1004 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1005 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1006 * content: URIs and other advanced features of {@link ClipData}. If
1007 * using this approach, you still must supply the same data through the
1008 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1009 * for compatibility with old applications. If you don't set a ClipData,
1010 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001011 * <p>
1012 * Optional standard extras, which may be interpreted by some recipients as
1013 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1014 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1015 * <p>
1016 * Output: nothing.
1017 */
1018 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1019 public static final String ACTION_SEND = "android.intent.action.SEND";
1020 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001021 * Activity Action: Deliver multiple data to someone else.
1022 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001023 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001024 * <p>
1025 * Input: {@link #getType} is the MIME type of the data being sent.
1026 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001027 * #EXTRA_STREAM} field, containing the data to be sent. If using
1028 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1029 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001030 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001031 * Multiple types are supported, and receivers should handle mixed types
1032 * whenever possible. The right way for the receiver to check them is to
1033 * use the content resolver on each URI. The intent sender should try to
1034 * put the most concrete mime type in the intent type, but it can fall
1035 * back to {@literal <type>/*} or {@literal *}/* as needed.
1036 * <p>
1037 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1038 * be image/jpg, but if you are sending image/jpg and image/png, then the
1039 * intent's type should be image/*.
1040 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001041 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1042 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1043 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1044 * content: URIs and other advanced features of {@link ClipData}. If
1045 * using this approach, you still must supply the same data through the
1046 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1047 * for compatibility with old applications. If you don't set a ClipData,
1048 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1049 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001050 * Optional standard extras, which may be interpreted by some recipients as
1051 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1052 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1053 * <p>
1054 * Output: nothing.
1055 */
1056 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1057 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1058 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001059 * Activity Action: Handle an incoming phone call.
1060 * <p>Input: nothing.
1061 * <p>Output: nothing.
1062 */
1063 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1064 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1065 /**
1066 * Activity Action: Insert an empty item into the given container.
1067 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1068 * in which to place the data.
1069 * <p>Output: URI of the new data that was created.
1070 */
1071 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1072 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1073 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001074 * Activity Action: Create a new item in the given container, initializing it
1075 * from the current contents of the clipboard.
1076 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1077 * in which to place the data.
1078 * <p>Output: URI of the new data that was created.
1079 */
1080 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1081 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1082 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001083 * Activity Action: Delete the given data from its container.
1084 * <p>Input: {@link #getData} is URI of data to be deleted.
1085 * <p>Output: nothing.
1086 */
1087 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1088 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1089 /**
1090 * Activity Action: Run the data, whatever that means.
1091 * <p>Input: ? (Note: this is currently specific to the test harness.)
1092 * <p>Output: nothing.
1093 */
1094 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1095 public static final String ACTION_RUN = "android.intent.action.RUN";
1096 /**
1097 * Activity Action: Perform a data synchronization.
1098 * <p>Input: ?
1099 * <p>Output: ?
1100 */
1101 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1102 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1103 /**
1104 * Activity Action: Pick an activity given an intent, returning the class
1105 * selected.
1106 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1107 * used with {@link PackageManager#queryIntentActivities} to determine the
1108 * set of activities from which to pick.
1109 * <p>Output: Class name of the activity that was selected.
1110 */
1111 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1112 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1113 /**
1114 * Activity Action: Perform a search.
1115 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1116 * is the text to search for. If empty, simply
1117 * enter your search results Activity with the search UI activated.
1118 * <p>Output: nothing.
1119 */
1120 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1121 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1122 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001123 * Activity Action: Start the platform-defined tutorial
1124 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1125 * is the text to search for. If empty, simply
1126 * enter your search results Activity with the search UI activated.
1127 * <p>Output: nothing.
1128 */
1129 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1130 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1131 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001132 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001133 * <p>
1134 * Input: {@link android.app.SearchManager#QUERY
1135 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1136 * a url starts with http or https, the site will be opened. If it is plain
1137 * text, Google search will be applied.
1138 * <p>
1139 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001140 */
1141 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1142 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1143 /**
Jim Miller07994402012-05-02 14:22:27 -07001144 * Activity Action: Perform assist action.
1145 * <p>
1146 * Input: nothing
1147 * Output: nothing.
1148 */
1149 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1150 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
1151 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001152 * Activity Action: List all available applications
1153 * <p>Input: Nothing.
1154 * <p>Output: nothing.
1155 */
1156 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1157 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1158 /**
1159 * Activity Action: Show settings for choosing wallpaper
1160 * <p>Input: Nothing.
1161 * <p>Output: Nothing.
1162 */
1163 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1164 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1165
1166 /**
1167 * Activity Action: Show activity for reporting a bug.
1168 * <p>Input: Nothing.
1169 * <p>Output: Nothing.
1170 */
1171 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1172 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1173
1174 /**
1175 * Activity Action: Main entry point for factory tests. Only used when
1176 * the device is booting in factory test node. The implementing package
1177 * must be installed in the system image.
1178 * <p>Input: nothing
1179 * <p>Output: nothing
1180 */
1181 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1182
1183 /**
1184 * Activity Action: The user pressed the "call" button to go to the dialer
1185 * or other appropriate UI for placing a call.
1186 * <p>Input: Nothing.
1187 * <p>Output: Nothing.
1188 */
1189 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1190 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1191
1192 /**
1193 * Activity Action: Start Voice Command.
1194 * <p>Input: Nothing.
1195 * <p>Output: Nothing.
1196 */
1197 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1198 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001199
1200 /**
1201 * Activity Action: Start action associated with long pressing on the
1202 * search key.
1203 * <p>Input: Nothing.
1204 * <p>Output: Nothing.
1205 */
1206 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1207 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001208
Jacek Surazski86b6c532009-05-13 14:38:28 +02001209 /**
1210 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1211 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001212 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001213 * <p>Input: No data is specified. The bug report is passed in using
1214 * an {@link #EXTRA_BUG_REPORT} field.
1215 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001216 *
1217 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001218 */
1219 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1220 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001221
1222 /**
1223 * Activity Action: Show power usage information to the user.
1224 * <p>Input: Nothing.
1225 * <p>Output: Nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001229
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001230 /**
1231 * Activity Action: Setup wizard to launch after a platform update. This
1232 * activity should have a string meta-data field associated with it,
1233 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1234 * the platform for setup. The activity will be launched only if
1235 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1236 * same value.
1237 * <p>Input: Nothing.
1238 * <p>Output: Nothing.
1239 * @hide
1240 */
1241 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1242 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001243
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001244 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001245 * Activity Action: Show settings for managing network data usage of a
1246 * specific application. Applications should define an activity that offers
1247 * options to control data usage.
1248 */
1249 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1250 public static final String ACTION_MANAGE_NETWORK_USAGE =
1251 "android.intent.action.MANAGE_NETWORK_USAGE";
1252
1253 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001254 * Activity Action: Launch application installer.
1255 * <p>
1256 * Input: The data must be a content: or file: URI at which the application
1257 * can be retrieved. You can optionally supply
1258 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1259 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1260 * <p>
1261 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1262 * succeeded.
1263 *
1264 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1265 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1266 * @see #EXTRA_RETURN_RESULT
1267 */
1268 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1269 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1270
1271 /**
1272 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1273 * package. Specifies the installer package name; this package will receive the
1274 * {@link #ACTION_APP_ERROR} intent.
1275 */
1276 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1277 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1278
1279 /**
1280 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1281 * package. Specifies that the application being installed should not be
1282 * treated as coming from an unknown source, but as coming from the app
1283 * invoking the Intent. For this to work you must start the installer with
1284 * startActivityForResult().
1285 */
1286 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1287 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1288
1289 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001290 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1291 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001292 * data field originated from.
1293 */
rich cannings706e8ba2012-08-20 13:20:14 -07001294 public static final String EXTRA_ORIGINATING_URI
1295 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001296
1297 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001298 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1299 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1300 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001301 */
1302 public static final String EXTRA_REFERRER
1303 = "android.intent.extra.REFERRER";
1304
1305 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001306 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1307 * package. Tells the installer UI to skip the confirmation with the user
1308 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001309 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1310 * will no longer show an interstitial message about updating existing
1311 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001312 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001313 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001314 public static final String EXTRA_ALLOW_REPLACE
1315 = "android.intent.extra.ALLOW_REPLACE";
1316
1317 /**
1318 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1319 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1320 * return to the application the result code of the install/uninstall. The returned result
1321 * code will be {@link android.app.Activity#RESULT_OK} on success or
1322 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1323 */
1324 public static final String EXTRA_RETURN_RESULT
1325 = "android.intent.extra.RETURN_RESULT";
1326
1327 /**
1328 * Package manager install result code. @hide because result codes are not
1329 * yet ready to be exposed.
1330 */
1331 public static final String EXTRA_INSTALL_RESULT
1332 = "android.intent.extra.INSTALL_RESULT";
1333
1334 /**
1335 * Activity Action: Launch application uninstaller.
1336 * <p>
1337 * Input: The data must be a package: URI whose scheme specific part is
1338 * the package name of the current installed package to be uninstalled.
1339 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1340 * <p>
1341 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1342 * succeeded.
1343 */
1344 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1345 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1346
1347 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001348 * Specify whether the package should be uninstalled for all users.
1349 * @hide because these should not be part of normal application flow.
1350 */
1351 public static final String EXTRA_UNINSTALL_ALL_USERS
1352 = "android.intent.extra.UNINSTALL_ALL_USERS";
1353
1354 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001355 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1356 * describing the last run version of the platform that was setup.
1357 * @hide
1358 */
1359 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1360
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001361 // ---------------------------------------------------------------------
1362 // ---------------------------------------------------------------------
1363 // Standard intent broadcast actions (see action variable).
1364
1365 /**
1366 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001367 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001368 * <p class="note">This is a protected intent that can only be sent
1369 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001370 */
1371 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1372 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1373 /**
1374 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001375 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001376 * <p class="note">This is a protected intent that can only be sent
1377 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001378 */
1379 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1380 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001381
1382 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001383 * 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 -07001384 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001385 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001386 * <p class="note">This is a protected intent that can only be sent
1387 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001388 */
1389 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001390 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001391
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001392 /**
1393 * Broadcast Action: The current time has changed. Sent every
1394 * minute. You can <em>not</em> receive this through components declared
1395 * in manifests, only by exlicitly registering for it with
1396 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1397 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001398 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001399 * <p class="note">This is a protected intent that can only be sent
1400 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001401 */
1402 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1403 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1404 /**
1405 * Broadcast Action: The time was set.
1406 */
1407 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1408 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1409 /**
1410 * Broadcast Action: The date has changed.
1411 */
1412 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1413 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1414 /**
1415 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1416 * <ul>
1417 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1418 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001419 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001420 * <p class="note">This is a protected intent that can only be sent
1421 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001422 */
1423 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1424 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1425 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001426 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1427 * DNS entries should be tossed.
1428 * @hide
1429 */
1430 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1431 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1432 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001433 * Alarm Changed Action: This is broadcast when the AlarmClock
1434 * application's alarm is set or unset. It is used by the
1435 * AlarmClock application and the StatusBar service.
1436 * @hide
1437 */
1438 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1439 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1440 /**
1441 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1442 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1443 * @hide
1444 */
1445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1446 public static final String ACTION_SYNC_STATE_CHANGED
1447 = "android.intent.action.SYNC_STATE_CHANGED";
1448 /**
1449 * Broadcast Action: This is broadcast once, after the system has finished
1450 * booting. It can be used to perform application-specific initialization,
1451 * such as installing alarms. You must hold the
1452 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1453 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001454 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001455 * <p class="note">This is a protected intent that can only be sent
1456 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001457 */
1458 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1459 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1460 /**
1461 * Broadcast Action: This is broadcast when a user action should request a
1462 * temporary system dialog to dismiss. Some examples of temporary system
1463 * dialogs are the notification window-shade and the recent tasks dialog.
1464 */
1465 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1466 /**
1467 * Broadcast Action: Trigger the download and eventual installation
1468 * of a package.
1469 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001470 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001471 * <p class="note">This is a protected intent that can only be sent
1472 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001473 *
1474 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001475 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001476 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001477 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1478 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1479 /**
1480 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001481 * device. The data contains the name of the package. Note that the
1482 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001483 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001484 * <ul>
1485 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1486 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1487 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1488 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001489 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001490 * <p class="note">This is a protected intent that can only be sent
1491 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001492 */
1493 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1494 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1495 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001496 * Broadcast Action: A new version of an application package has been
1497 * installed, replacing an existing version that was previously installed.
1498 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001499 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001500 * <ul>
1501 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1502 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001503 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001504 * <p class="note">This is a protected intent that can only be sent
1505 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001506 */
1507 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1508 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1509 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001510 * Broadcast Action: A new version of your application has been installed
1511 * over an existing one. This is only sent to the application that was
1512 * replaced. It does not contain any additional data; to receive it, just
1513 * use an intent filter for this action.
1514 *
1515 * <p class="note">This is a protected intent that can only be sent
1516 * by the system.
1517 */
1518 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1519 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1520 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001521 * Broadcast Action: An existing application package has been removed from
1522 * the device. The data contains the name of the package. The package
1523 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001524 * <ul>
1525 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1526 * to the package.
1527 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1528 * application -- data and code -- is being removed.
1529 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1530 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1531 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001532 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001533 * <p class="note">This is a protected intent that can only be sent
1534 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001535 */
1536 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1537 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1538 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001539 * Broadcast Action: An existing application package has been completely
1540 * removed from the device. The data contains the name of the package.
1541 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1542 * {@link #EXTRA_DATA_REMOVED} is true and
1543 * {@link #EXTRA_REPLACING} is false of that broadcast.
1544 *
1545 * <ul>
1546 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1547 * to the package.
1548 * </ul>
1549 *
1550 * <p class="note">This is a protected intent that can only be sent
1551 * by the system.
1552 */
1553 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1554 public static final String ACTION_PACKAGE_FULLY_REMOVED
1555 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1556 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001557 * Broadcast Action: An existing application package has been changed (e.g.
1558 * a component has been enabled or disabled). The data contains the name of
1559 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001560 * <ul>
1561 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001562 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1563 * of the changed components.
1564 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1565 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001566 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001567 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001568 * <p class="note">This is a protected intent that can only be sent
1569 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001570 */
1571 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1572 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1573 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001574 * @hide
1575 * Broadcast Action: Ask system services if there is any reason to
1576 * restart the given package. The data contains the name of the
1577 * package.
1578 * <ul>
1579 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1580 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1581 * </ul>
1582 *
1583 * <p class="note">This is a protected intent that can only be sent
1584 * by the system.
1585 */
1586 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1587 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1588 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001589 * Broadcast Action: The user has restarted a package, and all of its
1590 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001591 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001592 * be removed. Note that the restarted package does <em>not</em>
1593 * receive this broadcast.
1594 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001595 * <ul>
1596 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1597 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001598 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001599 * <p class="note">This is a protected intent that can only be sent
1600 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001601 */
1602 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1603 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1604 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001605 * Broadcast Action: The user has cleared the data of a package. This should
1606 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001607 * its persistent data is erased and this broadcast sent.
1608 * Note that the cleared package does <em>not</em>
1609 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001610 * <ul>
1611 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1612 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001613 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001614 * <p class="note">This is a protected intent that can only be sent
1615 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001616 */
1617 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1618 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1619 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001620 * Broadcast Action: A user ID has been removed from the system. The user
1621 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001622 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001623 * <p class="note">This is a protected intent that can only be sent
1624 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001625 */
1626 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1627 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001628
1629 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001630 * Broadcast Action: Sent to the installer package of an application
1631 * when that application is first launched (that is the first time it
1632 * is moved out of the stopped state). The data contains the name of the package.
1633 *
1634 * <p class="note">This is a protected intent that can only be sent
1635 * by the system.
1636 */
1637 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1638 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1639
1640 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001641 * Broadcast Action: Sent to the system package verifier when a package
1642 * needs to be verified. The data contains the package URI.
1643 * <p class="note">
1644 * This is a protected intent that can only be sent by the system.
1645 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001646 */
1647 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1648 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1649
1650 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001651 * Broadcast Action: Sent to the system package verifier when a package is
1652 * verified. The data contains the package URI.
1653 * <p class="note">
1654 * This is a protected intent that can only be sent by the system.
1655 */
1656 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1657 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1658
1659 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001660 * Broadcast Action: Resources for a set of packages (which were
1661 * previously unavailable) are currently
1662 * available since the media on which they exist is available.
1663 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1664 * list of packages whose availability changed.
1665 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1666 * list of uids of packages whose availability changed.
1667 * Note that the
1668 * packages in this list do <em>not</em> receive this broadcast.
1669 * The specified set of packages are now available on the system.
1670 * <p>Includes the following extras:
1671 * <ul>
1672 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1673 * whose resources(were previously unavailable) are currently available.
1674 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1675 * packages whose resources(were previously unavailable)
1676 * are currently available.
1677 * </ul>
1678 *
1679 * <p class="note">This is a protected intent that can only be sent
1680 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001681 */
1682 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001683 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1684 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001685
1686 /**
1687 * Broadcast Action: Resources for a set of packages are currently
1688 * unavailable since the media on which they exist is unavailable.
1689 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1690 * list of packages whose availability changed.
1691 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1692 * list of uids of packages whose availability changed.
1693 * The specified set of packages can no longer be
1694 * launched and are practically unavailable on the system.
1695 * <p>Inclues the following extras:
1696 * <ul>
1697 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1698 * whose resources are no longer available.
1699 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1700 * whose resources are no longer available.
1701 * </ul>
1702 *
1703 * <p class="note">This is a protected intent that can only be sent
1704 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001705 */
1706 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001707 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001708 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001709
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001710 /**
1711 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001712 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001713 * This should <em>only</em> be used to determine when the wallpaper
1714 * has changed to show the new wallpaper to the user. You should certainly
1715 * never, in response to this, change the wallpaper or other attributes of
1716 * it such as the suggested size. That would be crazy, right? You'd cause
1717 * all kinds of loops, especially if other apps are doing similar things,
1718 * right? Of course. So please don't do this.
1719 *
1720 * @deprecated Modern applications should use
1721 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1722 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1723 * shown behind their UI, rather than watching for this broadcast and
1724 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001725 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001726 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001727 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1728 /**
1729 * Broadcast Action: The current device {@link android.content.res.Configuration}
1730 * (orientation, locale, etc) has changed. When such a change happens, the
1731 * UIs (view hierarchy) will need to be rebuilt based on this new
1732 * information; for the most part, applications don't need to worry about
1733 * this, because the system will take care of stopping and restarting the
1734 * application to make sure it sees the new changes. Some system code that
1735 * can not be restarted will need to watch for this action and handle it
1736 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001737 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001738 * <p class="note">
1739 * You can <em>not</em> receive this through components declared
1740 * in manifests, only by explicitly registering for it with
1741 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1742 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001743 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001744 * <p class="note">This is a protected intent that can only be sent
1745 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001746 *
1747 * @see android.content.res.Configuration
1748 */
1749 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1750 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1751 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001752 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001753 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001754 * <p class="note">This is a protected intent that can only be sent
1755 * by the system.
1756 */
1757 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1758 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1759 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001760 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1761 * charging state, level, and other information about the battery.
1762 * See {@link android.os.BatteryManager} for documentation on the
1763 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001764 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001765 * <p class="note">
1766 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001767 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001768 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001769 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1770 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1771 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1772 * broadcasts that are sent and can be received through manifest
1773 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001774 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001775 * <p class="note">This is a protected intent that can only be sent
1776 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001777 */
1778 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1779 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1780 /**
1781 * Broadcast Action: Indicates low battery condition on the device.
1782 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001783 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001784 * <p class="note">This is a protected intent that can only be sent
1785 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001786 */
1787 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1788 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1789 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001790 * Broadcast Action: Indicates the battery is now okay after being low.
1791 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1792 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001793 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001794 * <p class="note">This is a protected intent that can only be sent
1795 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001796 */
1797 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1798 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1799 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001800 * Broadcast Action: External power has been connected to the device.
1801 * This is intended for applications that wish to register specifically to this notification.
1802 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1803 * stay active to receive this notification. This action can be used to implement actions
1804 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001805 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001806 * <p class="note">This is a protected intent that can only be sent
1807 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001808 */
1809 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001810 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001811 /**
1812 * Broadcast Action: External power has been removed from the device.
1813 * This is intended for applications that wish to register specifically to this notification.
1814 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1815 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001816 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001817 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001818 * <p class="note">This is a protected intent that can only be sent
1819 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001820 */
1821 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001822 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001823 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001824 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001825 * Broadcast Action: Device is shutting down.
1826 * This is broadcast when the device is being shut down (completely turned
1827 * off, not sleeping). Once the broadcast is complete, the final shutdown
1828 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001829 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001830 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001831 * <p class="note">This is a protected intent that can only be sent
1832 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001833 */
1834 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001835 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001836 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001837 * Activity Action: Start this activity to request system shutdown.
1838 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1839 * to request confirmation from the user before shutting down.
1840 *
1841 * <p class="note">This is a protected intent that can only be sent
1842 * by the system.
1843 *
1844 * {@hide}
1845 */
1846 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1847 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001848 * Broadcast Action: A sticky broadcast that indicates low memory
1849 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001850 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001851 * <p class="note">This is a protected intent that can only be sent
1852 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001853 */
1854 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1855 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1856 /**
1857 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001858 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001859 * <p class="note">This is a protected intent that can only be sent
1860 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001861 */
1862 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1863 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1864 /**
Jake Hambybb371632010-08-23 18:16:48 -07001865 * Broadcast Action: A sticky broadcast that indicates a memory full
1866 * condition on the device. This is intended for activities that want
1867 * to be able to fill the data partition completely, leaving only
1868 * enough free space to prevent system-wide SQLite failures.
1869 *
1870 * <p class="note">This is a protected intent that can only be sent
1871 * by the system.
1872 *
1873 * {@hide}
1874 */
1875 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1876 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1877 /**
1878 * Broadcast Action: Indicates memory full condition on the device
1879 * no longer exists.
1880 *
1881 * <p class="note">This is a protected intent that can only be sent
1882 * by the system.
1883 *
1884 * {@hide}
1885 */
1886 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1887 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1888 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001889 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1890 * and package management should be started.
1891 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1892 * notification.
1893 */
1894 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1895 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1896 /**
1897 * Broadcast Action: The device has entered USB Mass Storage mode.
1898 * This is used mainly for the USB Settings panel.
1899 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1900 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001901 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001902 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001903 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001904 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1905
1906 /**
1907 * Broadcast Action: The device has exited USB Mass Storage mode.
1908 * This is used mainly for the USB Settings panel.
1909 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1910 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001911 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001912 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001913 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001914 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1915
1916 /**
1917 * Broadcast Action: External media has been removed.
1918 * The path to the mount point for the removed media is contained in the Intent.mData field.
1919 */
1920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1921 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1922
1923 /**
1924 * Broadcast Action: External media is present, but not mounted at its mount point.
1925 * The path to the mount point for the removed media is contained in the Intent.mData field.
1926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1929
1930 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001931 * Broadcast Action: External media is present, and being disk-checked
1932 * 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 -08001933 */
1934 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1935 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1936
1937 /**
1938 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1939 * 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 -08001940 */
1941 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1942 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1943
1944 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001945 * Broadcast Action: External media is present and mounted at its mount point.
1946 * The path to the mount point for the removed media is contained in the Intent.mData field.
1947 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1948 * media was mounted read only.
1949 */
1950 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1951 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1952
1953 /**
1954 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001955 * 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 -07001956 */
1957 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1958 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1959
1960 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001961 * Broadcast Action: External media is no longer being shared via USB mass storage.
1962 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1963 *
1964 * @hide
1965 */
1966 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1967
1968 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001969 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1970 * The path to the mount point for the removed media is contained in the Intent.mData field.
1971 */
1972 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1973 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1974
1975 /**
1976 * Broadcast Action: External media is present but cannot be mounted.
1977 * The path to the mount point for the removed media is contained in the Intent.mData field.
1978 */
1979 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1980 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1981
1982 /**
1983 * Broadcast Action: User has expressed the desire to remove the external storage media.
1984 * Applications should close all files they have open within the mount point when they receive this intent.
1985 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1986 */
1987 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1988 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1989
1990 /**
1991 * Broadcast Action: The media scanner has started scanning a directory.
1992 * The path to the directory being scanned is contained in the Intent.mData field.
1993 */
1994 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1995 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1996
1997 /**
1998 * Broadcast Action: The media scanner has finished scanning a directory.
1999 * The path to the scanned directory is contained in the Intent.mData field.
2000 */
2001 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2002 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2003
2004 /**
2005 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2006 * The path to the file is contained in the Intent.mData field.
2007 */
2008 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2009 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2010
2011 /**
2012 * Broadcast Action: The "Media Button" was pressed. Includes a single
2013 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2014 * caused the broadcast.
2015 */
2016 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2017 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2018
2019 /**
2020 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2021 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2022 * caused the broadcast.
2023 */
2024 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2025 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2026
2027 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2028 // location; they are not general-purpose actions.
2029
2030 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002031 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002032 */
2033 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2034 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2035 "android.intent.action.GTALK_CONNECTED";
2036
2037 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002038 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002039 */
2040 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2041 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2042 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002043
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002044 /**
2045 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002046 */
2047 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2048 public static final String ACTION_INPUT_METHOD_CHANGED =
2049 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002050
2051 /**
2052 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2053 * more radios have been turned off or on. The intent will have the following extra value:</p>
2054 * <ul>
2055 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2056 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2057 * turned off</li>
2058 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002059 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002060 * <p class="note">This is a protected intent that can only be sent
2061 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002062 */
2063 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2064 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2065
2066 /**
2067 * Broadcast Action: Some content providers have parts of their namespace
2068 * where they publish new events or items that the user may be especially
2069 * interested in. For these things, they may broadcast this action when the
2070 * set of interesting items change.
2071 *
2072 * For example, GmailProvider sends this notification when the set of unread
2073 * mail in the inbox changes.
2074 *
2075 * <p>The data of the intent identifies which part of which provider
2076 * changed. When queried through the content resolver, the data URI will
2077 * return the data set in question.
2078 *
2079 * <p>The intent will have the following extra values:
2080 * <ul>
2081 * <li><em>count</em> - The number of items in the data set. This is the
2082 * same as the number of items in the cursor returned by querying the
2083 * data URI. </li>
2084 * </ul>
2085 *
2086 * This intent will be sent at boot (if the count is non-zero) and when the
2087 * data set changes. It is possible for the data set to change without the
2088 * count changing (for example, if a new unread message arrives in the same
2089 * sync operation in which a message is archived). The phone should still
2090 * ring/vibrate/etc as normal in this case.
2091 */
2092 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2093 public static final String ACTION_PROVIDER_CHANGED =
2094 "android.intent.action.PROVIDER_CHANGED";
2095
2096 /**
2097 * Broadcast Action: Wired Headset plugged in or unplugged.
2098 *
2099 * <p>The intent will have the following extra values:
2100 * <ul>
2101 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2102 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002103 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002104 * </ul>
2105 * </ul>
2106 */
2107 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2108 public static final String ACTION_HEADSET_PLUG =
2109 "android.intent.action.HEADSET_PLUG";
2110
2111 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002112 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2113 *
2114 * <p>The intent will have the following extra values:
2115 * <ul>
2116 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2117 * <li><em>name</em> - Headset type, human readable string </li>
2118 * </ul>
2119 * </ul>
2120 * @hide
2121 */
2122 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002123 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2124 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002125
2126 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002127 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002128 *
2129 * <p>The intent will have the following extra values:
2130 * <ul>
2131 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2132 * <li><em>name</em> - Headset type, human readable string </li>
2133 * </ul>
2134 * </ul>
2135 * @hide
2136 */
2137 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002138 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2139 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002140
2141 /**
2142 * Broadcast Action: A HMDI cable was plugged or unplugged
2143 *
2144 * <p>The intent will have the following extra values:
2145 * <ul>
2146 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2147 * <li><em>name</em> - HDMI cable, human readable string </li>
2148 * </ul>
2149 * </ul>
2150 * @hide
2151 */
2152 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2153 public static final String ACTION_HDMI_AUDIO_PLUG =
2154 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002155
2156 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002157 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2158 *
2159 * <p>The intent will have the following extra values:
2160 * <ul>
2161 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2162 * <li><em>card</em> - ALSA card number (integer) </li>
2163 * <li><em>device</em> - ALSA device number (integer) </li>
2164 * </ul>
2165 * </ul>
2166 * @hide
2167 */
2168 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2169 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2170 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2171
2172 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002173 * Broadcast Action: A USB audio device was plugged in or unplugged.
2174 *
2175 * <p>The intent will have the following extra values:
2176 * <ul>
2177 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2178 * <li><em>card</em> - ALSA card number (integer) </li>
2179 * <li><em>device</em> - ALSA device number (integer) </li>
2180 * </ul>
2181 * </ul>
2182 * @hide
2183 */
2184 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2185 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2186 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2187
2188 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002189 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2190 * <ul>
2191 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2192 * </ul>
2193 *
2194 * <p class="note">This is a protected intent that can only be sent
2195 * by the system.
2196 *
2197 * @hide
2198 */
2199 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2200 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2201 = "android.intent.action.ADVANCED_SETTINGS";
2202
2203 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002204 * Broadcast Action: An outgoing call is about to be placed.
2205 *
2206 * <p>The Intent will have the following extra value:
2207 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002208 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002209 * the phone number originally intended to be dialed.</li>
2210 * </ul>
2211 * <p>Once the broadcast is finished, the resultData is used as the actual
2212 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002213 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002214 * outgoing call in turn: for example, a parental control application
2215 * might verify that the user is authorized to place the call at that
2216 * time, then a number-rewriting application might add an area code if
2217 * one was not specified.</p>
2218 * <p>For consistency, any receiver whose purpose is to prohibit phone
2219 * calls should have a priority of 0, to ensure it will see the final
2220 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002221 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002222 * should have a positive priority.
2223 * Negative priorities are reserved for the system for this broadcast;
2224 * using them may cause problems.</p>
2225 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2226 * abort the broadcast.</p>
2227 * <p>Emergency calls cannot be intercepted using this mechanism, and
2228 * other calls cannot be modified to call emergency numbers using this
2229 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002230 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002231 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2232 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002233 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002234 * <p class="note">This is a protected intent that can only be sent
2235 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002236 */
2237 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2238 public static final String ACTION_NEW_OUTGOING_CALL =
2239 "android.intent.action.NEW_OUTGOING_CALL";
2240
2241 /**
2242 * Broadcast Action: Have the device reboot. This is only for use by
2243 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002244 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002245 * <p class="note">This is a protected intent that can only be sent
2246 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002247 */
2248 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2249 public static final String ACTION_REBOOT =
2250 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002251
Wei Huang97ecc9c2009-05-11 17:44:20 -07002252 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002253 * Broadcast Action: A sticky broadcast for changes in the physical
2254 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002255 *
2256 * <p>The intent will have the following extra values:
2257 * <ul>
2258 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002259 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002260 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002261 * <p>This is intended for monitoring the current physical dock state.
2262 * See {@link android.app.UiModeManager} for the normal API dealing with
2263 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002264 */
2265 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2266 public static final String ACTION_DOCK_EVENT =
2267 "android.intent.action.DOCK_EVENT";
2268
2269 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002270 * Broadcast Action: a remote intent is to be broadcasted.
2271 *
2272 * A remote intent is used for remote RPC between devices. The remote intent
2273 * is serialized and sent from one device to another device. The receiving
2274 * device parses the remote intent and broadcasts it. Note that anyone can
2275 * broadcast a remote intent. However, if the intent receiver of the remote intent
2276 * does not trust intent broadcasts from arbitrary intent senders, it should require
2277 * the sender to hold certain permissions so only trusted sender's broadcast will be
2278 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002279 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002280 */
2281 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002282 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002283
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002284 /**
2285 * Broadcast Action: hook for permforming cleanup after a system update.
2286 *
2287 * The broadcast is sent when the system is booting, before the
2288 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2289 * image. A receiver for this should do its work and then disable itself
2290 * so that it does not get run again at the next boot.
2291 * @hide
2292 */
2293 public static final String ACTION_PRE_BOOT_COMPLETED =
2294 "android.intent.action.PRE_BOOT_COMPLETED";
2295
Amith Yamasani13593602012-03-22 16:16:17 -07002296 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002297 * Sent the first time a user is starting, to allow system apps to
2298 * perform one time initialization. (This will not be seen by third
2299 * party applications because a newly initialized user does not have any
2300 * third party applications installed for it.) This is sent early in
2301 * starting the user, around the time the home app is started, before
2302 * {@link #ACTION_BOOT_COMPLETED} is sent.
2303 */
2304 public static final String ACTION_USER_INITIALIZE =
2305 "android.intent.action.USER_INITIALIZE";
2306
2307 /**
2308 * Sent when a user switch is happening, causing the process's user to be
2309 * brought to the foreground. This is only sent to receivers registered
2310 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2311 * Context.registerReceiver}. It is sent to the user that is going to the
2312 * foreground.
2313 */
2314 public static final String ACTION_USER_FOREGROUND =
2315 "android.intent.action.USER_FOREGROUND";
2316
2317 /**
2318 * Sent when a user switch is happening, causing the process's user to be
2319 * sent to the background. This is only sent to receivers registered
2320 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2321 * Context.registerReceiver}. It is sent to the user that is going to the
2322 * background.
2323 */
2324 public static final String ACTION_USER_BACKGROUND =
2325 "android.intent.action.USER_BACKGROUND";
2326
2327 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002328 * Broadcast sent to the system when a user is added. Carries an extra EXTRA_USER_HANDLE that has the
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002329 * userHandle of the new user. It is sent to all running users. You must hold
2330 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002331 * @hide
2332 */
2333 public static final String ACTION_USER_ADDED =
2334 "android.intent.action.USER_ADDED";
2335
2336 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002337 * Broadcast sent to the system when a user is started. Carries an extra EXTRA_USER_HANDLE that has
2338 * the userHandle of the user. This is only sent to
2339 * registered receivers, not manifest receivers. It is sent to the user
2340 * that has been started.
2341 * @hide
2342 */
2343 public static final String ACTION_USER_STARTED =
2344 "android.intent.action.USER_STARTED";
2345
2346 /**
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002347 * Broadcast sent to the system when a user is stopped. Carries an extra EXTRA_USER_HANDLE that has
2348 * the userHandle of the user. This is similar to {@link #ACTION_PACKAGE_RESTARTED},
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002349 * but for an entire user instead of a specific package. This is only sent to
2350 * registered receivers, not manifest receivers. It is sent to all running
2351 * users <em>except</em> the one that has just been stopped (which is no
2352 * longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002353 * @hide
2354 */
2355 public static final String ACTION_USER_STOPPED =
2356 "android.intent.action.USER_STOPPED";
2357
2358 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002359 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002360 * the userHandle of the user. It is sent to all running users except the
2361 * one that has been removed. You must hold
2362 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002363 * @hide
2364 */
2365 public static final String ACTION_USER_REMOVED =
2366 "android.intent.action.USER_REMOVED";
2367
2368 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002369 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002370 * the userHandle of the user to become the current one. This is only sent to
2371 * registered receivers, not manifest receivers. It is sent to all running users.
2372 * You must hold
2373 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002374 * @hide
2375 */
2376 public static final String ACTION_USER_SWITCHED =
2377 "android.intent.action.USER_SWITCHED";
2378
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002379 /**
2380 * Broadcast sent to the system when a user's information changes. Carries an extra
2381 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2382 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2383 * whose information has changed.
2384 * @hide
2385 */
2386 public static final String ACTION_USER_INFO_CHANGED =
2387 "android.intent.action.USER_INFO_CHANGED";
2388
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002389 // ---------------------------------------------------------------------
2390 // ---------------------------------------------------------------------
2391 // Standard intent categories (see addCategory()).
2392
2393 /**
2394 * Set if the activity should be an option for the default action
2395 * (center press) to perform on a piece of data. Setting this will
2396 * hide from the user any activities without it set when performing an
2397 * action on some data. Note that this is normal -not- set in the
2398 * Intent when initiating an action -- it is for use in intent filters
2399 * specified in packages.
2400 */
2401 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2402 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2403 /**
2404 * Activities that can be safely invoked from a browser must support this
2405 * category. For example, if the user is viewing a web page or an e-mail
2406 * and clicks on a link in the text, the Intent generated execute that
2407 * link will require the BROWSABLE category, so that only activities
2408 * supporting this category will be considered as possible actions. By
2409 * supporting this category, you are promising that there is nothing
2410 * damaging (without user intervention) that can happen by invoking any
2411 * matching Intent.
2412 */
2413 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2414 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2415 /**
2416 * Set if the activity should be considered as an alternative action to
2417 * the data the user is currently viewing. See also
2418 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2419 * applies to the selection in a list of items.
2420 *
2421 * <p>Supporting this category means that you would like your activity to be
2422 * displayed in the set of alternative things the user can do, usually as
2423 * part of the current activity's options menu. You will usually want to
2424 * include a specific label in the &lt;intent-filter&gt; of this action
2425 * describing to the user what it does.
2426 *
2427 * <p>The action of IntentFilter with this category is important in that it
2428 * describes the specific action the target will perform. This generally
2429 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2430 * a specific name such as "com.android.camera.action.CROP. Only one
2431 * alternative of any particular action will be shown to the user, so using
2432 * a specific action like this makes sure that your alternative will be
2433 * displayed while also allowing other applications to provide their own
2434 * overrides of that particular action.
2435 */
2436 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2437 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2438 /**
2439 * Set if the activity should be considered as an alternative selection
2440 * action to the data the user has currently selected. This is like
2441 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2442 * of items from which the user can select, giving them alternatives to the
2443 * default action that will be performed on it.
2444 */
2445 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2446 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2447 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002448 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002449 */
2450 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2451 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2452 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002453 * Should be displayed in the top-level launcher.
2454 */
2455 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2456 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2457 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002458 * Provides information about the package it is in; typically used if
2459 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2460 * a front-door to the user without having to be shown in the all apps list.
2461 */
2462 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2463 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2464 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002465 * This is the home activity, that is the first activity that is displayed
2466 * when the device boots.
2467 */
2468 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2469 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2470 /**
2471 * This activity is a preference panel.
2472 */
2473 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2474 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2475 /**
2476 * This activity is a development preference panel.
2477 */
2478 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2479 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2480 /**
2481 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002482 */
2483 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2484 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2485 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002486 * This activity allows the user to browse and download new applications.
2487 */
2488 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2489 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2490 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002491 * This activity may be exercised by the monkey or other automated test tools.
2492 */
2493 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2494 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2495 /**
2496 * To be used as a test (not part of the normal user experience).
2497 */
2498 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2499 /**
2500 * To be used as a unit test (run through the Test Harness).
2501 */
2502 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2503 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002504 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002505 * experience).
2506 */
2507 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2508 /**
2509 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2510 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2511 * when queried, though it is allowable for those columns to be blank.
2512 */
2513 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2514 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2515
2516 /**
2517 * To be used as code under test for framework instrumentation tests.
2518 */
2519 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2520 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002521 /**
2522 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002523 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2524 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002525 */
2526 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2527 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2528 /**
2529 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002530 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2531 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002532 */
2533 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2534 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002535 /**
2536 * An activity to run when device is inserted into a analog (low end) dock.
2537 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2538 * information, see {@link android.app.UiModeManager}.
2539 */
2540 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2541 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2542
2543 /**
2544 * An activity to run when device is inserted into a digital (high end) dock.
2545 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2546 * information, see {@link android.app.UiModeManager}.
2547 */
2548 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2549 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002550
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002551 /**
2552 * Used to indicate that the activity can be used in a car environment.
2553 */
2554 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2555 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2556
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002557 // ---------------------------------------------------------------------
2558 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002559 // Application launch intent categories (see addCategory()).
2560
2561 /**
2562 * Used with {@link #ACTION_MAIN} to launch the browser application.
2563 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002564 * <p>NOTE: This should not be used as the primary key of an Intent,
2565 * since it will not result in the app launching with the correct
2566 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002567 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002568 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002569 */
2570 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2571 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2572
2573 /**
2574 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2575 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002576 * <p>NOTE: This should not be used as the primary key of an Intent,
2577 * since it will not result in the app launching with the correct
2578 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002579 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002580 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002581 */
2582 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2583 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2584
2585 /**
2586 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2587 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002588 * <p>NOTE: This should not be used as the primary key of an Intent,
2589 * since it will not result in the app launching with the correct
2590 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002591 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002592 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002593 */
2594 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2595 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2596
2597 /**
2598 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2599 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002600 * <p>NOTE: This should not be used as the primary key of an Intent,
2601 * since it will not result in the app launching with the correct
2602 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002603 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002604 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002605 */
2606 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2607 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2608
2609 /**
2610 * Used with {@link #ACTION_MAIN} to launch the email application.
2611 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002612 * <p>NOTE: This should not be used as the primary key of an Intent,
2613 * since it will not result in the app launching with the correct
2614 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002615 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002616 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002617 */
2618 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2619 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2620
2621 /**
2622 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2623 * The activity should be able to view and manipulate image and video files
2624 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002625 * <p>NOTE: This should not be used as the primary key of an Intent,
2626 * since it will not result in the app launching with the correct
2627 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002628 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002629 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002630 */
2631 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2632 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2633
2634 /**
2635 * Used with {@link #ACTION_MAIN} to launch the maps application.
2636 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002637 * <p>NOTE: This should not be used as the primary key of an Intent,
2638 * since it will not result in the app launching with the correct
2639 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002640 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002641 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002642 */
2643 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2644 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2645
2646 /**
2647 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2648 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002649 * <p>NOTE: This should not be used as the primary key of an Intent,
2650 * since it will not result in the app launching with the correct
2651 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002652 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002653 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002654 */
2655 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2656 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2657
2658 /**
2659 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002660 * The activity should be able to play, browse, or manipulate music files
2661 * stored on the device.
2662 * <p>NOTE: This should not be used as the primary key of an Intent,
2663 * since it will not result in the app launching with the correct
2664 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002665 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002666 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002667 */
2668 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2669 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2670
2671 // ---------------------------------------------------------------------
2672 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002673 // Standard extra data keys.
2674
2675 /**
2676 * The initial data to place in a newly created record. Use with
2677 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2678 * fields as would be given to the underlying ContentProvider.insert()
2679 * call.
2680 */
2681 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2682
2683 /**
2684 * A constant CharSequence that is associated with the Intent, used with
2685 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2686 * this may be a styled CharSequence, so you must use
2687 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2688 * retrieve it.
2689 */
2690 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2691
2692 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002693 * A constant String that is associated with the Intent, used with
2694 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2695 * as HTML formatted text. Note that you <em>must</em> also supply
2696 * {@link #EXTRA_TEXT}.
2697 */
2698 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2699
2700 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002701 * A content: URI holding a stream of data associated with the Intent,
2702 * used with {@link #ACTION_SEND} to supply the data being sent.
2703 */
2704 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2705
2706 /**
2707 * A String[] holding e-mail addresses that should be delivered to.
2708 */
2709 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2710
2711 /**
2712 * A String[] holding e-mail addresses that should be carbon copied.
2713 */
2714 public static final String EXTRA_CC = "android.intent.extra.CC";
2715
2716 /**
2717 * A String[] holding e-mail addresses that should be blind carbon copied.
2718 */
2719 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2720
2721 /**
2722 * A constant string holding the desired subject line of a message.
2723 */
2724 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2725
2726 /**
2727 * An Intent describing the choices you would like shown with
2728 * {@link #ACTION_PICK_ACTIVITY}.
2729 */
2730 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2731
2732 /**
2733 * A CharSequence dialog title to provide to the user when used with a
2734 * {@link #ACTION_CHOOSER}.
2735 */
2736 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2737
2738 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002739 * A Parcelable[] of {@link Intent} or
2740 * {@link android.content.pm.LabeledIntent} objects as set with
2741 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2742 * a the front of the list of choices, when shown to the user with a
2743 * {@link #ACTION_CHOOSER}.
2744 */
2745 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2746
2747 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002748 * A {@link android.view.KeyEvent} object containing the event that
2749 * triggered the creation of the Intent it is in.
2750 */
2751 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2752
2753 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002754 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2755 * before shutting down.
2756 *
2757 * {@hide}
2758 */
2759 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2760
2761 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002762 * 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 -07002763 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2764 * of restarting the application.
2765 */
2766 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2767
2768 /**
2769 * A String holding the phone number originally entered in
2770 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2771 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2772 */
2773 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002774
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002775 /**
2776 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2777 * intents to supply the uid the package had been assigned. Also an optional
2778 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2779 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2780 * purpose.
2781 */
2782 public static final String EXTRA_UID = "android.intent.extra.UID";
2783
2784 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002785 * @hide String array of package names.
2786 */
2787 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2788
2789 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002790 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2791 * intents to indicate whether this represents a full uninstall (removing
2792 * both the code and its data) or a partial uninstall (leaving its data,
2793 * implying that this is an update).
2794 */
2795 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002796
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002797 /**
2798 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2799 * intents to indicate that this is a replacement of the package, so this
2800 * broadcast will immediately be followed by an add broadcast for a
2801 * different version of the same package.
2802 */
2803 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002804
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002805 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002806 * Used as an int extra field in {@link android.app.AlarmManager} intents
2807 * to tell the application being invoked how many pending alarms are being
2808 * delievered with the intent. For one-shot alarms this will always be 1.
2809 * For recurring alarms, this might be greater than 1 if the device was
2810 * asleep or powered off at the time an earlier alarm would have been
2811 * delivered.
2812 */
2813 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002814
Jacek Surazski86b6c532009-05-13 14:38:28 +02002815 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002816 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2817 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002818 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2819 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002820 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2821 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2822 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002823 */
2824 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2825
2826 /**
2827 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2828 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002829 */
2830 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2831
2832 /**
2833 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2834 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002835 */
2836 public static final int EXTRA_DOCK_STATE_DESK = 1;
2837
2838 /**
2839 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2840 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002841 */
2842 public static final int EXTRA_DOCK_STATE_CAR = 2;
2843
2844 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002845 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2846 * to represent that the phone is in a analog (low end) dock.
2847 */
2848 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2849
2850 /**
2851 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2852 * to represent that the phone is in a digital (high end) dock.
2853 */
2854 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2855
2856 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002857 * Boolean that can be supplied as meta-data with a dock activity, to
2858 * indicate that the dock should take over the home key when it is active.
2859 */
2860 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002861
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002862 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002863 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2864 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002865 */
2866 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2867
2868 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002869 * Used in the extra field in the remote intent. It's astring token passed with the
2870 * remote intent.
2871 */
2872 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2873 "android.intent.extra.remote_intent_token";
2874
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002875 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002876 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002877 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002878 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002879 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002880 "android.intent.extra.changed_component_name";
2881
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002882 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002883 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002884 * and contains a string array of all of the components that have changed.
2885 */
2886 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2887 "android.intent.extra.changed_component_name_list";
2888
2889 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002890 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002891 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2892 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002893 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002894 */
2895 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2896 "android.intent.extra.changed_package_list";
2897
2898 /**
2899 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002900 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2901 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002902 * and contains an integer array of uids of all of the components
2903 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002904 */
2905 public static final String EXTRA_CHANGED_UID_LIST =
2906 "android.intent.extra.changed_uid_list";
2907
2908 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002909 * @hide
2910 * Magic extra system code can use when binding, to give a label for
2911 * who it is that has bound to a service. This is an integer giving
2912 * a framework string resource that can be displayed to the user.
2913 */
2914 public static final String EXTRA_CLIENT_LABEL =
2915 "android.intent.extra.client_label";
2916
2917 /**
2918 * @hide
2919 * Magic extra system code can use when binding, to give a PendingIntent object
2920 * that can be launched for the user to disable the system's use of this
2921 * service.
2922 */
2923 public static final String EXTRA_CLIENT_INTENT =
2924 "android.intent.extra.client_intent";
2925
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002926 /**
2927 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2928 * data that is on the local device. This is a boolean extra; the default
2929 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2930 * the user to select media that is already on the device, not requiring it
2931 * be downloaded from a remote service when opened. Another way to look
2932 * at it is that such content should generally have a "_data" column to the
2933 * path of the content on local external storage.
2934 */
2935 public static final String EXTRA_LOCAL_ONLY =
2936 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07002937
Amith Yamasani13593602012-03-22 16:16:17 -07002938 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002939 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07002940 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
2941 * @hide
2942 */
Amith Yamasani2a003292012-08-14 18:25:45 -07002943 public static final String EXTRA_USER_HANDLE =
2944 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07002945
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002946 // ---------------------------------------------------------------------
2947 // ---------------------------------------------------------------------
2948 // Intent flags (see mFlags variable).
2949
2950 /**
2951 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002952 * perform read operations on the Uri in the Intent's data and any URIs
2953 * specified in its ClipData. When applying to an Intent's ClipData,
2954 * all URIs as well as recursive traversals through data or other ClipData
2955 * in Intent items will be granted; only the grant flags of the top-level
2956 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002957 */
2958 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2959 /**
2960 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002961 * perform write operations on the Uri in the Intent's data and any URIs
2962 * specified in its ClipData. When applying to an Intent's ClipData,
2963 * all URIs as well as recursive traversals through data or other ClipData
2964 * in Intent items will be granted; only the grant flags of the top-level
2965 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002966 */
2967 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2968 /**
2969 * Can be set by the caller to indicate that this Intent is coming from
2970 * a background operation, not from direct user interaction.
2971 */
2972 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2973 /**
2974 * A flag you can enable for debugging: when set, log messages will be
2975 * printed during the resolution of this intent to show you what has
2976 * been found to create the final resolved list.
2977 */
2978 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002979 /**
2980 * If set, this intent will not match any components in packages that
2981 * are currently stopped. If this is not set, then the default behavior
2982 * is to include such applications in the result.
2983 */
2984 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2985 /**
2986 * If set, this intent will always match any components in packages that
2987 * are currently stopped. This is the default behavior when
2988 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2989 * flags are set, this one wins (it allows overriding of exclude for
2990 * places where the framework may automatically set the exclude flag).
2991 */
2992 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002993
2994 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002995 * If set, the new activity is not kept in the history stack. As soon as
2996 * the user navigates away from it, the activity is finished. This may also
2997 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2998 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002999 */
3000 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3001 /**
3002 * If set, the activity will not be launched if it is already running
3003 * at the top of the history stack.
3004 */
3005 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3006 /**
3007 * If set, this activity will become the start of a new task on this
3008 * history stack. A task (from the activity that started it to the
3009 * next task activity) defines an atomic group of activities that the
3010 * user can move to. Tasks can be moved to the foreground and background;
3011 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003012 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003013 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3014 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003015 *
3016 * <p>This flag is generally used by activities that want
3017 * to present a "launcher" style behavior: they give the user a list of
3018 * separate things that can be done, which otherwise run completely
3019 * independently of the activity launching them.
3020 *
3021 * <p>When using this flag, if a task is already running for the activity
3022 * you are now starting, then a new activity will not be started; instead,
3023 * the current task will simply be brought to the front of the screen with
3024 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3025 * to disable this behavior.
3026 *
3027 * <p>This flag can not be used when the caller is requesting a result from
3028 * the activity being launched.
3029 */
3030 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3031 /**
3032 * <strong>Do not use this flag unless you are implementing your own
3033 * top-level application launcher.</strong> Used in conjunction with
3034 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3035 * behavior of bringing an existing task to the foreground. When set,
3036 * a new task is <em>always</em> started to host the Activity for the
3037 * Intent, regardless of whether there is already an existing task running
3038 * the same thing.
3039 *
3040 * <p><strong>Because the default system does not include graphical task management,
3041 * you should not use this flag unless you provide some way for a user to
3042 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003043 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003044 * <p>This flag is ignored if
3045 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3046 *
Scott Main7aee61f2011-02-08 11:25:01 -08003047 * <p>See
3048 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3049 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003050 */
3051 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3052 /**
3053 * If set, and the activity being launched is already running in the
3054 * current task, then instead of launching a new instance of that activity,
3055 * all of the other activities on top of it will be closed and this Intent
3056 * will be delivered to the (now on top) old activity as a new Intent.
3057 *
3058 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3059 * If D calls startActivity() with an Intent that resolves to the component
3060 * of activity B, then C and D will be finished and B receive the given
3061 * Intent, resulting in the stack now being: A, B.
3062 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003063 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003064 * either receive the new intent you are starting here in its
3065 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003066 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003067 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3068 * the same intent, then it will be finished and re-created; for all other
3069 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3070 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003071 *
3072 * <p>This launch mode can also be used to good effect in conjunction with
3073 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3074 * of a task, it will bring any currently running instance of that task
3075 * to the foreground, and then clear it to its root state. This is
3076 * especially useful, for example, when launching an activity from the
3077 * notification manager.
3078 *
Scott Main7aee61f2011-02-08 11:25:01 -08003079 * <p>See
3080 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3081 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003082 */
3083 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3084 /**
3085 * If set and this intent is being used to launch a new activity from an
3086 * existing one, then the reply target of the existing activity will be
3087 * transfered to the new activity. This way the new activity can call
3088 * {@link android.app.Activity#setResult} and have that result sent back to
3089 * the reply target of the original activity.
3090 */
3091 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3092 /**
3093 * If set and this intent is being used to launch a new activity from an
3094 * existing one, the current activity will not be counted as the top
3095 * activity for deciding whether the new intent should be delivered to
3096 * the top instead of starting a new one. The previous activity will
3097 * be used as the top, with the assumption being that the current activity
3098 * will finish itself immediately.
3099 */
3100 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3101 /**
3102 * If set, the new activity is not kept in the list of recently launched
3103 * activities.
3104 */
3105 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3106 /**
3107 * This flag is not normally set by application code, but set for you by
3108 * the system as described in the
3109 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3110 * launchMode} documentation for the singleTask mode.
3111 */
3112 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3113 /**
3114 * If set, and this activity is either being started in a new task or
3115 * bringing to the top an existing task, then it will be launched as
3116 * the front door of the task. This will result in the application of
3117 * any affinities needed to have that task in the proper state (either
3118 * moving activities to or from it), or simply resetting that task to
3119 * its initial state if needed.
3120 */
3121 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3122 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003123 * This flag is not normally set by application code, but set for you by
3124 * the system if this activity is being launched from history
3125 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003126 */
3127 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003128 /**
3129 * If set, this marks a point in the task's activity stack that should
3130 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003131 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003132 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3133 * the user re-launching it from home), this activity and all on top of
3134 * it will be finished so that the user does not return to them, but
3135 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003136 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003137 * <p>This is useful for cases where you have a logical break in your
3138 * application. For example, an e-mail application may have a command
3139 * to view an attachment, which launches an image view activity to
3140 * display it. This activity should be part of the e-mail application's
3141 * task, since it is a part of the task the user is involved in. However,
3142 * if the user leaves that task, and later selects the e-mail app from
3143 * home, we may like them to return to the conversation they were
3144 * viewing, not the picture attachment, since that is confusing. By
3145 * setting this flag when launching the image viewer, that viewer and
3146 * any activities it starts will be removed the next time the user returns
3147 * to mail.
3148 */
3149 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003150 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003151 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003152 * callback from occurring on the current frontmost activity before it is
3153 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003154 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003155 * <p>Typically, an activity can rely on that callback to indicate that an
3156 * explicit user action has caused their activity to be moved out of the
3157 * foreground. The callback marks an appropriate point in the activity's
3158 * lifecycle for it to dismiss any notifications that it intends to display
3159 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003160 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003161 * <p>If an activity is ever started via any non-user-driven events such as
3162 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3163 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003164 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003165 */
3166 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003167 /**
3168 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3169 * this flag will cause the launched activity to be brought to the front of its
3170 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003171 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003172 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3173 * If D calls startActivity() with an Intent that resolves to the component
3174 * of activity B, then B will be brought to the front of the history stack,
3175 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003176 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003177 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003178 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003179 */
3180 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003181 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003182 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3183 * this flag will prevent the system from applying an activity transition
3184 * animation to go to the next activity state. This doesn't mean an
3185 * animation will never run -- if another activity change happens that doesn't
3186 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003187 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003188 * when you are going to do a series of activity operations but the
3189 * animation seen by the user shouldn't be driven by the first activity
3190 * change but rather a later one.
3191 */
3192 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3193 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003194 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3195 * this flag will cause any existing task that would be associated with the
3196 * activity to be cleared before the activity is started. That is, the activity
3197 * becomes the new root of an otherwise empty task, and any old activities
3198 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3199 */
3200 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3201 /**
3202 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3203 * this flag will cause a newly launching task to be placed on top of the current
3204 * home activity task (if there is one). That is, pressing back from the task
3205 * will always return the user to home even if that was not the last activity they
3206 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3207 */
3208 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3209 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003210 * If set, when sending a broadcast only registered receivers will be
3211 * called -- no BroadcastReceiver components will be launched.
3212 */
3213 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003214 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003215 * If set, when sending a broadcast the new broadcast will replace
3216 * any existing pending broadcast that matches it. Matching is defined
3217 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3218 * true for the intents of the two broadcasts. When a match is found,
3219 * the new broadcast (and receivers associated with it) will replace the
3220 * existing one in the pending broadcast list, remaining at the same
3221 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003222 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003223 * <p>This flag is most typically used with sticky broadcasts, which
3224 * only care about delivering the most recent values of the broadcast
3225 * to their receivers.
3226 */
3227 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3228 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003229 * If set, when sending a broadcast the recipient is allowed to run at
3230 * foreground priority, with a shorter timeout interval. During normal
3231 * broadcasts the receivers are not automatically hoisted out of the
3232 * background priority class.
3233 */
3234 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3235 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003236 * If set, when sending a broadcast <i>before boot has completed</i> only
3237 * registered receivers will be called -- no BroadcastReceiver components
3238 * will be launched. Sticky intent state will be recorded properly even
3239 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3240 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003241 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003242 * <p>This flag is only for use by system sevices as a convenience to
3243 * avoid having to implement a more complex mechanism around detection
3244 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003245 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003246 * @hide
3247 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003248 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003249 /**
3250 * Set when this broadcast is for a boot upgrade, a special mode that
3251 * allows the broadcast to be sent before the system is ready and launches
3252 * the app process with no providers running in it.
3253 * @hide
3254 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003255 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003256
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003257 /**
3258 * @hide Flags that can't be changed with PendingIntent.
3259 */
3260 public static final int IMMUTABLE_FLAGS =
3261 FLAG_GRANT_READ_URI_PERMISSION
3262 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003263
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003264 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003265 // ---------------------------------------------------------------------
3266 // toUri() and parseUri() options.
3267
3268 /**
3269 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3270 * always has the "intent:" scheme. This syntax can be used when you want
3271 * to later disambiguate between URIs that are intended to describe an
3272 * Intent vs. all others that should be treated as raw URIs. When used
3273 * with {@link #parseUri}, any other scheme will result in a generic
3274 * VIEW action for that raw URI.
3275 */
3276 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003277
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003278 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003279
3280 private String mAction;
3281 private Uri mData;
3282 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003283 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003284 private ComponentName mComponent;
3285 private int mFlags;
3286 private HashSet<String> mCategories;
3287 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003288 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003289 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003290 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003291
3292 // ---------------------------------------------------------------------
3293
3294 /**
3295 * Create an empty intent.
3296 */
3297 public Intent() {
3298 }
3299
3300 /**
3301 * Copy constructor.
3302 */
3303 public Intent(Intent o) {
3304 this.mAction = o.mAction;
3305 this.mData = o.mData;
3306 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003307 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003308 this.mComponent = o.mComponent;
3309 this.mFlags = o.mFlags;
3310 if (o.mCategories != null) {
3311 this.mCategories = new HashSet<String>(o.mCategories);
3312 }
3313 if (o.mExtras != null) {
3314 this.mExtras = new Bundle(o.mExtras);
3315 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003316 if (o.mSourceBounds != null) {
3317 this.mSourceBounds = new Rect(o.mSourceBounds);
3318 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003319 if (o.mSelector != null) {
3320 this.mSelector = new Intent(o.mSelector);
3321 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003322 if (o.mClipData != null) {
3323 this.mClipData = new ClipData(o.mClipData);
3324 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003325 }
3326
3327 @Override
3328 public Object clone() {
3329 return new Intent(this);
3330 }
3331
3332 private Intent(Intent o, boolean all) {
3333 this.mAction = o.mAction;
3334 this.mData = o.mData;
3335 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003336 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003337 this.mComponent = o.mComponent;
3338 if (o.mCategories != null) {
3339 this.mCategories = new HashSet<String>(o.mCategories);
3340 }
3341 }
3342
3343 /**
3344 * Make a clone of only the parts of the Intent that are relevant for
3345 * filter matching: the action, data, type, component, and categories.
3346 */
3347 public Intent cloneFilter() {
3348 return new Intent(this, false);
3349 }
3350
3351 /**
3352 * Create an intent with a given action. All other fields (data, type,
3353 * class) are null. Note that the action <em>must</em> be in a
3354 * namespace because Intents are used globally in the system -- for
3355 * example the system VIEW action is android.intent.action.VIEW; an
3356 * application's custom action would be something like
3357 * com.google.app.myapp.CUSTOM_ACTION.
3358 *
3359 * @param action The Intent action, such as ACTION_VIEW.
3360 */
3361 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003362 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003363 }
3364
3365 /**
3366 * Create an intent with a given action and for a given data url. Note
3367 * that the action <em>must</em> be in a namespace because Intents are
3368 * used globally in the system -- for example the system VIEW action is
3369 * android.intent.action.VIEW; an application's custom action would be
3370 * something like com.google.app.myapp.CUSTOM_ACTION.
3371 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003372 * <p><em>Note: scheme and host name matching in the Android framework is
3373 * case-sensitive, unlike the formal RFC. As a result,
3374 * you should always ensure that you write your Uri with these elements
3375 * using lower case letters, and normalize any Uris you receive from
3376 * outside of Android to ensure the scheme and host is lower case.</em></p>
3377 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003378 * @param action The Intent action, such as ACTION_VIEW.
3379 * @param uri The Intent data URI.
3380 */
3381 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003382 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003383 mData = uri;
3384 }
3385
3386 /**
3387 * Create an intent for a specific component. All other fields (action, data,
3388 * type, class) are null, though they can be modified later with explicit
3389 * calls. This provides a convenient way to create an intent that is
3390 * intended to execute a hard-coded class name, rather than relying on the
3391 * system to find an appropriate class for you; see {@link #setComponent}
3392 * for more information on the repercussions of this.
3393 *
3394 * @param packageContext A Context of the application package implementing
3395 * this class.
3396 * @param cls The component class that is to be used for the intent.
3397 *
3398 * @see #setClass
3399 * @see #setComponent
3400 * @see #Intent(String, android.net.Uri , Context, Class)
3401 */
3402 public Intent(Context packageContext, Class<?> cls) {
3403 mComponent = new ComponentName(packageContext, cls);
3404 }
3405
3406 /**
3407 * Create an intent for a specific component with a specified action and data.
3408 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3409 * construct the Intent and then calling {@link #setClass} to set its
3410 * class.
3411 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003412 * <p><em>Note: scheme and host name matching in the Android framework is
3413 * case-sensitive, unlike the formal RFC. As a result,
3414 * you should always ensure that you write your Uri with these elements
3415 * using lower case letters, and normalize any Uris you receive from
3416 * outside of Android to ensure the scheme and host is lower case.</em></p>
3417 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003418 * @param action The Intent action, such as ACTION_VIEW.
3419 * @param uri The Intent data URI.
3420 * @param packageContext A Context of the application package implementing
3421 * this class.
3422 * @param cls The component class that is to be used for the intent.
3423 *
3424 * @see #Intent(String, android.net.Uri)
3425 * @see #Intent(Context, Class)
3426 * @see #setClass
3427 * @see #setComponent
3428 */
3429 public Intent(String action, Uri uri,
3430 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003431 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003432 mData = uri;
3433 mComponent = new ComponentName(packageContext, cls);
3434 }
3435
3436 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003437 * Create an intent to launch the main (root) activity of a task. This
3438 * is the Intent that is started when the application's is launched from
3439 * Home. For anything else that wants to launch an application in the
3440 * same way, it is important that they use an Intent structured the same
3441 * way, and can use this function to ensure this is the case.
3442 *
3443 * <p>The returned Intent has the given Activity component as its explicit
3444 * component, {@link #ACTION_MAIN} as its action, and includes the
3445 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3446 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3447 * to do that through {@link #addFlags(int)} on the returned Intent.
3448 *
3449 * @param mainActivity The main activity component that this Intent will
3450 * launch.
3451 * @return Returns a newly created Intent that can be used to launch the
3452 * activity as a main application entry.
3453 *
3454 * @see #setClass
3455 * @see #setComponent
3456 */
3457 public static Intent makeMainActivity(ComponentName mainActivity) {
3458 Intent intent = new Intent(ACTION_MAIN);
3459 intent.setComponent(mainActivity);
3460 intent.addCategory(CATEGORY_LAUNCHER);
3461 return intent;
3462 }
3463
3464 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003465 * Make an Intent for the main activity of an application, without
3466 * specifying a specific activity to run but giving a selector to find
3467 * the activity. This results in a final Intent that is structured
3468 * the same as when the application is launched from
3469 * Home. For anything else that wants to launch an application in the
3470 * same way, it is important that they use an Intent structured the same
3471 * way, and can use this function to ensure this is the case.
3472 *
3473 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3474 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3475 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3476 * to do that through {@link #addFlags(int)} on the returned Intent.
3477 *
3478 * @param selectorAction The action name of the Intent's selector.
3479 * @param selectorCategory The name of a category to add to the Intent's
3480 * selector.
3481 * @return Returns a newly created Intent that can be used to launch the
3482 * activity as a main application entry.
3483 *
3484 * @see #setSelector(Intent)
3485 */
3486 public static Intent makeMainSelectorActivity(String selectorAction,
3487 String selectorCategory) {
3488 Intent intent = new Intent(ACTION_MAIN);
3489 intent.addCategory(CATEGORY_LAUNCHER);
3490 Intent selector = new Intent();
3491 selector.setAction(selectorAction);
3492 selector.addCategory(selectorCategory);
3493 intent.setSelector(selector);
3494 return intent;
3495 }
3496
3497 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003498 * Make an Intent that can be used to re-launch an application's task
3499 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3500 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3501 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3502 *
3503 * @param mainActivity The activity component that is the root of the
3504 * task; this is the activity that has been published in the application's
3505 * manifest as the main launcher icon.
3506 *
3507 * @return Returns a newly created Intent that can be used to relaunch the
3508 * activity's task in its root state.
3509 */
3510 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3511 Intent intent = makeMainActivity(mainActivity);
3512 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3513 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3514 return intent;
3515 }
3516
3517 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003518 * Call {@link #parseUri} with 0 flags.
3519 * @deprecated Use {@link #parseUri} instead.
3520 */
3521 @Deprecated
3522 public static Intent getIntent(String uri) throws URISyntaxException {
3523 return parseUri(uri, 0);
3524 }
Tom Taylord4a47292009-12-21 13:59:18 -08003525
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003526 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003527 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003528 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003529 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003530 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003531 *
3532 * <p>The URI given here must not be relative -- that is, it must include
3533 * the scheme and full path.
3534 *
3535 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003536 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003537 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003538 *
3539 * @return Intent The newly created Intent object.
3540 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003541 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3542 * it bad (as parsed by the Uri class) or the Intent data within the
3543 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003544 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003545 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003546 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003547 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003548 int i = 0;
3549 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003550 // Validate intent scheme for if requested.
3551 if ((flags&URI_INTENT_SCHEME) != 0) {
3552 if (!uri.startsWith("intent:")) {
3553 Intent intent = new Intent(ACTION_VIEW);
3554 try {
3555 intent.setData(Uri.parse(uri));
3556 } catch (IllegalArgumentException e) {
3557 throw new URISyntaxException(uri, e.getMessage());
3558 }
3559 return intent;
3560 }
3561 }
Tom Taylord4a47292009-12-21 13:59:18 -08003562
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003563 // simple case
3564 i = uri.lastIndexOf("#");
3565 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3566
3567 // old format Intent URI
3568 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003569
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003570 // new format
3571 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003572 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003573
3574 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003575 String data = i >= 0 ? uri.substring(0, i) : null;
3576 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003577 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003578
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003579 // loop over contents of Intent, all name=value;
3580 while (!uri.startsWith("end", i)) {
3581 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003582 if (eq < 0) eq = i-1;
3583 int semi = uri.indexOf(';', i);
3584 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003585
3586 // action
3587 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003588 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003589 }
3590
3591 // categories
3592 else if (uri.startsWith("category=", i)) {
3593 intent.addCategory(value);
3594 }
3595
3596 // type
3597 else if (uri.startsWith("type=", i)) {
3598 intent.mType = value;
3599 }
3600
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003601 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003602 else if (uri.startsWith("launchFlags=", i)) {
3603 intent.mFlags = Integer.decode(value).intValue();
3604 }
3605
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003606 // package
3607 else if (uri.startsWith("package=", i)) {
3608 intent.mPackage = value;
3609 }
3610
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003611 // component
3612 else if (uri.startsWith("component=", i)) {
3613 intent.mComponent = ComponentName.unflattenFromString(value);
3614 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003615
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003616 // scheme
3617 else if (uri.startsWith("scheme=", i)) {
3618 scheme = value;
3619 }
3620
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003621 // source bounds
3622 else if (uri.startsWith("sourceBounds=", i)) {
3623 intent.mSourceBounds = Rect.unflattenFromString(value);
3624 }
3625
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003626 // selector
3627 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3628 intent = new Intent();
3629 }
3630
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003631 // extra
3632 else {
3633 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003634 // create Bundle if it doesn't already exist
3635 if (intent.mExtras == null) intent.mExtras = new Bundle();
3636 Bundle b = intent.mExtras;
3637 // add EXTRA
3638 if (uri.startsWith("S.", i)) b.putString(key, value);
3639 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3640 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3641 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3642 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3643 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3644 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3645 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3646 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3647 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3648 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003650 // move to the next item
3651 i = semi + 1;
3652 }
3653
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003654 if (intent != baseIntent) {
3655 // The Intent had a selector; fix it up.
3656 baseIntent.setSelector(intent);
3657 intent = baseIntent;
3658 }
3659
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003660 if (data != null) {
3661 if (data.startsWith("intent:")) {
3662 data = data.substring(7);
3663 if (scheme != null) {
3664 data = scheme + ':' + data;
3665 }
3666 }
Tom Taylord4a47292009-12-21 13:59:18 -08003667
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003668 if (data.length() > 0) {
3669 try {
3670 intent.mData = Uri.parse(data);
3671 } catch (IllegalArgumentException e) {
3672 throw new URISyntaxException(uri, e.getMessage());
3673 }
3674 }
3675 }
Tom Taylord4a47292009-12-21 13:59:18 -08003676
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003677 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003678
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003679 } catch (IndexOutOfBoundsException e) {
3680 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3681 }
3682 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003683
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003684 public static Intent getIntentOld(String uri) throws URISyntaxException {
3685 Intent intent;
3686
3687 int i = uri.lastIndexOf('#');
3688 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003689 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003690 final int intentFragmentStart = i;
3691 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003692
3693 i++;
3694
3695 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003696 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003697 i += 7;
3698 int j = uri.indexOf(')', i);
3699 action = uri.substring(i, j);
3700 i = j + 1;
3701 }
3702
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003703 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003704
3705 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003706 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003707 i += 11;
3708 int j = uri.indexOf(')', i);
3709 while (i < j) {
3710 int sep = uri.indexOf('!', i);
3711 if (sep < 0) sep = j;
3712 if (i < sep) {
3713 intent.addCategory(uri.substring(i, sep));
3714 }
3715 i = sep + 1;
3716 }
3717 i = j + 1;
3718 }
3719
3720 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003721 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003722 i += 5;
3723 int j = uri.indexOf(')', i);
3724 intent.mType = uri.substring(i, j);
3725 i = j + 1;
3726 }
3727
3728 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003729 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003730 i += 12;
3731 int j = uri.indexOf(')', i);
3732 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3733 i = j + 1;
3734 }
3735
3736 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003737 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003738 i += 10;
3739 int j = uri.indexOf(')', i);
3740 int sep = uri.indexOf('!', i);
3741 if (sep >= 0 && sep < j) {
3742 String pkg = uri.substring(i, sep);
3743 String cls = uri.substring(sep + 1, j);
3744 intent.mComponent = new ComponentName(pkg, cls);
3745 }
3746 i = j + 1;
3747 }
3748
3749 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003750 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003751 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003752
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003753 final int closeParen = uri.indexOf(')', i);
3754 if (closeParen == -1) throw new URISyntaxException(uri,
3755 "EXTRA missing trailing ')'", i);
3756
3757 while (i < closeParen) {
3758 // fetch the key value
3759 int j = uri.indexOf('=', i);
3760 if (j <= i + 1 || i >= closeParen) {
3761 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3762 }
3763 char type = uri.charAt(i);
3764 i++;
3765 String key = uri.substring(i, j);
3766 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003767
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003768 // get type-value
3769 j = uri.indexOf('!', i);
3770 if (j == -1 || j >= closeParen) j = closeParen;
3771 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3772 String value = uri.substring(i, j);
3773 i = j;
3774
3775 // create Bundle if it doesn't already exist
3776 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003777
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003778 // add item to bundle
3779 try {
3780 switch (type) {
3781 case 'S':
3782 intent.mExtras.putString(key, Uri.decode(value));
3783 break;
3784 case 'B':
3785 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3786 break;
3787 case 'b':
3788 intent.mExtras.putByte(key, Byte.parseByte(value));
3789 break;
3790 case 'c':
3791 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3792 break;
3793 case 'd':
3794 intent.mExtras.putDouble(key, Double.parseDouble(value));
3795 break;
3796 case 'f':
3797 intent.mExtras.putFloat(key, Float.parseFloat(value));
3798 break;
3799 case 'i':
3800 intent.mExtras.putInt(key, Integer.parseInt(value));
3801 break;
3802 case 'l':
3803 intent.mExtras.putLong(key, Long.parseLong(value));
3804 break;
3805 case 's':
3806 intent.mExtras.putShort(key, Short.parseShort(value));
3807 break;
3808 default:
3809 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3810 }
3811 } catch (NumberFormatException e) {
3812 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3813 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003814
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003815 char ch = uri.charAt(i);
3816 if (ch == ')') break;
3817 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3818 i++;
3819 }
3820 }
3821
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003822 if (isIntentFragment) {
3823 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3824 } else {
3825 intent.mData = Uri.parse(uri);
3826 }
Tom Taylord4a47292009-12-21 13:59:18 -08003827
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003828 if (intent.mAction == null) {
3829 // By default, if no action is specified, then use VIEW.
3830 intent.mAction = ACTION_VIEW;
3831 }
3832
3833 } else {
3834 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3835 }
3836
3837 return intent;
3838 }
3839
3840 /**
3841 * Retrieve the general action to be performed, such as
3842 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3843 * the information in the intent should be interpreted -- most importantly,
3844 * what to do with the data returned by {@link #getData}.
3845 *
3846 * @return The action of this intent or null if none is specified.
3847 *
3848 * @see #setAction
3849 */
3850 public String getAction() {
3851 return mAction;
3852 }
3853
3854 /**
3855 * Retrieve data this intent is operating on. This URI specifies the name
3856 * of the data; often it uses the content: scheme, specifying data in a
3857 * content provider. Other schemes may be handled by specific activities,
3858 * such as http: by the web browser.
3859 *
3860 * @return The URI of the data this intent is targeting or null.
3861 *
3862 * @see #getScheme
3863 * @see #setData
3864 */
3865 public Uri getData() {
3866 return mData;
3867 }
3868
3869 /**
3870 * The same as {@link #getData()}, but returns the URI as an encoded
3871 * String.
3872 */
3873 public String getDataString() {
3874 return mData != null ? mData.toString() : null;
3875 }
3876
3877 /**
3878 * Return the scheme portion of the intent's data. If the data is null or
3879 * does not include a scheme, null is returned. Otherwise, the scheme
3880 * prefix without the final ':' is returned, i.e. "http".
3881 *
3882 * <p>This is the same as calling getData().getScheme() (and checking for
3883 * null data).
3884 *
3885 * @return The scheme of this intent.
3886 *
3887 * @see #getData
3888 */
3889 public String getScheme() {
3890 return mData != null ? mData.getScheme() : null;
3891 }
3892
3893 /**
3894 * Retrieve any explicit MIME type included in the intent. This is usually
3895 * null, as the type is determined by the intent data.
3896 *
3897 * @return If a type was manually set, it is returned; else null is
3898 * returned.
3899 *
3900 * @see #resolveType(ContentResolver)
3901 * @see #setType
3902 */
3903 public String getType() {
3904 return mType;
3905 }
3906
3907 /**
3908 * Return the MIME data type of this intent. If the type field is
3909 * explicitly set, that is simply returned. Otherwise, if the data is set,
3910 * the type of that data is returned. If neither fields are set, a null is
3911 * returned.
3912 *
3913 * @return The MIME type of this intent.
3914 *
3915 * @see #getType
3916 * @see #resolveType(ContentResolver)
3917 */
3918 public String resolveType(Context context) {
3919 return resolveType(context.getContentResolver());
3920 }
3921
3922 /**
3923 * Return the MIME data type of this intent. If the type field is
3924 * explicitly set, that is simply returned. Otherwise, if the data is set,
3925 * the type of that data is returned. If neither fields are set, a null is
3926 * returned.
3927 *
3928 * @param resolver A ContentResolver that can be used to determine the MIME
3929 * type of the intent's data.
3930 *
3931 * @return The MIME type of this intent.
3932 *
3933 * @see #getType
3934 * @see #resolveType(Context)
3935 */
3936 public String resolveType(ContentResolver resolver) {
3937 if (mType != null) {
3938 return mType;
3939 }
3940 if (mData != null) {
3941 if ("content".equals(mData.getScheme())) {
3942 return resolver.getType(mData);
3943 }
3944 }
3945 return null;
3946 }
3947
3948 /**
3949 * Return the MIME data type of this intent, only if it will be needed for
3950 * intent resolution. This is not generally useful for application code;
3951 * it is used by the frameworks for communicating with back-end system
3952 * services.
3953 *
3954 * @param resolver A ContentResolver that can be used to determine the MIME
3955 * type of the intent's data.
3956 *
3957 * @return The MIME type of this intent, or null if it is unknown or not
3958 * needed.
3959 */
3960 public String resolveTypeIfNeeded(ContentResolver resolver) {
3961 if (mComponent != null) {
3962 return mType;
3963 }
3964 return resolveType(resolver);
3965 }
3966
3967 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003968 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003969 *
3970 * @param category The category to check.
3971 *
3972 * @return boolean True if the intent contains the category, else false.
3973 *
3974 * @see #getCategories
3975 * @see #addCategory
3976 */
3977 public boolean hasCategory(String category) {
3978 return mCategories != null && mCategories.contains(category);
3979 }
3980
3981 /**
3982 * Return the set of all categories in the intent. If there are no categories,
3983 * returns NULL.
3984 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003985 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003986 *
3987 * @see #hasCategory
3988 * @see #addCategory
3989 */
3990 public Set<String> getCategories() {
3991 return mCategories;
3992 }
3993
3994 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003995 * Return the specific selector associated with this Intent. If there is
3996 * none, returns null. See {@link #setSelector} for more information.
3997 *
3998 * @see #setSelector
3999 */
4000 public Intent getSelector() {
4001 return mSelector;
4002 }
4003
4004 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004005 * Return the {@link ClipData} associated with this Intent. If there is
4006 * none, returns null. See {@link #setClipData} for more information.
4007 *
4008 * @see #setClipData;
4009 */
4010 public ClipData getClipData() {
4011 return mClipData;
4012 }
4013
4014 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004015 * Sets the ClassLoader that will be used when unmarshalling
4016 * any Parcelable values from the extras of this Intent.
4017 *
4018 * @param loader a ClassLoader, or null to use the default loader
4019 * at the time of unmarshalling.
4020 */
4021 public void setExtrasClassLoader(ClassLoader loader) {
4022 if (mExtras != null) {
4023 mExtras.setClassLoader(loader);
4024 }
4025 }
4026
4027 /**
4028 * Returns true if an extra value is associated with the given name.
4029 * @param name the extra's name
4030 * @return true if the given extra is present.
4031 */
4032 public boolean hasExtra(String name) {
4033 return mExtras != null && mExtras.containsKey(name);
4034 }
4035
4036 /**
4037 * Returns true if the Intent's extras contain a parcelled file descriptor.
4038 * @return true if the Intent contains a parcelled file descriptor.
4039 */
4040 public boolean hasFileDescriptors() {
4041 return mExtras != null && mExtras.hasFileDescriptors();
4042 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004043
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004044 /** @hide */
4045 public void setAllowFds(boolean allowFds) {
4046 if (mExtras != null) {
4047 mExtras.setAllowFds(allowFds);
4048 }
4049 }
4050
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004051 /**
4052 * Retrieve extended data from the intent.
4053 *
4054 * @param name The name of the desired item.
4055 *
4056 * @return the value of an item that previously added with putExtra()
4057 * or null if none was found.
4058 *
4059 * @deprecated
4060 * @hide
4061 */
4062 @Deprecated
4063 public Object getExtra(String name) {
4064 return getExtra(name, null);
4065 }
4066
4067 /**
4068 * Retrieve extended data from the intent.
4069 *
4070 * @param name The name of the desired item.
4071 * @param defaultValue the value to be returned if no value of the desired
4072 * type is stored with the given name.
4073 *
4074 * @return the value of an item that previously added with putExtra()
4075 * or the default value if none was found.
4076 *
4077 * @see #putExtra(String, boolean)
4078 */
4079 public boolean getBooleanExtra(String name, boolean defaultValue) {
4080 return mExtras == null ? defaultValue :
4081 mExtras.getBoolean(name, defaultValue);
4082 }
4083
4084 /**
4085 * Retrieve extended data from the intent.
4086 *
4087 * @param name The name of the desired item.
4088 * @param defaultValue the value to be returned if no value of the desired
4089 * type is stored with the given name.
4090 *
4091 * @return the value of an item that previously added with putExtra()
4092 * or the default value if none was found.
4093 *
4094 * @see #putExtra(String, byte)
4095 */
4096 public byte getByteExtra(String name, byte defaultValue) {
4097 return mExtras == null ? defaultValue :
4098 mExtras.getByte(name, defaultValue);
4099 }
4100
4101 /**
4102 * Retrieve extended data from the intent.
4103 *
4104 * @param name The name of the desired item.
4105 * @param defaultValue the value to be returned if no value of the desired
4106 * type is stored with the given name.
4107 *
4108 * @return the value of an item that previously added with putExtra()
4109 * or the default value if none was found.
4110 *
4111 * @see #putExtra(String, short)
4112 */
4113 public short getShortExtra(String name, short defaultValue) {
4114 return mExtras == null ? defaultValue :
4115 mExtras.getShort(name, defaultValue);
4116 }
4117
4118 /**
4119 * Retrieve extended data from the intent.
4120 *
4121 * @param name The name of the desired item.
4122 * @param defaultValue the value to be returned if no value of the desired
4123 * type is stored with the given name.
4124 *
4125 * @return the value of an item that previously added with putExtra()
4126 * or the default value if none was found.
4127 *
4128 * @see #putExtra(String, char)
4129 */
4130 public char getCharExtra(String name, char defaultValue) {
4131 return mExtras == null ? defaultValue :
4132 mExtras.getChar(name, defaultValue);
4133 }
4134
4135 /**
4136 * Retrieve extended data from the intent.
4137 *
4138 * @param name The name of the desired item.
4139 * @param defaultValue the value to be returned if no value of the desired
4140 * type is stored with the given name.
4141 *
4142 * @return the value of an item that previously added with putExtra()
4143 * or the default value if none was found.
4144 *
4145 * @see #putExtra(String, int)
4146 */
4147 public int getIntExtra(String name, int defaultValue) {
4148 return mExtras == null ? defaultValue :
4149 mExtras.getInt(name, defaultValue);
4150 }
4151
4152 /**
4153 * Retrieve extended data from the intent.
4154 *
4155 * @param name The name of the desired item.
4156 * @param defaultValue the value to be returned if no value of the desired
4157 * type is stored with the given name.
4158 *
4159 * @return the value of an item that previously added with putExtra()
4160 * or the default value if none was found.
4161 *
4162 * @see #putExtra(String, long)
4163 */
4164 public long getLongExtra(String name, long defaultValue) {
4165 return mExtras == null ? defaultValue :
4166 mExtras.getLong(name, defaultValue);
4167 }
4168
4169 /**
4170 * Retrieve extended data from the intent.
4171 *
4172 * @param name The name of the desired item.
4173 * @param defaultValue the value to be returned if no value of the desired
4174 * type is stored with the given name.
4175 *
4176 * @return the value of an item that previously added with putExtra(),
4177 * or the default value if no such item is present
4178 *
4179 * @see #putExtra(String, float)
4180 */
4181 public float getFloatExtra(String name, float defaultValue) {
4182 return mExtras == null ? defaultValue :
4183 mExtras.getFloat(name, defaultValue);
4184 }
4185
4186 /**
4187 * Retrieve extended data from the intent.
4188 *
4189 * @param name The name of the desired item.
4190 * @param defaultValue the value to be returned if no value of the desired
4191 * type is stored with the given name.
4192 *
4193 * @return the value of an item that previously added with putExtra()
4194 * or the default value if none was found.
4195 *
4196 * @see #putExtra(String, double)
4197 */
4198 public double getDoubleExtra(String name, double defaultValue) {
4199 return mExtras == null ? defaultValue :
4200 mExtras.getDouble(name, defaultValue);
4201 }
4202
4203 /**
4204 * Retrieve extended data from the intent.
4205 *
4206 * @param name The name of the desired item.
4207 *
4208 * @return the value of an item that previously added with putExtra()
4209 * or null if no String value was found.
4210 *
4211 * @see #putExtra(String, String)
4212 */
4213 public String getStringExtra(String name) {
4214 return mExtras == null ? null : mExtras.getString(name);
4215 }
4216
4217 /**
4218 * Retrieve extended data from the intent.
4219 *
4220 * @param name The name of the desired item.
4221 *
4222 * @return the value of an item that previously added with putExtra()
4223 * or null if no CharSequence value was found.
4224 *
4225 * @see #putExtra(String, CharSequence)
4226 */
4227 public CharSequence getCharSequenceExtra(String name) {
4228 return mExtras == null ? null : mExtras.getCharSequence(name);
4229 }
4230
4231 /**
4232 * Retrieve extended data from the intent.
4233 *
4234 * @param name The name of the desired item.
4235 *
4236 * @return the value of an item that previously added with putExtra()
4237 * or null if no Parcelable value was found.
4238 *
4239 * @see #putExtra(String, Parcelable)
4240 */
4241 public <T extends Parcelable> T getParcelableExtra(String name) {
4242 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4243 }
4244
4245 /**
4246 * Retrieve extended data from the intent.
4247 *
4248 * @param name The name of the desired item.
4249 *
4250 * @return the value of an item that previously added with putExtra()
4251 * or null if no Parcelable[] value was found.
4252 *
4253 * @see #putExtra(String, Parcelable[])
4254 */
4255 public Parcelable[] getParcelableArrayExtra(String name) {
4256 return mExtras == null ? null : mExtras.getParcelableArray(name);
4257 }
4258
4259 /**
4260 * Retrieve extended data from the intent.
4261 *
4262 * @param name The name of the desired item.
4263 *
4264 * @return the value of an item that previously added with putExtra()
4265 * or null if no ArrayList<Parcelable> value was found.
4266 *
4267 * @see #putParcelableArrayListExtra(String, ArrayList)
4268 */
4269 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4270 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4271 }
4272
4273 /**
4274 * Retrieve extended data from the intent.
4275 *
4276 * @param name The name of the desired item.
4277 *
4278 * @return the value of an item that previously added with putExtra()
4279 * or null if no Serializable value was found.
4280 *
4281 * @see #putExtra(String, Serializable)
4282 */
4283 public Serializable getSerializableExtra(String name) {
4284 return mExtras == null ? null : mExtras.getSerializable(name);
4285 }
4286
4287 /**
4288 * Retrieve extended data from the intent.
4289 *
4290 * @param name The name of the desired item.
4291 *
4292 * @return the value of an item that previously added with putExtra()
4293 * or null if no ArrayList<Integer> value was found.
4294 *
4295 * @see #putIntegerArrayListExtra(String, ArrayList)
4296 */
4297 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4298 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4299 }
4300
4301 /**
4302 * Retrieve extended data from the intent.
4303 *
4304 * @param name The name of the desired item.
4305 *
4306 * @return the value of an item that previously added with putExtra()
4307 * or null if no ArrayList<String> value was found.
4308 *
4309 * @see #putStringArrayListExtra(String, ArrayList)
4310 */
4311 public ArrayList<String> getStringArrayListExtra(String name) {
4312 return mExtras == null ? null : mExtras.getStringArrayList(name);
4313 }
4314
4315 /**
4316 * Retrieve extended data from the intent.
4317 *
4318 * @param name The name of the desired item.
4319 *
4320 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004321 * or null if no ArrayList<CharSequence> value was found.
4322 *
4323 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4324 */
4325 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4326 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4327 }
4328
4329 /**
4330 * Retrieve extended data from the intent.
4331 *
4332 * @param name The name of the desired item.
4333 *
4334 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004335 * or null if no boolean array value was found.
4336 *
4337 * @see #putExtra(String, boolean[])
4338 */
4339 public boolean[] getBooleanArrayExtra(String name) {
4340 return mExtras == null ? null : mExtras.getBooleanArray(name);
4341 }
4342
4343 /**
4344 * Retrieve extended data from the intent.
4345 *
4346 * @param name The name of the desired item.
4347 *
4348 * @return the value of an item that previously added with putExtra()
4349 * or null if no byte array value was found.
4350 *
4351 * @see #putExtra(String, byte[])
4352 */
4353 public byte[] getByteArrayExtra(String name) {
4354 return mExtras == null ? null : mExtras.getByteArray(name);
4355 }
4356
4357 /**
4358 * Retrieve extended data from the intent.
4359 *
4360 * @param name The name of the desired item.
4361 *
4362 * @return the value of an item that previously added with putExtra()
4363 * or null if no short array value was found.
4364 *
4365 * @see #putExtra(String, short[])
4366 */
4367 public short[] getShortArrayExtra(String name) {
4368 return mExtras == null ? null : mExtras.getShortArray(name);
4369 }
4370
4371 /**
4372 * Retrieve extended data from the intent.
4373 *
4374 * @param name The name of the desired item.
4375 *
4376 * @return the value of an item that previously added with putExtra()
4377 * or null if no char array value was found.
4378 *
4379 * @see #putExtra(String, char[])
4380 */
4381 public char[] getCharArrayExtra(String name) {
4382 return mExtras == null ? null : mExtras.getCharArray(name);
4383 }
4384
4385 /**
4386 * Retrieve extended data from the intent.
4387 *
4388 * @param name The name of the desired item.
4389 *
4390 * @return the value of an item that previously added with putExtra()
4391 * or null if no int array value was found.
4392 *
4393 * @see #putExtra(String, int[])
4394 */
4395 public int[] getIntArrayExtra(String name) {
4396 return mExtras == null ? null : mExtras.getIntArray(name);
4397 }
4398
4399 /**
4400 * Retrieve extended data from the intent.
4401 *
4402 * @param name The name of the desired item.
4403 *
4404 * @return the value of an item that previously added with putExtra()
4405 * or null if no long array value was found.
4406 *
4407 * @see #putExtra(String, long[])
4408 */
4409 public long[] getLongArrayExtra(String name) {
4410 return mExtras == null ? null : mExtras.getLongArray(name);
4411 }
4412
4413 /**
4414 * Retrieve extended data from the intent.
4415 *
4416 * @param name The name of the desired item.
4417 *
4418 * @return the value of an item that previously added with putExtra()
4419 * or null if no float array value was found.
4420 *
4421 * @see #putExtra(String, float[])
4422 */
4423 public float[] getFloatArrayExtra(String name) {
4424 return mExtras == null ? null : mExtras.getFloatArray(name);
4425 }
4426
4427 /**
4428 * Retrieve extended data from the intent.
4429 *
4430 * @param name The name of the desired item.
4431 *
4432 * @return the value of an item that previously added with putExtra()
4433 * or null if no double array value was found.
4434 *
4435 * @see #putExtra(String, double[])
4436 */
4437 public double[] getDoubleArrayExtra(String name) {
4438 return mExtras == null ? null : mExtras.getDoubleArray(name);
4439 }
4440
4441 /**
4442 * Retrieve extended data from the intent.
4443 *
4444 * @param name The name of the desired item.
4445 *
4446 * @return the value of an item that previously added with putExtra()
4447 * or null if no String array value was found.
4448 *
4449 * @see #putExtra(String, String[])
4450 */
4451 public String[] getStringArrayExtra(String name) {
4452 return mExtras == null ? null : mExtras.getStringArray(name);
4453 }
4454
4455 /**
4456 * Retrieve extended data from the intent.
4457 *
4458 * @param name The name of the desired item.
4459 *
4460 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004461 * or null if no CharSequence array value was found.
4462 *
4463 * @see #putExtra(String, CharSequence[])
4464 */
4465 public CharSequence[] getCharSequenceArrayExtra(String name) {
4466 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4467 }
4468
4469 /**
4470 * Retrieve extended data from the intent.
4471 *
4472 * @param name The name of the desired item.
4473 *
4474 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004475 * or null if no Bundle value was found.
4476 *
4477 * @see #putExtra(String, Bundle)
4478 */
4479 public Bundle getBundleExtra(String name) {
4480 return mExtras == null ? null : mExtras.getBundle(name);
4481 }
4482
4483 /**
4484 * Retrieve extended data from the intent.
4485 *
4486 * @param name The name of the desired item.
4487 *
4488 * @return the value of an item that previously added with putExtra()
4489 * or null if no IBinder value was found.
4490 *
4491 * @see #putExtra(String, IBinder)
4492 *
4493 * @deprecated
4494 * @hide
4495 */
4496 @Deprecated
4497 public IBinder getIBinderExtra(String name) {
4498 return mExtras == null ? null : mExtras.getIBinder(name);
4499 }
4500
4501 /**
4502 * Retrieve extended data from the intent.
4503 *
4504 * @param name The name of the desired item.
4505 * @param defaultValue The default value to return in case no item is
4506 * associated with the key 'name'
4507 *
4508 * @return the value of an item that previously added with putExtra()
4509 * or defaultValue if none was found.
4510 *
4511 * @see #putExtra
4512 *
4513 * @deprecated
4514 * @hide
4515 */
4516 @Deprecated
4517 public Object getExtra(String name, Object defaultValue) {
4518 Object result = defaultValue;
4519 if (mExtras != null) {
4520 Object result2 = mExtras.get(name);
4521 if (result2 != null) {
4522 result = result2;
4523 }
4524 }
4525
4526 return result;
4527 }
4528
4529 /**
4530 * Retrieves a map of extended data from the intent.
4531 *
4532 * @return the map of all extras previously added with putExtra(),
4533 * or null if none have been added.
4534 */
4535 public Bundle getExtras() {
4536 return (mExtras != null)
4537 ? new Bundle(mExtras)
4538 : null;
4539 }
4540
4541 /**
4542 * Retrieve any special flags associated with this intent. You will
4543 * normally just set them with {@link #setFlags} and let the system
4544 * take the appropriate action with them.
4545 *
4546 * @return int The currently set flags.
4547 *
4548 * @see #setFlags
4549 */
4550 public int getFlags() {
4551 return mFlags;
4552 }
4553
Dianne Hackborne7f97212011-02-24 14:40:20 -08004554 /** @hide */
4555 public boolean isExcludingStopped() {
4556 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4557 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4558 }
4559
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004560 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004561 * Retrieve the application package name this Intent is limited to. When
4562 * resolving an Intent, if non-null this limits the resolution to only
4563 * components in the given application package.
4564 *
4565 * @return The name of the application package for the Intent.
4566 *
4567 * @see #resolveActivity
4568 * @see #setPackage
4569 */
4570 public String getPackage() {
4571 return mPackage;
4572 }
4573
4574 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004575 * Retrieve the concrete component associated with the intent. When receiving
4576 * an intent, this is the component that was found to best handle it (that is,
4577 * yourself) and will always be non-null; in all other cases it will be
4578 * null unless explicitly set.
4579 *
4580 * @return The name of the application component to handle the intent.
4581 *
4582 * @see #resolveActivity
4583 * @see #setComponent
4584 */
4585 public ComponentName getComponent() {
4586 return mComponent;
4587 }
4588
4589 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004590 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4591 * used as a hint to the receiver for animations and the like. Null means that there
4592 * is no source bounds.
4593 */
4594 public Rect getSourceBounds() {
4595 return mSourceBounds;
4596 }
4597
4598 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004599 * Return the Activity component that should be used to handle this intent.
4600 * The appropriate component is determined based on the information in the
4601 * intent, evaluated as follows:
4602 *
4603 * <p>If {@link #getComponent} returns an explicit class, that is returned
4604 * without any further consideration.
4605 *
4606 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4607 * category to be considered.
4608 *
4609 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4610 * action.
4611 *
4612 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4613 * this type.
4614 *
4615 * <p>If {@link #addCategory} has added any categories, the activity must
4616 * handle ALL of the categories specified.
4617 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004618 * <p>If {@link #getPackage} is non-NULL, only activity components in
4619 * that application package will be considered.
4620 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004621 * <p>If there are no activities that satisfy all of these conditions, a
4622 * null string is returned.
4623 *
4624 * <p>If multiple activities are found to satisfy the intent, the one with
4625 * the highest priority will be used. If there are multiple activities
4626 * with the same priority, the system will either pick the best activity
4627 * based on user preference, or resolve to a system class that will allow
4628 * the user to pick an activity and forward from there.
4629 *
4630 * <p>This method is implemented simply by calling
4631 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4632 * true.</p>
4633 * <p> This API is called for you as part of starting an activity from an
4634 * intent. You do not normally need to call it yourself.</p>
4635 *
4636 * @param pm The package manager with which to resolve the Intent.
4637 *
4638 * @return Name of the component implementing an activity that can
4639 * display the intent.
4640 *
4641 * @see #setComponent
4642 * @see #getComponent
4643 * @see #resolveActivityInfo
4644 */
4645 public ComponentName resolveActivity(PackageManager pm) {
4646 if (mComponent != null) {
4647 return mComponent;
4648 }
4649
4650 ResolveInfo info = pm.resolveActivity(
4651 this, PackageManager.MATCH_DEFAULT_ONLY);
4652 if (info != null) {
4653 return new ComponentName(
4654 info.activityInfo.applicationInfo.packageName,
4655 info.activityInfo.name);
4656 }
4657
4658 return null;
4659 }
4660
4661 /**
4662 * Resolve the Intent into an {@link ActivityInfo}
4663 * describing the activity that should execute the intent. Resolution
4664 * follows the same rules as described for {@link #resolveActivity}, but
4665 * you get back the completely information about the resolved activity
4666 * instead of just its class name.
4667 *
4668 * @param pm The package manager with which to resolve the Intent.
4669 * @param flags Addition information to retrieve as per
4670 * {@link PackageManager#getActivityInfo(ComponentName, int)
4671 * PackageManager.getActivityInfo()}.
4672 *
4673 * @return PackageManager.ActivityInfo
4674 *
4675 * @see #resolveActivity
4676 */
4677 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4678 ActivityInfo ai = null;
4679 if (mComponent != null) {
4680 try {
4681 ai = pm.getActivityInfo(mComponent, flags);
4682 } catch (PackageManager.NameNotFoundException e) {
4683 // ignore
4684 }
4685 } else {
4686 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004687 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004688 if (info != null) {
4689 ai = info.activityInfo;
4690 }
4691 }
4692
4693 return ai;
4694 }
4695
4696 /**
4697 * Set the general action to be performed.
4698 *
4699 * @param action An action name, such as ACTION_VIEW. Application-specific
4700 * actions should be prefixed with the vendor's package name.
4701 *
4702 * @return Returns the same Intent object, for chaining multiple calls
4703 * into a single statement.
4704 *
4705 * @see #getAction
4706 */
4707 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004708 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004709 return this;
4710 }
4711
4712 /**
4713 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004714 * clears any type that was previously set by {@link #setType} or
4715 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004716 *
Nick Pellyccae4122012-01-09 14:12:58 -08004717 * <p><em>Note: scheme matching in the Android framework is
4718 * case-sensitive, unlike the formal RFC. As a result,
4719 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004720 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004721 * {@link #setDataAndNormalize}
4722 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004723 *
Nick Pellyccae4122012-01-09 14:12:58 -08004724 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004725 *
4726 * @return Returns the same Intent object, for chaining multiple calls
4727 * into a single statement.
4728 *
4729 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004730 * @see #setDataAndNormalize
4731 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004732 */
4733 public Intent setData(Uri data) {
4734 mData = data;
4735 mType = null;
4736 return this;
4737 }
4738
4739 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004740 * Normalize and set the data this intent is operating on.
4741 *
4742 * <p>This method automatically clears any type that was
4743 * previously set (for example, by {@link #setType}).
4744 *
4745 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004746 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004747 * so really this is just a convenience method for
4748 * <pre>
4749 * setData(data.normalize())
4750 * </pre>
4751 *
4752 * @param data The Uri of the data this intent is now targeting.
4753 *
4754 * @return Returns the same Intent object, for chaining multiple calls
4755 * into a single statement.
4756 *
4757 * @see #getData
4758 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004759 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004760 */
4761 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004762 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004763 }
4764
4765 /**
4766 * Set an explicit MIME data type.
4767 *
4768 * <p>This is used to create intents that only specify a type and not data,
4769 * for example to indicate the type of data to return.
4770 *
4771 * <p>This method automatically clears any data that was
4772 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004773 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004774 * <p><em>Note: MIME type matching in the Android framework is
4775 * case-sensitive, unlike formal RFC MIME types. As a result,
4776 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004777 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4778 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004779 *
4780 * @param type The MIME type of the data being handled by this intent.
4781 *
4782 * @return Returns the same Intent object, for chaining multiple calls
4783 * into a single statement.
4784 *
4785 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004786 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004787 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004788 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004789 */
4790 public Intent setType(String type) {
4791 mData = null;
4792 mType = type;
4793 return this;
4794 }
4795
4796 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004797 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004798 *
Nick Pellyccae4122012-01-09 14:12:58 -08004799 * <p>This is used to create intents that only specify a type and not data,
4800 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004801 *
Nick Pellyccae4122012-01-09 14:12:58 -08004802 * <p>This method automatically clears any data that was
4803 * previously set (for example by {@link #setData}).
4804 *
4805 * <p>The MIME type is normalized using
4806 * {@link #normalizeMimeType} before it is set,
4807 * so really this is just a convenience method for
4808 * <pre>
4809 * setType(Intent.normalizeMimeType(type))
4810 * </pre>
4811 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004812 * @param type The MIME type of the data being handled by this intent.
4813 *
4814 * @return Returns the same Intent object, for chaining multiple calls
4815 * into a single statement.
4816 *
Nick Pellyccae4122012-01-09 14:12:58 -08004817 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004818 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004819 * @see #normalizeMimeType
4820 */
4821 public Intent setTypeAndNormalize(String type) {
4822 return setType(normalizeMimeType(type));
4823 }
4824
4825 /**
4826 * (Usually optional) Set the data for the intent along with an explicit
4827 * MIME data type. This method should very rarely be used -- it allows you
4828 * to override the MIME type that would ordinarily be inferred from the
4829 * data with your own type given here.
4830 *
4831 * <p><em>Note: MIME type and Uri scheme matching in the
4832 * Android framework is case-sensitive, unlike the formal RFC definitions.
4833 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004834 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004835 * {@link #setDataAndTypeAndNormalize}
4836 * to ensure that they are converted to lower case.</em>
4837 *
4838 * @param data The Uri of the data this intent is now targeting.
4839 * @param type The MIME type of the data being handled by this intent.
4840 *
4841 * @return Returns the same Intent object, for chaining multiple calls
4842 * into a single statement.
4843 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004844 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004845 * @see #setData
4846 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004847 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004848 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004849 */
4850 public Intent setDataAndType(Uri data, String type) {
4851 mData = data;
4852 mType = type;
4853 return this;
4854 }
4855
4856 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004857 * (Usually optional) Normalize and set both the data Uri and an explicit
4858 * MIME data type. This method should very rarely be used -- it allows you
4859 * to override the MIME type that would ordinarily be inferred from the
4860 * data with your own type given here.
4861 *
4862 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004863 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08004864 * before they are set, so really this is just a convenience method for
4865 * <pre>
4866 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4867 * </pre>
4868 *
4869 * @param data The Uri of the data this intent is now targeting.
4870 * @param type The MIME type of the data being handled by this intent.
4871 *
4872 * @return Returns the same Intent object, for chaining multiple calls
4873 * into a single statement.
4874 *
4875 * @see #setType
4876 * @see #setData
4877 * @see #setDataAndType
4878 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004879 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004880 */
4881 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004882 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08004883 }
4884
4885 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004886 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004887 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004888 * activities that provide <em>all</em> of the requested categories will be
4889 * used.
4890 *
4891 * @param category The desired category. This can be either one of the
4892 * predefined Intent categories, or a custom category in your own
4893 * namespace.
4894 *
4895 * @return Returns the same Intent object, for chaining multiple calls
4896 * into a single statement.
4897 *
4898 * @see #hasCategory
4899 * @see #removeCategory
4900 */
4901 public Intent addCategory(String category) {
4902 if (mCategories == null) {
4903 mCategories = new HashSet<String>();
4904 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004905 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004906 return this;
4907 }
4908
4909 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004910 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004911 *
4912 * @param category The category to remove.
4913 *
4914 * @see #addCategory
4915 */
4916 public void removeCategory(String category) {
4917 if (mCategories != null) {
4918 mCategories.remove(category);
4919 if (mCategories.size() == 0) {
4920 mCategories = null;
4921 }
4922 }
4923 }
4924
4925 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004926 * Set a selector for this Intent. This is a modification to the kinds of
4927 * things the Intent will match. If the selector is set, it will be used
4928 * when trying to find entities that can handle the Intent, instead of the
4929 * main contents of the Intent. This allows you build an Intent containing
4930 * a generic protocol while targeting it more specifically.
4931 *
4932 * <p>An example of where this may be used is with things like
4933 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
4934 * Intent that will launch the Browser application. However, the correct
4935 * main entry point of an application is actually {@link #ACTION_MAIN}
4936 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
4937 * used to specify the actual Activity to launch. If you launch the browser
4938 * with something different, undesired behavior may happen if the user has
4939 * previously or later launches it the normal way, since they do not match.
4940 * Instead, you can build an Intent with the MAIN action (but no ComponentName
4941 * yet specified) and set a selector with {@link #ACTION_MAIN} and
4942 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
4943 *
4944 * <p>Setting a selector does not impact the behavior of
4945 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
4946 * desired behavior of a selector -- it does not impact the base meaning
4947 * of the Intent, just what kinds of things will be matched against it
4948 * when determining who can handle it.</p>
4949 *
4950 * <p>You can not use both a selector and {@link #setPackage(String)} on
4951 * the same base Intent.</p>
4952 *
4953 * @param selector The desired selector Intent; set to null to not use
4954 * a special selector.
4955 */
4956 public void setSelector(Intent selector) {
4957 if (selector == this) {
4958 throw new IllegalArgumentException(
4959 "Intent being set as a selector of itself");
4960 }
4961 if (selector != null && mPackage != null) {
4962 throw new IllegalArgumentException(
4963 "Can't set selector when package name is already set");
4964 }
4965 mSelector = selector;
4966 }
4967
4968 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004969 * Set a {@link ClipData} associated with this Intent. This replaces any
4970 * previously set ClipData.
4971 *
4972 * <p>The ClipData in an intent is not used for Intent matching or other
4973 * such operations. Semantically it is like extras, used to transmit
4974 * additional data with the Intent. The main feature of using this over
4975 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
4976 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
4977 * items included in the clip data. This is useful, in particular, if
4978 * you want to transmit an Intent containing multiple <code>content:</code>
4979 * URIs for which the recipient may not have global permission to access the
4980 * content provider.
4981 *
4982 * <p>If the ClipData contains items that are themselves Intents, any
4983 * grant flags in those Intents will be ignored. Only the top-level flags
4984 * of the main Intent are respected, and will be applied to all Uri or
4985 * Intent items in the clip (or sub-items of the clip).
4986 *
4987 * <p>The MIME type, label, and icon in the ClipData object are not
4988 * directly used by Intent. Applications should generally rely on the
4989 * MIME type of the Intent itself, not what it may find in the ClipData.
4990 * A common practice is to construct a ClipData for use with an Intent
4991 * with a MIME type of "*\/*".
4992 *
4993 * @param clip The new clip to set. May be null to clear the current clip.
4994 */
4995 public void setClipData(ClipData clip) {
4996 mClipData = clip;
4997 }
4998
4999 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005000 * Add extended data to the intent. The name must include a package
5001 * prefix, for example the app com.android.contacts would use names
5002 * like "com.android.contacts.ShowAll".
5003 *
5004 * @param name The name of the extra data, with package prefix.
5005 * @param value The boolean data value.
5006 *
5007 * @return Returns the same Intent object, for chaining multiple calls
5008 * into a single statement.
5009 *
5010 * @see #putExtras
5011 * @see #removeExtra
5012 * @see #getBooleanExtra(String, boolean)
5013 */
5014 public Intent putExtra(String name, boolean value) {
5015 if (mExtras == null) {
5016 mExtras = new Bundle();
5017 }
5018 mExtras.putBoolean(name, value);
5019 return this;
5020 }
5021
5022 /**
5023 * Add extended data to the intent. The name must include a package
5024 * prefix, for example the app com.android.contacts would use names
5025 * like "com.android.contacts.ShowAll".
5026 *
5027 * @param name The name of the extra data, with package prefix.
5028 * @param value The byte data value.
5029 *
5030 * @return Returns the same Intent object, for chaining multiple calls
5031 * into a single statement.
5032 *
5033 * @see #putExtras
5034 * @see #removeExtra
5035 * @see #getByteExtra(String, byte)
5036 */
5037 public Intent putExtra(String name, byte value) {
5038 if (mExtras == null) {
5039 mExtras = new Bundle();
5040 }
5041 mExtras.putByte(name, value);
5042 return this;
5043 }
5044
5045 /**
5046 * Add extended data to the intent. The name must include a package
5047 * prefix, for example the app com.android.contacts would use names
5048 * like "com.android.contacts.ShowAll".
5049 *
5050 * @param name The name of the extra data, with package prefix.
5051 * @param value The char data value.
5052 *
5053 * @return Returns the same Intent object, for chaining multiple calls
5054 * into a single statement.
5055 *
5056 * @see #putExtras
5057 * @see #removeExtra
5058 * @see #getCharExtra(String, char)
5059 */
5060 public Intent putExtra(String name, char value) {
5061 if (mExtras == null) {
5062 mExtras = new Bundle();
5063 }
5064 mExtras.putChar(name, value);
5065 return this;
5066 }
5067
5068 /**
5069 * Add extended data to the intent. The name must include a package
5070 * prefix, for example the app com.android.contacts would use names
5071 * like "com.android.contacts.ShowAll".
5072 *
5073 * @param name The name of the extra data, with package prefix.
5074 * @param value The short data value.
5075 *
5076 * @return Returns the same Intent object, for chaining multiple calls
5077 * into a single statement.
5078 *
5079 * @see #putExtras
5080 * @see #removeExtra
5081 * @see #getShortExtra(String, short)
5082 */
5083 public Intent putExtra(String name, short value) {
5084 if (mExtras == null) {
5085 mExtras = new Bundle();
5086 }
5087 mExtras.putShort(name, value);
5088 return this;
5089 }
5090
5091 /**
5092 * Add extended data to the intent. The name must include a package
5093 * prefix, for example the app com.android.contacts would use names
5094 * like "com.android.contacts.ShowAll".
5095 *
5096 * @param name The name of the extra data, with package prefix.
5097 * @param value The integer data value.
5098 *
5099 * @return Returns the same Intent object, for chaining multiple calls
5100 * into a single statement.
5101 *
5102 * @see #putExtras
5103 * @see #removeExtra
5104 * @see #getIntExtra(String, int)
5105 */
5106 public Intent putExtra(String name, int value) {
5107 if (mExtras == null) {
5108 mExtras = new Bundle();
5109 }
5110 mExtras.putInt(name, value);
5111 return this;
5112 }
5113
5114 /**
5115 * Add extended data to the intent. The name must include a package
5116 * prefix, for example the app com.android.contacts would use names
5117 * like "com.android.contacts.ShowAll".
5118 *
5119 * @param name The name of the extra data, with package prefix.
5120 * @param value The long data value.
5121 *
5122 * @return Returns the same Intent object, for chaining multiple calls
5123 * into a single statement.
5124 *
5125 * @see #putExtras
5126 * @see #removeExtra
5127 * @see #getLongExtra(String, long)
5128 */
5129 public Intent putExtra(String name, long value) {
5130 if (mExtras == null) {
5131 mExtras = new Bundle();
5132 }
5133 mExtras.putLong(name, value);
5134 return this;
5135 }
5136
5137 /**
5138 * Add extended data to the intent. The name must include a package
5139 * prefix, for example the app com.android.contacts would use names
5140 * like "com.android.contacts.ShowAll".
5141 *
5142 * @param name The name of the extra data, with package prefix.
5143 * @param value The float data value.
5144 *
5145 * @return Returns the same Intent object, for chaining multiple calls
5146 * into a single statement.
5147 *
5148 * @see #putExtras
5149 * @see #removeExtra
5150 * @see #getFloatExtra(String, float)
5151 */
5152 public Intent putExtra(String name, float value) {
5153 if (mExtras == null) {
5154 mExtras = new Bundle();
5155 }
5156 mExtras.putFloat(name, value);
5157 return this;
5158 }
5159
5160 /**
5161 * Add extended data to the intent. The name must include a package
5162 * prefix, for example the app com.android.contacts would use names
5163 * like "com.android.contacts.ShowAll".
5164 *
5165 * @param name The name of the extra data, with package prefix.
5166 * @param value The double data value.
5167 *
5168 * @return Returns the same Intent object, for chaining multiple calls
5169 * into a single statement.
5170 *
5171 * @see #putExtras
5172 * @see #removeExtra
5173 * @see #getDoubleExtra(String, double)
5174 */
5175 public Intent putExtra(String name, double value) {
5176 if (mExtras == null) {
5177 mExtras = new Bundle();
5178 }
5179 mExtras.putDouble(name, value);
5180 return this;
5181 }
5182
5183 /**
5184 * Add extended data to the intent. The name must include a package
5185 * prefix, for example the app com.android.contacts would use names
5186 * like "com.android.contacts.ShowAll".
5187 *
5188 * @param name The name of the extra data, with package prefix.
5189 * @param value The String data value.
5190 *
5191 * @return Returns the same Intent object, for chaining multiple calls
5192 * into a single statement.
5193 *
5194 * @see #putExtras
5195 * @see #removeExtra
5196 * @see #getStringExtra(String)
5197 */
5198 public Intent putExtra(String name, String value) {
5199 if (mExtras == null) {
5200 mExtras = new Bundle();
5201 }
5202 mExtras.putString(name, value);
5203 return this;
5204 }
5205
5206 /**
5207 * Add extended data to the intent. The name must include a package
5208 * prefix, for example the app com.android.contacts would use names
5209 * like "com.android.contacts.ShowAll".
5210 *
5211 * @param name The name of the extra data, with package prefix.
5212 * @param value The CharSequence data value.
5213 *
5214 * @return Returns the same Intent object, for chaining multiple calls
5215 * into a single statement.
5216 *
5217 * @see #putExtras
5218 * @see #removeExtra
5219 * @see #getCharSequenceExtra(String)
5220 */
5221 public Intent putExtra(String name, CharSequence value) {
5222 if (mExtras == null) {
5223 mExtras = new Bundle();
5224 }
5225 mExtras.putCharSequence(name, value);
5226 return this;
5227 }
5228
5229 /**
5230 * Add extended data to the intent. The name must include a package
5231 * prefix, for example the app com.android.contacts would use names
5232 * like "com.android.contacts.ShowAll".
5233 *
5234 * @param name The name of the extra data, with package prefix.
5235 * @param value The Parcelable data value.
5236 *
5237 * @return Returns the same Intent object, for chaining multiple calls
5238 * into a single statement.
5239 *
5240 * @see #putExtras
5241 * @see #removeExtra
5242 * @see #getParcelableExtra(String)
5243 */
5244 public Intent putExtra(String name, Parcelable value) {
5245 if (mExtras == null) {
5246 mExtras = new Bundle();
5247 }
5248 mExtras.putParcelable(name, value);
5249 return this;
5250 }
5251
5252 /**
5253 * Add extended data to the intent. The name must include a package
5254 * prefix, for example the app com.android.contacts would use names
5255 * like "com.android.contacts.ShowAll".
5256 *
5257 * @param name The name of the extra data, with package prefix.
5258 * @param value The Parcelable[] data value.
5259 *
5260 * @return Returns the same Intent object, for chaining multiple calls
5261 * into a single statement.
5262 *
5263 * @see #putExtras
5264 * @see #removeExtra
5265 * @see #getParcelableArrayExtra(String)
5266 */
5267 public Intent putExtra(String name, Parcelable[] value) {
5268 if (mExtras == null) {
5269 mExtras = new Bundle();
5270 }
5271 mExtras.putParcelableArray(name, value);
5272 return this;
5273 }
5274
5275 /**
5276 * Add extended data to the intent. The name must include a package
5277 * prefix, for example the app com.android.contacts would use names
5278 * like "com.android.contacts.ShowAll".
5279 *
5280 * @param name The name of the extra data, with package prefix.
5281 * @param value The ArrayList<Parcelable> data value.
5282 *
5283 * @return Returns the same Intent object, for chaining multiple calls
5284 * into a single statement.
5285 *
5286 * @see #putExtras
5287 * @see #removeExtra
5288 * @see #getParcelableArrayListExtra(String)
5289 */
5290 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5291 if (mExtras == null) {
5292 mExtras = new Bundle();
5293 }
5294 mExtras.putParcelableArrayList(name, value);
5295 return this;
5296 }
5297
5298 /**
5299 * Add extended data to the intent. The name must include a package
5300 * prefix, for example the app com.android.contacts would use names
5301 * like "com.android.contacts.ShowAll".
5302 *
5303 * @param name The name of the extra data, with package prefix.
5304 * @param value The ArrayList<Integer> data value.
5305 *
5306 * @return Returns the same Intent object, for chaining multiple calls
5307 * into a single statement.
5308 *
5309 * @see #putExtras
5310 * @see #removeExtra
5311 * @see #getIntegerArrayListExtra(String)
5312 */
5313 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5314 if (mExtras == null) {
5315 mExtras = new Bundle();
5316 }
5317 mExtras.putIntegerArrayList(name, value);
5318 return this;
5319 }
5320
5321 /**
5322 * Add extended data to the intent. The name must include a package
5323 * prefix, for example the app com.android.contacts would use names
5324 * like "com.android.contacts.ShowAll".
5325 *
5326 * @param name The name of the extra data, with package prefix.
5327 * @param value The ArrayList<String> data value.
5328 *
5329 * @return Returns the same Intent object, for chaining multiple calls
5330 * into a single statement.
5331 *
5332 * @see #putExtras
5333 * @see #removeExtra
5334 * @see #getStringArrayListExtra(String)
5335 */
5336 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5337 if (mExtras == null) {
5338 mExtras = new Bundle();
5339 }
5340 mExtras.putStringArrayList(name, value);
5341 return this;
5342 }
5343
5344 /**
5345 * Add extended data to the intent. The name must include a package
5346 * prefix, for example the app com.android.contacts would use names
5347 * like "com.android.contacts.ShowAll".
5348 *
5349 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005350 * @param value The ArrayList<CharSequence> data value.
5351 *
5352 * @return Returns the same Intent object, for chaining multiple calls
5353 * into a single statement.
5354 *
5355 * @see #putExtras
5356 * @see #removeExtra
5357 * @see #getCharSequenceArrayListExtra(String)
5358 */
5359 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5360 if (mExtras == null) {
5361 mExtras = new Bundle();
5362 }
5363 mExtras.putCharSequenceArrayList(name, value);
5364 return this;
5365 }
5366
5367 /**
5368 * Add extended data to the intent. The name must include a package
5369 * prefix, for example the app com.android.contacts would use names
5370 * like "com.android.contacts.ShowAll".
5371 *
5372 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005373 * @param value The Serializable data value.
5374 *
5375 * @return Returns the same Intent object, for chaining multiple calls
5376 * into a single statement.
5377 *
5378 * @see #putExtras
5379 * @see #removeExtra
5380 * @see #getSerializableExtra(String)
5381 */
5382 public Intent putExtra(String name, Serializable value) {
5383 if (mExtras == null) {
5384 mExtras = new Bundle();
5385 }
5386 mExtras.putSerializable(name, value);
5387 return this;
5388 }
5389
5390 /**
5391 * Add extended data to the intent. The name must include a package
5392 * prefix, for example the app com.android.contacts would use names
5393 * like "com.android.contacts.ShowAll".
5394 *
5395 * @param name The name of the extra data, with package prefix.
5396 * @param value The boolean array data value.
5397 *
5398 * @return Returns the same Intent object, for chaining multiple calls
5399 * into a single statement.
5400 *
5401 * @see #putExtras
5402 * @see #removeExtra
5403 * @see #getBooleanArrayExtra(String)
5404 */
5405 public Intent putExtra(String name, boolean[] value) {
5406 if (mExtras == null) {
5407 mExtras = new Bundle();
5408 }
5409 mExtras.putBooleanArray(name, value);
5410 return this;
5411 }
5412
5413 /**
5414 * Add extended data to the intent. The name must include a package
5415 * prefix, for example the app com.android.contacts would use names
5416 * like "com.android.contacts.ShowAll".
5417 *
5418 * @param name The name of the extra data, with package prefix.
5419 * @param value The byte array data value.
5420 *
5421 * @return Returns the same Intent object, for chaining multiple calls
5422 * into a single statement.
5423 *
5424 * @see #putExtras
5425 * @see #removeExtra
5426 * @see #getByteArrayExtra(String)
5427 */
5428 public Intent putExtra(String name, byte[] value) {
5429 if (mExtras == null) {
5430 mExtras = new Bundle();
5431 }
5432 mExtras.putByteArray(name, value);
5433 return this;
5434 }
5435
5436 /**
5437 * Add extended data to the intent. The name must include a package
5438 * prefix, for example the app com.android.contacts would use names
5439 * like "com.android.contacts.ShowAll".
5440 *
5441 * @param name The name of the extra data, with package prefix.
5442 * @param value The short array data value.
5443 *
5444 * @return Returns the same Intent object, for chaining multiple calls
5445 * into a single statement.
5446 *
5447 * @see #putExtras
5448 * @see #removeExtra
5449 * @see #getShortArrayExtra(String)
5450 */
5451 public Intent putExtra(String name, short[] value) {
5452 if (mExtras == null) {
5453 mExtras = new Bundle();
5454 }
5455 mExtras.putShortArray(name, value);
5456 return this;
5457 }
5458
5459 /**
5460 * Add extended data to the intent. The name must include a package
5461 * prefix, for example the app com.android.contacts would use names
5462 * like "com.android.contacts.ShowAll".
5463 *
5464 * @param name The name of the extra data, with package prefix.
5465 * @param value The char array data value.
5466 *
5467 * @return Returns the same Intent object, for chaining multiple calls
5468 * into a single statement.
5469 *
5470 * @see #putExtras
5471 * @see #removeExtra
5472 * @see #getCharArrayExtra(String)
5473 */
5474 public Intent putExtra(String name, char[] value) {
5475 if (mExtras == null) {
5476 mExtras = new Bundle();
5477 }
5478 mExtras.putCharArray(name, value);
5479 return this;
5480 }
5481
5482 /**
5483 * Add extended data to the intent. The name must include a package
5484 * prefix, for example the app com.android.contacts would use names
5485 * like "com.android.contacts.ShowAll".
5486 *
5487 * @param name The name of the extra data, with package prefix.
5488 * @param value The int array data value.
5489 *
5490 * @return Returns the same Intent object, for chaining multiple calls
5491 * into a single statement.
5492 *
5493 * @see #putExtras
5494 * @see #removeExtra
5495 * @see #getIntArrayExtra(String)
5496 */
5497 public Intent putExtra(String name, int[] value) {
5498 if (mExtras == null) {
5499 mExtras = new Bundle();
5500 }
5501 mExtras.putIntArray(name, value);
5502 return this;
5503 }
5504
5505 /**
5506 * Add extended data to the intent. The name must include a package
5507 * prefix, for example the app com.android.contacts would use names
5508 * like "com.android.contacts.ShowAll".
5509 *
5510 * @param name The name of the extra data, with package prefix.
5511 * @param value The byte array data value.
5512 *
5513 * @return Returns the same Intent object, for chaining multiple calls
5514 * into a single statement.
5515 *
5516 * @see #putExtras
5517 * @see #removeExtra
5518 * @see #getLongArrayExtra(String)
5519 */
5520 public Intent putExtra(String name, long[] value) {
5521 if (mExtras == null) {
5522 mExtras = new Bundle();
5523 }
5524 mExtras.putLongArray(name, value);
5525 return this;
5526 }
5527
5528 /**
5529 * Add extended data to the intent. The name must include a package
5530 * prefix, for example the app com.android.contacts would use names
5531 * like "com.android.contacts.ShowAll".
5532 *
5533 * @param name The name of the extra data, with package prefix.
5534 * @param value The float array data value.
5535 *
5536 * @return Returns the same Intent object, for chaining multiple calls
5537 * into a single statement.
5538 *
5539 * @see #putExtras
5540 * @see #removeExtra
5541 * @see #getFloatArrayExtra(String)
5542 */
5543 public Intent putExtra(String name, float[] value) {
5544 if (mExtras == null) {
5545 mExtras = new Bundle();
5546 }
5547 mExtras.putFloatArray(name, value);
5548 return this;
5549 }
5550
5551 /**
5552 * Add extended data to the intent. The name must include a package
5553 * prefix, for example the app com.android.contacts would use names
5554 * like "com.android.contacts.ShowAll".
5555 *
5556 * @param name The name of the extra data, with package prefix.
5557 * @param value The double array data value.
5558 *
5559 * @return Returns the same Intent object, for chaining multiple calls
5560 * into a single statement.
5561 *
5562 * @see #putExtras
5563 * @see #removeExtra
5564 * @see #getDoubleArrayExtra(String)
5565 */
5566 public Intent putExtra(String name, double[] value) {
5567 if (mExtras == null) {
5568 mExtras = new Bundle();
5569 }
5570 mExtras.putDoubleArray(name, value);
5571 return this;
5572 }
5573
5574 /**
5575 * Add extended data to the intent. The name must include a package
5576 * prefix, for example the app com.android.contacts would use names
5577 * like "com.android.contacts.ShowAll".
5578 *
5579 * @param name The name of the extra data, with package prefix.
5580 * @param value The String array data value.
5581 *
5582 * @return Returns the same Intent object, for chaining multiple calls
5583 * into a single statement.
5584 *
5585 * @see #putExtras
5586 * @see #removeExtra
5587 * @see #getStringArrayExtra(String)
5588 */
5589 public Intent putExtra(String name, String[] value) {
5590 if (mExtras == null) {
5591 mExtras = new Bundle();
5592 }
5593 mExtras.putStringArray(name, value);
5594 return this;
5595 }
5596
5597 /**
5598 * Add extended data to the intent. The name must include a package
5599 * prefix, for example the app com.android.contacts would use names
5600 * like "com.android.contacts.ShowAll".
5601 *
5602 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005603 * @param value The CharSequence array data value.
5604 *
5605 * @return Returns the same Intent object, for chaining multiple calls
5606 * into a single statement.
5607 *
5608 * @see #putExtras
5609 * @see #removeExtra
5610 * @see #getCharSequenceArrayExtra(String)
5611 */
5612 public Intent putExtra(String name, CharSequence[] value) {
5613 if (mExtras == null) {
5614 mExtras = new Bundle();
5615 }
5616 mExtras.putCharSequenceArray(name, value);
5617 return this;
5618 }
5619
5620 /**
5621 * Add extended data to the intent. The name must include a package
5622 * prefix, for example the app com.android.contacts would use names
5623 * like "com.android.contacts.ShowAll".
5624 *
5625 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005626 * @param value The Bundle data value.
5627 *
5628 * @return Returns the same Intent object, for chaining multiple calls
5629 * into a single statement.
5630 *
5631 * @see #putExtras
5632 * @see #removeExtra
5633 * @see #getBundleExtra(String)
5634 */
5635 public Intent putExtra(String name, Bundle value) {
5636 if (mExtras == null) {
5637 mExtras = new Bundle();
5638 }
5639 mExtras.putBundle(name, value);
5640 return this;
5641 }
5642
5643 /**
5644 * Add extended data to the intent. The name must include a package
5645 * prefix, for example the app com.android.contacts would use names
5646 * like "com.android.contacts.ShowAll".
5647 *
5648 * @param name The name of the extra data, with package prefix.
5649 * @param value The IBinder data value.
5650 *
5651 * @return Returns the same Intent object, for chaining multiple calls
5652 * into a single statement.
5653 *
5654 * @see #putExtras
5655 * @see #removeExtra
5656 * @see #getIBinderExtra(String)
5657 *
5658 * @deprecated
5659 * @hide
5660 */
5661 @Deprecated
5662 public Intent putExtra(String name, IBinder value) {
5663 if (mExtras == null) {
5664 mExtras = new Bundle();
5665 }
5666 mExtras.putIBinder(name, value);
5667 return this;
5668 }
5669
5670 /**
5671 * Copy all extras in 'src' in to this intent.
5672 *
5673 * @param src Contains the extras to copy.
5674 *
5675 * @see #putExtra
5676 */
5677 public Intent putExtras(Intent src) {
5678 if (src.mExtras != null) {
5679 if (mExtras == null) {
5680 mExtras = new Bundle(src.mExtras);
5681 } else {
5682 mExtras.putAll(src.mExtras);
5683 }
5684 }
5685 return this;
5686 }
5687
5688 /**
5689 * Add a set of extended data to the intent. The keys must include a package
5690 * prefix, for example the app com.android.contacts would use names
5691 * like "com.android.contacts.ShowAll".
5692 *
5693 * @param extras The Bundle of extras to add to this intent.
5694 *
5695 * @see #putExtra
5696 * @see #removeExtra
5697 */
5698 public Intent putExtras(Bundle extras) {
5699 if (mExtras == null) {
5700 mExtras = new Bundle();
5701 }
5702 mExtras.putAll(extras);
5703 return this;
5704 }
5705
5706 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005707 * Completely replace the extras in the Intent with the extras in the
5708 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005709 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005710 * @param src The exact extras contained in this Intent are copied
5711 * into the target intent, replacing any that were previously there.
5712 */
5713 public Intent replaceExtras(Intent src) {
5714 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5715 return this;
5716 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005717
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005718 /**
5719 * Completely replace the extras in the Intent with the given Bundle of
5720 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005721 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005722 * @param extras The new set of extras in the Intent, or null to erase
5723 * all extras.
5724 */
5725 public Intent replaceExtras(Bundle extras) {
5726 mExtras = extras != null ? new Bundle(extras) : null;
5727 return this;
5728 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005729
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005730 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005731 * Remove extended data from the intent.
5732 *
5733 * @see #putExtra
5734 */
5735 public void removeExtra(String name) {
5736 if (mExtras != null) {
5737 mExtras.remove(name);
5738 if (mExtras.size() == 0) {
5739 mExtras = null;
5740 }
5741 }
5742 }
5743
5744 /**
5745 * Set special flags controlling how this intent is handled. Most values
5746 * here depend on the type of component being executed by the Intent,
5747 * specifically the FLAG_ACTIVITY_* flags are all for use with
5748 * {@link Context#startActivity Context.startActivity()} and the
5749 * FLAG_RECEIVER_* flags are all for use with
5750 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5751 *
Scott Main7aee61f2011-02-08 11:25:01 -08005752 * <p>See the
5753 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5754 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005755 * the behavior of your application.
5756 *
5757 * @param flags The desired flags.
5758 *
5759 * @return Returns the same Intent object, for chaining multiple calls
5760 * into a single statement.
5761 *
5762 * @see #getFlags
5763 * @see #addFlags
5764 *
5765 * @see #FLAG_GRANT_READ_URI_PERMISSION
5766 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5767 * @see #FLAG_DEBUG_LOG_RESOLUTION
5768 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005769 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005770 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005771 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005772 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005773 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5774 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005775 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005776 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5777 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005778 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005779 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005780 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005781 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5782 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005783 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005784 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005785 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005786 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5787 */
5788 public Intent setFlags(int flags) {
5789 mFlags = flags;
5790 return this;
5791 }
5792
5793 /**
5794 * Add additional flags to the intent (or with existing flags
5795 * value).
5796 *
5797 * @param flags The new flags to set.
5798 *
5799 * @return Returns the same Intent object, for chaining multiple calls
5800 * into a single statement.
5801 *
5802 * @see #setFlags
5803 */
5804 public Intent addFlags(int flags) {
5805 mFlags |= flags;
5806 return this;
5807 }
5808
5809 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005810 * (Usually optional) Set an explicit application package name that limits
5811 * the components this Intent will resolve to. If left to the default
5812 * value of null, all components in all applications will considered.
5813 * If non-null, the Intent can only match the components in the given
5814 * application package.
5815 *
5816 * @param packageName The name of the application package to handle the
5817 * intent, or null to allow any application package.
5818 *
5819 * @return Returns the same Intent object, for chaining multiple calls
5820 * into a single statement.
5821 *
5822 * @see #getPackage
5823 * @see #resolveActivity
5824 */
5825 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005826 if (packageName != null && mSelector != null) {
5827 throw new IllegalArgumentException(
5828 "Can't set package name when selector is already set");
5829 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005830 mPackage = packageName;
5831 return this;
5832 }
5833
5834 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005835 * (Usually optional) Explicitly set the component to handle the intent.
5836 * If left with the default value of null, the system will determine the
5837 * appropriate class to use based on the other fields (action, data,
5838 * type, categories) in the Intent. If this class is defined, the
5839 * specified class will always be used regardless of the other fields. You
5840 * should only set this value when you know you absolutely want a specific
5841 * class to be used; otherwise it is better to let the system find the
5842 * appropriate class so that you will respect the installed applications
5843 * and user preferences.
5844 *
5845 * @param component The name of the application component to handle the
5846 * intent, or null to let the system find one for you.
5847 *
5848 * @return Returns the same Intent object, for chaining multiple calls
5849 * into a single statement.
5850 *
5851 * @see #setClass
5852 * @see #setClassName(Context, String)
5853 * @see #setClassName(String, String)
5854 * @see #getComponent
5855 * @see #resolveActivity
5856 */
5857 public Intent setComponent(ComponentName component) {
5858 mComponent = component;
5859 return this;
5860 }
5861
5862 /**
5863 * Convenience for calling {@link #setComponent} with an
5864 * explicit class name.
5865 *
5866 * @param packageContext A Context of the application package implementing
5867 * this class.
5868 * @param className The name of a class inside of the application package
5869 * that will be used as the component for this Intent.
5870 *
5871 * @return Returns the same Intent object, for chaining multiple calls
5872 * into a single statement.
5873 *
5874 * @see #setComponent
5875 * @see #setClass
5876 */
5877 public Intent setClassName(Context packageContext, String className) {
5878 mComponent = new ComponentName(packageContext, className);
5879 return this;
5880 }
5881
5882 /**
5883 * Convenience for calling {@link #setComponent} with an
5884 * explicit application package name and class name.
5885 *
5886 * @param packageName The name of the package implementing the desired
5887 * component.
5888 * @param className The name of a class inside of the application package
5889 * that will be used as the component for this Intent.
5890 *
5891 * @return Returns the same Intent object, for chaining multiple calls
5892 * into a single statement.
5893 *
5894 * @see #setComponent
5895 * @see #setClass
5896 */
5897 public Intent setClassName(String packageName, String className) {
5898 mComponent = new ComponentName(packageName, className);
5899 return this;
5900 }
5901
5902 /**
5903 * Convenience for calling {@link #setComponent(ComponentName)} with the
5904 * name returned by a {@link Class} object.
5905 *
5906 * @param packageContext A Context of the application package implementing
5907 * this class.
5908 * @param cls The class name to set, equivalent to
5909 * <code>setClassName(context, cls.getName())</code>.
5910 *
5911 * @return Returns the same Intent object, for chaining multiple calls
5912 * into a single statement.
5913 *
5914 * @see #setComponent
5915 */
5916 public Intent setClass(Context packageContext, Class<?> cls) {
5917 mComponent = new ComponentName(packageContext, cls);
5918 return this;
5919 }
5920
5921 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005922 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5923 * used as a hint to the receiver for animations and the like. Null means that there
5924 * is no source bounds.
5925 */
5926 public void setSourceBounds(Rect r) {
5927 if (r != null) {
5928 mSourceBounds = new Rect(r);
5929 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005930 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005931 }
5932 }
5933
5934 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005935 * Use with {@link #fillIn} to allow the current action value to be
5936 * overwritten, even if it is already set.
5937 */
5938 public static final int FILL_IN_ACTION = 1<<0;
5939
5940 /**
5941 * Use with {@link #fillIn} to allow the current data or type value
5942 * overwritten, even if it is already set.
5943 */
5944 public static final int FILL_IN_DATA = 1<<1;
5945
5946 /**
5947 * Use with {@link #fillIn} to allow the current categories to be
5948 * overwritten, even if they are already set.
5949 */
5950 public static final int FILL_IN_CATEGORIES = 1<<2;
5951
5952 /**
5953 * Use with {@link #fillIn} to allow the current component value to be
5954 * overwritten, even if it is already set.
5955 */
5956 public static final int FILL_IN_COMPONENT = 1<<3;
5957
5958 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005959 * Use with {@link #fillIn} to allow the current package value to be
5960 * overwritten, even if it is already set.
5961 */
5962 public static final int FILL_IN_PACKAGE = 1<<4;
5963
5964 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005965 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005966 * overwritten, even if it is already set.
5967 */
5968 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5969
5970 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005971 * Use with {@link #fillIn} to allow the current selector to be
5972 * overwritten, even if it is already set.
5973 */
5974 public static final int FILL_IN_SELECTOR = 1<<6;
5975
5976 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005977 * Use with {@link #fillIn} to allow the current ClipData to be
5978 * overwritten, even if it is already set.
5979 */
5980 public static final int FILL_IN_CLIP_DATA = 1<<7;
5981
5982 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005983 * Copy the contents of <var>other</var> in to this object, but only
5984 * where fields are not defined by this object. For purposes of a field
5985 * being defined, the following pieces of data in the Intent are
5986 * considered to be separate fields:
5987 *
5988 * <ul>
5989 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08005990 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005991 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5992 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005993 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005994 * <li> component, as set by {@link #setComponent(ComponentName)} or
5995 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005996 * <li> source bounds, as set by {@link #setSourceBounds}.
5997 * <li> selector, as set by {@link #setSelector(Intent)}.
5998 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005999 * <li> each top-level name in the associated extras.
6000 * </ul>
6001 *
6002 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006003 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006004 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6005 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6006 * the restriction where the corresponding field will not be replaced if
6007 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006008 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006009 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6010 * is explicitly specified. The selector will only be copied if
6011 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006012 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006013 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6014 * and Intent B with {action="gotit", data-type="some/thing",
6015 * categories="one","two"}.
6016 *
6017 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6018 * containing: {action="gotit", data-type="some/thing",
6019 * categories="bar"}.
6020 *
6021 * @param other Another Intent whose values are to be used to fill in
6022 * the current one.
6023 * @param flags Options to control which fields can be filled in.
6024 *
6025 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006026 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006027 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6028 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006029 */
6030 public int fillIn(Intent other, int flags) {
6031 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006032 if (other.mAction != null
6033 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006034 mAction = other.mAction;
6035 changes |= FILL_IN_ACTION;
6036 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006037 if ((other.mData != null || other.mType != null)
6038 && ((mData == null && mType == null)
6039 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006040 mData = other.mData;
6041 mType = other.mType;
6042 changes |= FILL_IN_DATA;
6043 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006044 if (other.mCategories != null
6045 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006046 if (other.mCategories != null) {
6047 mCategories = new HashSet<String>(other.mCategories);
6048 }
6049 changes |= FILL_IN_CATEGORIES;
6050 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006051 if (other.mPackage != null
6052 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006053 // Only do this if mSelector is not set.
6054 if (mSelector == null) {
6055 mPackage = other.mPackage;
6056 changes |= FILL_IN_PACKAGE;
6057 }
6058 }
6059 // Selector is special: it can only be set if explicitly allowed,
6060 // for the same reason as the component name.
6061 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6062 if (mPackage == null) {
6063 mSelector = new Intent(other.mSelector);
6064 mPackage = null;
6065 changes |= FILL_IN_SELECTOR;
6066 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006067 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006068 if (other.mClipData != null
6069 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6070 mClipData = other.mClipData;
6071 changes |= FILL_IN_CLIP_DATA;
6072 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006073 // Component is special: it can -only- be set if explicitly allowed,
6074 // since otherwise the sender could force the intent somewhere the
6075 // originator didn't intend.
6076 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006077 mComponent = other.mComponent;
6078 changes |= FILL_IN_COMPONENT;
6079 }
6080 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006081 if (other.mSourceBounds != null
6082 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6083 mSourceBounds = new Rect(other.mSourceBounds);
6084 changes |= FILL_IN_SOURCE_BOUNDS;
6085 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006086 if (mExtras == null) {
6087 if (other.mExtras != null) {
6088 mExtras = new Bundle(other.mExtras);
6089 }
6090 } else if (other.mExtras != null) {
6091 try {
6092 Bundle newb = new Bundle(other.mExtras);
6093 newb.putAll(mExtras);
6094 mExtras = newb;
6095 } catch (RuntimeException e) {
6096 // Modifying the extras can cause us to unparcel the contents
6097 // of the bundle, and if we do this in the system process that
6098 // may fail. We really should handle this (i.e., the Bundle
6099 // impl shouldn't be on top of a plain map), but for now just
6100 // ignore it and keep the original contents. :(
6101 Log.w("Intent", "Failure filling in extras", e);
6102 }
6103 }
6104 return changes;
6105 }
6106
6107 /**
6108 * Wrapper class holding an Intent and implementing comparisons on it for
6109 * the purpose of filtering. The class implements its
6110 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6111 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6112 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6113 * on the wrapped Intent.
6114 */
6115 public static final class FilterComparison {
6116 private final Intent mIntent;
6117 private final int mHashCode;
6118
6119 public FilterComparison(Intent intent) {
6120 mIntent = intent;
6121 mHashCode = intent.filterHashCode();
6122 }
6123
6124 /**
6125 * Return the Intent that this FilterComparison represents.
6126 * @return Returns the Intent held by the FilterComparison. Do
6127 * not modify!
6128 */
6129 public Intent getIntent() {
6130 return mIntent;
6131 }
6132
6133 @Override
6134 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006135 if (obj instanceof FilterComparison) {
6136 Intent other = ((FilterComparison)obj).mIntent;
6137 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006138 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006139 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006140 }
6141
6142 @Override
6143 public int hashCode() {
6144 return mHashCode;
6145 }
6146 }
6147
6148 /**
6149 * Determine if two intents are the same for the purposes of intent
6150 * resolution (filtering). That is, if their action, data, type,
6151 * class, and categories are the same. This does <em>not</em> compare
6152 * any extra data included in the intents.
6153 *
6154 * @param other The other Intent to compare against.
6155 *
6156 * @return Returns true if action, data, type, class, and categories
6157 * are the same.
6158 */
6159 public boolean filterEquals(Intent other) {
6160 if (other == null) {
6161 return false;
6162 }
6163 if (mAction != other.mAction) {
6164 if (mAction != null) {
6165 if (!mAction.equals(other.mAction)) {
6166 return false;
6167 }
6168 } else {
6169 if (!other.mAction.equals(mAction)) {
6170 return false;
6171 }
6172 }
6173 }
6174 if (mData != other.mData) {
6175 if (mData != null) {
6176 if (!mData.equals(other.mData)) {
6177 return false;
6178 }
6179 } else {
6180 if (!other.mData.equals(mData)) {
6181 return false;
6182 }
6183 }
6184 }
6185 if (mType != other.mType) {
6186 if (mType != null) {
6187 if (!mType.equals(other.mType)) {
6188 return false;
6189 }
6190 } else {
6191 if (!other.mType.equals(mType)) {
6192 return false;
6193 }
6194 }
6195 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006196 if (mPackage != other.mPackage) {
6197 if (mPackage != null) {
6198 if (!mPackage.equals(other.mPackage)) {
6199 return false;
6200 }
6201 } else {
6202 if (!other.mPackage.equals(mPackage)) {
6203 return false;
6204 }
6205 }
6206 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006207 if (mComponent != other.mComponent) {
6208 if (mComponent != null) {
6209 if (!mComponent.equals(other.mComponent)) {
6210 return false;
6211 }
6212 } else {
6213 if (!other.mComponent.equals(mComponent)) {
6214 return false;
6215 }
6216 }
6217 }
6218 if (mCategories != other.mCategories) {
6219 if (mCategories != null) {
6220 if (!mCategories.equals(other.mCategories)) {
6221 return false;
6222 }
6223 } else {
6224 if (!other.mCategories.equals(mCategories)) {
6225 return false;
6226 }
6227 }
6228 }
6229
6230 return true;
6231 }
6232
6233 /**
6234 * Generate hash code that matches semantics of filterEquals().
6235 *
6236 * @return Returns the hash value of the action, data, type, class, and
6237 * categories.
6238 *
6239 * @see #filterEquals
6240 */
6241 public int filterHashCode() {
6242 int code = 0;
6243 if (mAction != null) {
6244 code += mAction.hashCode();
6245 }
6246 if (mData != null) {
6247 code += mData.hashCode();
6248 }
6249 if (mType != null) {
6250 code += mType.hashCode();
6251 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006252 if (mPackage != null) {
6253 code += mPackage.hashCode();
6254 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006255 if (mComponent != null) {
6256 code += mComponent.hashCode();
6257 }
6258 if (mCategories != null) {
6259 code += mCategories.hashCode();
6260 }
6261 return code;
6262 }
6263
6264 @Override
6265 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006266 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006267
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006268 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006269 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006270 b.append(" }");
6271
6272 return b.toString();
6273 }
6274
6275 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006276 public String toInsecureString() {
6277 StringBuilder b = new StringBuilder(128);
6278
6279 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006280 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006281 b.append(" }");
6282
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006283 return b.toString();
6284 }
Romain Guy4969af72009-06-17 10:53:19 -07006285
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006286 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006287 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006288 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006289
6290 b.append("Intent { ");
6291 toShortString(b, false, true, true, true);
6292 b.append(" }");
6293
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006294 return b.toString();
6295 }
6296
6297 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006298 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6299 StringBuilder b = new StringBuilder(128);
6300 toShortString(b, secure, comp, extras, clip);
6301 return b.toString();
6302 }
6303
6304 /** @hide */
6305 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6306 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006307 boolean first = true;
6308 if (mAction != null) {
6309 b.append("act=").append(mAction);
6310 first = false;
6311 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006312 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006313 if (!first) {
6314 b.append(' ');
6315 }
6316 first = false;
6317 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006318 Iterator<String> i = mCategories.iterator();
6319 boolean didone = false;
6320 while (i.hasNext()) {
6321 if (didone) b.append(",");
6322 didone = true;
6323 b.append(i.next());
6324 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006325 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006326 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006327 if (mData != null) {
6328 if (!first) {
6329 b.append(' ');
6330 }
6331 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006332 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006333 if (secure) {
6334 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006335 } else {
6336 b.append(mData);
6337 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006338 }
6339 if (mType != null) {
6340 if (!first) {
6341 b.append(' ');
6342 }
6343 first = false;
6344 b.append("typ=").append(mType);
6345 }
6346 if (mFlags != 0) {
6347 if (!first) {
6348 b.append(' ');
6349 }
6350 first = false;
6351 b.append("flg=0x").append(Integer.toHexString(mFlags));
6352 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006353 if (mPackage != null) {
6354 if (!first) {
6355 b.append(' ');
6356 }
6357 first = false;
6358 b.append("pkg=").append(mPackage);
6359 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006360 if (comp && mComponent != null) {
6361 if (!first) {
6362 b.append(' ');
6363 }
6364 first = false;
6365 b.append("cmp=").append(mComponent.flattenToShortString());
6366 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006367 if (mSourceBounds != null) {
6368 if (!first) {
6369 b.append(' ');
6370 }
6371 first = false;
6372 b.append("bnds=").append(mSourceBounds.toShortString());
6373 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006374 if (mClipData != null) {
6375 if (!first) {
6376 b.append(' ');
6377 }
6378 first = false;
6379 if (clip) {
6380 b.append("clip={");
6381 mClipData.toShortString(b);
6382 b.append('}');
6383 } else {
6384 b.append("(has clip)");
6385 }
6386 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006387 if (extras && mExtras != null) {
6388 if (!first) {
6389 b.append(' ');
6390 }
6391 first = false;
6392 b.append("(has extras)");
6393 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006394 if (mSelector != null) {
6395 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006396 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006397 b.append("}");
6398 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006399 }
6400
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006401 /**
6402 * Call {@link #toUri} with 0 flags.
6403 * @deprecated Use {@link #toUri} instead.
6404 */
6405 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006406 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006407 return toUri(0);
6408 }
6409
6410 /**
6411 * Convert this Intent into a String holding a URI representation of it.
6412 * The returned URI string has been properly URI encoded, so it can be
6413 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6414 * Intent's data as the base URI, with an additional fragment describing
6415 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006416 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006417 * <p>You can convert the returned string back to an Intent with
6418 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006419 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006420 * @param flags Additional operating flags. Either 0 or
6421 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006422 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006423 * @return Returns a URI encoding URI string describing the entire contents
6424 * of the Intent.
6425 */
6426 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006427 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006428 String scheme = null;
6429 if (mData != null) {
6430 String data = mData.toString();
6431 if ((flags&URI_INTENT_SCHEME) != 0) {
6432 final int N = data.length();
6433 for (int i=0; i<N; i++) {
6434 char c = data.charAt(i);
6435 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6436 || c == '.' || c == '-') {
6437 continue;
6438 }
6439 if (c == ':' && i > 0) {
6440 // Valid scheme.
6441 scheme = data.substring(0, i);
6442 uri.append("intent:");
6443 data = data.substring(i+1);
6444 break;
6445 }
Tom Taylord4a47292009-12-21 13:59:18 -08006446
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006447 // No scheme.
6448 break;
6449 }
6450 }
6451 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006452
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006453 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6454 uri.append("intent:");
6455 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006456
6457 uri.append("#Intent;");
6458
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006459 toUriInner(uri, scheme, flags);
6460 if (mSelector != null) {
6461 uri.append("SEL;");
6462 // Note that for now we are not going to try to handle the
6463 // data part; not clear how to represent this as a URI, and
6464 // not much utility in it.
6465 mSelector.toUriInner(uri, null, flags);
6466 }
6467
6468 uri.append("end");
6469
6470 return uri.toString();
6471 }
6472
6473 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006474 if (scheme != null) {
6475 uri.append("scheme=").append(scheme).append(';');
6476 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006477 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006478 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006479 }
6480 if (mCategories != null) {
6481 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006482 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006483 }
6484 }
6485 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006486 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006487 }
6488 if (mFlags != 0) {
6489 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6490 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006491 if (mPackage != null) {
6492 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6493 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006494 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006495 uri.append("component=").append(Uri.encode(
6496 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006497 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006498 if (mSourceBounds != null) {
6499 uri.append("sourceBounds=")
6500 .append(Uri.encode(mSourceBounds.flattenToString()))
6501 .append(';');
6502 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006503 if (mExtras != null) {
6504 for (String key : mExtras.keySet()) {
6505 final Object value = mExtras.get(key);
6506 char entryType =
6507 value instanceof String ? 'S' :
6508 value instanceof Boolean ? 'B' :
6509 value instanceof Byte ? 'b' :
6510 value instanceof Character ? 'c' :
6511 value instanceof Double ? 'd' :
6512 value instanceof Float ? 'f' :
6513 value instanceof Integer ? 'i' :
6514 value instanceof Long ? 'l' :
6515 value instanceof Short ? 's' :
6516 '\0';
6517
6518 if (entryType != '\0') {
6519 uri.append(entryType);
6520 uri.append('.');
6521 uri.append(Uri.encode(key));
6522 uri.append('=');
6523 uri.append(Uri.encode(value.toString()));
6524 uri.append(';');
6525 }
6526 }
6527 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006528 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006529
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006530 public int describeContents() {
6531 return (mExtras != null) ? mExtras.describeContents() : 0;
6532 }
6533
6534 public void writeToParcel(Parcel out, int flags) {
6535 out.writeString(mAction);
6536 Uri.writeToParcel(out, mData);
6537 out.writeString(mType);
6538 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006539 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006540 ComponentName.writeToParcel(mComponent, out);
6541
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006542 if (mSourceBounds != null) {
6543 out.writeInt(1);
6544 mSourceBounds.writeToParcel(out, flags);
6545 } else {
6546 out.writeInt(0);
6547 }
6548
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006549 if (mCategories != null) {
6550 out.writeInt(mCategories.size());
6551 for (String category : mCategories) {
6552 out.writeString(category);
6553 }
6554 } else {
6555 out.writeInt(0);
6556 }
6557
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006558 if (mSelector != null) {
6559 out.writeInt(1);
6560 mSelector.writeToParcel(out, flags);
6561 } else {
6562 out.writeInt(0);
6563 }
6564
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006565 if (mClipData != null) {
6566 out.writeInt(1);
6567 mClipData.writeToParcel(out, flags);
6568 } else {
6569 out.writeInt(0);
6570 }
6571
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006572 out.writeBundle(mExtras);
6573 }
6574
6575 public static final Parcelable.Creator<Intent> CREATOR
6576 = new Parcelable.Creator<Intent>() {
6577 public Intent createFromParcel(Parcel in) {
6578 return new Intent(in);
6579 }
6580 public Intent[] newArray(int size) {
6581 return new Intent[size];
6582 }
6583 };
6584
Dianne Hackborneb034652009-09-07 00:49:58 -07006585 /** @hide */
6586 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006587 readFromParcel(in);
6588 }
6589
6590 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006591 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006592 mData = Uri.CREATOR.createFromParcel(in);
6593 mType = in.readString();
6594 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006595 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006596 mComponent = ComponentName.readFromParcel(in);
6597
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006598 if (in.readInt() != 0) {
6599 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6600 }
6601
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006602 int N = in.readInt();
6603 if (N > 0) {
6604 mCategories = new HashSet<String>();
6605 int i;
6606 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006607 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006608 }
6609 } else {
6610 mCategories = null;
6611 }
6612
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006613 if (in.readInt() != 0) {
6614 mSelector = new Intent(in);
6615 }
6616
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006617 if (in.readInt() != 0) {
6618 mClipData = new ClipData(in);
6619 }
6620
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006621 mExtras = in.readBundle();
6622 }
6623
6624 /**
6625 * Parses the "intent" element (and its children) from XML and instantiates
6626 * an Intent object. The given XML parser should be located at the tag
6627 * where parsing should start (often named "intent"), from which the
6628 * basic action, data, type, and package and class name will be
6629 * retrieved. The function will then parse in to any child elements,
6630 * looking for <category android:name="xxx"> tags to add categories and
6631 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6632 * to the intent.
6633 *
6634 * @param resources The Resources to use when inflating resources.
6635 * @param parser The XML parser pointing at an "intent" tag.
6636 * @param attrs The AttributeSet interface for retrieving extended
6637 * attribute data at the current <var>parser</var> location.
6638 * @return An Intent object matching the XML data.
6639 * @throws XmlPullParserException If there was an XML parsing error.
6640 * @throws IOException If there was an I/O error.
6641 */
6642 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6643 throws XmlPullParserException, IOException {
6644 Intent intent = new Intent();
6645
6646 TypedArray sa = resources.obtainAttributes(attrs,
6647 com.android.internal.R.styleable.Intent);
6648
6649 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6650
6651 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6652 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6653 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6654
6655 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6656 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6657 if (packageName != null && className != null) {
6658 intent.setComponent(new ComponentName(packageName, className));
6659 }
6660
6661 sa.recycle();
6662
6663 int outerDepth = parser.getDepth();
6664 int type;
6665 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6666 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6667 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6668 continue;
6669 }
6670
6671 String nodeName = parser.getName();
6672 if (nodeName.equals("category")) {
6673 sa = resources.obtainAttributes(attrs,
6674 com.android.internal.R.styleable.IntentCategory);
6675 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6676 sa.recycle();
6677
6678 if (cat != null) {
6679 intent.addCategory(cat);
6680 }
6681 XmlUtils.skipCurrentTag(parser);
6682
6683 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006684 if (intent.mExtras == null) {
6685 intent.mExtras = new Bundle();
6686 }
6687 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6688 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006689
6690 } else {
6691 XmlUtils.skipCurrentTag(parser);
6692 }
6693 }
6694
6695 return intent;
6696 }
Nick Pellyccae4122012-01-09 14:12:58 -08006697
6698 /**
6699 * Normalize a MIME data type.
6700 *
6701 * <p>A normalized MIME type has white-space trimmed,
6702 * content-type parameters removed, and is lower-case.
6703 * This aligns the type with Android best practices for
6704 * intent filtering.
6705 *
6706 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6707 * "text/x-vCard" becomes "text/x-vcard".
6708 *
6709 * <p>All MIME types received from outside Android (such as user input,
6710 * or external sources like Bluetooth, NFC, or the Internet) should
6711 * be normalized before they are used to create an Intent.
6712 *
6713 * @param type MIME data type to normalize
6714 * @return normalized MIME data type, or null if the input was null
6715 * @see {@link #setType}
6716 * @see {@link #setTypeAndNormalize}
6717 */
6718 public static String normalizeMimeType(String type) {
6719 if (type == null) {
6720 return null;
6721 }
6722
6723 type = type.trim().toLowerCase(Locale.US);
6724
6725 final int semicolonIndex = type.indexOf(';');
6726 if (semicolonIndex != -1) {
6727 type = type.substring(0, semicolonIndex);
6728 }
6729 return type;
6730 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006731
6732 /**
6733 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006734 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6735 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006736 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006737 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006738 * @hide
6739 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006740 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006741 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006742 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006743
6744 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006745 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006746
6747 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006748 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006749 try {
6750 // Inspect target intent to see if we need to migrate
6751 final Intent target = getParcelableExtra(EXTRA_INTENT);
6752 if (target != null && target.migrateExtraStreamToClipData()) {
6753 // Since we migrated in child, we need to promote ClipData
6754 // and flags to ourselves to grant.
6755 setClipData(target.getClipData());
6756 addFlags(target.getFlags()
6757 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6758 return true;
6759 } else {
6760 return false;
6761 }
6762 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006763 }
6764
6765 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006766 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006767 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6768 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6769 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6770 if (stream != null || text != null || htmlText != null) {
6771 final ClipData clipData = new ClipData(
6772 null, new String[] { getType() },
6773 new ClipData.Item(text, htmlText, null, stream));
6774 setClipData(clipData);
6775 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006776 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006777 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006778 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006779 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006780
6781 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006782 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006783 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6784 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6785 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6786 int num = -1;
6787 if (streams != null) {
6788 num = streams.size();
6789 }
6790 if (texts != null) {
6791 if (num >= 0 && num != texts.size()) {
6792 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006793 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006794 }
6795 num = texts.size();
6796 }
6797 if (htmlTexts != null) {
6798 if (num >= 0 && num != htmlTexts.size()) {
6799 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006800 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006801 }
6802 num = htmlTexts.size();
6803 }
6804 if (num > 0) {
6805 final ClipData clipData = new ClipData(
6806 null, new String[] { getType() },
6807 makeClipItem(streams, texts, htmlTexts, 0));
6808
6809 for (int i = 1; i < num; i++) {
6810 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6811 }
6812
6813 setClipData(clipData);
6814 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006815 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006816 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006817 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006818 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006819 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006820
6821 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006822 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006823
6824 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6825 ArrayList<String> htmlTexts, int which) {
6826 Uri uri = streams != null ? streams.get(which) : null;
6827 CharSequence text = texts != null ? texts.get(which) : null;
6828 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6829 return new ClipData.Item(text, htmlText, null, uri);
6830 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006831}