blob: c791e47c23fe009605eb99d57de4fd041891106c [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
19import org.xmlpull.v1.XmlPullParser;
20import org.xmlpull.v1.XmlPullParserException;
21
22import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
24import android.content.pm.ActivityInfo;
25import android.content.pm.PackageManager;
26import android.content.pm.ResolveInfo;
27import android.content.res.Resources;
28import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080029import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.net.Uri;
31import android.os.Bundle;
32import android.os.IBinder;
33import android.os.Parcel;
34import android.os.Parcelable;
35import android.util.AttributeSet;
36import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080037
38import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039
40import java.io.IOException;
41import java.io.Serializable;
42import java.net.URISyntaxException;
43import java.util.ArrayList;
44import java.util.HashSet;
45import java.util.Iterator;
Nick Pellyccae4122012-01-09 14:12:58 -080046import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070047import java.util.Set;
48
49/**
50 * An intent is an abstract description of an operation to be performed. It
51 * can be used with {@link Context#startActivity(Intent) startActivity} to
52 * launch an {@link android.app.Activity},
53 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
54 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
55 * and {@link android.content.Context#startService} or
56 * {@link android.content.Context#bindService} to communicate with a
57 * background {@link android.app.Service}.
58 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070059 * <p>An Intent provides a facility for performing late runtime binding between the code in
60 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070061 * can be thought of as the glue between activities. It is basically a passive data structure
62 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070063 *
64 * <div class="special reference">
65 * <h3>Developer Guides</h3>
66 * <p>For information about how to create and resolve intents, read the
67 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
68 * developer guide.</p>
69 * </div>
70 *
71 * <a name="IntentStructure"></a>
72 * <h3>Intent Structure</h3>
73 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070074 *
75 * <ul>
76 * <li> <p><b>action</b> -- The general action to be performed, such as
77 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
78 * etc.</p>
79 * </li>
80 * <li> <p><b>data</b> -- The data to operate on, such as a person record
81 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
82 * </li>
83 * </ul>
84 *
85 *
86 * <p>Some examples of action/data pairs are:</p>
87 *
88 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070089 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070090 * information about the person whose identifier is "1".</p>
91 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * the phone dialer with the person filled in.</p>
94 * </li>
95 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
96 * the phone dialer with the given number filled in. Note how the
97 * VIEW action does what what is considered the most reasonable thing for
98 * a particular URI.</p>
99 * </li>
100 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
101 * the phone dialer with the given number filled in.</p>
102 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700103 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700104 * information about the person whose identifier is "1".</p>
105 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700106 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700107 * a list of people, which the user can browse through. This example is a
108 * typical top-level entry into the Contacts application, showing you the
109 * list of people. Selecting a particular person to view would result in a
110 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
111 * being used to start an activity to display that person.</p>
112 * </li>
113 * </ul>
114 *
115 * <p>In addition to these primary attributes, there are a number of secondary
116 * attributes that you can also include with an intent:</p>
117 *
118 * <ul>
119 * <li> <p><b>category</b> -- Gives additional information about the action
120 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
121 * appear in the Launcher as a top-level application, while
122 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
123 * of alternative actions the user can perform on a piece of data.</p>
124 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
125 * intent data. Normally the type is inferred from the data itself.
126 * By setting this attribute, you disable that evaluation and force
127 * an explicit type.</p>
128 * <li> <p><b>component</b> -- Specifies an explicit name of a component
129 * class to use for the intent. Normally this is determined by looking
130 * at the other information in the intent (the action, data/type, and
131 * categories) and matching that with a component that can handle it.
132 * If this attribute is set then none of the evaluation is performed,
133 * and this component is used exactly as is. By specifying this attribute,
134 * all of the other Intent attributes become optional.</p>
135 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
136 * This can be used to provide extended information to the component.
137 * For example, if we have a action to send an e-mail message, we could
138 * also include extra pieces of data here to supply a subject, body,
139 * etc.</p>
140 * </ul>
141 *
142 * <p>Here are some examples of other operations you can specify as intents
143 * using these additional parameters:</p>
144 *
145 * <ul>
146 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
147 * Launch the home screen.</p>
148 * </li>
149 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
150 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
151 * vnd.android.cursor.item/phone}</i></b>
152 * -- Display the list of people's phone numbers, allowing the user to
153 * browse through them and pick one and return it to the parent activity.</p>
154 * </li>
155 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
156 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
157 * -- Display all pickers for data that can be opened with
158 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
159 * allowing the user to pick one of them and then some data inside of it
160 * and returning the resulting URI to the caller. This can be used,
161 * for example, in an e-mail application to allow the user to pick some
162 * data to include as an attachment.</p>
163 * </li>
164 * </ul>
165 *
166 * <p>There are a variety of standard Intent action and category constants
167 * defined in the Intent class, but applications can also define their own.
168 * These strings use java style scoping, to ensure they are unique -- for
169 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700170 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700171 *
172 * <p>Put together, the set of actions, data types, categories, and extra data
173 * defines a language for the system allowing for the expression of phrases
174 * such as "call john smith's cell". As applications are added to the system,
175 * they can extend this language by adding new actions, types, and categories, or
176 * they can modify the behavior of existing phrases by supplying their own
177 * activities that handle them.</p>
178 *
179 * <a name="IntentResolution"></a>
180 * <h3>Intent Resolution</h3>
181 *
182 * <p>There are two primary forms of intents you will use.
183 *
184 * <ul>
185 * <li> <p><b>Explicit Intents</b> have specified a component (via
186 * {@link #setComponent} or {@link #setClass}), which provides the exact
187 * class to be run. Often these will not include any other information,
188 * simply being a way for an application to launch various internal
189 * activities it has as the user interacts with the application.
190 *
191 * <li> <p><b>Implicit Intents</b> have not specified a component;
192 * instead, they must include enough information for the system to
193 * determine which of the available components is best to run for that
194 * intent.
195 * </ul>
196 *
197 * <p>When using implicit intents, given such an arbitrary intent we need to
198 * know what to do with it. This is handled by the process of <em>Intent
199 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
200 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
201 * more activities/receivers) that can handle it.</p>
202 *
203 * <p>The intent resolution mechanism basically revolves around matching an
204 * Intent against all of the &lt;intent-filter&gt; descriptions in the
205 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
206 * objects explicitly registered with {@link Context#registerReceiver}.) More
207 * details on this can be found in the documentation on the {@link
208 * IntentFilter} class.</p>
209 *
210 * <p>There are three pieces of information in the Intent that are used for
211 * resolution: the action, type, and category. Using this information, a query
212 * is done on the {@link PackageManager} for a component that can handle the
213 * intent. The appropriate component is determined based on the intent
214 * information supplied in the <code>AndroidManifest.xml</code> file as
215 * follows:</p>
216 *
217 * <ul>
218 * <li> <p>The <b>action</b>, if given, must be listed by the component as
219 * one it handles.</p>
220 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
221 * already supplied in the Intent. Like the action, if a type is
222 * included in the intent (either explicitly or implicitly in its
223 * data), then this must be listed by the component as one it handles.</p>
224 * <li> For data that is not a <code>content:</code> URI and where no explicit
225 * type is included in the Intent, instead the <b>scheme</b> of the
226 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
227 * considered. Again like the action, if we are matching a scheme it
228 * must be listed by the component as one it can handle.
229 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
230 * by the activity as categories it handles. That is, if you include
231 * the categories {@link #CATEGORY_LAUNCHER} and
232 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
233 * with an intent that lists <em>both</em> of those categories.
234 * Activities will very often need to support the
235 * {@link #CATEGORY_DEFAULT} so that they can be found by
236 * {@link Context#startActivity Context.startActivity()}.</p>
237 * </ul>
238 *
239 * <p>For example, consider the Note Pad sample application that
240 * allows user to browse through a list of notes data and view details about
241 * individual items. Text in italics indicate places were you would replace a
242 * name with one specific to your own package.</p>
243 *
244 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
245 * package="<i>com.android.notepad</i>"&gt;
246 * &lt;application android:icon="@drawable/app_notes"
247 * android:label="@string/app_name"&gt;
248 *
249 * &lt;provider class=".NotePadProvider"
250 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
251 *
252 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
253 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700254 * &lt;action android:name="android.intent.action.MAIN" /&gt;
255 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700256 * &lt;/intent-filter&gt;
257 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700258 * &lt;action android:name="android.intent.action.VIEW" /&gt;
259 * &lt;action android:name="android.intent.action.EDIT" /&gt;
260 * &lt;action android:name="android.intent.action.PICK" /&gt;
261 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
262 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700263 * &lt;/intent-filter&gt;
264 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700265 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
266 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
267 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700268 * &lt;/intent-filter&gt;
269 * &lt;/activity&gt;
270 *
271 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
272 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700273 * &lt;action android:name="android.intent.action.VIEW" /&gt;
274 * &lt;action android:name="android.intent.action.EDIT" /&gt;
275 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
276 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 *
279 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700280 * &lt;action android:name="android.intent.action.INSERT" /&gt;
281 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
282 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700283 * &lt;/intent-filter&gt;
284 *
285 * &lt;/activity&gt;
286 *
287 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
288 * android:theme="@android:style/Theme.Dialog"&gt;
289 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
293 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 * &lt;/activity&gt;
297 *
298 * &lt;/application&gt;
299 * &lt;/manifest&gt;</pre>
300 *
301 * <p>The first activity,
302 * <code>com.android.notepad.NotesList</code>, serves as our main
303 * entry into the app. It can do three things as described by its three intent
304 * templates:
305 * <ol>
306 * <li><pre>
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
309 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700310 * &lt;/intent-filter&gt;</pre>
311 * <p>This provides a top-level entry into the NotePad application: the standard
312 * MAIN action is a main entry point (not requiring any other information in
313 * the Intent), and the LAUNCHER category says that this entry point should be
314 * listed in the application launcher.</p>
315 * <li><pre>
316 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700317 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
318 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
319 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
320 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
321 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700322 * &lt;/intent-filter&gt;</pre>
323 * <p>This declares the things that the activity can do on a directory of
324 * notes. The type being supported is given with the &lt;type&gt; tag, where
325 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
326 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
327 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
328 * The activity allows the user to view or edit the directory of data (via
329 * the VIEW and EDIT actions), or to pick a particular note and return it
330 * to the caller (via the PICK action). Note also the DEFAULT category
331 * supplied here: this is <em>required</em> for the
332 * {@link Context#startActivity Context.startActivity} method to resolve your
333 * activity when its component name is not explicitly specified.</p>
334 * <li><pre>
335 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700336 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
337 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
338 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700339 * &lt;/intent-filter&gt;</pre>
340 * <p>This filter describes the ability return to the caller a note selected by
341 * the user without needing to know where it came from. The data type
342 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
343 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
344 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
345 * The GET_CONTENT action is similar to the PICK action, where the activity
346 * will return to its caller a piece of data selected by the user. Here,
347 * however, the caller specifies the type of data they desire instead of
348 * the type of data the user will be picking from.</p>
349 * </ol>
350 *
351 * <p>Given these capabilities, the following intents will resolve to the
352 * NotesList activity:</p>
353 *
354 * <ul>
355 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
356 * activities that can be used as top-level entry points into an
357 * application.</p>
358 * <li> <p><b>{ action=android.app.action.MAIN,
359 * category=android.app.category.LAUNCHER }</b> is the actual intent
360 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700361 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * data=content://com.google.provider.NotePad/notes }</b>
363 * displays a list of all the notes under
364 * "content://com.google.provider.NotePad/notes", which
365 * the user can browse through and see the details on.</p>
366 * <li> <p><b>{ action=android.app.action.PICK
367 * data=content://com.google.provider.NotePad/notes }</b>
368 * provides a list of the notes under
369 * "content://com.google.provider.NotePad/notes", from which
370 * the user can pick a note whose data URL is returned back to the caller.</p>
371 * <li> <p><b>{ action=android.app.action.GET_CONTENT
372 * type=vnd.android.cursor.item/vnd.google.note }</b>
373 * is similar to the pick action, but allows the caller to specify the
374 * kind of data they want back so that the system can find the appropriate
375 * activity to pick something of that data type.</p>
376 * </ul>
377 *
378 * <p>The second activity,
379 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
380 * note entry and allows them to edit it. It can do two things as described
381 * by its two intent templates:
382 * <ol>
383 * <li><pre>
384 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700385 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
386 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
387 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
388 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700389 * &lt;/intent-filter&gt;</pre>
390 * <p>The first, primary, purpose of this activity is to let the user interact
391 * with a single note, as decribed by the MIME type
392 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
393 * either VIEW a note or allow the user to EDIT it. Again we support the
394 * DEFAULT category to allow the activity to be launched without explicitly
395 * specifying its component.</p>
396 * <li><pre>
397 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700398 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
399 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
400 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700401 * &lt;/intent-filter&gt;</pre>
402 * <p>The secondary use of this activity is to insert a new note entry into
403 * an existing directory of notes. This is used when the user creates a new
404 * note: the INSERT action is executed on the directory of notes, causing
405 * this activity to run and have the user create the new note data which
406 * it then adds to the content provider.</p>
407 * </ol>
408 *
409 * <p>Given these capabilities, the following intents will resolve to the
410 * NoteEditor activity:</p>
411 *
412 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700413 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700414 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
415 * shows the user the content of note <var>{ID}</var>.</p>
416 * <li> <p><b>{ action=android.app.action.EDIT
417 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
418 * allows the user to edit the content of note <var>{ID}</var>.</p>
419 * <li> <p><b>{ action=android.app.action.INSERT
420 * data=content://com.google.provider.NotePad/notes }</b>
421 * creates a new, empty note in the notes list at
422 * "content://com.google.provider.NotePad/notes"
423 * and allows the user to edit it. If they keep their changes, the URI
424 * of the newly created note is returned to the caller.</p>
425 * </ul>
426 *
427 * <p>The last activity,
428 * <code>com.android.notepad.TitleEditor</code>, allows the user to
429 * edit the title of a note. This could be implemented as a class that the
430 * application directly invokes (by explicitly setting its component in
431 * the Intent), but here we show a way you can publish alternative
432 * operations on existing data:</p>
433 *
434 * <pre>
435 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700436 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
437 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
438 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
439 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
440 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700441 * &lt;/intent-filter&gt;</pre>
442 *
443 * <p>In the single intent template here, we
444 * have created our own private action called
445 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
446 * edit the title of a note. It must be invoked on a specific note
447 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
448 * view and edit actions, but here displays and edits the title contained
449 * in the note data.
450 *
451 * <p>In addition to supporting the default category as usual, our title editor
452 * also supports two other standard categories: ALTERNATIVE and
453 * SELECTED_ALTERNATIVE. Implementing
454 * these categories allows others to find the special action it provides
455 * without directly knowing about it, through the
456 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
457 * more often to build dynamic menu items with
458 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
459 * template here was also supply an explicit name for the template
460 * (via <code>android:label="@string/resolve_title"</code>) to better control
461 * what the user sees when presented with this activity as an alternative
462 * action to the data they are viewing.
463 *
464 * <p>Given these capabilities, the following intent will resolve to the
465 * TitleEditor activity:</p>
466 *
467 * <ul>
468 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
469 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
470 * displays and allows the user to edit the title associated
471 * with note <var>{ID}</var>.</p>
472 * </ul>
473 *
474 * <h3>Standard Activity Actions</h3>
475 *
476 * <p>These are the current standard actions that Intent defines for launching
477 * activities (usually through {@link Context#startActivity}. The most
478 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
479 * {@link #ACTION_EDIT}.
480 *
481 * <ul>
482 * <li> {@link #ACTION_MAIN}
483 * <li> {@link #ACTION_VIEW}
484 * <li> {@link #ACTION_ATTACH_DATA}
485 * <li> {@link #ACTION_EDIT}
486 * <li> {@link #ACTION_PICK}
487 * <li> {@link #ACTION_CHOOSER}
488 * <li> {@link #ACTION_GET_CONTENT}
489 * <li> {@link #ACTION_DIAL}
490 * <li> {@link #ACTION_CALL}
491 * <li> {@link #ACTION_SEND}
492 * <li> {@link #ACTION_SENDTO}
493 * <li> {@link #ACTION_ANSWER}
494 * <li> {@link #ACTION_INSERT}
495 * <li> {@link #ACTION_DELETE}
496 * <li> {@link #ACTION_RUN}
497 * <li> {@link #ACTION_SYNC}
498 * <li> {@link #ACTION_PICK_ACTIVITY}
499 * <li> {@link #ACTION_SEARCH}
500 * <li> {@link #ACTION_WEB_SEARCH}
501 * <li> {@link #ACTION_FACTORY_TEST}
502 * </ul>
503 *
504 * <h3>Standard Broadcast Actions</h3>
505 *
506 * <p>These are the current standard actions that Intent defines for receiving
507 * broadcasts (usually through {@link Context#registerReceiver} or a
508 * &lt;receiver&gt; tag in a manifest).
509 *
510 * <ul>
511 * <li> {@link #ACTION_TIME_TICK}
512 * <li> {@link #ACTION_TIME_CHANGED}
513 * <li> {@link #ACTION_TIMEZONE_CHANGED}
514 * <li> {@link #ACTION_BOOT_COMPLETED}
515 * <li> {@link #ACTION_PACKAGE_ADDED}
516 * <li> {@link #ACTION_PACKAGE_CHANGED}
517 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800518 * <li> {@link #ACTION_PACKAGE_RESTARTED}
519 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700520 * <li> {@link #ACTION_UID_REMOVED}
521 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700522 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700523 * <li> {@link #ACTION_POWER_DISCONNECTED}
524 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700525 * </ul>
526 *
527 * <h3>Standard Categories</h3>
528 *
529 * <p>These are the current standard categories that can be used to further
530 * clarify an Intent via {@link #addCategory}.
531 *
532 * <ul>
533 * <li> {@link #CATEGORY_DEFAULT}
534 * <li> {@link #CATEGORY_BROWSABLE}
535 * <li> {@link #CATEGORY_TAB}
536 * <li> {@link #CATEGORY_ALTERNATIVE}
537 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
538 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700540 * <li> {@link #CATEGORY_HOME}
541 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700542 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400543 * <li> {@link #CATEGORY_CAR_DOCK}
544 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500545 * <li> {@link #CATEGORY_LE_DESK_DOCK}
546 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200547 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700548 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * </ul>
550 *
551 * <h3>Standard Extra Data</h3>
552 *
553 * <p>These are the current standard fields that can be used as extra data via
554 * {@link #putExtra}.
555 *
556 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800557 * <li> {@link #EXTRA_ALARM_COUNT}
558 * <li> {@link #EXTRA_BCC}
559 * <li> {@link #EXTRA_CC}
560 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
561 * <li> {@link #EXTRA_DATA_REMOVED}
562 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500563 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
564 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800565 * <li> {@link #EXTRA_DOCK_STATE_CAR}
566 * <li> {@link #EXTRA_DOCK_STATE_DESK}
567 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
568 * <li> {@link #EXTRA_DONT_KILL_APP}
569 * <li> {@link #EXTRA_EMAIL}
570 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800572 * <li> {@link #EXTRA_KEY_EVENT}
573 * <li> {@link #EXTRA_PHONE_NUMBER}
574 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
575 * <li> {@link #EXTRA_REPLACING}
576 * <li> {@link #EXTRA_SHORTCUT_ICON}
577 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
578 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700579 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800580 * <li> {@link #EXTRA_SHORTCUT_NAME}
581 * <li> {@link #EXTRA_SUBJECT}
582 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700583 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800584 * <li> {@link #EXTRA_TITLE}
585 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700586 * </ul>
587 *
588 * <h3>Flags</h3>
589 *
590 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800591 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
592 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700593 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800594public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 // ---------------------------------------------------------------------
596 // ---------------------------------------------------------------------
597 // Standard intent activity actions (see action variable).
598
599 /**
600 * Activity Action: Start as a main entry point, does not expect to
601 * receive data.
602 * <p>Input: nothing
603 * <p>Output: nothing
604 */
605 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
606 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800607
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 /**
609 * Activity Action: Display the data to the user. This is the most common
610 * action performed on data -- it is the generic action you can use on
611 * a piece of data to get the most reasonable thing to occur. For example,
612 * when used on a contacts entry it will view the entry; when used on a
613 * mailto: URI it will bring up a compose window filled with the information
614 * supplied by the URI; when used with a tel: URI it will invoke the
615 * dialer.
616 * <p>Input: {@link #getData} is URI from which to retrieve data.
617 * <p>Output: nothing.
618 */
619 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
620 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800621
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700622 /**
623 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
624 * performed on a piece of data.
625 */
626 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800627
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700628 /**
629 * Used to indicate that some piece of data should be attached to some other
630 * place. For example, image data could be attached to a contact. It is up
631 * to the recipient to decide where the data should be attached; the intent
632 * does not specify the ultimate destination.
633 * <p>Input: {@link #getData} is URI of data to be attached.
634 * <p>Output: nothing.
635 */
636 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
637 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800638
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700639 /**
640 * Activity Action: Provide explicit editable access to the given data.
641 * <p>Input: {@link #getData} is URI of data to be edited.
642 * <p>Output: nothing.
643 */
644 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
645 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800646
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700647 /**
648 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
649 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
650 * The extras can contain type specific data to pass through to the editing/creating
651 * activity.
652 * <p>Output: The URI of the item that was picked. This must be a content:
653 * URI so that any receiver can access it.
654 */
655 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
656 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800657
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700658 /**
659 * Activity Action: Pick an item from the data, returning what was selected.
660 * <p>Input: {@link #getData} is URI containing a directory of data
661 * (vnd.android.cursor.dir/*) from which to pick an item.
662 * <p>Output: The URI of the item that was picked.
663 */
664 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
665 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800666
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700667 /**
668 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800669 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700670 * <p>Output: An Intent representing the shortcut. The intent must contain three
671 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
672 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800673 * (value: ShortcutIconResource).</p>
674 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700675 * @see #EXTRA_SHORTCUT_INTENT
676 * @see #EXTRA_SHORTCUT_NAME
677 * @see #EXTRA_SHORTCUT_ICON
678 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
679 * @see android.content.Intent.ShortcutIconResource
680 */
681 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
682 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
683
684 /**
685 * The name of the extra used to define the Intent of a shortcut.
686 *
687 * @see #ACTION_CREATE_SHORTCUT
688 */
689 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
690 /**
691 * The name of the extra used to define the name of a shortcut.
692 *
693 * @see #ACTION_CREATE_SHORTCUT
694 */
695 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
696 /**
697 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
698 *
699 * @see #ACTION_CREATE_SHORTCUT
700 */
701 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
702 /**
703 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
704 *
705 * @see #ACTION_CREATE_SHORTCUT
706 * @see android.content.Intent.ShortcutIconResource
707 */
708 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
709 "android.intent.extra.shortcut.ICON_RESOURCE";
710
711 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800712 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700713 *
714 * @see Intent#ACTION_CREATE_SHORTCUT
715 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800716 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
717 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700718 */
719 public static class ShortcutIconResource implements Parcelable {
720 /**
721 * The package name of the application containing the icon.
722 */
723 public String packageName;
724
725 /**
726 * The resource name of the icon, including package, name and type.
727 */
728 public String resourceName;
729
730 /**
731 * Creates a new ShortcutIconResource for the specified context and resource
732 * identifier.
733 *
734 * @param context The context of the application.
735 * @param resourceId The resource idenfitier for the icon.
736 * @return A new ShortcutIconResource with the specified's context package name
737 * and icon resource idenfitier.
738 */
739 public static ShortcutIconResource fromContext(Context context, int resourceId) {
740 ShortcutIconResource icon = new ShortcutIconResource();
741 icon.packageName = context.getPackageName();
742 icon.resourceName = context.getResources().getResourceName(resourceId);
743 return icon;
744 }
745
746 /**
747 * Used to read a ShortcutIconResource from a Parcel.
748 */
749 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
750 new Parcelable.Creator<ShortcutIconResource>() {
751
752 public ShortcutIconResource createFromParcel(Parcel source) {
753 ShortcutIconResource icon = new ShortcutIconResource();
754 icon.packageName = source.readString();
755 icon.resourceName = source.readString();
756 return icon;
757 }
758
759 public ShortcutIconResource[] newArray(int size) {
760 return new ShortcutIconResource[size];
761 }
762 };
763
764 /**
765 * No special parcel contents.
766 */
767 public int describeContents() {
768 return 0;
769 }
770
771 public void writeToParcel(Parcel dest, int flags) {
772 dest.writeString(packageName);
773 dest.writeString(resourceName);
774 }
775
776 @Override
777 public String toString() {
778 return resourceName;
779 }
780 }
781
782 /**
783 * Activity Action: Display an activity chooser, allowing the user to pick
784 * what they want to before proceeding. This can be used as an alternative
785 * to the standard activity picker that is displayed by the system when
786 * you try to start an activity with multiple possible matches, with these
787 * differences in behavior:
788 * <ul>
789 * <li>You can specify the title that will appear in the activity chooser.
790 * <li>The user does not have the option to make one of the matching
791 * activities a preferred activity, and all possible activities will
792 * always be shown even if one of them is currently marked as the
793 * preferred activity.
794 * </ul>
795 * <p>
796 * This action should be used when the user will naturally expect to
797 * select an activity in order to proceed. An example if when not to use
798 * it is when the user clicks on a "mailto:" link. They would naturally
799 * expect to go directly to their mail app, so startActivity() should be
800 * called directly: it will
801 * either launch the current preferred app, or put up a dialog allowing the
802 * user to pick an app to use and optionally marking that as preferred.
803 * <p>
804 * In contrast, if the user is selecting a menu item to send a picture
805 * they are viewing to someone else, there are many different things they
806 * may want to do at this point: send it through e-mail, upload it to a
807 * web service, etc. In this case the CHOOSER action should be used, to
808 * always present to the user a list of the things they can do, with a
809 * nice title given by the caller such as "Send this photo with:".
810 * <p>
811 * As a convenience, an Intent of this form can be created with the
812 * {@link #createChooser} function.
813 * <p>Input: No data should be specified. get*Extra must have
814 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
815 * and can optionally have a {@link #EXTRA_TITLE} field containing the
816 * title text to display in the chooser.
817 * <p>Output: Depends on the protocol of {@link #EXTRA_INTENT}.
818 */
819 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
820 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
821
822 /**
823 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
824 *
825 * @param target The Intent that the user will be selecting an activity
826 * to perform.
827 * @param title Optional title that will be displayed in the chooser.
828 * @return Return a new Intent object that you can hand to
829 * {@link Context#startActivity(Intent) Context.startActivity()} and
830 * related methods.
831 */
832 public static Intent createChooser(Intent target, CharSequence title) {
833 Intent intent = new Intent(ACTION_CHOOSER);
834 intent.putExtra(EXTRA_INTENT, target);
835 if (title != null) {
836 intent.putExtra(EXTRA_TITLE, title);
837 }
838 return intent;
839 }
840 /**
841 * Activity Action: Allow the user to select a particular kind of data and
842 * return it. This is different than {@link #ACTION_PICK} in that here we
843 * just say what kind of data is desired, not a URI of existing data from
844 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
845 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900846 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700847 * etc.
848 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900849 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700850 * of data, such as a person contact, you set the MIME type to the kind of
851 * data you want and launch it with {@link Context#startActivity(Intent)}.
852 * The system will then launch the best application to select that kind
853 * of data for you.
854 * <p>
855 * You may also be interested in any of a set of types of content the user
856 * can pick. For example, an e-mail application that wants to allow the
857 * user to add an attachment to an e-mail message can use this action to
858 * bring up a list of all of the types of content the user can attach.
859 * <p>
860 * In this case, you should wrap the GET_CONTENT intent with a chooser
861 * (through {@link #createChooser}), which will give the proper interface
862 * for the user to pick how to send your data and allow you to specify
863 * a prompt indicating what they are doing. You will usually specify a
864 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
865 * broad range of content types the user can select from.
866 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900867 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700868 * only pick from data that can be represented as a stream. This is
869 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
870 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800871 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900872 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800873 * is locally available on the device. For example, if this extra is set
874 * to true then an image picker should not show any pictures that are available
875 * from a remote server but not already on the local device (thus requiring
876 * they be downloaded when opened).
877 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700878 * Input: {@link #getType} is the desired MIME type to retrieve. Note
879 * that no URI is supplied in the intent, as there are no constraints on
880 * where the returned data originally comes from. You may also include the
881 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800882 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
883 * selection to local data.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700884 * <p>
885 * Output: The URI of the item that was picked. This must be a content:
886 * URI so that any receiver can access it.
887 */
888 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
889 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
890 /**
891 * Activity Action: Dial a number as specified by the data. This shows a
892 * UI with the number being dialed, allowing the user to explicitly
893 * initiate the call.
894 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
895 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
896 * number.
897 * <p>Output: nothing.
898 */
899 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
900 public static final String ACTION_DIAL = "android.intent.action.DIAL";
901 /**
902 * Activity Action: Perform a call to someone specified by the data.
903 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
904 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
905 * number.
906 * <p>Output: nothing.
907 *
908 * <p>Note: there will be restrictions on which applications can initiate a
909 * call; most applications should use the {@link #ACTION_DIAL}.
910 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
911 * numbers. Applications can <strong>dial</strong> emergency numbers using
912 * {@link #ACTION_DIAL}, however.
913 */
914 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
915 public static final String ACTION_CALL = "android.intent.action.CALL";
916 /**
917 * Activity Action: Perform a call to an emergency number specified by the
918 * data.
919 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
920 * tel: URI of an explicit phone number.
921 * <p>Output: nothing.
922 * @hide
923 */
924 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
925 /**
926 * Activity action: Perform a call to any number (emergency or not)
927 * specified by the data.
928 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
929 * tel: URI of an explicit phone number.
930 * <p>Output: nothing.
931 * @hide
932 */
933 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
934 /**
935 * Activity Action: Send a message to someone specified by the data.
936 * <p>Input: {@link #getData} is URI describing the target.
937 * <p>Output: nothing.
938 */
939 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
940 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
941 /**
942 * Activity Action: Deliver some data to someone else. Who the data is
943 * being delivered to is not specified; it is up to the receiver of this
944 * action to ask the user where the data should be sent.
945 * <p>
946 * When launching a SEND intent, you should usually wrap it in a chooser
947 * (through {@link #createChooser}), which will give the proper interface
948 * for the user to pick how to send your data and allow you to specify
949 * a prompt indicating what they are doing.
950 * <p>
951 * Input: {@link #getType} is the MIME type of the data being sent.
952 * get*Extra can have either a {@link #EXTRA_TEXT}
953 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
954 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
955 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
956 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700957 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
958 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
959 * your text with HTML formatting.
960 * <p>
961 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
962 * being sent can be supplied through {@link #setClipData(ClipData)}. This
963 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
964 * content: URIs and other advanced features of {@link ClipData}. If
965 * using this approach, you still must supply the same data through the
966 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
967 * for compatibility with old applications. If you don't set a ClipData,
968 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700969 * <p>
970 * Optional standard extras, which may be interpreted by some recipients as
971 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
972 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
973 * <p>
974 * Output: nothing.
975 */
976 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
977 public static final String ACTION_SEND = "android.intent.action.SEND";
978 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800979 * Activity Action: Deliver multiple data to someone else.
980 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700981 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800982 * <p>
983 * Input: {@link #getType} is the MIME type of the data being sent.
984 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700985 * #EXTRA_STREAM} field, containing the data to be sent. If using
986 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
987 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800988 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +0800989 * Multiple types are supported, and receivers should handle mixed types
990 * whenever possible. The right way for the receiver to check them is to
991 * use the content resolver on each URI. The intent sender should try to
992 * put the most concrete mime type in the intent type, but it can fall
993 * back to {@literal <type>/*} or {@literal *}/* as needed.
994 * <p>
995 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
996 * be image/jpg, but if you are sending image/jpg and image/png, then the
997 * intent's type should be image/*.
998 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700999 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1000 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1001 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1002 * content: URIs and other advanced features of {@link ClipData}. If
1003 * using this approach, you still must supply the same data through the
1004 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1005 * for compatibility with old applications. If you don't set a ClipData,
1006 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1007 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001008 * Optional standard extras, which may be interpreted by some recipients as
1009 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1010 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1011 * <p>
1012 * Output: nothing.
1013 */
1014 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1015 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1016 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001017 * Activity Action: Handle an incoming phone call.
1018 * <p>Input: nothing.
1019 * <p>Output: nothing.
1020 */
1021 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1022 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1023 /**
1024 * Activity Action: Insert an empty item into the given container.
1025 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1026 * in which to place the data.
1027 * <p>Output: URI of the new data that was created.
1028 */
1029 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1030 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1031 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001032 * Activity Action: Create a new item in the given container, initializing it
1033 * from the current contents of the clipboard.
1034 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1035 * in which to place the data.
1036 * <p>Output: URI of the new data that was created.
1037 */
1038 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1039 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1040 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001041 * Activity Action: Delete the given data from its container.
1042 * <p>Input: {@link #getData} is URI of data to be deleted.
1043 * <p>Output: nothing.
1044 */
1045 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1046 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1047 /**
1048 * Activity Action: Run the data, whatever that means.
1049 * <p>Input: ? (Note: this is currently specific to the test harness.)
1050 * <p>Output: nothing.
1051 */
1052 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1053 public static final String ACTION_RUN = "android.intent.action.RUN";
1054 /**
1055 * Activity Action: Perform a data synchronization.
1056 * <p>Input: ?
1057 * <p>Output: ?
1058 */
1059 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1060 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1061 /**
1062 * Activity Action: Pick an activity given an intent, returning the class
1063 * selected.
1064 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1065 * used with {@link PackageManager#queryIntentActivities} to determine the
1066 * set of activities from which to pick.
1067 * <p>Output: Class name of the activity that was selected.
1068 */
1069 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1070 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1071 /**
1072 * Activity Action: Perform a search.
1073 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1074 * is the text to search for. If empty, simply
1075 * enter your search results Activity with the search UI activated.
1076 * <p>Output: nothing.
1077 */
1078 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1079 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1080 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001081 * Activity Action: Start the platform-defined tutorial
1082 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1083 * is the text to search for. If empty, simply
1084 * enter your search results Activity with the search UI activated.
1085 * <p>Output: nothing.
1086 */
1087 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1088 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1089 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001090 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001091 * <p>
1092 * Input: {@link android.app.SearchManager#QUERY
1093 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1094 * a url starts with http or https, the site will be opened. If it is plain
1095 * text, Google search will be applied.
1096 * <p>
1097 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001098 */
1099 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1100 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1101 /**
Jim Miller07994402012-05-02 14:22:27 -07001102 * Activity Action: Perform assist action.
1103 * <p>
1104 * Input: nothing
1105 * Output: nothing.
1106 */
1107 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1108 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
1109 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001110 * Activity Action: List all available applications
1111 * <p>Input: Nothing.
1112 * <p>Output: nothing.
1113 */
1114 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1115 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1116 /**
1117 * Activity Action: Show settings for choosing wallpaper
1118 * <p>Input: Nothing.
1119 * <p>Output: Nothing.
1120 */
1121 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1122 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1123
1124 /**
1125 * Activity Action: Show activity for reporting a bug.
1126 * <p>Input: Nothing.
1127 * <p>Output: Nothing.
1128 */
1129 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1130 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1131
1132 /**
1133 * Activity Action: Main entry point for factory tests. Only used when
1134 * the device is booting in factory test node. The implementing package
1135 * must be installed in the system image.
1136 * <p>Input: nothing
1137 * <p>Output: nothing
1138 */
1139 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1140
1141 /**
1142 * Activity Action: The user pressed the "call" button to go to the dialer
1143 * or other appropriate UI for placing a call.
1144 * <p>Input: Nothing.
1145 * <p>Output: Nothing.
1146 */
1147 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1148 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1149
1150 /**
1151 * Activity Action: Start Voice Command.
1152 * <p>Input: Nothing.
1153 * <p>Output: Nothing.
1154 */
1155 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1156 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001157
1158 /**
1159 * Activity Action: Start action associated with long pressing on the
1160 * search key.
1161 * <p>Input: Nothing.
1162 * <p>Output: Nothing.
1163 */
1164 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1165 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001166
Jacek Surazski86b6c532009-05-13 14:38:28 +02001167 /**
1168 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1169 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001170 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001171 * <p>Input: No data is specified. The bug report is passed in using
1172 * an {@link #EXTRA_BUG_REPORT} field.
1173 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001174 *
1175 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001176 */
1177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1178 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001179
1180 /**
1181 * Activity Action: Show power usage information to the user.
1182 * <p>Input: Nothing.
1183 * <p>Output: Nothing.
1184 */
1185 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1186 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001187
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001188 /**
1189 * Activity Action: Setup wizard to launch after a platform update. This
1190 * activity should have a string meta-data field associated with it,
1191 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1192 * the platform for setup. The activity will be launched only if
1193 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1194 * same value.
1195 * <p>Input: Nothing.
1196 * <p>Output: Nothing.
1197 * @hide
1198 */
1199 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1200 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001201
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001202 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001203 * Activity Action: Show settings for managing network data usage of a
1204 * specific application. Applications should define an activity that offers
1205 * options to control data usage.
1206 */
1207 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1208 public static final String ACTION_MANAGE_NETWORK_USAGE =
1209 "android.intent.action.MANAGE_NETWORK_USAGE";
1210
1211 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001212 * Activity Action: Launch application installer.
1213 * <p>
1214 * Input: The data must be a content: or file: URI at which the application
1215 * can be retrieved. You can optionally supply
1216 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1217 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1218 * <p>
1219 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1220 * succeeded.
1221 *
1222 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1223 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1224 * @see #EXTRA_RETURN_RESULT
1225 */
1226 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1227 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1228
1229 /**
1230 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1231 * package. Specifies the installer package name; this package will receive the
1232 * {@link #ACTION_APP_ERROR} intent.
1233 */
1234 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1235 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1236
1237 /**
1238 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1239 * package. Specifies that the application being installed should not be
1240 * treated as coming from an unknown source, but as coming from the app
1241 * invoking the Intent. For this to work you must start the installer with
1242 * startActivityForResult().
1243 */
1244 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1245 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1246
1247 /**
1248 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1249 * package. Tells the installer UI to skip the confirmation with the user
1250 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001251 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1252 * will no longer show an interstitial message about updating existing
1253 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001254 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001255 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001256 public static final String EXTRA_ALLOW_REPLACE
1257 = "android.intent.extra.ALLOW_REPLACE";
1258
1259 /**
1260 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1261 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1262 * return to the application the result code of the install/uninstall. The returned result
1263 * code will be {@link android.app.Activity#RESULT_OK} on success or
1264 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1265 */
1266 public static final String EXTRA_RETURN_RESULT
1267 = "android.intent.extra.RETURN_RESULT";
1268
1269 /**
1270 * Package manager install result code. @hide because result codes are not
1271 * yet ready to be exposed.
1272 */
1273 public static final String EXTRA_INSTALL_RESULT
1274 = "android.intent.extra.INSTALL_RESULT";
1275
1276 /**
1277 * Activity Action: Launch application uninstaller.
1278 * <p>
1279 * Input: The data must be a package: URI whose scheme specific part is
1280 * the package name of the current installed package to be uninstalled.
1281 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1282 * <p>
1283 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1284 * succeeded.
1285 */
1286 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1287 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1288
1289 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001290 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1291 * describing the last run version of the platform that was setup.
1292 * @hide
1293 */
1294 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1295
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001296 // ---------------------------------------------------------------------
1297 // ---------------------------------------------------------------------
1298 // Standard intent broadcast actions (see action variable).
1299
1300 /**
1301 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001302 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001303 * <p class="note">This is a protected intent that can only be sent
1304 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001305 */
1306 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1307 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1308 /**
1309 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001310 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001311 * <p class="note">This is a protected intent that can only be sent
1312 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001313 */
1314 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1315 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001316
1317 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001318 * 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 -07001319 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001320 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001321 * <p class="note">This is a protected intent that can only be sent
1322 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001323 */
1324 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001325 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001326
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001327 /**
1328 * Broadcast Action: The current time has changed. Sent every
1329 * minute. You can <em>not</em> receive this through components declared
1330 * in manifests, only by exlicitly registering for it with
1331 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1332 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001333 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001334 * <p class="note">This is a protected intent that can only be sent
1335 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001336 */
1337 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1338 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1339 /**
1340 * Broadcast Action: The time was set.
1341 */
1342 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1343 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1344 /**
1345 * Broadcast Action: The date has changed.
1346 */
1347 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1348 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1349 /**
1350 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1351 * <ul>
1352 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1353 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001354 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001355 * <p class="note">This is a protected intent that can only be sent
1356 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001357 */
1358 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1359 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1360 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001361 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1362 * DNS entries should be tossed.
1363 * @hide
1364 */
1365 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1366 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1367 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001368 * Alarm Changed Action: This is broadcast when the AlarmClock
1369 * application's alarm is set or unset. It is used by the
1370 * AlarmClock application and the StatusBar service.
1371 * @hide
1372 */
1373 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1374 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1375 /**
1376 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1377 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1378 * @hide
1379 */
1380 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1381 public static final String ACTION_SYNC_STATE_CHANGED
1382 = "android.intent.action.SYNC_STATE_CHANGED";
1383 /**
1384 * Broadcast Action: This is broadcast once, after the system has finished
1385 * booting. It can be used to perform application-specific initialization,
1386 * such as installing alarms. You must hold the
1387 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1388 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001389 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001390 * <p class="note">This is a protected intent that can only be sent
1391 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001392 */
1393 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1394 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1395 /**
1396 * Broadcast Action: This is broadcast when a user action should request a
1397 * temporary system dialog to dismiss. Some examples of temporary system
1398 * dialogs are the notification window-shade and the recent tasks dialog.
1399 */
1400 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1401 /**
1402 * Broadcast Action: Trigger the download and eventual installation
1403 * of a package.
1404 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001405 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001406 * <p class="note">This is a protected intent that can only be sent
1407 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001408 *
1409 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001410 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001411 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001412 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1413 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1414 /**
1415 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001416 * device. The data contains the name of the package. Note that the
1417 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001418 * <p>My include the following extras:
1419 * <ul>
1420 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1421 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1422 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1423 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001424 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001425 * <p class="note">This is a protected intent that can only be sent
1426 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001427 */
1428 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1429 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1430 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001431 * Broadcast Action: A new version of an application package has been
1432 * installed, replacing an existing version that was previously installed.
1433 * The data contains the name of the package.
1434 * <p>My include the following extras:
1435 * <ul>
1436 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1437 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001438 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001439 * <p class="note">This is a protected intent that can only be sent
1440 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001441 */
1442 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1443 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1444 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001445 * Broadcast Action: A new version of your application has been installed
1446 * over an existing one. This is only sent to the application that was
1447 * replaced. It does not contain any additional data; to receive it, just
1448 * use an intent filter for this action.
1449 *
1450 * <p class="note">This is a protected intent that can only be sent
1451 * by the system.
1452 */
1453 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1454 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1455 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001456 * Broadcast Action: An existing application package has been removed from
1457 * the device. The data contains the name of the package. The package
1458 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001459 * <ul>
1460 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1461 * to the package.
1462 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1463 * application -- data and code -- is being removed.
1464 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1465 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1466 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001467 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001468 * <p class="note">This is a protected intent that can only be sent
1469 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001470 */
1471 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1472 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1473 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001474 * Broadcast Action: An existing application package has been completely
1475 * removed from the device. The data contains the name of the package.
1476 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1477 * {@link #EXTRA_DATA_REMOVED} is true and
1478 * {@link #EXTRA_REPLACING} is false of that broadcast.
1479 *
1480 * <ul>
1481 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1482 * to the package.
1483 * </ul>
1484 *
1485 * <p class="note">This is a protected intent that can only be sent
1486 * by the system.
1487 */
1488 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1489 public static final String ACTION_PACKAGE_FULLY_REMOVED
1490 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1491 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001492 * Broadcast Action: An existing application package has been changed (e.g.
1493 * a component has been enabled or disabled). The data contains the name of
1494 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001495 * <ul>
1496 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001497 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1498 * of the changed components.
1499 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1500 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001501 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001502 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001503 * <p class="note">This is a protected intent that can only be sent
1504 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001505 */
1506 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1507 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1508 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001509 * @hide
1510 * Broadcast Action: Ask system services if there is any reason to
1511 * restart the given package. The data contains the name of the
1512 * package.
1513 * <ul>
1514 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1515 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1516 * </ul>
1517 *
1518 * <p class="note">This is a protected intent that can only be sent
1519 * by the system.
1520 */
1521 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1522 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1523 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001524 * Broadcast Action: The user has restarted a package, and all of its
1525 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001526 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001527 * be removed. Note that the restarted package does <em>not</em>
1528 * receive this broadcast.
1529 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001530 * <ul>
1531 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1532 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001533 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001534 * <p class="note">This is a protected intent that can only be sent
1535 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001536 */
1537 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1538 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1539 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001540 * Broadcast Action: The user has cleared the data of a package. This should
1541 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001542 * its persistent data is erased and this broadcast sent.
1543 * Note that the cleared package does <em>not</em>
1544 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001545 * <ul>
1546 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1547 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001548 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001549 * <p class="note">This is a protected intent that can only be sent
1550 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001551 */
1552 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1553 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1554 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001555 * Broadcast Action: A user ID has been removed from the system. The user
1556 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001557 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001558 * <p class="note">This is a protected intent that can only be sent
1559 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001560 */
1561 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1562 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001563
1564 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001565 * Broadcast Action: Sent to the installer package of an application
1566 * when that application is first launched (that is the first time it
1567 * is moved out of the stopped state). The data contains the name of the package.
1568 *
1569 * <p class="note">This is a protected intent that can only be sent
1570 * by the system.
1571 */
1572 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1573 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1574
1575 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001576 * Broadcast Action: Sent to the system package verifier when a package
1577 * needs to be verified. The data contains the package URI.
1578 * <p class="note">
1579 * This is a protected intent that can only be sent by the system.
1580 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001581 */
1582 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1583 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1584
1585 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001586 * Broadcast Action: Resources for a set of packages (which were
1587 * previously unavailable) are currently
1588 * available since the media on which they exist is available.
1589 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1590 * list of packages whose availability changed.
1591 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1592 * list of uids of packages whose availability changed.
1593 * Note that the
1594 * packages in this list do <em>not</em> receive this broadcast.
1595 * The specified set of packages are now available on the system.
1596 * <p>Includes the following extras:
1597 * <ul>
1598 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1599 * whose resources(were previously unavailable) are currently available.
1600 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1601 * packages whose resources(were previously unavailable)
1602 * are currently available.
1603 * </ul>
1604 *
1605 * <p class="note">This is a protected intent that can only be sent
1606 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001607 */
1608 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001609 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1610 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001611
1612 /**
1613 * Broadcast Action: Resources for a set of packages are currently
1614 * unavailable since the media on which they exist is unavailable.
1615 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1616 * list of packages whose availability changed.
1617 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1618 * list of uids of packages whose availability changed.
1619 * The specified set of packages can no longer be
1620 * launched and are practically unavailable on the system.
1621 * <p>Inclues the following extras:
1622 * <ul>
1623 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1624 * whose resources are no longer available.
1625 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1626 * whose resources are no longer available.
1627 * </ul>
1628 *
1629 * <p class="note">This is a protected intent that can only be sent
1630 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001631 */
1632 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001633 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001634 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001635
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001636 /**
1637 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001638 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001639 * This should <em>only</em> be used to determine when the wallpaper
1640 * has changed to show the new wallpaper to the user. You should certainly
1641 * never, in response to this, change the wallpaper or other attributes of
1642 * it such as the suggested size. That would be crazy, right? You'd cause
1643 * all kinds of loops, especially if other apps are doing similar things,
1644 * right? Of course. So please don't do this.
1645 *
1646 * @deprecated Modern applications should use
1647 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1648 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1649 * shown behind their UI, rather than watching for this broadcast and
1650 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001651 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001652 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001653 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1654 /**
1655 * Broadcast Action: The current device {@link android.content.res.Configuration}
1656 * (orientation, locale, etc) has changed. When such a change happens, the
1657 * UIs (view hierarchy) will need to be rebuilt based on this new
1658 * information; for the most part, applications don't need to worry about
1659 * this, because the system will take care of stopping and restarting the
1660 * application to make sure it sees the new changes. Some system code that
1661 * can not be restarted will need to watch for this action and handle it
1662 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001663 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001664 * <p class="note">
1665 * You can <em>not</em> receive this through components declared
1666 * in manifests, only by explicitly registering for it with
1667 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1668 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001669 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001670 * <p class="note">This is a protected intent that can only be sent
1671 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001672 *
1673 * @see android.content.res.Configuration
1674 */
1675 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1676 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1677 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001678 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001679 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001680 * <p class="note">This is a protected intent that can only be sent
1681 * by the system.
1682 */
1683 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1684 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1685 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001686 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1687 * charging state, level, and other information about the battery.
1688 * See {@link android.os.BatteryManager} for documentation on the
1689 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001690 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001691 * <p class="note">
1692 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001693 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001694 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001695 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1696 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1697 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1698 * broadcasts that are sent and can be received through manifest
1699 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001700 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001701 * <p class="note">This is a protected intent that can only be sent
1702 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001703 */
1704 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1705 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1706 /**
1707 * Broadcast Action: Indicates low battery condition on the device.
1708 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001709 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001710 * <p class="note">This is a protected intent that can only be sent
1711 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001712 */
1713 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1714 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1715 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001716 * Broadcast Action: Indicates the battery is now okay after being low.
1717 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1718 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001719 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001720 * <p class="note">This is a protected intent that can only be sent
1721 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001722 */
1723 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1724 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1725 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001726 * Broadcast Action: External power has been connected to the device.
1727 * This is intended for applications that wish to register specifically to this notification.
1728 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1729 * stay active to receive this notification. This action can be used to implement actions
1730 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001731 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001732 * <p class="note">This is a protected intent that can only be sent
1733 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001734 */
1735 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001736 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001737 /**
1738 * Broadcast Action: External power has been removed from the device.
1739 * This is intended for applications that wish to register specifically to this notification.
1740 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1741 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001742 * that wait until power is available to trigger.
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.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001746 */
1747 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001748 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001749 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001750 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001751 * Broadcast Action: Device is shutting down.
1752 * This is broadcast when the device is being shut down (completely turned
1753 * off, not sleeping). Once the broadcast is complete, the final shutdown
1754 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001755 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001756 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001757 * <p class="note">This is a protected intent that can only be sent
1758 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001759 */
1760 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001761 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001762 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001763 * Activity Action: Start this activity to request system shutdown.
1764 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1765 * to request confirmation from the user before shutting down.
1766 *
1767 * <p class="note">This is a protected intent that can only be sent
1768 * by the system.
1769 *
1770 * {@hide}
1771 */
1772 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1773 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001774 * Broadcast Action: A sticky broadcast that indicates low memory
1775 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001776 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001777 * <p class="note">This is a protected intent that can only be sent
1778 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001779 */
1780 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1781 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1782 /**
1783 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001784 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001785 * <p class="note">This is a protected intent that can only be sent
1786 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001787 */
1788 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1789 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1790 /**
Jake Hambybb371632010-08-23 18:16:48 -07001791 * Broadcast Action: A sticky broadcast that indicates a memory full
1792 * condition on the device. This is intended for activities that want
1793 * to be able to fill the data partition completely, leaving only
1794 * enough free space to prevent system-wide SQLite failures.
1795 *
1796 * <p class="note">This is a protected intent that can only be sent
1797 * by the system.
1798 *
1799 * {@hide}
1800 */
1801 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1802 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1803 /**
1804 * Broadcast Action: Indicates memory full condition on the device
1805 * no longer exists.
1806 *
1807 * <p class="note">This is a protected intent that can only be sent
1808 * by the system.
1809 *
1810 * {@hide}
1811 */
1812 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1813 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1814 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001815 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1816 * and package management should be started.
1817 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1818 * notification.
1819 */
1820 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1821 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1822 /**
1823 * Broadcast Action: The device has entered USB Mass Storage mode.
1824 * This is used mainly for the USB Settings panel.
1825 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1826 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001827 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001828 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001829 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001830 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1831
1832 /**
1833 * Broadcast Action: The device has exited USB Mass Storage mode.
1834 * This is used mainly for the USB Settings panel.
1835 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1836 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001837 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001838 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001839 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001840 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1841
1842 /**
1843 * Broadcast Action: External media has been removed.
1844 * The path to the mount point for the removed media is contained in the Intent.mData field.
1845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1848
1849 /**
1850 * Broadcast Action: External media is present, but not mounted at its mount point.
1851 * The path to the mount point for the removed media is contained in the Intent.mData field.
1852 */
1853 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1854 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1855
1856 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001857 * Broadcast Action: External media is present, and being disk-checked
1858 * 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 -08001859 */
1860 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1861 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1862
1863 /**
1864 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1865 * 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 -08001866 */
1867 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1868 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1869
1870 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001871 * Broadcast Action: External media is present and mounted at its mount point.
1872 * The path to the mount point for the removed media is contained in the Intent.mData field.
1873 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1874 * media was mounted read only.
1875 */
1876 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1877 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1878
1879 /**
1880 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001881 * 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 -07001882 */
1883 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1884 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1885
1886 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001887 * Broadcast Action: External media is no longer being shared via USB mass storage.
1888 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1889 *
1890 * @hide
1891 */
1892 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1893
1894 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001895 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1896 * The path to the mount point for the removed media is contained in the Intent.mData field.
1897 */
1898 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1899 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1900
1901 /**
1902 * Broadcast Action: External media is present but cannot be mounted.
1903 * The path to the mount point for the removed media is contained in the Intent.mData field.
1904 */
1905 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1906 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1907
1908 /**
1909 * Broadcast Action: User has expressed the desire to remove the external storage media.
1910 * Applications should close all files they have open within the mount point when they receive this intent.
1911 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1912 */
1913 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1914 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1915
1916 /**
1917 * Broadcast Action: The media scanner has started scanning a directory.
1918 * The path to the directory being scanned is contained in the Intent.mData field.
1919 */
1920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1921 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1922
1923 /**
1924 * Broadcast Action: The media scanner has finished scanning a directory.
1925 * The path to the scanned directory is contained in the Intent.mData field.
1926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1929
1930 /**
1931 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1932 * The path to the file is contained in the Intent.mData field.
1933 */
1934 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1935 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1936
1937 /**
1938 * Broadcast Action: The "Media Button" was pressed. Includes a single
1939 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1940 * caused the broadcast.
1941 */
1942 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1943 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1944
1945 /**
1946 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1947 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1948 * caused the broadcast.
1949 */
1950 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1951 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1952
1953 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1954 // location; they are not general-purpose actions.
1955
1956 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001957 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001958 */
1959 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1960 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1961 "android.intent.action.GTALK_CONNECTED";
1962
1963 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001964 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001965 */
1966 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1967 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1968 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001969
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001970 /**
1971 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001972 */
1973 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1974 public static final String ACTION_INPUT_METHOD_CHANGED =
1975 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001976
1977 /**
1978 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1979 * more radios have been turned off or on. The intent will have the following extra value:</p>
1980 * <ul>
1981 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1982 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1983 * turned off</li>
1984 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001985 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001986 * <p class="note">This is a protected intent that can only be sent
1987 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001988 */
1989 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1990 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1991
1992 /**
1993 * Broadcast Action: Some content providers have parts of their namespace
1994 * where they publish new events or items that the user may be especially
1995 * interested in. For these things, they may broadcast this action when the
1996 * set of interesting items change.
1997 *
1998 * For example, GmailProvider sends this notification when the set of unread
1999 * mail in the inbox changes.
2000 *
2001 * <p>The data of the intent identifies which part of which provider
2002 * changed. When queried through the content resolver, the data URI will
2003 * return the data set in question.
2004 *
2005 * <p>The intent will have the following extra values:
2006 * <ul>
2007 * <li><em>count</em> - The number of items in the data set. This is the
2008 * same as the number of items in the cursor returned by querying the
2009 * data URI. </li>
2010 * </ul>
2011 *
2012 * This intent will be sent at boot (if the count is non-zero) and when the
2013 * data set changes. It is possible for the data set to change without the
2014 * count changing (for example, if a new unread message arrives in the same
2015 * sync operation in which a message is archived). The phone should still
2016 * ring/vibrate/etc as normal in this case.
2017 */
2018 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2019 public static final String ACTION_PROVIDER_CHANGED =
2020 "android.intent.action.PROVIDER_CHANGED";
2021
2022 /**
2023 * Broadcast Action: Wired Headset plugged in or unplugged.
2024 *
2025 * <p>The intent will have the following extra values:
2026 * <ul>
2027 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2028 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002029 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002030 * </ul>
2031 * </ul>
2032 */
2033 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2034 public static final String ACTION_HEADSET_PLUG =
2035 "android.intent.action.HEADSET_PLUG";
2036
2037 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002038 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2039 *
2040 * <p>The intent will have the following extra values:
2041 * <ul>
2042 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2043 * <li><em>name</em> - Headset type, human readable string </li>
2044 * </ul>
2045 * </ul>
2046 * @hide
2047 */
2048 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002049 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2050 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002051
2052 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002053 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002054 *
2055 * <p>The intent will have the following extra values:
2056 * <ul>
2057 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2058 * <li><em>name</em> - Headset type, human readable string </li>
2059 * </ul>
2060 * </ul>
2061 * @hide
2062 */
2063 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002064 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2065 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002066
2067 /**
2068 * Broadcast Action: A HMDI cable was plugged or unplugged
2069 *
2070 * <p>The intent will have the following extra values:
2071 * <ul>
2072 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2073 * <li><em>name</em> - HDMI cable, human readable string </li>
2074 * </ul>
2075 * </ul>
2076 * @hide
2077 */
2078 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2079 public static final String ACTION_HDMI_AUDIO_PLUG =
2080 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002081
2082 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002083 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2084 *
2085 * <p>The intent will have the following extra values:
2086 * <ul>
2087 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2088 * <li><em>card</em> - ALSA card number (integer) </li>
2089 * <li><em>device</em> - ALSA device number (integer) </li>
2090 * </ul>
2091 * </ul>
2092 * @hide
2093 */
2094 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2095 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2096 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2097
2098 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002099 * Broadcast Action: A USB audio device was plugged in or unplugged.
2100 *
2101 * <p>The intent will have the following extra values:
2102 * <ul>
2103 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2104 * <li><em>card</em> - ALSA card number (integer) </li>
2105 * <li><em>device</em> - ALSA device number (integer) </li>
2106 * </ul>
2107 * </ul>
2108 * @hide
2109 */
2110 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2111 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2112 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2113
2114 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002115 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2116 * <ul>
2117 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2118 * </ul>
2119 *
2120 * <p class="note">This is a protected intent that can only be sent
2121 * by the system.
2122 *
2123 * @hide
2124 */
2125 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2126 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2127 = "android.intent.action.ADVANCED_SETTINGS";
2128
2129 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002130 * Broadcast Action: An outgoing call is about to be placed.
2131 *
2132 * <p>The Intent will have the following extra value:
2133 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002134 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002135 * the phone number originally intended to be dialed.</li>
2136 * </ul>
2137 * <p>Once the broadcast is finished, the resultData is used as the actual
2138 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002139 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002140 * outgoing call in turn: for example, a parental control application
2141 * might verify that the user is authorized to place the call at that
2142 * time, then a number-rewriting application might add an area code if
2143 * one was not specified.</p>
2144 * <p>For consistency, any receiver whose purpose is to prohibit phone
2145 * calls should have a priority of 0, to ensure it will see the final
2146 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002147 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002148 * should have a positive priority.
2149 * Negative priorities are reserved for the system for this broadcast;
2150 * using them may cause problems.</p>
2151 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2152 * abort the broadcast.</p>
2153 * <p>Emergency calls cannot be intercepted using this mechanism, and
2154 * other calls cannot be modified to call emergency numbers using this
2155 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002156 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002157 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2158 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002159 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002160 * <p class="note">This is a protected intent that can only be sent
2161 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002162 */
2163 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2164 public static final String ACTION_NEW_OUTGOING_CALL =
2165 "android.intent.action.NEW_OUTGOING_CALL";
2166
2167 /**
2168 * Broadcast Action: Have the device reboot. This is only for use by
2169 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002170 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002171 * <p class="note">This is a protected intent that can only be sent
2172 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002173 */
2174 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2175 public static final String ACTION_REBOOT =
2176 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002177
Wei Huang97ecc9c2009-05-11 17:44:20 -07002178 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002179 * Broadcast Action: A sticky broadcast for changes in the physical
2180 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002181 *
2182 * <p>The intent will have the following extra values:
2183 * <ul>
2184 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002185 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002186 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002187 * <p>This is intended for monitoring the current physical dock state.
2188 * See {@link android.app.UiModeManager} for the normal API dealing with
2189 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002190 */
2191 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2192 public static final String ACTION_DOCK_EVENT =
2193 "android.intent.action.DOCK_EVENT";
2194
2195 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002196 * Broadcast Action: a remote intent is to be broadcasted.
2197 *
2198 * A remote intent is used for remote RPC between devices. The remote intent
2199 * is serialized and sent from one device to another device. The receiving
2200 * device parses the remote intent and broadcasts it. Note that anyone can
2201 * broadcast a remote intent. However, if the intent receiver of the remote intent
2202 * does not trust intent broadcasts from arbitrary intent senders, it should require
2203 * the sender to hold certain permissions so only trusted sender's broadcast will be
2204 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002205 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002206 */
2207 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002208 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002209
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002210 /**
2211 * Broadcast Action: hook for permforming cleanup after a system update.
2212 *
2213 * The broadcast is sent when the system is booting, before the
2214 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2215 * image. A receiver for this should do its work and then disable itself
2216 * so that it does not get run again at the next boot.
2217 * @hide
2218 */
2219 public static final String ACTION_PRE_BOOT_COMPLETED =
2220 "android.intent.action.PRE_BOOT_COMPLETED";
2221
Amith Yamasani13593602012-03-22 16:16:17 -07002222 /**
2223 * Broadcast sent to the system when a user is added. Carries an extra EXTRA_USERID that has the
2224 * userid of the new user.
2225 * @hide
2226 */
2227 public static final String ACTION_USER_ADDED =
2228 "android.intent.action.USER_ADDED";
2229
2230 /**
2231 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USERID that has
2232 * the userid of the user.
2233 * @hide
2234 */
2235 public static final String ACTION_USER_REMOVED =
2236 "android.intent.action.USER_REMOVED";
2237
2238 /**
2239 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USERID that has
2240 * the userid of the user to become the current one.
2241 * @hide
2242 */
2243 public static final String ACTION_USER_SWITCHED =
2244 "android.intent.action.USER_SWITCHED";
2245
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002246 // ---------------------------------------------------------------------
2247 // ---------------------------------------------------------------------
2248 // Standard intent categories (see addCategory()).
2249
2250 /**
2251 * Set if the activity should be an option for the default action
2252 * (center press) to perform on a piece of data. Setting this will
2253 * hide from the user any activities without it set when performing an
2254 * action on some data. Note that this is normal -not- set in the
2255 * Intent when initiating an action -- it is for use in intent filters
2256 * specified in packages.
2257 */
2258 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2259 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2260 /**
2261 * Activities that can be safely invoked from a browser must support this
2262 * category. For example, if the user is viewing a web page or an e-mail
2263 * and clicks on a link in the text, the Intent generated execute that
2264 * link will require the BROWSABLE category, so that only activities
2265 * supporting this category will be considered as possible actions. By
2266 * supporting this category, you are promising that there is nothing
2267 * damaging (without user intervention) that can happen by invoking any
2268 * matching Intent.
2269 */
2270 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2271 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2272 /**
2273 * Set if the activity should be considered as an alternative action to
2274 * the data the user is currently viewing. See also
2275 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2276 * applies to the selection in a list of items.
2277 *
2278 * <p>Supporting this category means that you would like your activity to be
2279 * displayed in the set of alternative things the user can do, usually as
2280 * part of the current activity's options menu. You will usually want to
2281 * include a specific label in the &lt;intent-filter&gt; of this action
2282 * describing to the user what it does.
2283 *
2284 * <p>The action of IntentFilter with this category is important in that it
2285 * describes the specific action the target will perform. This generally
2286 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2287 * a specific name such as "com.android.camera.action.CROP. Only one
2288 * alternative of any particular action will be shown to the user, so using
2289 * a specific action like this makes sure that your alternative will be
2290 * displayed while also allowing other applications to provide their own
2291 * overrides of that particular action.
2292 */
2293 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2294 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2295 /**
2296 * Set if the activity should be considered as an alternative selection
2297 * action to the data the user has currently selected. This is like
2298 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2299 * of items from which the user can select, giving them alternatives to the
2300 * default action that will be performed on it.
2301 */
2302 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2303 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2304 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002305 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002306 */
2307 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2308 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2309 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002310 * Should be displayed in the top-level launcher.
2311 */
2312 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2313 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2314 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002315 * Provides information about the package it is in; typically used if
2316 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2317 * a front-door to the user without having to be shown in the all apps list.
2318 */
2319 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2320 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2321 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002322 * This is the home activity, that is the first activity that is displayed
2323 * when the device boots.
2324 */
2325 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2326 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2327 /**
2328 * This activity is a preference panel.
2329 */
2330 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2331 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2332 /**
2333 * This activity is a development preference panel.
2334 */
2335 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2336 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2337 /**
2338 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002339 */
2340 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2341 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2342 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002343 * This activity allows the user to browse and download new applications.
2344 */
2345 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2346 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2347 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002348 * This activity may be exercised by the monkey or other automated test tools.
2349 */
2350 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2351 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2352 /**
2353 * To be used as a test (not part of the normal user experience).
2354 */
2355 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2356 /**
2357 * To be used as a unit test (run through the Test Harness).
2358 */
2359 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2360 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002361 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002362 * experience).
2363 */
2364 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2365 /**
2366 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2367 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2368 * when queried, though it is allowable for those columns to be blank.
2369 */
2370 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2371 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2372
2373 /**
2374 * To be used as code under test for framework instrumentation tests.
2375 */
2376 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2377 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002378 /**
2379 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002380 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2381 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002382 */
2383 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2384 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2385 /**
2386 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002387 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2388 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002389 */
2390 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2391 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002392 /**
2393 * An activity to run when device is inserted into a analog (low end) dock.
2394 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2395 * information, see {@link android.app.UiModeManager}.
2396 */
2397 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2398 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2399
2400 /**
2401 * An activity to run when device is inserted into a digital (high end) dock.
2402 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2403 * information, see {@link android.app.UiModeManager}.
2404 */
2405 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2406 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002407
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002408 /**
2409 * Used to indicate that the activity can be used in a car environment.
2410 */
2411 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2412 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2413
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002414 // ---------------------------------------------------------------------
2415 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002416 // Application launch intent categories (see addCategory()).
2417
2418 /**
2419 * Used with {@link #ACTION_MAIN} to launch the browser application.
2420 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002421 * <p>NOTE: This should not be used as the primary key of an Intent,
2422 * since it will not result in the app launching with the correct
2423 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002424 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002425 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002426 */
2427 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2428 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2429
2430 /**
2431 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2432 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002433 * <p>NOTE: This should not be used as the primary key of an Intent,
2434 * since it will not result in the app launching with the correct
2435 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002436 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002437 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002438 */
2439 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2440 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2441
2442 /**
2443 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2444 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002445 * <p>NOTE: This should not be used as the primary key of an Intent,
2446 * since it will not result in the app launching with the correct
2447 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002448 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002449 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002450 */
2451 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2452 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2453
2454 /**
2455 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2456 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002457 * <p>NOTE: This should not be used as the primary key of an Intent,
2458 * since it will not result in the app launching with the correct
2459 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002460 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002461 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002462 */
2463 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2464 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2465
2466 /**
2467 * Used with {@link #ACTION_MAIN} to launch the email application.
2468 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002469 * <p>NOTE: This should not be used as the primary key of an Intent,
2470 * since it will not result in the app launching with the correct
2471 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002472 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002473 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002474 */
2475 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2476 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2477
2478 /**
2479 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2480 * The activity should be able to view and manipulate image and video files
2481 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002482 * <p>NOTE: This should not be used as the primary key of an Intent,
2483 * since it will not result in the app launching with the correct
2484 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002485 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002486 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002487 */
2488 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2489 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2490
2491 /**
2492 * Used with {@link #ACTION_MAIN} to launch the maps application.
2493 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002494 * <p>NOTE: This should not be used as the primary key of an Intent,
2495 * since it will not result in the app launching with the correct
2496 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002497 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002498 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002499 */
2500 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2501 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2502
2503 /**
2504 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2505 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002506 * <p>NOTE: This should not be used as the primary key of an Intent,
2507 * since it will not result in the app launching with the correct
2508 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002509 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002510 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002511 */
2512 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2513 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2514
2515 /**
2516 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002517 * The activity should be able to play, browse, or manipulate music files
2518 * stored on the device.
2519 * <p>NOTE: This should not be used as the primary key of an Intent,
2520 * since it will not result in the app launching with the correct
2521 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002522 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002523 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002524 */
2525 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2526 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2527
2528 // ---------------------------------------------------------------------
2529 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002530 // Standard extra data keys.
2531
2532 /**
2533 * The initial data to place in a newly created record. Use with
2534 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2535 * fields as would be given to the underlying ContentProvider.insert()
2536 * call.
2537 */
2538 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2539
2540 /**
2541 * A constant CharSequence that is associated with the Intent, used with
2542 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2543 * this may be a styled CharSequence, so you must use
2544 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2545 * retrieve it.
2546 */
2547 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2548
2549 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002550 * A constant String that is associated with the Intent, used with
2551 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2552 * as HTML formatted text. Note that you <em>must</em> also supply
2553 * {@link #EXTRA_TEXT}.
2554 */
2555 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2556
2557 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002558 * A content: URI holding a stream of data associated with the Intent,
2559 * used with {@link #ACTION_SEND} to supply the data being sent.
2560 */
2561 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2562
2563 /**
2564 * A String[] holding e-mail addresses that should be delivered to.
2565 */
2566 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2567
2568 /**
2569 * A String[] holding e-mail addresses that should be carbon copied.
2570 */
2571 public static final String EXTRA_CC = "android.intent.extra.CC";
2572
2573 /**
2574 * A String[] holding e-mail addresses that should be blind carbon copied.
2575 */
2576 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2577
2578 /**
2579 * A constant string holding the desired subject line of a message.
2580 */
2581 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2582
2583 /**
2584 * An Intent describing the choices you would like shown with
2585 * {@link #ACTION_PICK_ACTIVITY}.
2586 */
2587 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2588
2589 /**
2590 * A CharSequence dialog title to provide to the user when used with a
2591 * {@link #ACTION_CHOOSER}.
2592 */
2593 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2594
2595 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002596 * A Parcelable[] of {@link Intent} or
2597 * {@link android.content.pm.LabeledIntent} objects as set with
2598 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2599 * a the front of the list of choices, when shown to the user with a
2600 * {@link #ACTION_CHOOSER}.
2601 */
2602 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2603
2604 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002605 * A {@link android.view.KeyEvent} object containing the event that
2606 * triggered the creation of the Intent it is in.
2607 */
2608 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2609
2610 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002611 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2612 * before shutting down.
2613 *
2614 * {@hide}
2615 */
2616 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2617
2618 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002619 * 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 -07002620 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2621 * of restarting the application.
2622 */
2623 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2624
2625 /**
2626 * A String holding the phone number originally entered in
2627 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2628 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2629 */
2630 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002631
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002632 /**
2633 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2634 * intents to supply the uid the package had been assigned. Also an optional
2635 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2636 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2637 * purpose.
2638 */
2639 public static final String EXTRA_UID = "android.intent.extra.UID";
2640
2641 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002642 * @hide String array of package names.
2643 */
2644 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2645
2646 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002647 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2648 * intents to indicate whether this represents a full uninstall (removing
2649 * both the code and its data) or a partial uninstall (leaving its data,
2650 * implying that this is an update).
2651 */
2652 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002653
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002654 /**
2655 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2656 * intents to indicate that this is a replacement of the package, so this
2657 * broadcast will immediately be followed by an add broadcast for a
2658 * different version of the same package.
2659 */
2660 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002661
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002662 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002663 * Used as an int extra field in {@link android.app.AlarmManager} intents
2664 * to tell the application being invoked how many pending alarms are being
2665 * delievered with the intent. For one-shot alarms this will always be 1.
2666 * For recurring alarms, this might be greater than 1 if the device was
2667 * asleep or powered off at the time an earlier alarm would have been
2668 * delivered.
2669 */
2670 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002671
Jacek Surazski86b6c532009-05-13 14:38:28 +02002672 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002673 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2674 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002675 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2676 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002677 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2678 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2679 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002680 */
2681 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2682
2683 /**
2684 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2685 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002686 */
2687 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2688
2689 /**
2690 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2691 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002692 */
2693 public static final int EXTRA_DOCK_STATE_DESK = 1;
2694
2695 /**
2696 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2697 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002698 */
2699 public static final int EXTRA_DOCK_STATE_CAR = 2;
2700
2701 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002702 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2703 * to represent that the phone is in a analog (low end) dock.
2704 */
2705 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2706
2707 /**
2708 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2709 * to represent that the phone is in a digital (high end) dock.
2710 */
2711 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2712
2713 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002714 * Boolean that can be supplied as meta-data with a dock activity, to
2715 * indicate that the dock should take over the home key when it is active.
2716 */
2717 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002718
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002719 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002720 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2721 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002722 */
2723 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2724
2725 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002726 * Used in the extra field in the remote intent. It's astring token passed with the
2727 * remote intent.
2728 */
2729 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2730 "android.intent.extra.remote_intent_token";
2731
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002732 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002733 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002734 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002735 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002736 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002737 "android.intent.extra.changed_component_name";
2738
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002739 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002740 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002741 * and contains a string array of all of the components that have changed.
2742 */
2743 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2744 "android.intent.extra.changed_component_name_list";
2745
2746 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002747 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002748 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2749 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002750 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002751 */
2752 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2753 "android.intent.extra.changed_package_list";
2754
2755 /**
2756 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002757 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2758 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002759 * and contains an integer array of uids of all of the components
2760 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002761 */
2762 public static final String EXTRA_CHANGED_UID_LIST =
2763 "android.intent.extra.changed_uid_list";
2764
2765 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002766 * @hide
2767 * Magic extra system code can use when binding, to give a label for
2768 * who it is that has bound to a service. This is an integer giving
2769 * a framework string resource that can be displayed to the user.
2770 */
2771 public static final String EXTRA_CLIENT_LABEL =
2772 "android.intent.extra.client_label";
2773
2774 /**
2775 * @hide
2776 * Magic extra system code can use when binding, to give a PendingIntent object
2777 * that can be launched for the user to disable the system's use of this
2778 * service.
2779 */
2780 public static final String EXTRA_CLIENT_INTENT =
2781 "android.intent.extra.client_intent";
2782
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002783 /**
2784 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2785 * data that is on the local device. This is a boolean extra; the default
2786 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2787 * the user to select media that is already on the device, not requiring it
2788 * be downloaded from a remote service when opened. Another way to look
2789 * at it is that such content should generally have a "_data" column to the
2790 * path of the content on local external storage.
2791 */
2792 public static final String EXTRA_LOCAL_ONLY =
2793 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07002794
Amith Yamasani13593602012-03-22 16:16:17 -07002795 /**
2796 * The userid carried with broadcast intents related to addition, removal and switching of users
2797 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
2798 * @hide
2799 */
2800 public static final String EXTRA_USERID =
2801 "android.intent.extra.user_id";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002802 // ---------------------------------------------------------------------
2803 // ---------------------------------------------------------------------
2804 // Intent flags (see mFlags variable).
2805
2806 /**
2807 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002808 * perform read operations on the Uri in the Intent's data and any URIs
2809 * specified in its ClipData. When applying to an Intent's ClipData,
2810 * all URIs as well as recursive traversals through data or other ClipData
2811 * in Intent items will be granted; only the grant flags of the top-level
2812 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002813 */
2814 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2815 /**
2816 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002817 * perform write operations on the Uri in the Intent's data and any URIs
2818 * specified in its ClipData. When applying to an Intent's ClipData,
2819 * all URIs as well as recursive traversals through data or other ClipData
2820 * in Intent items will be granted; only the grant flags of the top-level
2821 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002822 */
2823 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2824 /**
2825 * Can be set by the caller to indicate that this Intent is coming from
2826 * a background operation, not from direct user interaction.
2827 */
2828 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2829 /**
2830 * A flag you can enable for debugging: when set, log messages will be
2831 * printed during the resolution of this intent to show you what has
2832 * been found to create the final resolved list.
2833 */
2834 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002835 /**
2836 * If set, this intent will not match any components in packages that
2837 * are currently stopped. If this is not set, then the default behavior
2838 * is to include such applications in the result.
2839 */
2840 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2841 /**
2842 * If set, this intent will always match any components in packages that
2843 * are currently stopped. This is the default behavior when
2844 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2845 * flags are set, this one wins (it allows overriding of exclude for
2846 * places where the framework may automatically set the exclude flag).
2847 */
2848 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002849
2850 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002851 * If set, the new activity is not kept in the history stack. As soon as
2852 * the user navigates away from it, the activity is finished. This may also
2853 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2854 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002855 */
2856 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2857 /**
2858 * If set, the activity will not be launched if it is already running
2859 * at the top of the history stack.
2860 */
2861 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2862 /**
2863 * If set, this activity will become the start of a new task on this
2864 * history stack. A task (from the activity that started it to the
2865 * next task activity) defines an atomic group of activities that the
2866 * user can move to. Tasks can be moved to the foreground and background;
2867 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002868 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002869 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2870 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002871 *
2872 * <p>This flag is generally used by activities that want
2873 * to present a "launcher" style behavior: they give the user a list of
2874 * separate things that can be done, which otherwise run completely
2875 * independently of the activity launching them.
2876 *
2877 * <p>When using this flag, if a task is already running for the activity
2878 * you are now starting, then a new activity will not be started; instead,
2879 * the current task will simply be brought to the front of the screen with
2880 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2881 * to disable this behavior.
2882 *
2883 * <p>This flag can not be used when the caller is requesting a result from
2884 * the activity being launched.
2885 */
2886 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2887 /**
2888 * <strong>Do not use this flag unless you are implementing your own
2889 * top-level application launcher.</strong> Used in conjunction with
2890 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2891 * behavior of bringing an existing task to the foreground. When set,
2892 * a new task is <em>always</em> started to host the Activity for the
2893 * Intent, regardless of whether there is already an existing task running
2894 * the same thing.
2895 *
2896 * <p><strong>Because the default system does not include graphical task management,
2897 * you should not use this flag unless you provide some way for a user to
2898 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002899 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002900 * <p>This flag is ignored if
2901 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2902 *
Scott Main7aee61f2011-02-08 11:25:01 -08002903 * <p>See
2904 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2905 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002906 */
2907 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2908 /**
2909 * If set, and the activity being launched is already running in the
2910 * current task, then instead of launching a new instance of that activity,
2911 * all of the other activities on top of it will be closed and this Intent
2912 * will be delivered to the (now on top) old activity as a new Intent.
2913 *
2914 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2915 * If D calls startActivity() with an Intent that resolves to the component
2916 * of activity B, then C and D will be finished and B receive the given
2917 * Intent, resulting in the stack now being: A, B.
2918 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002919 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002920 * either receive the new intent you are starting here in its
2921 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002922 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002923 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2924 * the same intent, then it will be finished and re-created; for all other
2925 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2926 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002927 *
2928 * <p>This launch mode can also be used to good effect in conjunction with
2929 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2930 * of a task, it will bring any currently running instance of that task
2931 * to the foreground, and then clear it to its root state. This is
2932 * especially useful, for example, when launching an activity from the
2933 * notification manager.
2934 *
Scott Main7aee61f2011-02-08 11:25:01 -08002935 * <p>See
2936 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2937 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002938 */
2939 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2940 /**
2941 * If set and this intent is being used to launch a new activity from an
2942 * existing one, then the reply target of the existing activity will be
2943 * transfered to the new activity. This way the new activity can call
2944 * {@link android.app.Activity#setResult} and have that result sent back to
2945 * the reply target of the original activity.
2946 */
2947 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2948 /**
2949 * If set and this intent is being used to launch a new activity from an
2950 * existing one, the current activity will not be counted as the top
2951 * activity for deciding whether the new intent should be delivered to
2952 * the top instead of starting a new one. The previous activity will
2953 * be used as the top, with the assumption being that the current activity
2954 * will finish itself immediately.
2955 */
2956 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2957 /**
2958 * If set, the new activity is not kept in the list of recently launched
2959 * activities.
2960 */
2961 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2962 /**
2963 * This flag is not normally set by application code, but set for you by
2964 * the system as described in the
2965 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2966 * launchMode} documentation for the singleTask mode.
2967 */
2968 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2969 /**
2970 * If set, and this activity is either being started in a new task or
2971 * bringing to the top an existing task, then it will be launched as
2972 * the front door of the task. This will result in the application of
2973 * any affinities needed to have that task in the proper state (either
2974 * moving activities to or from it), or simply resetting that task to
2975 * its initial state if needed.
2976 */
2977 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2978 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002979 * This flag is not normally set by application code, but set for you by
2980 * the system if this activity is being launched from history
2981 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002982 */
2983 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002984 /**
2985 * If set, this marks a point in the task's activity stack that should
2986 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002987 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002988 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2989 * the user re-launching it from home), this activity and all on top of
2990 * it will be finished so that the user does not return to them, but
2991 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002992 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002993 * <p>This is useful for cases where you have a logical break in your
2994 * application. For example, an e-mail application may have a command
2995 * to view an attachment, which launches an image view activity to
2996 * display it. This activity should be part of the e-mail application's
2997 * task, since it is a part of the task the user is involved in. However,
2998 * if the user leaves that task, and later selects the e-mail app from
2999 * home, we may like them to return to the conversation they were
3000 * viewing, not the picture attachment, since that is confusing. By
3001 * setting this flag when launching the image viewer, that viewer and
3002 * any activities it starts will be removed the next time the user returns
3003 * to mail.
3004 */
3005 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003006 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003007 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003008 * callback from occurring on the current frontmost activity before it is
3009 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003010 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003011 * <p>Typically, an activity can rely on that callback to indicate that an
3012 * explicit user action has caused their activity to be moved out of the
3013 * foreground. The callback marks an appropriate point in the activity's
3014 * lifecycle for it to dismiss any notifications that it intends to display
3015 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003016 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003017 * <p>If an activity is ever started via any non-user-driven events such as
3018 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3019 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003020 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003021 */
3022 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003023 /**
3024 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3025 * this flag will cause the launched activity to be brought to the front of its
3026 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003027 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003028 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3029 * If D calls startActivity() with an Intent that resolves to the component
3030 * of activity B, then B will be brought to the front of the history stack,
3031 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003032 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003033 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003034 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003035 */
3036 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003037 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003038 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3039 * this flag will prevent the system from applying an activity transition
3040 * animation to go to the next activity state. This doesn't mean an
3041 * animation will never run -- if another activity change happens that doesn't
3042 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003043 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003044 * when you are going to do a series of activity operations but the
3045 * animation seen by the user shouldn't be driven by the first activity
3046 * change but rather a later one.
3047 */
3048 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3049 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003050 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3051 * this flag will cause any existing task that would be associated with the
3052 * activity to be cleared before the activity is started. That is, the activity
3053 * becomes the new root of an otherwise empty task, and any old activities
3054 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3055 */
3056 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3057 /**
3058 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3059 * this flag will cause a newly launching task to be placed on top of the current
3060 * home activity task (if there is one). That is, pressing back from the task
3061 * will always return the user to home even if that was not the last activity they
3062 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3063 */
3064 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3065 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003066 * If set, when sending a broadcast only registered receivers will be
3067 * called -- no BroadcastReceiver components will be launched.
3068 */
3069 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003070 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003071 * If set, when sending a broadcast the new broadcast will replace
3072 * any existing pending broadcast that matches it. Matching is defined
3073 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3074 * true for the intents of the two broadcasts. When a match is found,
3075 * the new broadcast (and receivers associated with it) will replace the
3076 * existing one in the pending broadcast list, remaining at the same
3077 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003078 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003079 * <p>This flag is most typically used with sticky broadcasts, which
3080 * only care about delivering the most recent values of the broadcast
3081 * to their receivers.
3082 */
3083 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3084 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003085 * If set, when sending a broadcast the recipient is allowed to run at
3086 * foreground priority, with a shorter timeout interval. During normal
3087 * broadcasts the receivers are not automatically hoisted out of the
3088 * background priority class.
3089 */
3090 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3091 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003092 * If set, when sending a broadcast <i>before boot has completed</i> only
3093 * registered receivers will be called -- no BroadcastReceiver components
3094 * will be launched. Sticky intent state will be recorded properly even
3095 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3096 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003097 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003098 * <p>This flag is only for use by system sevices as a convenience to
3099 * avoid having to implement a more complex mechanism around detection
3100 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003101 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003102 * @hide
3103 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003104 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003105 /**
3106 * Set when this broadcast is for a boot upgrade, a special mode that
3107 * allows the broadcast to be sent before the system is ready and launches
3108 * the app process with no providers running in it.
3109 * @hide
3110 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003111 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003112
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003113 /**
3114 * @hide Flags that can't be changed with PendingIntent.
3115 */
3116 public static final int IMMUTABLE_FLAGS =
3117 FLAG_GRANT_READ_URI_PERMISSION
3118 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003119
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003120 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003121 // ---------------------------------------------------------------------
3122 // toUri() and parseUri() options.
3123
3124 /**
3125 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3126 * always has the "intent:" scheme. This syntax can be used when you want
3127 * to later disambiguate between URIs that are intended to describe an
3128 * Intent vs. all others that should be treated as raw URIs. When used
3129 * with {@link #parseUri}, any other scheme will result in a generic
3130 * VIEW action for that raw URI.
3131 */
3132 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003133
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003134 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003135
3136 private String mAction;
3137 private Uri mData;
3138 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003139 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003140 private ComponentName mComponent;
3141 private int mFlags;
3142 private HashSet<String> mCategories;
3143 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003144 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003145 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003146 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003147
3148 // ---------------------------------------------------------------------
3149
3150 /**
3151 * Create an empty intent.
3152 */
3153 public Intent() {
3154 }
3155
3156 /**
3157 * Copy constructor.
3158 */
3159 public Intent(Intent o) {
3160 this.mAction = o.mAction;
3161 this.mData = o.mData;
3162 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003163 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003164 this.mComponent = o.mComponent;
3165 this.mFlags = o.mFlags;
3166 if (o.mCategories != null) {
3167 this.mCategories = new HashSet<String>(o.mCategories);
3168 }
3169 if (o.mExtras != null) {
3170 this.mExtras = new Bundle(o.mExtras);
3171 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003172 if (o.mSourceBounds != null) {
3173 this.mSourceBounds = new Rect(o.mSourceBounds);
3174 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003175 if (o.mSelector != null) {
3176 this.mSelector = new Intent(o.mSelector);
3177 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003178 if (o.mClipData != null) {
3179 this.mClipData = new ClipData(o.mClipData);
3180 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003181 }
3182
3183 @Override
3184 public Object clone() {
3185 return new Intent(this);
3186 }
3187
3188 private Intent(Intent o, boolean all) {
3189 this.mAction = o.mAction;
3190 this.mData = o.mData;
3191 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003192 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003193 this.mComponent = o.mComponent;
3194 if (o.mCategories != null) {
3195 this.mCategories = new HashSet<String>(o.mCategories);
3196 }
3197 }
3198
3199 /**
3200 * Make a clone of only the parts of the Intent that are relevant for
3201 * filter matching: the action, data, type, component, and categories.
3202 */
3203 public Intent cloneFilter() {
3204 return new Intent(this, false);
3205 }
3206
3207 /**
3208 * Create an intent with a given action. All other fields (data, type,
3209 * class) are null. Note that the action <em>must</em> be in a
3210 * namespace because Intents are used globally in the system -- for
3211 * example the system VIEW action is android.intent.action.VIEW; an
3212 * application's custom action would be something like
3213 * com.google.app.myapp.CUSTOM_ACTION.
3214 *
3215 * @param action The Intent action, such as ACTION_VIEW.
3216 */
3217 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003218 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003219 }
3220
3221 /**
3222 * Create an intent with a given action and for a given data url. Note
3223 * that the action <em>must</em> be in a namespace because Intents are
3224 * used globally in the system -- for example the system VIEW action is
3225 * android.intent.action.VIEW; an application's custom action would be
3226 * something like com.google.app.myapp.CUSTOM_ACTION.
3227 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003228 * <p><em>Note: scheme and host name matching in the Android framework is
3229 * case-sensitive, unlike the formal RFC. As a result,
3230 * you should always ensure that you write your Uri with these elements
3231 * using lower case letters, and normalize any Uris you receive from
3232 * outside of Android to ensure the scheme and host is lower case.</em></p>
3233 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003234 * @param action The Intent action, such as ACTION_VIEW.
3235 * @param uri The Intent data URI.
3236 */
3237 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003238 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003239 mData = uri;
3240 }
3241
3242 /**
3243 * Create an intent for a specific component. All other fields (action, data,
3244 * type, class) are null, though they can be modified later with explicit
3245 * calls. This provides a convenient way to create an intent that is
3246 * intended to execute a hard-coded class name, rather than relying on the
3247 * system to find an appropriate class for you; see {@link #setComponent}
3248 * for more information on the repercussions of this.
3249 *
3250 * @param packageContext A Context of the application package implementing
3251 * this class.
3252 * @param cls The component class that is to be used for the intent.
3253 *
3254 * @see #setClass
3255 * @see #setComponent
3256 * @see #Intent(String, android.net.Uri , Context, Class)
3257 */
3258 public Intent(Context packageContext, Class<?> cls) {
3259 mComponent = new ComponentName(packageContext, cls);
3260 }
3261
3262 /**
3263 * Create an intent for a specific component with a specified action and data.
3264 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3265 * construct the Intent and then calling {@link #setClass} to set its
3266 * class.
3267 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003268 * <p><em>Note: scheme and host name matching in the Android framework is
3269 * case-sensitive, unlike the formal RFC. As a result,
3270 * you should always ensure that you write your Uri with these elements
3271 * using lower case letters, and normalize any Uris you receive from
3272 * outside of Android to ensure the scheme and host is lower case.</em></p>
3273 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003274 * @param action The Intent action, such as ACTION_VIEW.
3275 * @param uri The Intent data URI.
3276 * @param packageContext A Context of the application package implementing
3277 * this class.
3278 * @param cls The component class that is to be used for the intent.
3279 *
3280 * @see #Intent(String, android.net.Uri)
3281 * @see #Intent(Context, Class)
3282 * @see #setClass
3283 * @see #setComponent
3284 */
3285 public Intent(String action, Uri uri,
3286 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003287 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003288 mData = uri;
3289 mComponent = new ComponentName(packageContext, cls);
3290 }
3291
3292 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003293 * Create an intent to launch the main (root) activity of a task. This
3294 * is the Intent that is started when the application's is launched from
3295 * Home. For anything else that wants to launch an application in the
3296 * same way, it is important that they use an Intent structured the same
3297 * way, and can use this function to ensure this is the case.
3298 *
3299 * <p>The returned Intent has the given Activity component as its explicit
3300 * component, {@link #ACTION_MAIN} as its action, and includes the
3301 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3302 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3303 * to do that through {@link #addFlags(int)} on the returned Intent.
3304 *
3305 * @param mainActivity The main activity component that this Intent will
3306 * launch.
3307 * @return Returns a newly created Intent that can be used to launch the
3308 * activity as a main application entry.
3309 *
3310 * @see #setClass
3311 * @see #setComponent
3312 */
3313 public static Intent makeMainActivity(ComponentName mainActivity) {
3314 Intent intent = new Intent(ACTION_MAIN);
3315 intent.setComponent(mainActivity);
3316 intent.addCategory(CATEGORY_LAUNCHER);
3317 return intent;
3318 }
3319
3320 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003321 * Make an Intent for the main activity of an application, without
3322 * specifying a specific activity to run but giving a selector to find
3323 * the activity. This results in a final Intent that is structured
3324 * the same as when the application is launched from
3325 * Home. For anything else that wants to launch an application in the
3326 * same way, it is important that they use an Intent structured the same
3327 * way, and can use this function to ensure this is the case.
3328 *
3329 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3330 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3331 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3332 * to do that through {@link #addFlags(int)} on the returned Intent.
3333 *
3334 * @param selectorAction The action name of the Intent's selector.
3335 * @param selectorCategory The name of a category to add to the Intent's
3336 * selector.
3337 * @return Returns a newly created Intent that can be used to launch the
3338 * activity as a main application entry.
3339 *
3340 * @see #setSelector(Intent)
3341 */
3342 public static Intent makeMainSelectorActivity(String selectorAction,
3343 String selectorCategory) {
3344 Intent intent = new Intent(ACTION_MAIN);
3345 intent.addCategory(CATEGORY_LAUNCHER);
3346 Intent selector = new Intent();
3347 selector.setAction(selectorAction);
3348 selector.addCategory(selectorCategory);
3349 intent.setSelector(selector);
3350 return intent;
3351 }
3352
3353 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003354 * Make an Intent that can be used to re-launch an application's task
3355 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3356 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3357 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3358 *
3359 * @param mainActivity The activity component that is the root of the
3360 * task; this is the activity that has been published in the application's
3361 * manifest as the main launcher icon.
3362 *
3363 * @return Returns a newly created Intent that can be used to relaunch the
3364 * activity's task in its root state.
3365 */
3366 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3367 Intent intent = makeMainActivity(mainActivity);
3368 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3369 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3370 return intent;
3371 }
3372
3373 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003374 * Call {@link #parseUri} with 0 flags.
3375 * @deprecated Use {@link #parseUri} instead.
3376 */
3377 @Deprecated
3378 public static Intent getIntent(String uri) throws URISyntaxException {
3379 return parseUri(uri, 0);
3380 }
Tom Taylord4a47292009-12-21 13:59:18 -08003381
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003382 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003383 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003384 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003385 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003386 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003387 *
3388 * <p>The URI given here must not be relative -- that is, it must include
3389 * the scheme and full path.
3390 *
3391 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003392 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003393 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003394 *
3395 * @return Intent The newly created Intent object.
3396 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003397 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3398 * it bad (as parsed by the Uri class) or the Intent data within the
3399 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003400 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003401 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003402 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003403 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003404 int i = 0;
3405 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003406 // Validate intent scheme for if requested.
3407 if ((flags&URI_INTENT_SCHEME) != 0) {
3408 if (!uri.startsWith("intent:")) {
3409 Intent intent = new Intent(ACTION_VIEW);
3410 try {
3411 intent.setData(Uri.parse(uri));
3412 } catch (IllegalArgumentException e) {
3413 throw new URISyntaxException(uri, e.getMessage());
3414 }
3415 return intent;
3416 }
3417 }
Tom Taylord4a47292009-12-21 13:59:18 -08003418
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003419 // simple case
3420 i = uri.lastIndexOf("#");
3421 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3422
3423 // old format Intent URI
3424 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003425
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003426 // new format
3427 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003428 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003429
3430 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003431 String data = i >= 0 ? uri.substring(0, i) : null;
3432 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003433 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003434
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003435 // loop over contents of Intent, all name=value;
3436 while (!uri.startsWith("end", i)) {
3437 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003438 if (eq < 0) eq = i-1;
3439 int semi = uri.indexOf(';', i);
3440 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003441
3442 // action
3443 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003444 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003445 }
3446
3447 // categories
3448 else if (uri.startsWith("category=", i)) {
3449 intent.addCategory(value);
3450 }
3451
3452 // type
3453 else if (uri.startsWith("type=", i)) {
3454 intent.mType = value;
3455 }
3456
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003457 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003458 else if (uri.startsWith("launchFlags=", i)) {
3459 intent.mFlags = Integer.decode(value).intValue();
3460 }
3461
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003462 // package
3463 else if (uri.startsWith("package=", i)) {
3464 intent.mPackage = value;
3465 }
3466
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003467 // component
3468 else if (uri.startsWith("component=", i)) {
3469 intent.mComponent = ComponentName.unflattenFromString(value);
3470 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003471
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003472 // scheme
3473 else if (uri.startsWith("scheme=", i)) {
3474 scheme = value;
3475 }
3476
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003477 // source bounds
3478 else if (uri.startsWith("sourceBounds=", i)) {
3479 intent.mSourceBounds = Rect.unflattenFromString(value);
3480 }
3481
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003482 // selector
3483 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3484 intent = new Intent();
3485 }
3486
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003487 // extra
3488 else {
3489 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003490 // create Bundle if it doesn't already exist
3491 if (intent.mExtras == null) intent.mExtras = new Bundle();
3492 Bundle b = intent.mExtras;
3493 // add EXTRA
3494 if (uri.startsWith("S.", i)) b.putString(key, value);
3495 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3496 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3497 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3498 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3499 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3500 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3501 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3502 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3503 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3504 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003505
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003506 // move to the next item
3507 i = semi + 1;
3508 }
3509
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003510 if (intent != baseIntent) {
3511 // The Intent had a selector; fix it up.
3512 baseIntent.setSelector(intent);
3513 intent = baseIntent;
3514 }
3515
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003516 if (data != null) {
3517 if (data.startsWith("intent:")) {
3518 data = data.substring(7);
3519 if (scheme != null) {
3520 data = scheme + ':' + data;
3521 }
3522 }
Tom Taylord4a47292009-12-21 13:59:18 -08003523
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003524 if (data.length() > 0) {
3525 try {
3526 intent.mData = Uri.parse(data);
3527 } catch (IllegalArgumentException e) {
3528 throw new URISyntaxException(uri, e.getMessage());
3529 }
3530 }
3531 }
Tom Taylord4a47292009-12-21 13:59:18 -08003532
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003533 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003534
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003535 } catch (IndexOutOfBoundsException e) {
3536 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3537 }
3538 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003539
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003540 public static Intent getIntentOld(String uri) throws URISyntaxException {
3541 Intent intent;
3542
3543 int i = uri.lastIndexOf('#');
3544 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003545 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003546 final int intentFragmentStart = i;
3547 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003548
3549 i++;
3550
3551 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003552 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003553 i += 7;
3554 int j = uri.indexOf(')', i);
3555 action = uri.substring(i, j);
3556 i = j + 1;
3557 }
3558
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003559 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003560
3561 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003562 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003563 i += 11;
3564 int j = uri.indexOf(')', i);
3565 while (i < j) {
3566 int sep = uri.indexOf('!', i);
3567 if (sep < 0) sep = j;
3568 if (i < sep) {
3569 intent.addCategory(uri.substring(i, sep));
3570 }
3571 i = sep + 1;
3572 }
3573 i = j + 1;
3574 }
3575
3576 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003577 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003578 i += 5;
3579 int j = uri.indexOf(')', i);
3580 intent.mType = uri.substring(i, j);
3581 i = j + 1;
3582 }
3583
3584 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003585 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003586 i += 12;
3587 int j = uri.indexOf(')', i);
3588 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3589 i = j + 1;
3590 }
3591
3592 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003593 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003594 i += 10;
3595 int j = uri.indexOf(')', i);
3596 int sep = uri.indexOf('!', i);
3597 if (sep >= 0 && sep < j) {
3598 String pkg = uri.substring(i, sep);
3599 String cls = uri.substring(sep + 1, j);
3600 intent.mComponent = new ComponentName(pkg, cls);
3601 }
3602 i = j + 1;
3603 }
3604
3605 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003606 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003607 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003608
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003609 final int closeParen = uri.indexOf(')', i);
3610 if (closeParen == -1) throw new URISyntaxException(uri,
3611 "EXTRA missing trailing ')'", i);
3612
3613 while (i < closeParen) {
3614 // fetch the key value
3615 int j = uri.indexOf('=', i);
3616 if (j <= i + 1 || i >= closeParen) {
3617 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3618 }
3619 char type = uri.charAt(i);
3620 i++;
3621 String key = uri.substring(i, j);
3622 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003624 // get type-value
3625 j = uri.indexOf('!', i);
3626 if (j == -1 || j >= closeParen) j = closeParen;
3627 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3628 String value = uri.substring(i, j);
3629 i = j;
3630
3631 // create Bundle if it doesn't already exist
3632 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003633
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003634 // add item to bundle
3635 try {
3636 switch (type) {
3637 case 'S':
3638 intent.mExtras.putString(key, Uri.decode(value));
3639 break;
3640 case 'B':
3641 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3642 break;
3643 case 'b':
3644 intent.mExtras.putByte(key, Byte.parseByte(value));
3645 break;
3646 case 'c':
3647 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3648 break;
3649 case 'd':
3650 intent.mExtras.putDouble(key, Double.parseDouble(value));
3651 break;
3652 case 'f':
3653 intent.mExtras.putFloat(key, Float.parseFloat(value));
3654 break;
3655 case 'i':
3656 intent.mExtras.putInt(key, Integer.parseInt(value));
3657 break;
3658 case 'l':
3659 intent.mExtras.putLong(key, Long.parseLong(value));
3660 break;
3661 case 's':
3662 intent.mExtras.putShort(key, Short.parseShort(value));
3663 break;
3664 default:
3665 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3666 }
3667 } catch (NumberFormatException e) {
3668 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3669 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003670
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003671 char ch = uri.charAt(i);
3672 if (ch == ')') break;
3673 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3674 i++;
3675 }
3676 }
3677
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003678 if (isIntentFragment) {
3679 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3680 } else {
3681 intent.mData = Uri.parse(uri);
3682 }
Tom Taylord4a47292009-12-21 13:59:18 -08003683
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003684 if (intent.mAction == null) {
3685 // By default, if no action is specified, then use VIEW.
3686 intent.mAction = ACTION_VIEW;
3687 }
3688
3689 } else {
3690 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3691 }
3692
3693 return intent;
3694 }
3695
3696 /**
3697 * Retrieve the general action to be performed, such as
3698 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3699 * the information in the intent should be interpreted -- most importantly,
3700 * what to do with the data returned by {@link #getData}.
3701 *
3702 * @return The action of this intent or null if none is specified.
3703 *
3704 * @see #setAction
3705 */
3706 public String getAction() {
3707 return mAction;
3708 }
3709
3710 /**
3711 * Retrieve data this intent is operating on. This URI specifies the name
3712 * of the data; often it uses the content: scheme, specifying data in a
3713 * content provider. Other schemes may be handled by specific activities,
3714 * such as http: by the web browser.
3715 *
3716 * @return The URI of the data this intent is targeting or null.
3717 *
3718 * @see #getScheme
3719 * @see #setData
3720 */
3721 public Uri getData() {
3722 return mData;
3723 }
3724
3725 /**
3726 * The same as {@link #getData()}, but returns the URI as an encoded
3727 * String.
3728 */
3729 public String getDataString() {
3730 return mData != null ? mData.toString() : null;
3731 }
3732
3733 /**
3734 * Return the scheme portion of the intent's data. If the data is null or
3735 * does not include a scheme, null is returned. Otherwise, the scheme
3736 * prefix without the final ':' is returned, i.e. "http".
3737 *
3738 * <p>This is the same as calling getData().getScheme() (and checking for
3739 * null data).
3740 *
3741 * @return The scheme of this intent.
3742 *
3743 * @see #getData
3744 */
3745 public String getScheme() {
3746 return mData != null ? mData.getScheme() : null;
3747 }
3748
3749 /**
3750 * Retrieve any explicit MIME type included in the intent. This is usually
3751 * null, as the type is determined by the intent data.
3752 *
3753 * @return If a type was manually set, it is returned; else null is
3754 * returned.
3755 *
3756 * @see #resolveType(ContentResolver)
3757 * @see #setType
3758 */
3759 public String getType() {
3760 return mType;
3761 }
3762
3763 /**
3764 * Return the MIME data type of this intent. If the type field is
3765 * explicitly set, that is simply returned. Otherwise, if the data is set,
3766 * the type of that data is returned. If neither fields are set, a null is
3767 * returned.
3768 *
3769 * @return The MIME type of this intent.
3770 *
3771 * @see #getType
3772 * @see #resolveType(ContentResolver)
3773 */
3774 public String resolveType(Context context) {
3775 return resolveType(context.getContentResolver());
3776 }
3777
3778 /**
3779 * Return the MIME data type of this intent. If the type field is
3780 * explicitly set, that is simply returned. Otherwise, if the data is set,
3781 * the type of that data is returned. If neither fields are set, a null is
3782 * returned.
3783 *
3784 * @param resolver A ContentResolver that can be used to determine the MIME
3785 * type of the intent's data.
3786 *
3787 * @return The MIME type of this intent.
3788 *
3789 * @see #getType
3790 * @see #resolveType(Context)
3791 */
3792 public String resolveType(ContentResolver resolver) {
3793 if (mType != null) {
3794 return mType;
3795 }
3796 if (mData != null) {
3797 if ("content".equals(mData.getScheme())) {
3798 return resolver.getType(mData);
3799 }
3800 }
3801 return null;
3802 }
3803
3804 /**
3805 * Return the MIME data type of this intent, only if it will be needed for
3806 * intent resolution. This is not generally useful for application code;
3807 * it is used by the frameworks for communicating with back-end system
3808 * services.
3809 *
3810 * @param resolver A ContentResolver that can be used to determine the MIME
3811 * type of the intent's data.
3812 *
3813 * @return The MIME type of this intent, or null if it is unknown or not
3814 * needed.
3815 */
3816 public String resolveTypeIfNeeded(ContentResolver resolver) {
3817 if (mComponent != null) {
3818 return mType;
3819 }
3820 return resolveType(resolver);
3821 }
3822
3823 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003824 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003825 *
3826 * @param category The category to check.
3827 *
3828 * @return boolean True if the intent contains the category, else false.
3829 *
3830 * @see #getCategories
3831 * @see #addCategory
3832 */
3833 public boolean hasCategory(String category) {
3834 return mCategories != null && mCategories.contains(category);
3835 }
3836
3837 /**
3838 * Return the set of all categories in the intent. If there are no categories,
3839 * returns NULL.
3840 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003841 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003842 *
3843 * @see #hasCategory
3844 * @see #addCategory
3845 */
3846 public Set<String> getCategories() {
3847 return mCategories;
3848 }
3849
3850 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003851 * Return the specific selector associated with this Intent. If there is
3852 * none, returns null. See {@link #setSelector} for more information.
3853 *
3854 * @see #setSelector
3855 */
3856 public Intent getSelector() {
3857 return mSelector;
3858 }
3859
3860 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003861 * Return the {@link ClipData} associated with this Intent. If there is
3862 * none, returns null. See {@link #setClipData} for more information.
3863 *
3864 * @see #setClipData;
3865 */
3866 public ClipData getClipData() {
3867 return mClipData;
3868 }
3869
3870 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003871 * Sets the ClassLoader that will be used when unmarshalling
3872 * any Parcelable values from the extras of this Intent.
3873 *
3874 * @param loader a ClassLoader, or null to use the default loader
3875 * at the time of unmarshalling.
3876 */
3877 public void setExtrasClassLoader(ClassLoader loader) {
3878 if (mExtras != null) {
3879 mExtras.setClassLoader(loader);
3880 }
3881 }
3882
3883 /**
3884 * Returns true if an extra value is associated with the given name.
3885 * @param name the extra's name
3886 * @return true if the given extra is present.
3887 */
3888 public boolean hasExtra(String name) {
3889 return mExtras != null && mExtras.containsKey(name);
3890 }
3891
3892 /**
3893 * Returns true if the Intent's extras contain a parcelled file descriptor.
3894 * @return true if the Intent contains a parcelled file descriptor.
3895 */
3896 public boolean hasFileDescriptors() {
3897 return mExtras != null && mExtras.hasFileDescriptors();
3898 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003899
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003900 /** @hide */
3901 public void setAllowFds(boolean allowFds) {
3902 if (mExtras != null) {
3903 mExtras.setAllowFds(allowFds);
3904 }
3905 }
3906
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003907 /**
3908 * Retrieve extended data from the intent.
3909 *
3910 * @param name The name of the desired item.
3911 *
3912 * @return the value of an item that previously added with putExtra()
3913 * or null if none was found.
3914 *
3915 * @deprecated
3916 * @hide
3917 */
3918 @Deprecated
3919 public Object getExtra(String name) {
3920 return getExtra(name, null);
3921 }
3922
3923 /**
3924 * Retrieve extended data from the intent.
3925 *
3926 * @param name The name of the desired item.
3927 * @param defaultValue the value to be returned if no value of the desired
3928 * type is stored with the given name.
3929 *
3930 * @return the value of an item that previously added with putExtra()
3931 * or the default value if none was found.
3932 *
3933 * @see #putExtra(String, boolean)
3934 */
3935 public boolean getBooleanExtra(String name, boolean defaultValue) {
3936 return mExtras == null ? defaultValue :
3937 mExtras.getBoolean(name, defaultValue);
3938 }
3939
3940 /**
3941 * Retrieve extended data from the intent.
3942 *
3943 * @param name The name of the desired item.
3944 * @param defaultValue the value to be returned if no value of the desired
3945 * type is stored with the given name.
3946 *
3947 * @return the value of an item that previously added with putExtra()
3948 * or the default value if none was found.
3949 *
3950 * @see #putExtra(String, byte)
3951 */
3952 public byte getByteExtra(String name, byte defaultValue) {
3953 return mExtras == null ? defaultValue :
3954 mExtras.getByte(name, defaultValue);
3955 }
3956
3957 /**
3958 * Retrieve extended data from the intent.
3959 *
3960 * @param name The name of the desired item.
3961 * @param defaultValue the value to be returned if no value of the desired
3962 * type is stored with the given name.
3963 *
3964 * @return the value of an item that previously added with putExtra()
3965 * or the default value if none was found.
3966 *
3967 * @see #putExtra(String, short)
3968 */
3969 public short getShortExtra(String name, short defaultValue) {
3970 return mExtras == null ? defaultValue :
3971 mExtras.getShort(name, defaultValue);
3972 }
3973
3974 /**
3975 * Retrieve extended data from the intent.
3976 *
3977 * @param name The name of the desired item.
3978 * @param defaultValue the value to be returned if no value of the desired
3979 * type is stored with the given name.
3980 *
3981 * @return the value of an item that previously added with putExtra()
3982 * or the default value if none was found.
3983 *
3984 * @see #putExtra(String, char)
3985 */
3986 public char getCharExtra(String name, char defaultValue) {
3987 return mExtras == null ? defaultValue :
3988 mExtras.getChar(name, defaultValue);
3989 }
3990
3991 /**
3992 * Retrieve extended data from the intent.
3993 *
3994 * @param name The name of the desired item.
3995 * @param defaultValue the value to be returned if no value of the desired
3996 * type is stored with the given name.
3997 *
3998 * @return the value of an item that previously added with putExtra()
3999 * or the default value if none was found.
4000 *
4001 * @see #putExtra(String, int)
4002 */
4003 public int getIntExtra(String name, int defaultValue) {
4004 return mExtras == null ? defaultValue :
4005 mExtras.getInt(name, defaultValue);
4006 }
4007
4008 /**
4009 * Retrieve extended data from the intent.
4010 *
4011 * @param name The name of the desired item.
4012 * @param defaultValue the value to be returned if no value of the desired
4013 * type is stored with the given name.
4014 *
4015 * @return the value of an item that previously added with putExtra()
4016 * or the default value if none was found.
4017 *
4018 * @see #putExtra(String, long)
4019 */
4020 public long getLongExtra(String name, long defaultValue) {
4021 return mExtras == null ? defaultValue :
4022 mExtras.getLong(name, defaultValue);
4023 }
4024
4025 /**
4026 * Retrieve extended data from the intent.
4027 *
4028 * @param name The name of the desired item.
4029 * @param defaultValue the value to be returned if no value of the desired
4030 * type is stored with the given name.
4031 *
4032 * @return the value of an item that previously added with putExtra(),
4033 * or the default value if no such item is present
4034 *
4035 * @see #putExtra(String, float)
4036 */
4037 public float getFloatExtra(String name, float defaultValue) {
4038 return mExtras == null ? defaultValue :
4039 mExtras.getFloat(name, defaultValue);
4040 }
4041
4042 /**
4043 * Retrieve extended data from the intent.
4044 *
4045 * @param name The name of the desired item.
4046 * @param defaultValue the value to be returned if no value of the desired
4047 * type is stored with the given name.
4048 *
4049 * @return the value of an item that previously added with putExtra()
4050 * or the default value if none was found.
4051 *
4052 * @see #putExtra(String, double)
4053 */
4054 public double getDoubleExtra(String name, double defaultValue) {
4055 return mExtras == null ? defaultValue :
4056 mExtras.getDouble(name, defaultValue);
4057 }
4058
4059 /**
4060 * Retrieve extended data from the intent.
4061 *
4062 * @param name The name of the desired item.
4063 *
4064 * @return the value of an item that previously added with putExtra()
4065 * or null if no String value was found.
4066 *
4067 * @see #putExtra(String, String)
4068 */
4069 public String getStringExtra(String name) {
4070 return mExtras == null ? null : mExtras.getString(name);
4071 }
4072
4073 /**
4074 * Retrieve extended data from the intent.
4075 *
4076 * @param name The name of the desired item.
4077 *
4078 * @return the value of an item that previously added with putExtra()
4079 * or null if no CharSequence value was found.
4080 *
4081 * @see #putExtra(String, CharSequence)
4082 */
4083 public CharSequence getCharSequenceExtra(String name) {
4084 return mExtras == null ? null : mExtras.getCharSequence(name);
4085 }
4086
4087 /**
4088 * Retrieve extended data from the intent.
4089 *
4090 * @param name The name of the desired item.
4091 *
4092 * @return the value of an item that previously added with putExtra()
4093 * or null if no Parcelable value was found.
4094 *
4095 * @see #putExtra(String, Parcelable)
4096 */
4097 public <T extends Parcelable> T getParcelableExtra(String name) {
4098 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4099 }
4100
4101 /**
4102 * Retrieve extended data from the intent.
4103 *
4104 * @param name The name of the desired item.
4105 *
4106 * @return the value of an item that previously added with putExtra()
4107 * or null if no Parcelable[] value was found.
4108 *
4109 * @see #putExtra(String, Parcelable[])
4110 */
4111 public Parcelable[] getParcelableArrayExtra(String name) {
4112 return mExtras == null ? null : mExtras.getParcelableArray(name);
4113 }
4114
4115 /**
4116 * Retrieve extended data from the intent.
4117 *
4118 * @param name The name of the desired item.
4119 *
4120 * @return the value of an item that previously added with putExtra()
4121 * or null if no ArrayList<Parcelable> value was found.
4122 *
4123 * @see #putParcelableArrayListExtra(String, ArrayList)
4124 */
4125 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4126 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4127 }
4128
4129 /**
4130 * Retrieve extended data from the intent.
4131 *
4132 * @param name The name of the desired item.
4133 *
4134 * @return the value of an item that previously added with putExtra()
4135 * or null if no Serializable value was found.
4136 *
4137 * @see #putExtra(String, Serializable)
4138 */
4139 public Serializable getSerializableExtra(String name) {
4140 return mExtras == null ? null : mExtras.getSerializable(name);
4141 }
4142
4143 /**
4144 * Retrieve extended data from the intent.
4145 *
4146 * @param name The name of the desired item.
4147 *
4148 * @return the value of an item that previously added with putExtra()
4149 * or null if no ArrayList<Integer> value was found.
4150 *
4151 * @see #putIntegerArrayListExtra(String, ArrayList)
4152 */
4153 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4154 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4155 }
4156
4157 /**
4158 * Retrieve extended data from the intent.
4159 *
4160 * @param name The name of the desired item.
4161 *
4162 * @return the value of an item that previously added with putExtra()
4163 * or null if no ArrayList<String> value was found.
4164 *
4165 * @see #putStringArrayListExtra(String, ArrayList)
4166 */
4167 public ArrayList<String> getStringArrayListExtra(String name) {
4168 return mExtras == null ? null : mExtras.getStringArrayList(name);
4169 }
4170
4171 /**
4172 * Retrieve extended data from the intent.
4173 *
4174 * @param name The name of the desired item.
4175 *
4176 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004177 * or null if no ArrayList<CharSequence> value was found.
4178 *
4179 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4180 */
4181 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4182 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4183 }
4184
4185 /**
4186 * Retrieve extended data from the intent.
4187 *
4188 * @param name The name of the desired item.
4189 *
4190 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004191 * or null if no boolean array value was found.
4192 *
4193 * @see #putExtra(String, boolean[])
4194 */
4195 public boolean[] getBooleanArrayExtra(String name) {
4196 return mExtras == null ? null : mExtras.getBooleanArray(name);
4197 }
4198
4199 /**
4200 * Retrieve extended data from the intent.
4201 *
4202 * @param name The name of the desired item.
4203 *
4204 * @return the value of an item that previously added with putExtra()
4205 * or null if no byte array value was found.
4206 *
4207 * @see #putExtra(String, byte[])
4208 */
4209 public byte[] getByteArrayExtra(String name) {
4210 return mExtras == null ? null : mExtras.getByteArray(name);
4211 }
4212
4213 /**
4214 * Retrieve extended data from the intent.
4215 *
4216 * @param name The name of the desired item.
4217 *
4218 * @return the value of an item that previously added with putExtra()
4219 * or null if no short array value was found.
4220 *
4221 * @see #putExtra(String, short[])
4222 */
4223 public short[] getShortArrayExtra(String name) {
4224 return mExtras == null ? null : mExtras.getShortArray(name);
4225 }
4226
4227 /**
4228 * Retrieve extended data from the intent.
4229 *
4230 * @param name The name of the desired item.
4231 *
4232 * @return the value of an item that previously added with putExtra()
4233 * or null if no char array value was found.
4234 *
4235 * @see #putExtra(String, char[])
4236 */
4237 public char[] getCharArrayExtra(String name) {
4238 return mExtras == null ? null : mExtras.getCharArray(name);
4239 }
4240
4241 /**
4242 * Retrieve extended data from the intent.
4243 *
4244 * @param name The name of the desired item.
4245 *
4246 * @return the value of an item that previously added with putExtra()
4247 * or null if no int array value was found.
4248 *
4249 * @see #putExtra(String, int[])
4250 */
4251 public int[] getIntArrayExtra(String name) {
4252 return mExtras == null ? null : mExtras.getIntArray(name);
4253 }
4254
4255 /**
4256 * Retrieve extended data from the intent.
4257 *
4258 * @param name The name of the desired item.
4259 *
4260 * @return the value of an item that previously added with putExtra()
4261 * or null if no long array value was found.
4262 *
4263 * @see #putExtra(String, long[])
4264 */
4265 public long[] getLongArrayExtra(String name) {
4266 return mExtras == null ? null : mExtras.getLongArray(name);
4267 }
4268
4269 /**
4270 * Retrieve extended data from the intent.
4271 *
4272 * @param name The name of the desired item.
4273 *
4274 * @return the value of an item that previously added with putExtra()
4275 * or null if no float array value was found.
4276 *
4277 * @see #putExtra(String, float[])
4278 */
4279 public float[] getFloatArrayExtra(String name) {
4280 return mExtras == null ? null : mExtras.getFloatArray(name);
4281 }
4282
4283 /**
4284 * Retrieve extended data from the intent.
4285 *
4286 * @param name The name of the desired item.
4287 *
4288 * @return the value of an item that previously added with putExtra()
4289 * or null if no double array value was found.
4290 *
4291 * @see #putExtra(String, double[])
4292 */
4293 public double[] getDoubleArrayExtra(String name) {
4294 return mExtras == null ? null : mExtras.getDoubleArray(name);
4295 }
4296
4297 /**
4298 * Retrieve extended data from the intent.
4299 *
4300 * @param name The name of the desired item.
4301 *
4302 * @return the value of an item that previously added with putExtra()
4303 * or null if no String array value was found.
4304 *
4305 * @see #putExtra(String, String[])
4306 */
4307 public String[] getStringArrayExtra(String name) {
4308 return mExtras == null ? null : mExtras.getStringArray(name);
4309 }
4310
4311 /**
4312 * Retrieve extended data from the intent.
4313 *
4314 * @param name The name of the desired item.
4315 *
4316 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004317 * or null if no CharSequence array value was found.
4318 *
4319 * @see #putExtra(String, CharSequence[])
4320 */
4321 public CharSequence[] getCharSequenceArrayExtra(String name) {
4322 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4323 }
4324
4325 /**
4326 * Retrieve extended data from the intent.
4327 *
4328 * @param name The name of the desired item.
4329 *
4330 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004331 * or null if no Bundle value was found.
4332 *
4333 * @see #putExtra(String, Bundle)
4334 */
4335 public Bundle getBundleExtra(String name) {
4336 return mExtras == null ? null : mExtras.getBundle(name);
4337 }
4338
4339 /**
4340 * Retrieve extended data from the intent.
4341 *
4342 * @param name The name of the desired item.
4343 *
4344 * @return the value of an item that previously added with putExtra()
4345 * or null if no IBinder value was found.
4346 *
4347 * @see #putExtra(String, IBinder)
4348 *
4349 * @deprecated
4350 * @hide
4351 */
4352 @Deprecated
4353 public IBinder getIBinderExtra(String name) {
4354 return mExtras == null ? null : mExtras.getIBinder(name);
4355 }
4356
4357 /**
4358 * Retrieve extended data from the intent.
4359 *
4360 * @param name The name of the desired item.
4361 * @param defaultValue The default value to return in case no item is
4362 * associated with the key 'name'
4363 *
4364 * @return the value of an item that previously added with putExtra()
4365 * or defaultValue if none was found.
4366 *
4367 * @see #putExtra
4368 *
4369 * @deprecated
4370 * @hide
4371 */
4372 @Deprecated
4373 public Object getExtra(String name, Object defaultValue) {
4374 Object result = defaultValue;
4375 if (mExtras != null) {
4376 Object result2 = mExtras.get(name);
4377 if (result2 != null) {
4378 result = result2;
4379 }
4380 }
4381
4382 return result;
4383 }
4384
4385 /**
4386 * Retrieves a map of extended data from the intent.
4387 *
4388 * @return the map of all extras previously added with putExtra(),
4389 * or null if none have been added.
4390 */
4391 public Bundle getExtras() {
4392 return (mExtras != null)
4393 ? new Bundle(mExtras)
4394 : null;
4395 }
4396
4397 /**
4398 * Retrieve any special flags associated with this intent. You will
4399 * normally just set them with {@link #setFlags} and let the system
4400 * take the appropriate action with them.
4401 *
4402 * @return int The currently set flags.
4403 *
4404 * @see #setFlags
4405 */
4406 public int getFlags() {
4407 return mFlags;
4408 }
4409
Dianne Hackborne7f97212011-02-24 14:40:20 -08004410 /** @hide */
4411 public boolean isExcludingStopped() {
4412 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4413 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4414 }
4415
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004416 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004417 * Retrieve the application package name this Intent is limited to. When
4418 * resolving an Intent, if non-null this limits the resolution to only
4419 * components in the given application package.
4420 *
4421 * @return The name of the application package for the Intent.
4422 *
4423 * @see #resolveActivity
4424 * @see #setPackage
4425 */
4426 public String getPackage() {
4427 return mPackage;
4428 }
4429
4430 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004431 * Retrieve the concrete component associated with the intent. When receiving
4432 * an intent, this is the component that was found to best handle it (that is,
4433 * yourself) and will always be non-null; in all other cases it will be
4434 * null unless explicitly set.
4435 *
4436 * @return The name of the application component to handle the intent.
4437 *
4438 * @see #resolveActivity
4439 * @see #setComponent
4440 */
4441 public ComponentName getComponent() {
4442 return mComponent;
4443 }
4444
4445 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004446 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4447 * used as a hint to the receiver for animations and the like. Null means that there
4448 * is no source bounds.
4449 */
4450 public Rect getSourceBounds() {
4451 return mSourceBounds;
4452 }
4453
4454 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004455 * Return the Activity component that should be used to handle this intent.
4456 * The appropriate component is determined based on the information in the
4457 * intent, evaluated as follows:
4458 *
4459 * <p>If {@link #getComponent} returns an explicit class, that is returned
4460 * without any further consideration.
4461 *
4462 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4463 * category to be considered.
4464 *
4465 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4466 * action.
4467 *
4468 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4469 * this type.
4470 *
4471 * <p>If {@link #addCategory} has added any categories, the activity must
4472 * handle ALL of the categories specified.
4473 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004474 * <p>If {@link #getPackage} is non-NULL, only activity components in
4475 * that application package will be considered.
4476 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004477 * <p>If there are no activities that satisfy all of these conditions, a
4478 * null string is returned.
4479 *
4480 * <p>If multiple activities are found to satisfy the intent, the one with
4481 * the highest priority will be used. If there are multiple activities
4482 * with the same priority, the system will either pick the best activity
4483 * based on user preference, or resolve to a system class that will allow
4484 * the user to pick an activity and forward from there.
4485 *
4486 * <p>This method is implemented simply by calling
4487 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4488 * true.</p>
4489 * <p> This API is called for you as part of starting an activity from an
4490 * intent. You do not normally need to call it yourself.</p>
4491 *
4492 * @param pm The package manager with which to resolve the Intent.
4493 *
4494 * @return Name of the component implementing an activity that can
4495 * display the intent.
4496 *
4497 * @see #setComponent
4498 * @see #getComponent
4499 * @see #resolveActivityInfo
4500 */
4501 public ComponentName resolveActivity(PackageManager pm) {
4502 if (mComponent != null) {
4503 return mComponent;
4504 }
4505
4506 ResolveInfo info = pm.resolveActivity(
4507 this, PackageManager.MATCH_DEFAULT_ONLY);
4508 if (info != null) {
4509 return new ComponentName(
4510 info.activityInfo.applicationInfo.packageName,
4511 info.activityInfo.name);
4512 }
4513
4514 return null;
4515 }
4516
4517 /**
4518 * Resolve the Intent into an {@link ActivityInfo}
4519 * describing the activity that should execute the intent. Resolution
4520 * follows the same rules as described for {@link #resolveActivity}, but
4521 * you get back the completely information about the resolved activity
4522 * instead of just its class name.
4523 *
4524 * @param pm The package manager with which to resolve the Intent.
4525 * @param flags Addition information to retrieve as per
4526 * {@link PackageManager#getActivityInfo(ComponentName, int)
4527 * PackageManager.getActivityInfo()}.
4528 *
4529 * @return PackageManager.ActivityInfo
4530 *
4531 * @see #resolveActivity
4532 */
4533 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4534 ActivityInfo ai = null;
4535 if (mComponent != null) {
4536 try {
4537 ai = pm.getActivityInfo(mComponent, flags);
4538 } catch (PackageManager.NameNotFoundException e) {
4539 // ignore
4540 }
4541 } else {
4542 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004543 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004544 if (info != null) {
4545 ai = info.activityInfo;
4546 }
4547 }
4548
4549 return ai;
4550 }
4551
4552 /**
4553 * Set the general action to be performed.
4554 *
4555 * @param action An action name, such as ACTION_VIEW. Application-specific
4556 * actions should be prefixed with the vendor's package name.
4557 *
4558 * @return Returns the same Intent object, for chaining multiple calls
4559 * into a single statement.
4560 *
4561 * @see #getAction
4562 */
4563 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004564 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004565 return this;
4566 }
4567
4568 /**
4569 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004570 * clears any type that was previously set by {@link #setType} or
4571 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004572 *
Nick Pellyccae4122012-01-09 14:12:58 -08004573 * <p><em>Note: scheme matching in the Android framework is
4574 * case-sensitive, unlike the formal RFC. As a result,
4575 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004576 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004577 * {@link #setDataAndNormalize}
4578 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004579 *
Nick Pellyccae4122012-01-09 14:12:58 -08004580 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004581 *
4582 * @return Returns the same Intent object, for chaining multiple calls
4583 * into a single statement.
4584 *
4585 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004586 * @see #setDataAndNormalize
4587 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004588 */
4589 public Intent setData(Uri data) {
4590 mData = data;
4591 mType = null;
4592 return this;
4593 }
4594
4595 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004596 * Normalize and set the data this intent is operating on.
4597 *
4598 * <p>This method automatically clears any type that was
4599 * previously set (for example, by {@link #setType}).
4600 *
4601 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004602 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004603 * so really this is just a convenience method for
4604 * <pre>
4605 * setData(data.normalize())
4606 * </pre>
4607 *
4608 * @param data The Uri of the data this intent is now targeting.
4609 *
4610 * @return Returns the same Intent object, for chaining multiple calls
4611 * into a single statement.
4612 *
4613 * @see #getData
4614 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004615 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004616 */
4617 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004618 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004619 }
4620
4621 /**
4622 * Set an explicit MIME data type.
4623 *
4624 * <p>This is used to create intents that only specify a type and not data,
4625 * for example to indicate the type of data to return.
4626 *
4627 * <p>This method automatically clears any data that was
4628 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004629 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004630 * <p><em>Note: MIME type matching in the Android framework is
4631 * case-sensitive, unlike formal RFC MIME types. As a result,
4632 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004633 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4634 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004635 *
4636 * @param type The MIME type of the data being handled by this intent.
4637 *
4638 * @return Returns the same Intent object, for chaining multiple calls
4639 * into a single statement.
4640 *
4641 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004642 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004643 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004644 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004645 */
4646 public Intent setType(String type) {
4647 mData = null;
4648 mType = type;
4649 return this;
4650 }
4651
4652 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004653 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004654 *
Nick Pellyccae4122012-01-09 14:12:58 -08004655 * <p>This is used to create intents that only specify a type and not data,
4656 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004657 *
Nick Pellyccae4122012-01-09 14:12:58 -08004658 * <p>This method automatically clears any data that was
4659 * previously set (for example by {@link #setData}).
4660 *
4661 * <p>The MIME type is normalized using
4662 * {@link #normalizeMimeType} before it is set,
4663 * so really this is just a convenience method for
4664 * <pre>
4665 * setType(Intent.normalizeMimeType(type))
4666 * </pre>
4667 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004668 * @param type The MIME type of the data being handled by this intent.
4669 *
4670 * @return Returns the same Intent object, for chaining multiple calls
4671 * into a single statement.
4672 *
Nick Pellyccae4122012-01-09 14:12:58 -08004673 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004674 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004675 * @see #normalizeMimeType
4676 */
4677 public Intent setTypeAndNormalize(String type) {
4678 return setType(normalizeMimeType(type));
4679 }
4680
4681 /**
4682 * (Usually optional) Set the data for the intent along with an explicit
4683 * MIME data type. This method should very rarely be used -- it allows you
4684 * to override the MIME type that would ordinarily be inferred from the
4685 * data with your own type given here.
4686 *
4687 * <p><em>Note: MIME type and Uri scheme matching in the
4688 * Android framework is case-sensitive, unlike the formal RFC definitions.
4689 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004690 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004691 * {@link #setDataAndTypeAndNormalize}
4692 * to ensure that they are converted to lower case.</em>
4693 *
4694 * @param data The Uri of the data this intent is now targeting.
4695 * @param type The MIME type of the data being handled by this intent.
4696 *
4697 * @return Returns the same Intent object, for chaining multiple calls
4698 * into a single statement.
4699 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004700 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004701 * @see #setData
4702 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004703 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004704 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004705 */
4706 public Intent setDataAndType(Uri data, String type) {
4707 mData = data;
4708 mType = type;
4709 return this;
4710 }
4711
4712 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004713 * (Usually optional) Normalize and set both the data Uri and an explicit
4714 * MIME data type. This method should very rarely be used -- it allows you
4715 * to override the MIME type that would ordinarily be inferred from the
4716 * data with your own type given here.
4717 *
4718 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004719 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08004720 * before they are set, so really this is just a convenience method for
4721 * <pre>
4722 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4723 * </pre>
4724 *
4725 * @param data The Uri of the data this intent is now targeting.
4726 * @param type The MIME type of the data being handled by this intent.
4727 *
4728 * @return Returns the same Intent object, for chaining multiple calls
4729 * into a single statement.
4730 *
4731 * @see #setType
4732 * @see #setData
4733 * @see #setDataAndType
4734 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004735 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004736 */
4737 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004738 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08004739 }
4740
4741 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004742 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004743 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004744 * activities that provide <em>all</em> of the requested categories will be
4745 * used.
4746 *
4747 * @param category The desired category. This can be either one of the
4748 * predefined Intent categories, or a custom category in your own
4749 * namespace.
4750 *
4751 * @return Returns the same Intent object, for chaining multiple calls
4752 * into a single statement.
4753 *
4754 * @see #hasCategory
4755 * @see #removeCategory
4756 */
4757 public Intent addCategory(String category) {
4758 if (mCategories == null) {
4759 mCategories = new HashSet<String>();
4760 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004761 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004762 return this;
4763 }
4764
4765 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004766 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004767 *
4768 * @param category The category to remove.
4769 *
4770 * @see #addCategory
4771 */
4772 public void removeCategory(String category) {
4773 if (mCategories != null) {
4774 mCategories.remove(category);
4775 if (mCategories.size() == 0) {
4776 mCategories = null;
4777 }
4778 }
4779 }
4780
4781 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004782 * Set a selector for this Intent. This is a modification to the kinds of
4783 * things the Intent will match. If the selector is set, it will be used
4784 * when trying to find entities that can handle the Intent, instead of the
4785 * main contents of the Intent. This allows you build an Intent containing
4786 * a generic protocol while targeting it more specifically.
4787 *
4788 * <p>An example of where this may be used is with things like
4789 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
4790 * Intent that will launch the Browser application. However, the correct
4791 * main entry point of an application is actually {@link #ACTION_MAIN}
4792 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
4793 * used to specify the actual Activity to launch. If you launch the browser
4794 * with something different, undesired behavior may happen if the user has
4795 * previously or later launches it the normal way, since they do not match.
4796 * Instead, you can build an Intent with the MAIN action (but no ComponentName
4797 * yet specified) and set a selector with {@link #ACTION_MAIN} and
4798 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
4799 *
4800 * <p>Setting a selector does not impact the behavior of
4801 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
4802 * desired behavior of a selector -- it does not impact the base meaning
4803 * of the Intent, just what kinds of things will be matched against it
4804 * when determining who can handle it.</p>
4805 *
4806 * <p>You can not use both a selector and {@link #setPackage(String)} on
4807 * the same base Intent.</p>
4808 *
4809 * @param selector The desired selector Intent; set to null to not use
4810 * a special selector.
4811 */
4812 public void setSelector(Intent selector) {
4813 if (selector == this) {
4814 throw new IllegalArgumentException(
4815 "Intent being set as a selector of itself");
4816 }
4817 if (selector != null && mPackage != null) {
4818 throw new IllegalArgumentException(
4819 "Can't set selector when package name is already set");
4820 }
4821 mSelector = selector;
4822 }
4823
4824 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004825 * Set a {@link ClipData} associated with this Intent. This replaces any
4826 * previously set ClipData.
4827 *
4828 * <p>The ClipData in an intent is not used for Intent matching or other
4829 * such operations. Semantically it is like extras, used to transmit
4830 * additional data with the Intent. The main feature of using this over
4831 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
4832 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
4833 * items included in the clip data. This is useful, in particular, if
4834 * you want to transmit an Intent containing multiple <code>content:</code>
4835 * URIs for which the recipient may not have global permission to access the
4836 * content provider.
4837 *
4838 * <p>If the ClipData contains items that are themselves Intents, any
4839 * grant flags in those Intents will be ignored. Only the top-level flags
4840 * of the main Intent are respected, and will be applied to all Uri or
4841 * Intent items in the clip (or sub-items of the clip).
4842 *
4843 * <p>The MIME type, label, and icon in the ClipData object are not
4844 * directly used by Intent. Applications should generally rely on the
4845 * MIME type of the Intent itself, not what it may find in the ClipData.
4846 * A common practice is to construct a ClipData for use with an Intent
4847 * with a MIME type of "*\/*".
4848 *
4849 * @param clip The new clip to set. May be null to clear the current clip.
4850 */
4851 public void setClipData(ClipData clip) {
4852 mClipData = clip;
4853 }
4854
4855 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004856 * Add extended data to the intent. The name must include a package
4857 * prefix, for example the app com.android.contacts would use names
4858 * like "com.android.contacts.ShowAll".
4859 *
4860 * @param name The name of the extra data, with package prefix.
4861 * @param value The boolean data value.
4862 *
4863 * @return Returns the same Intent object, for chaining multiple calls
4864 * into a single statement.
4865 *
4866 * @see #putExtras
4867 * @see #removeExtra
4868 * @see #getBooleanExtra(String, boolean)
4869 */
4870 public Intent putExtra(String name, boolean value) {
4871 if (mExtras == null) {
4872 mExtras = new Bundle();
4873 }
4874 mExtras.putBoolean(name, value);
4875 return this;
4876 }
4877
4878 /**
4879 * Add extended data to the intent. The name must include a package
4880 * prefix, for example the app com.android.contacts would use names
4881 * like "com.android.contacts.ShowAll".
4882 *
4883 * @param name The name of the extra data, with package prefix.
4884 * @param value The byte data value.
4885 *
4886 * @return Returns the same Intent object, for chaining multiple calls
4887 * into a single statement.
4888 *
4889 * @see #putExtras
4890 * @see #removeExtra
4891 * @see #getByteExtra(String, byte)
4892 */
4893 public Intent putExtra(String name, byte value) {
4894 if (mExtras == null) {
4895 mExtras = new Bundle();
4896 }
4897 mExtras.putByte(name, value);
4898 return this;
4899 }
4900
4901 /**
4902 * Add extended data to the intent. The name must include a package
4903 * prefix, for example the app com.android.contacts would use names
4904 * like "com.android.contacts.ShowAll".
4905 *
4906 * @param name The name of the extra data, with package prefix.
4907 * @param value The char data value.
4908 *
4909 * @return Returns the same Intent object, for chaining multiple calls
4910 * into a single statement.
4911 *
4912 * @see #putExtras
4913 * @see #removeExtra
4914 * @see #getCharExtra(String, char)
4915 */
4916 public Intent putExtra(String name, char value) {
4917 if (mExtras == null) {
4918 mExtras = new Bundle();
4919 }
4920 mExtras.putChar(name, value);
4921 return this;
4922 }
4923
4924 /**
4925 * Add extended data to the intent. The name must include a package
4926 * prefix, for example the app com.android.contacts would use names
4927 * like "com.android.contacts.ShowAll".
4928 *
4929 * @param name The name of the extra data, with package prefix.
4930 * @param value The short data value.
4931 *
4932 * @return Returns the same Intent object, for chaining multiple calls
4933 * into a single statement.
4934 *
4935 * @see #putExtras
4936 * @see #removeExtra
4937 * @see #getShortExtra(String, short)
4938 */
4939 public Intent putExtra(String name, short value) {
4940 if (mExtras == null) {
4941 mExtras = new Bundle();
4942 }
4943 mExtras.putShort(name, value);
4944 return this;
4945 }
4946
4947 /**
4948 * Add extended data to the intent. The name must include a package
4949 * prefix, for example the app com.android.contacts would use names
4950 * like "com.android.contacts.ShowAll".
4951 *
4952 * @param name The name of the extra data, with package prefix.
4953 * @param value The integer data value.
4954 *
4955 * @return Returns the same Intent object, for chaining multiple calls
4956 * into a single statement.
4957 *
4958 * @see #putExtras
4959 * @see #removeExtra
4960 * @see #getIntExtra(String, int)
4961 */
4962 public Intent putExtra(String name, int value) {
4963 if (mExtras == null) {
4964 mExtras = new Bundle();
4965 }
4966 mExtras.putInt(name, value);
4967 return this;
4968 }
4969
4970 /**
4971 * Add extended data to the intent. The name must include a package
4972 * prefix, for example the app com.android.contacts would use names
4973 * like "com.android.contacts.ShowAll".
4974 *
4975 * @param name The name of the extra data, with package prefix.
4976 * @param value The long data value.
4977 *
4978 * @return Returns the same Intent object, for chaining multiple calls
4979 * into a single statement.
4980 *
4981 * @see #putExtras
4982 * @see #removeExtra
4983 * @see #getLongExtra(String, long)
4984 */
4985 public Intent putExtra(String name, long value) {
4986 if (mExtras == null) {
4987 mExtras = new Bundle();
4988 }
4989 mExtras.putLong(name, value);
4990 return this;
4991 }
4992
4993 /**
4994 * Add extended data to the intent. The name must include a package
4995 * prefix, for example the app com.android.contacts would use names
4996 * like "com.android.contacts.ShowAll".
4997 *
4998 * @param name The name of the extra data, with package prefix.
4999 * @param value The float data value.
5000 *
5001 * @return Returns the same Intent object, for chaining multiple calls
5002 * into a single statement.
5003 *
5004 * @see #putExtras
5005 * @see #removeExtra
5006 * @see #getFloatExtra(String, float)
5007 */
5008 public Intent putExtra(String name, float value) {
5009 if (mExtras == null) {
5010 mExtras = new Bundle();
5011 }
5012 mExtras.putFloat(name, value);
5013 return this;
5014 }
5015
5016 /**
5017 * Add extended data to the intent. The name must include a package
5018 * prefix, for example the app com.android.contacts would use names
5019 * like "com.android.contacts.ShowAll".
5020 *
5021 * @param name The name of the extra data, with package prefix.
5022 * @param value The double data value.
5023 *
5024 * @return Returns the same Intent object, for chaining multiple calls
5025 * into a single statement.
5026 *
5027 * @see #putExtras
5028 * @see #removeExtra
5029 * @see #getDoubleExtra(String, double)
5030 */
5031 public Intent putExtra(String name, double value) {
5032 if (mExtras == null) {
5033 mExtras = new Bundle();
5034 }
5035 mExtras.putDouble(name, value);
5036 return this;
5037 }
5038
5039 /**
5040 * Add extended data to the intent. The name must include a package
5041 * prefix, for example the app com.android.contacts would use names
5042 * like "com.android.contacts.ShowAll".
5043 *
5044 * @param name The name of the extra data, with package prefix.
5045 * @param value The String data value.
5046 *
5047 * @return Returns the same Intent object, for chaining multiple calls
5048 * into a single statement.
5049 *
5050 * @see #putExtras
5051 * @see #removeExtra
5052 * @see #getStringExtra(String)
5053 */
5054 public Intent putExtra(String name, String value) {
5055 if (mExtras == null) {
5056 mExtras = new Bundle();
5057 }
5058 mExtras.putString(name, value);
5059 return this;
5060 }
5061
5062 /**
5063 * Add extended data to the intent. The name must include a package
5064 * prefix, for example the app com.android.contacts would use names
5065 * like "com.android.contacts.ShowAll".
5066 *
5067 * @param name The name of the extra data, with package prefix.
5068 * @param value The CharSequence data value.
5069 *
5070 * @return Returns the same Intent object, for chaining multiple calls
5071 * into a single statement.
5072 *
5073 * @see #putExtras
5074 * @see #removeExtra
5075 * @see #getCharSequenceExtra(String)
5076 */
5077 public Intent putExtra(String name, CharSequence value) {
5078 if (mExtras == null) {
5079 mExtras = new Bundle();
5080 }
5081 mExtras.putCharSequence(name, value);
5082 return this;
5083 }
5084
5085 /**
5086 * Add extended data to the intent. The name must include a package
5087 * prefix, for example the app com.android.contacts would use names
5088 * like "com.android.contacts.ShowAll".
5089 *
5090 * @param name The name of the extra data, with package prefix.
5091 * @param value The Parcelable data value.
5092 *
5093 * @return Returns the same Intent object, for chaining multiple calls
5094 * into a single statement.
5095 *
5096 * @see #putExtras
5097 * @see #removeExtra
5098 * @see #getParcelableExtra(String)
5099 */
5100 public Intent putExtra(String name, Parcelable value) {
5101 if (mExtras == null) {
5102 mExtras = new Bundle();
5103 }
5104 mExtras.putParcelable(name, value);
5105 return this;
5106 }
5107
5108 /**
5109 * Add extended data to the intent. The name must include a package
5110 * prefix, for example the app com.android.contacts would use names
5111 * like "com.android.contacts.ShowAll".
5112 *
5113 * @param name The name of the extra data, with package prefix.
5114 * @param value The Parcelable[] data value.
5115 *
5116 * @return Returns the same Intent object, for chaining multiple calls
5117 * into a single statement.
5118 *
5119 * @see #putExtras
5120 * @see #removeExtra
5121 * @see #getParcelableArrayExtra(String)
5122 */
5123 public Intent putExtra(String name, Parcelable[] value) {
5124 if (mExtras == null) {
5125 mExtras = new Bundle();
5126 }
5127 mExtras.putParcelableArray(name, value);
5128 return this;
5129 }
5130
5131 /**
5132 * Add extended data to the intent. The name must include a package
5133 * prefix, for example the app com.android.contacts would use names
5134 * like "com.android.contacts.ShowAll".
5135 *
5136 * @param name The name of the extra data, with package prefix.
5137 * @param value The ArrayList<Parcelable> data value.
5138 *
5139 * @return Returns the same Intent object, for chaining multiple calls
5140 * into a single statement.
5141 *
5142 * @see #putExtras
5143 * @see #removeExtra
5144 * @see #getParcelableArrayListExtra(String)
5145 */
5146 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5147 if (mExtras == null) {
5148 mExtras = new Bundle();
5149 }
5150 mExtras.putParcelableArrayList(name, value);
5151 return this;
5152 }
5153
5154 /**
5155 * Add extended data to the intent. The name must include a package
5156 * prefix, for example the app com.android.contacts would use names
5157 * like "com.android.contacts.ShowAll".
5158 *
5159 * @param name The name of the extra data, with package prefix.
5160 * @param value The ArrayList<Integer> data value.
5161 *
5162 * @return Returns the same Intent object, for chaining multiple calls
5163 * into a single statement.
5164 *
5165 * @see #putExtras
5166 * @see #removeExtra
5167 * @see #getIntegerArrayListExtra(String)
5168 */
5169 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5170 if (mExtras == null) {
5171 mExtras = new Bundle();
5172 }
5173 mExtras.putIntegerArrayList(name, value);
5174 return this;
5175 }
5176
5177 /**
5178 * Add extended data to the intent. The name must include a package
5179 * prefix, for example the app com.android.contacts would use names
5180 * like "com.android.contacts.ShowAll".
5181 *
5182 * @param name The name of the extra data, with package prefix.
5183 * @param value The ArrayList<String> data value.
5184 *
5185 * @return Returns the same Intent object, for chaining multiple calls
5186 * into a single statement.
5187 *
5188 * @see #putExtras
5189 * @see #removeExtra
5190 * @see #getStringArrayListExtra(String)
5191 */
5192 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5193 if (mExtras == null) {
5194 mExtras = new Bundle();
5195 }
5196 mExtras.putStringArrayList(name, value);
5197 return this;
5198 }
5199
5200 /**
5201 * Add extended data to the intent. The name must include a package
5202 * prefix, for example the app com.android.contacts would use names
5203 * like "com.android.contacts.ShowAll".
5204 *
5205 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005206 * @param value The ArrayList<CharSequence> data value.
5207 *
5208 * @return Returns the same Intent object, for chaining multiple calls
5209 * into a single statement.
5210 *
5211 * @see #putExtras
5212 * @see #removeExtra
5213 * @see #getCharSequenceArrayListExtra(String)
5214 */
5215 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5216 if (mExtras == null) {
5217 mExtras = new Bundle();
5218 }
5219 mExtras.putCharSequenceArrayList(name, value);
5220 return this;
5221 }
5222
5223 /**
5224 * Add extended data to the intent. The name must include a package
5225 * prefix, for example the app com.android.contacts would use names
5226 * like "com.android.contacts.ShowAll".
5227 *
5228 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005229 * @param value The Serializable data value.
5230 *
5231 * @return Returns the same Intent object, for chaining multiple calls
5232 * into a single statement.
5233 *
5234 * @see #putExtras
5235 * @see #removeExtra
5236 * @see #getSerializableExtra(String)
5237 */
5238 public Intent putExtra(String name, Serializable value) {
5239 if (mExtras == null) {
5240 mExtras = new Bundle();
5241 }
5242 mExtras.putSerializable(name, value);
5243 return this;
5244 }
5245
5246 /**
5247 * Add extended data to the intent. The name must include a package
5248 * prefix, for example the app com.android.contacts would use names
5249 * like "com.android.contacts.ShowAll".
5250 *
5251 * @param name The name of the extra data, with package prefix.
5252 * @param value The boolean array data value.
5253 *
5254 * @return Returns the same Intent object, for chaining multiple calls
5255 * into a single statement.
5256 *
5257 * @see #putExtras
5258 * @see #removeExtra
5259 * @see #getBooleanArrayExtra(String)
5260 */
5261 public Intent putExtra(String name, boolean[] value) {
5262 if (mExtras == null) {
5263 mExtras = new Bundle();
5264 }
5265 mExtras.putBooleanArray(name, value);
5266 return this;
5267 }
5268
5269 /**
5270 * Add extended data to the intent. The name must include a package
5271 * prefix, for example the app com.android.contacts would use names
5272 * like "com.android.contacts.ShowAll".
5273 *
5274 * @param name The name of the extra data, with package prefix.
5275 * @param value The byte array data value.
5276 *
5277 * @return Returns the same Intent object, for chaining multiple calls
5278 * into a single statement.
5279 *
5280 * @see #putExtras
5281 * @see #removeExtra
5282 * @see #getByteArrayExtra(String)
5283 */
5284 public Intent putExtra(String name, byte[] value) {
5285 if (mExtras == null) {
5286 mExtras = new Bundle();
5287 }
5288 mExtras.putByteArray(name, value);
5289 return this;
5290 }
5291
5292 /**
5293 * Add extended data to the intent. The name must include a package
5294 * prefix, for example the app com.android.contacts would use names
5295 * like "com.android.contacts.ShowAll".
5296 *
5297 * @param name The name of the extra data, with package prefix.
5298 * @param value The short array data value.
5299 *
5300 * @return Returns the same Intent object, for chaining multiple calls
5301 * into a single statement.
5302 *
5303 * @see #putExtras
5304 * @see #removeExtra
5305 * @see #getShortArrayExtra(String)
5306 */
5307 public Intent putExtra(String name, short[] value) {
5308 if (mExtras == null) {
5309 mExtras = new Bundle();
5310 }
5311 mExtras.putShortArray(name, value);
5312 return this;
5313 }
5314
5315 /**
5316 * Add extended data to the intent. The name must include a package
5317 * prefix, for example the app com.android.contacts would use names
5318 * like "com.android.contacts.ShowAll".
5319 *
5320 * @param name The name of the extra data, with package prefix.
5321 * @param value The char array data value.
5322 *
5323 * @return Returns the same Intent object, for chaining multiple calls
5324 * into a single statement.
5325 *
5326 * @see #putExtras
5327 * @see #removeExtra
5328 * @see #getCharArrayExtra(String)
5329 */
5330 public Intent putExtra(String name, char[] value) {
5331 if (mExtras == null) {
5332 mExtras = new Bundle();
5333 }
5334 mExtras.putCharArray(name, value);
5335 return this;
5336 }
5337
5338 /**
5339 * Add extended data to the intent. The name must include a package
5340 * prefix, for example the app com.android.contacts would use names
5341 * like "com.android.contacts.ShowAll".
5342 *
5343 * @param name The name of the extra data, with package prefix.
5344 * @param value The int array data value.
5345 *
5346 * @return Returns the same Intent object, for chaining multiple calls
5347 * into a single statement.
5348 *
5349 * @see #putExtras
5350 * @see #removeExtra
5351 * @see #getIntArrayExtra(String)
5352 */
5353 public Intent putExtra(String name, int[] value) {
5354 if (mExtras == null) {
5355 mExtras = new Bundle();
5356 }
5357 mExtras.putIntArray(name, value);
5358 return this;
5359 }
5360
5361 /**
5362 * Add extended data to the intent. The name must include a package
5363 * prefix, for example the app com.android.contacts would use names
5364 * like "com.android.contacts.ShowAll".
5365 *
5366 * @param name The name of the extra data, with package prefix.
5367 * @param value The byte array data value.
5368 *
5369 * @return Returns the same Intent object, for chaining multiple calls
5370 * into a single statement.
5371 *
5372 * @see #putExtras
5373 * @see #removeExtra
5374 * @see #getLongArrayExtra(String)
5375 */
5376 public Intent putExtra(String name, long[] value) {
5377 if (mExtras == null) {
5378 mExtras = new Bundle();
5379 }
5380 mExtras.putLongArray(name, value);
5381 return this;
5382 }
5383
5384 /**
5385 * Add extended data to the intent. The name must include a package
5386 * prefix, for example the app com.android.contacts would use names
5387 * like "com.android.contacts.ShowAll".
5388 *
5389 * @param name The name of the extra data, with package prefix.
5390 * @param value The float array data value.
5391 *
5392 * @return Returns the same Intent object, for chaining multiple calls
5393 * into a single statement.
5394 *
5395 * @see #putExtras
5396 * @see #removeExtra
5397 * @see #getFloatArrayExtra(String)
5398 */
5399 public Intent putExtra(String name, float[] value) {
5400 if (mExtras == null) {
5401 mExtras = new Bundle();
5402 }
5403 mExtras.putFloatArray(name, value);
5404 return this;
5405 }
5406
5407 /**
5408 * Add extended data to the intent. The name must include a package
5409 * prefix, for example the app com.android.contacts would use names
5410 * like "com.android.contacts.ShowAll".
5411 *
5412 * @param name The name of the extra data, with package prefix.
5413 * @param value The double array data value.
5414 *
5415 * @return Returns the same Intent object, for chaining multiple calls
5416 * into a single statement.
5417 *
5418 * @see #putExtras
5419 * @see #removeExtra
5420 * @see #getDoubleArrayExtra(String)
5421 */
5422 public Intent putExtra(String name, double[] value) {
5423 if (mExtras == null) {
5424 mExtras = new Bundle();
5425 }
5426 mExtras.putDoubleArray(name, value);
5427 return this;
5428 }
5429
5430 /**
5431 * Add extended data to the intent. The name must include a package
5432 * prefix, for example the app com.android.contacts would use names
5433 * like "com.android.contacts.ShowAll".
5434 *
5435 * @param name The name of the extra data, with package prefix.
5436 * @param value The String array data value.
5437 *
5438 * @return Returns the same Intent object, for chaining multiple calls
5439 * into a single statement.
5440 *
5441 * @see #putExtras
5442 * @see #removeExtra
5443 * @see #getStringArrayExtra(String)
5444 */
5445 public Intent putExtra(String name, String[] value) {
5446 if (mExtras == null) {
5447 mExtras = new Bundle();
5448 }
5449 mExtras.putStringArray(name, value);
5450 return this;
5451 }
5452
5453 /**
5454 * Add extended data to the intent. The name must include a package
5455 * prefix, for example the app com.android.contacts would use names
5456 * like "com.android.contacts.ShowAll".
5457 *
5458 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005459 * @param value The CharSequence array data value.
5460 *
5461 * @return Returns the same Intent object, for chaining multiple calls
5462 * into a single statement.
5463 *
5464 * @see #putExtras
5465 * @see #removeExtra
5466 * @see #getCharSequenceArrayExtra(String)
5467 */
5468 public Intent putExtra(String name, CharSequence[] value) {
5469 if (mExtras == null) {
5470 mExtras = new Bundle();
5471 }
5472 mExtras.putCharSequenceArray(name, value);
5473 return this;
5474 }
5475
5476 /**
5477 * Add extended data to the intent. The name must include a package
5478 * prefix, for example the app com.android.contacts would use names
5479 * like "com.android.contacts.ShowAll".
5480 *
5481 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005482 * @param value The Bundle data value.
5483 *
5484 * @return Returns the same Intent object, for chaining multiple calls
5485 * into a single statement.
5486 *
5487 * @see #putExtras
5488 * @see #removeExtra
5489 * @see #getBundleExtra(String)
5490 */
5491 public Intent putExtra(String name, Bundle value) {
5492 if (mExtras == null) {
5493 mExtras = new Bundle();
5494 }
5495 mExtras.putBundle(name, value);
5496 return this;
5497 }
5498
5499 /**
5500 * Add extended data to the intent. The name must include a package
5501 * prefix, for example the app com.android.contacts would use names
5502 * like "com.android.contacts.ShowAll".
5503 *
5504 * @param name The name of the extra data, with package prefix.
5505 * @param value The IBinder data value.
5506 *
5507 * @return Returns the same Intent object, for chaining multiple calls
5508 * into a single statement.
5509 *
5510 * @see #putExtras
5511 * @see #removeExtra
5512 * @see #getIBinderExtra(String)
5513 *
5514 * @deprecated
5515 * @hide
5516 */
5517 @Deprecated
5518 public Intent putExtra(String name, IBinder value) {
5519 if (mExtras == null) {
5520 mExtras = new Bundle();
5521 }
5522 mExtras.putIBinder(name, value);
5523 return this;
5524 }
5525
5526 /**
5527 * Copy all extras in 'src' in to this intent.
5528 *
5529 * @param src Contains the extras to copy.
5530 *
5531 * @see #putExtra
5532 */
5533 public Intent putExtras(Intent src) {
5534 if (src.mExtras != null) {
5535 if (mExtras == null) {
5536 mExtras = new Bundle(src.mExtras);
5537 } else {
5538 mExtras.putAll(src.mExtras);
5539 }
5540 }
5541 return this;
5542 }
5543
5544 /**
5545 * Add a set of extended data to the intent. The keys must include a package
5546 * prefix, for example the app com.android.contacts would use names
5547 * like "com.android.contacts.ShowAll".
5548 *
5549 * @param extras The Bundle of extras to add to this intent.
5550 *
5551 * @see #putExtra
5552 * @see #removeExtra
5553 */
5554 public Intent putExtras(Bundle extras) {
5555 if (mExtras == null) {
5556 mExtras = new Bundle();
5557 }
5558 mExtras.putAll(extras);
5559 return this;
5560 }
5561
5562 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005563 * Completely replace the extras in the Intent with the extras in the
5564 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005565 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005566 * @param src The exact extras contained in this Intent are copied
5567 * into the target intent, replacing any that were previously there.
5568 */
5569 public Intent replaceExtras(Intent src) {
5570 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5571 return this;
5572 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005573
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005574 /**
5575 * Completely replace the extras in the Intent with the given Bundle of
5576 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005577 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005578 * @param extras The new set of extras in the Intent, or null to erase
5579 * all extras.
5580 */
5581 public Intent replaceExtras(Bundle extras) {
5582 mExtras = extras != null ? new Bundle(extras) : null;
5583 return this;
5584 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005585
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005586 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005587 * Remove extended data from the intent.
5588 *
5589 * @see #putExtra
5590 */
5591 public void removeExtra(String name) {
5592 if (mExtras != null) {
5593 mExtras.remove(name);
5594 if (mExtras.size() == 0) {
5595 mExtras = null;
5596 }
5597 }
5598 }
5599
5600 /**
5601 * Set special flags controlling how this intent is handled. Most values
5602 * here depend on the type of component being executed by the Intent,
5603 * specifically the FLAG_ACTIVITY_* flags are all for use with
5604 * {@link Context#startActivity Context.startActivity()} and the
5605 * FLAG_RECEIVER_* flags are all for use with
5606 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5607 *
Scott Main7aee61f2011-02-08 11:25:01 -08005608 * <p>See the
5609 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5610 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005611 * the behavior of your application.
5612 *
5613 * @param flags The desired flags.
5614 *
5615 * @return Returns the same Intent object, for chaining multiple calls
5616 * into a single statement.
5617 *
5618 * @see #getFlags
5619 * @see #addFlags
5620 *
5621 * @see #FLAG_GRANT_READ_URI_PERMISSION
5622 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5623 * @see #FLAG_DEBUG_LOG_RESOLUTION
5624 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005625 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005626 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005627 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005628 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005629 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5630 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005631 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005632 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5633 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005634 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005635 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005636 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005637 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5638 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005639 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005640 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005641 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005642 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5643 */
5644 public Intent setFlags(int flags) {
5645 mFlags = flags;
5646 return this;
5647 }
5648
5649 /**
5650 * Add additional flags to the intent (or with existing flags
5651 * value).
5652 *
5653 * @param flags The new flags to set.
5654 *
5655 * @return Returns the same Intent object, for chaining multiple calls
5656 * into a single statement.
5657 *
5658 * @see #setFlags
5659 */
5660 public Intent addFlags(int flags) {
5661 mFlags |= flags;
5662 return this;
5663 }
5664
5665 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005666 * (Usually optional) Set an explicit application package name that limits
5667 * the components this Intent will resolve to. If left to the default
5668 * value of null, all components in all applications will considered.
5669 * If non-null, the Intent can only match the components in the given
5670 * application package.
5671 *
5672 * @param packageName The name of the application package to handle the
5673 * intent, or null to allow any application package.
5674 *
5675 * @return Returns the same Intent object, for chaining multiple calls
5676 * into a single statement.
5677 *
5678 * @see #getPackage
5679 * @see #resolveActivity
5680 */
5681 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005682 if (packageName != null && mSelector != null) {
5683 throw new IllegalArgumentException(
5684 "Can't set package name when selector is already set");
5685 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005686 mPackage = packageName;
5687 return this;
5688 }
5689
5690 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005691 * (Usually optional) Explicitly set the component to handle the intent.
5692 * If left with the default value of null, the system will determine the
5693 * appropriate class to use based on the other fields (action, data,
5694 * type, categories) in the Intent. If this class is defined, the
5695 * specified class will always be used regardless of the other fields. You
5696 * should only set this value when you know you absolutely want a specific
5697 * class to be used; otherwise it is better to let the system find the
5698 * appropriate class so that you will respect the installed applications
5699 * and user preferences.
5700 *
5701 * @param component The name of the application component to handle the
5702 * intent, or null to let the system find one for you.
5703 *
5704 * @return Returns the same Intent object, for chaining multiple calls
5705 * into a single statement.
5706 *
5707 * @see #setClass
5708 * @see #setClassName(Context, String)
5709 * @see #setClassName(String, String)
5710 * @see #getComponent
5711 * @see #resolveActivity
5712 */
5713 public Intent setComponent(ComponentName component) {
5714 mComponent = component;
5715 return this;
5716 }
5717
5718 /**
5719 * Convenience for calling {@link #setComponent} with an
5720 * explicit class name.
5721 *
5722 * @param packageContext A Context of the application package implementing
5723 * this class.
5724 * @param className The name of a class inside of the application package
5725 * that will be used as the component for this Intent.
5726 *
5727 * @return Returns the same Intent object, for chaining multiple calls
5728 * into a single statement.
5729 *
5730 * @see #setComponent
5731 * @see #setClass
5732 */
5733 public Intent setClassName(Context packageContext, String className) {
5734 mComponent = new ComponentName(packageContext, className);
5735 return this;
5736 }
5737
5738 /**
5739 * Convenience for calling {@link #setComponent} with an
5740 * explicit application package name and class name.
5741 *
5742 * @param packageName The name of the package implementing the desired
5743 * component.
5744 * @param className The name of a class inside of the application package
5745 * that will be used as the component for this Intent.
5746 *
5747 * @return Returns the same Intent object, for chaining multiple calls
5748 * into a single statement.
5749 *
5750 * @see #setComponent
5751 * @see #setClass
5752 */
5753 public Intent setClassName(String packageName, String className) {
5754 mComponent = new ComponentName(packageName, className);
5755 return this;
5756 }
5757
5758 /**
5759 * Convenience for calling {@link #setComponent(ComponentName)} with the
5760 * name returned by a {@link Class} object.
5761 *
5762 * @param packageContext A Context of the application package implementing
5763 * this class.
5764 * @param cls The class name to set, equivalent to
5765 * <code>setClassName(context, cls.getName())</code>.
5766 *
5767 * @return Returns the same Intent object, for chaining multiple calls
5768 * into a single statement.
5769 *
5770 * @see #setComponent
5771 */
5772 public Intent setClass(Context packageContext, Class<?> cls) {
5773 mComponent = new ComponentName(packageContext, cls);
5774 return this;
5775 }
5776
5777 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005778 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5779 * used as a hint to the receiver for animations and the like. Null means that there
5780 * is no source bounds.
5781 */
5782 public void setSourceBounds(Rect r) {
5783 if (r != null) {
5784 mSourceBounds = new Rect(r);
5785 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005786 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005787 }
5788 }
5789
5790 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005791 * Use with {@link #fillIn} to allow the current action value to be
5792 * overwritten, even if it is already set.
5793 */
5794 public static final int FILL_IN_ACTION = 1<<0;
5795
5796 /**
5797 * Use with {@link #fillIn} to allow the current data or type value
5798 * overwritten, even if it is already set.
5799 */
5800 public static final int FILL_IN_DATA = 1<<1;
5801
5802 /**
5803 * Use with {@link #fillIn} to allow the current categories to be
5804 * overwritten, even if they are already set.
5805 */
5806 public static final int FILL_IN_CATEGORIES = 1<<2;
5807
5808 /**
5809 * Use with {@link #fillIn} to allow the current component value to be
5810 * overwritten, even if it is already set.
5811 */
5812 public static final int FILL_IN_COMPONENT = 1<<3;
5813
5814 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005815 * Use with {@link #fillIn} to allow the current package value to be
5816 * overwritten, even if it is already set.
5817 */
5818 public static final int FILL_IN_PACKAGE = 1<<4;
5819
5820 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005821 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005822 * overwritten, even if it is already set.
5823 */
5824 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5825
5826 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005827 * Use with {@link #fillIn} to allow the current selector to be
5828 * overwritten, even if it is already set.
5829 */
5830 public static final int FILL_IN_SELECTOR = 1<<6;
5831
5832 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005833 * Use with {@link #fillIn} to allow the current ClipData to be
5834 * overwritten, even if it is already set.
5835 */
5836 public static final int FILL_IN_CLIP_DATA = 1<<7;
5837
5838 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005839 * Copy the contents of <var>other</var> in to this object, but only
5840 * where fields are not defined by this object. For purposes of a field
5841 * being defined, the following pieces of data in the Intent are
5842 * considered to be separate fields:
5843 *
5844 * <ul>
5845 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08005846 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005847 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5848 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005849 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005850 * <li> component, as set by {@link #setComponent(ComponentName)} or
5851 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005852 * <li> source bounds, as set by {@link #setSourceBounds}.
5853 * <li> selector, as set by {@link #setSelector(Intent)}.
5854 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005855 * <li> each top-level name in the associated extras.
5856 * </ul>
5857 *
5858 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005859 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005860 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
5861 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
5862 * the restriction where the corresponding field will not be replaced if
5863 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005864 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005865 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
5866 * is explicitly specified. The selector will only be copied if
5867 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07005868 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005869 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5870 * and Intent B with {action="gotit", data-type="some/thing",
5871 * categories="one","two"}.
5872 *
5873 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5874 * containing: {action="gotit", data-type="some/thing",
5875 * categories="bar"}.
5876 *
5877 * @param other Another Intent whose values are to be used to fill in
5878 * the current one.
5879 * @param flags Options to control which fields can be filled in.
5880 *
5881 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005882 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005883 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
5884 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005885 */
5886 public int fillIn(Intent other, int flags) {
5887 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005888 if (other.mAction != null
5889 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005890 mAction = other.mAction;
5891 changes |= FILL_IN_ACTION;
5892 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005893 if ((other.mData != null || other.mType != null)
5894 && ((mData == null && mType == null)
5895 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005896 mData = other.mData;
5897 mType = other.mType;
5898 changes |= FILL_IN_DATA;
5899 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005900 if (other.mCategories != null
5901 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005902 if (other.mCategories != null) {
5903 mCategories = new HashSet<String>(other.mCategories);
5904 }
5905 changes |= FILL_IN_CATEGORIES;
5906 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005907 if (other.mPackage != null
5908 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005909 // Only do this if mSelector is not set.
5910 if (mSelector == null) {
5911 mPackage = other.mPackage;
5912 changes |= FILL_IN_PACKAGE;
5913 }
5914 }
5915 // Selector is special: it can only be set if explicitly allowed,
5916 // for the same reason as the component name.
5917 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
5918 if (mPackage == null) {
5919 mSelector = new Intent(other.mSelector);
5920 mPackage = null;
5921 changes |= FILL_IN_SELECTOR;
5922 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005923 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005924 if (other.mClipData != null
5925 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
5926 mClipData = other.mClipData;
5927 changes |= FILL_IN_CLIP_DATA;
5928 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005929 // Component is special: it can -only- be set if explicitly allowed,
5930 // since otherwise the sender could force the intent somewhere the
5931 // originator didn't intend.
5932 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005933 mComponent = other.mComponent;
5934 changes |= FILL_IN_COMPONENT;
5935 }
5936 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005937 if (other.mSourceBounds != null
5938 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5939 mSourceBounds = new Rect(other.mSourceBounds);
5940 changes |= FILL_IN_SOURCE_BOUNDS;
5941 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005942 if (mExtras == null) {
5943 if (other.mExtras != null) {
5944 mExtras = new Bundle(other.mExtras);
5945 }
5946 } else if (other.mExtras != null) {
5947 try {
5948 Bundle newb = new Bundle(other.mExtras);
5949 newb.putAll(mExtras);
5950 mExtras = newb;
5951 } catch (RuntimeException e) {
5952 // Modifying the extras can cause us to unparcel the contents
5953 // of the bundle, and if we do this in the system process that
5954 // may fail. We really should handle this (i.e., the Bundle
5955 // impl shouldn't be on top of a plain map), but for now just
5956 // ignore it and keep the original contents. :(
5957 Log.w("Intent", "Failure filling in extras", e);
5958 }
5959 }
5960 return changes;
5961 }
5962
5963 /**
5964 * Wrapper class holding an Intent and implementing comparisons on it for
5965 * the purpose of filtering. The class implements its
5966 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5967 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5968 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5969 * on the wrapped Intent.
5970 */
5971 public static final class FilterComparison {
5972 private final Intent mIntent;
5973 private final int mHashCode;
5974
5975 public FilterComparison(Intent intent) {
5976 mIntent = intent;
5977 mHashCode = intent.filterHashCode();
5978 }
5979
5980 /**
5981 * Return the Intent that this FilterComparison represents.
5982 * @return Returns the Intent held by the FilterComparison. Do
5983 * not modify!
5984 */
5985 public Intent getIntent() {
5986 return mIntent;
5987 }
5988
5989 @Override
5990 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005991 if (obj instanceof FilterComparison) {
5992 Intent other = ((FilterComparison)obj).mIntent;
5993 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005994 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005995 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005996 }
5997
5998 @Override
5999 public int hashCode() {
6000 return mHashCode;
6001 }
6002 }
6003
6004 /**
6005 * Determine if two intents are the same for the purposes of intent
6006 * resolution (filtering). That is, if their action, data, type,
6007 * class, and categories are the same. This does <em>not</em> compare
6008 * any extra data included in the intents.
6009 *
6010 * @param other The other Intent to compare against.
6011 *
6012 * @return Returns true if action, data, type, class, and categories
6013 * are the same.
6014 */
6015 public boolean filterEquals(Intent other) {
6016 if (other == null) {
6017 return false;
6018 }
6019 if (mAction != other.mAction) {
6020 if (mAction != null) {
6021 if (!mAction.equals(other.mAction)) {
6022 return false;
6023 }
6024 } else {
6025 if (!other.mAction.equals(mAction)) {
6026 return false;
6027 }
6028 }
6029 }
6030 if (mData != other.mData) {
6031 if (mData != null) {
6032 if (!mData.equals(other.mData)) {
6033 return false;
6034 }
6035 } else {
6036 if (!other.mData.equals(mData)) {
6037 return false;
6038 }
6039 }
6040 }
6041 if (mType != other.mType) {
6042 if (mType != null) {
6043 if (!mType.equals(other.mType)) {
6044 return false;
6045 }
6046 } else {
6047 if (!other.mType.equals(mType)) {
6048 return false;
6049 }
6050 }
6051 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006052 if (mPackage != other.mPackage) {
6053 if (mPackage != null) {
6054 if (!mPackage.equals(other.mPackage)) {
6055 return false;
6056 }
6057 } else {
6058 if (!other.mPackage.equals(mPackage)) {
6059 return false;
6060 }
6061 }
6062 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006063 if (mComponent != other.mComponent) {
6064 if (mComponent != null) {
6065 if (!mComponent.equals(other.mComponent)) {
6066 return false;
6067 }
6068 } else {
6069 if (!other.mComponent.equals(mComponent)) {
6070 return false;
6071 }
6072 }
6073 }
6074 if (mCategories != other.mCategories) {
6075 if (mCategories != null) {
6076 if (!mCategories.equals(other.mCategories)) {
6077 return false;
6078 }
6079 } else {
6080 if (!other.mCategories.equals(mCategories)) {
6081 return false;
6082 }
6083 }
6084 }
6085
6086 return true;
6087 }
6088
6089 /**
6090 * Generate hash code that matches semantics of filterEquals().
6091 *
6092 * @return Returns the hash value of the action, data, type, class, and
6093 * categories.
6094 *
6095 * @see #filterEquals
6096 */
6097 public int filterHashCode() {
6098 int code = 0;
6099 if (mAction != null) {
6100 code += mAction.hashCode();
6101 }
6102 if (mData != null) {
6103 code += mData.hashCode();
6104 }
6105 if (mType != null) {
6106 code += mType.hashCode();
6107 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006108 if (mPackage != null) {
6109 code += mPackage.hashCode();
6110 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006111 if (mComponent != null) {
6112 code += mComponent.hashCode();
6113 }
6114 if (mCategories != null) {
6115 code += mCategories.hashCode();
6116 }
6117 return code;
6118 }
6119
6120 @Override
6121 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006122 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006123
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006124 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006125 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006126 b.append(" }");
6127
6128 return b.toString();
6129 }
6130
6131 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006132 public String toInsecureString() {
6133 StringBuilder b = new StringBuilder(128);
6134
6135 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006136 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006137 b.append(" }");
6138
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006139 return b.toString();
6140 }
Romain Guy4969af72009-06-17 10:53:19 -07006141
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006142 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006143 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006144 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006145
6146 b.append("Intent { ");
6147 toShortString(b, false, true, true, true);
6148 b.append(" }");
6149
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006150 return b.toString();
6151 }
6152
6153 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006154 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6155 StringBuilder b = new StringBuilder(128);
6156 toShortString(b, secure, comp, extras, clip);
6157 return b.toString();
6158 }
6159
6160 /** @hide */
6161 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6162 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006163 boolean first = true;
6164 if (mAction != null) {
6165 b.append("act=").append(mAction);
6166 first = false;
6167 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006168 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006169 if (!first) {
6170 b.append(' ');
6171 }
6172 first = false;
6173 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006174 Iterator<String> i = mCategories.iterator();
6175 boolean didone = false;
6176 while (i.hasNext()) {
6177 if (didone) b.append(",");
6178 didone = true;
6179 b.append(i.next());
6180 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006181 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006182 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006183 if (mData != null) {
6184 if (!first) {
6185 b.append(' ');
6186 }
6187 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006188 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006189 if (secure) {
6190 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006191 } else {
6192 b.append(mData);
6193 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006194 }
6195 if (mType != null) {
6196 if (!first) {
6197 b.append(' ');
6198 }
6199 first = false;
6200 b.append("typ=").append(mType);
6201 }
6202 if (mFlags != 0) {
6203 if (!first) {
6204 b.append(' ');
6205 }
6206 first = false;
6207 b.append("flg=0x").append(Integer.toHexString(mFlags));
6208 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006209 if (mPackage != null) {
6210 if (!first) {
6211 b.append(' ');
6212 }
6213 first = false;
6214 b.append("pkg=").append(mPackage);
6215 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006216 if (comp && mComponent != null) {
6217 if (!first) {
6218 b.append(' ');
6219 }
6220 first = false;
6221 b.append("cmp=").append(mComponent.flattenToShortString());
6222 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006223 if (mSourceBounds != null) {
6224 if (!first) {
6225 b.append(' ');
6226 }
6227 first = false;
6228 b.append("bnds=").append(mSourceBounds.toShortString());
6229 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006230 if (mClipData != null) {
6231 if (!first) {
6232 b.append(' ');
6233 }
6234 first = false;
6235 if (clip) {
6236 b.append("clip={");
6237 mClipData.toShortString(b);
6238 b.append('}');
6239 } else {
6240 b.append("(has clip)");
6241 }
6242 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006243 if (extras && mExtras != null) {
6244 if (!first) {
6245 b.append(' ');
6246 }
6247 first = false;
6248 b.append("(has extras)");
6249 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006250 if (mSelector != null) {
6251 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006252 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006253 b.append("}");
6254 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006255 }
6256
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006257 /**
6258 * Call {@link #toUri} with 0 flags.
6259 * @deprecated Use {@link #toUri} instead.
6260 */
6261 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006262 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006263 return toUri(0);
6264 }
6265
6266 /**
6267 * Convert this Intent into a String holding a URI representation of it.
6268 * The returned URI string has been properly URI encoded, so it can be
6269 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6270 * Intent's data as the base URI, with an additional fragment describing
6271 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006272 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006273 * <p>You can convert the returned string back to an Intent with
6274 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006275 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006276 * @param flags Additional operating flags. Either 0 or
6277 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006278 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006279 * @return Returns a URI encoding URI string describing the entire contents
6280 * of the Intent.
6281 */
6282 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006283 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006284 String scheme = null;
6285 if (mData != null) {
6286 String data = mData.toString();
6287 if ((flags&URI_INTENT_SCHEME) != 0) {
6288 final int N = data.length();
6289 for (int i=0; i<N; i++) {
6290 char c = data.charAt(i);
6291 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6292 || c == '.' || c == '-') {
6293 continue;
6294 }
6295 if (c == ':' && i > 0) {
6296 // Valid scheme.
6297 scheme = data.substring(0, i);
6298 uri.append("intent:");
6299 data = data.substring(i+1);
6300 break;
6301 }
Tom Taylord4a47292009-12-21 13:59:18 -08006302
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006303 // No scheme.
6304 break;
6305 }
6306 }
6307 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006308
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006309 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6310 uri.append("intent:");
6311 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006312
6313 uri.append("#Intent;");
6314
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006315 toUriInner(uri, scheme, flags);
6316 if (mSelector != null) {
6317 uri.append("SEL;");
6318 // Note that for now we are not going to try to handle the
6319 // data part; not clear how to represent this as a URI, and
6320 // not much utility in it.
6321 mSelector.toUriInner(uri, null, flags);
6322 }
6323
6324 uri.append("end");
6325
6326 return uri.toString();
6327 }
6328
6329 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006330 if (scheme != null) {
6331 uri.append("scheme=").append(scheme).append(';');
6332 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006333 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006334 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006335 }
6336 if (mCategories != null) {
6337 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006338 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006339 }
6340 }
6341 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006342 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006343 }
6344 if (mFlags != 0) {
6345 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6346 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006347 if (mPackage != null) {
6348 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6349 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006350 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006351 uri.append("component=").append(Uri.encode(
6352 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006353 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006354 if (mSourceBounds != null) {
6355 uri.append("sourceBounds=")
6356 .append(Uri.encode(mSourceBounds.flattenToString()))
6357 .append(';');
6358 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006359 if (mExtras != null) {
6360 for (String key : mExtras.keySet()) {
6361 final Object value = mExtras.get(key);
6362 char entryType =
6363 value instanceof String ? 'S' :
6364 value instanceof Boolean ? 'B' :
6365 value instanceof Byte ? 'b' :
6366 value instanceof Character ? 'c' :
6367 value instanceof Double ? 'd' :
6368 value instanceof Float ? 'f' :
6369 value instanceof Integer ? 'i' :
6370 value instanceof Long ? 'l' :
6371 value instanceof Short ? 's' :
6372 '\0';
6373
6374 if (entryType != '\0') {
6375 uri.append(entryType);
6376 uri.append('.');
6377 uri.append(Uri.encode(key));
6378 uri.append('=');
6379 uri.append(Uri.encode(value.toString()));
6380 uri.append(';');
6381 }
6382 }
6383 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006384 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006385
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006386 public int describeContents() {
6387 return (mExtras != null) ? mExtras.describeContents() : 0;
6388 }
6389
6390 public void writeToParcel(Parcel out, int flags) {
6391 out.writeString(mAction);
6392 Uri.writeToParcel(out, mData);
6393 out.writeString(mType);
6394 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006395 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006396 ComponentName.writeToParcel(mComponent, out);
6397
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006398 if (mSourceBounds != null) {
6399 out.writeInt(1);
6400 mSourceBounds.writeToParcel(out, flags);
6401 } else {
6402 out.writeInt(0);
6403 }
6404
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006405 if (mCategories != null) {
6406 out.writeInt(mCategories.size());
6407 for (String category : mCategories) {
6408 out.writeString(category);
6409 }
6410 } else {
6411 out.writeInt(0);
6412 }
6413
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006414 if (mSelector != null) {
6415 out.writeInt(1);
6416 mSelector.writeToParcel(out, flags);
6417 } else {
6418 out.writeInt(0);
6419 }
6420
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006421 if (mClipData != null) {
6422 out.writeInt(1);
6423 mClipData.writeToParcel(out, flags);
6424 } else {
6425 out.writeInt(0);
6426 }
6427
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006428 out.writeBundle(mExtras);
6429 }
6430
6431 public static final Parcelable.Creator<Intent> CREATOR
6432 = new Parcelable.Creator<Intent>() {
6433 public Intent createFromParcel(Parcel in) {
6434 return new Intent(in);
6435 }
6436 public Intent[] newArray(int size) {
6437 return new Intent[size];
6438 }
6439 };
6440
Dianne Hackborneb034652009-09-07 00:49:58 -07006441 /** @hide */
6442 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006443 readFromParcel(in);
6444 }
6445
6446 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006447 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006448 mData = Uri.CREATOR.createFromParcel(in);
6449 mType = in.readString();
6450 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006451 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006452 mComponent = ComponentName.readFromParcel(in);
6453
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006454 if (in.readInt() != 0) {
6455 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6456 }
6457
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006458 int N = in.readInt();
6459 if (N > 0) {
6460 mCategories = new HashSet<String>();
6461 int i;
6462 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006463 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006464 }
6465 } else {
6466 mCategories = null;
6467 }
6468
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006469 if (in.readInt() != 0) {
6470 mSelector = new Intent(in);
6471 }
6472
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006473 if (in.readInt() != 0) {
6474 mClipData = new ClipData(in);
6475 }
6476
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006477 mExtras = in.readBundle();
6478 }
6479
6480 /**
6481 * Parses the "intent" element (and its children) from XML and instantiates
6482 * an Intent object. The given XML parser should be located at the tag
6483 * where parsing should start (often named "intent"), from which the
6484 * basic action, data, type, and package and class name will be
6485 * retrieved. The function will then parse in to any child elements,
6486 * looking for <category android:name="xxx"> tags to add categories and
6487 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6488 * to the intent.
6489 *
6490 * @param resources The Resources to use when inflating resources.
6491 * @param parser The XML parser pointing at an "intent" tag.
6492 * @param attrs The AttributeSet interface for retrieving extended
6493 * attribute data at the current <var>parser</var> location.
6494 * @return An Intent object matching the XML data.
6495 * @throws XmlPullParserException If there was an XML parsing error.
6496 * @throws IOException If there was an I/O error.
6497 */
6498 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6499 throws XmlPullParserException, IOException {
6500 Intent intent = new Intent();
6501
6502 TypedArray sa = resources.obtainAttributes(attrs,
6503 com.android.internal.R.styleable.Intent);
6504
6505 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6506
6507 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6508 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6509 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6510
6511 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6512 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6513 if (packageName != null && className != null) {
6514 intent.setComponent(new ComponentName(packageName, className));
6515 }
6516
6517 sa.recycle();
6518
6519 int outerDepth = parser.getDepth();
6520 int type;
6521 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6522 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6523 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6524 continue;
6525 }
6526
6527 String nodeName = parser.getName();
6528 if (nodeName.equals("category")) {
6529 sa = resources.obtainAttributes(attrs,
6530 com.android.internal.R.styleable.IntentCategory);
6531 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6532 sa.recycle();
6533
6534 if (cat != null) {
6535 intent.addCategory(cat);
6536 }
6537 XmlUtils.skipCurrentTag(parser);
6538
6539 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006540 if (intent.mExtras == null) {
6541 intent.mExtras = new Bundle();
6542 }
6543 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6544 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006545
6546 } else {
6547 XmlUtils.skipCurrentTag(parser);
6548 }
6549 }
6550
6551 return intent;
6552 }
Nick Pellyccae4122012-01-09 14:12:58 -08006553
6554 /**
6555 * Normalize a MIME data type.
6556 *
6557 * <p>A normalized MIME type has white-space trimmed,
6558 * content-type parameters removed, and is lower-case.
6559 * This aligns the type with Android best practices for
6560 * intent filtering.
6561 *
6562 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6563 * "text/x-vCard" becomes "text/x-vcard".
6564 *
6565 * <p>All MIME types received from outside Android (such as user input,
6566 * or external sources like Bluetooth, NFC, or the Internet) should
6567 * be normalized before they are used to create an Intent.
6568 *
6569 * @param type MIME data type to normalize
6570 * @return normalized MIME data type, or null if the input was null
6571 * @see {@link #setType}
6572 * @see {@link #setTypeAndNormalize}
6573 */
6574 public static String normalizeMimeType(String type) {
6575 if (type == null) {
6576 return null;
6577 }
6578
6579 type = type.trim().toLowerCase(Locale.US);
6580
6581 final int semicolonIndex = type.indexOf(';');
6582 if (semicolonIndex != -1) {
6583 type = type.substring(0, semicolonIndex);
6584 }
6585 return type;
6586 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006587
6588 /**
6589 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
6590 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}.
6591 *
6592 * @hide
6593 */
6594 public void migrateExtraStreamToClipData() {
6595 // Refuse to touch if extras already parcelled
6596 if (mExtras != null && mExtras.isParcelled()) return;
6597
6598 // Bail when someone already gave us ClipData
6599 if (getClipData() != null) return;
6600
6601 final String action = getAction();
6602 if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006603 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006604 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6605 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6606 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6607 if (stream != null || text != null || htmlText != null) {
6608 final ClipData clipData = new ClipData(
6609 null, new String[] { getType() },
6610 new ClipData.Item(text, htmlText, null, stream));
6611 setClipData(clipData);
6612 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
6613 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006614 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006615 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006616
6617 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006618 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006619 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6620 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6621 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6622 int num = -1;
6623 if (streams != null) {
6624 num = streams.size();
6625 }
6626 if (texts != null) {
6627 if (num >= 0 && num != texts.size()) {
6628 // Wha...! F- you.
6629 return;
6630 }
6631 num = texts.size();
6632 }
6633 if (htmlTexts != null) {
6634 if (num >= 0 && num != htmlTexts.size()) {
6635 // Wha...! F- you.
6636 return;
6637 }
6638 num = htmlTexts.size();
6639 }
6640 if (num > 0) {
6641 final ClipData clipData = new ClipData(
6642 null, new String[] { getType() },
6643 makeClipItem(streams, texts, htmlTexts, 0));
6644
6645 for (int i = 1; i < num; i++) {
6646 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6647 }
6648
6649 setClipData(clipData);
6650 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
6651 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006652 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006653 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006654 }
6655 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006656
6657 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6658 ArrayList<String> htmlTexts, int which) {
6659 Uri uri = streams != null ? streams.get(which) : null;
6660 CharSequence text = texts != null ? texts.get(which) : null;
6661 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6662 return new ClipData.Item(text, htmlText, null, uri);
6663 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006664}