blob: 19e43727f7c8a74aa9a422269cfb438345dc9d5a [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
19import org.xmlpull.v1.XmlPullParser;
20import org.xmlpull.v1.XmlPullParserException;
21
22import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
24import android.content.pm.ActivityInfo;
25import android.content.pm.PackageManager;
26import android.content.pm.ResolveInfo;
27import android.content.res.Resources;
28import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080029import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.net.Uri;
31import android.os.Bundle;
32import android.os.IBinder;
33import android.os.Parcel;
34import android.os.Parcelable;
35import android.util.AttributeSet;
36import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080037
38import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039
40import java.io.IOException;
41import java.io.Serializable;
42import java.net.URISyntaxException;
43import java.util.ArrayList;
44import java.util.HashSet;
45import java.util.Iterator;
Nick Pellyccae4122012-01-09 14:12:58 -080046import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070047import java.util.Set;
48
49/**
50 * An intent is an abstract description of an operation to be performed. It
51 * can be used with {@link Context#startActivity(Intent) startActivity} to
52 * launch an {@link android.app.Activity},
53 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
54 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
55 * and {@link android.content.Context#startService} or
56 * {@link android.content.Context#bindService} to communicate with a
57 * background {@link android.app.Service}.
58 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070059 * <p>An Intent provides a facility for performing late runtime binding between the code in
60 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070061 * can be thought of as the glue between activities. It is basically a passive data structure
62 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070063 *
64 * <div class="special reference">
65 * <h3>Developer Guides</h3>
66 * <p>For information about how to create and resolve intents, read the
67 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
68 * developer guide.</p>
69 * </div>
70 *
71 * <a name="IntentStructure"></a>
72 * <h3>Intent Structure</h3>
73 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070074 *
75 * <ul>
76 * <li> <p><b>action</b> -- The general action to be performed, such as
77 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
78 * etc.</p>
79 * </li>
80 * <li> <p><b>data</b> -- The data to operate on, such as a person record
81 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
82 * </li>
83 * </ul>
84 *
85 *
86 * <p>Some examples of action/data pairs are:</p>
87 *
88 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070089 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070090 * information about the person whose identifier is "1".</p>
91 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * the phone dialer with the person filled in.</p>
94 * </li>
95 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
96 * the phone dialer with the given number filled in. Note how the
97 * VIEW action does what what is considered the most reasonable thing for
98 * a particular URI.</p>
99 * </li>
100 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
101 * the phone dialer with the given number filled in.</p>
102 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700103 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700104 * information about the person whose identifier is "1".</p>
105 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700106 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700107 * a list of people, which the user can browse through. This example is a
108 * typical top-level entry into the Contacts application, showing you the
109 * list of people. Selecting a particular person to view would result in a
110 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
111 * being used to start an activity to display that person.</p>
112 * </li>
113 * </ul>
114 *
115 * <p>In addition to these primary attributes, there are a number of secondary
116 * attributes that you can also include with an intent:</p>
117 *
118 * <ul>
119 * <li> <p><b>category</b> -- Gives additional information about the action
120 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
121 * appear in the Launcher as a top-level application, while
122 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
123 * of alternative actions the user can perform on a piece of data.</p>
124 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
125 * intent data. Normally the type is inferred from the data itself.
126 * By setting this attribute, you disable that evaluation and force
127 * an explicit type.</p>
128 * <li> <p><b>component</b> -- Specifies an explicit name of a component
129 * class to use for the intent. Normally this is determined by looking
130 * at the other information in the intent (the action, data/type, and
131 * categories) and matching that with a component that can handle it.
132 * If this attribute is set then none of the evaluation is performed,
133 * and this component is used exactly as is. By specifying this attribute,
134 * all of the other Intent attributes become optional.</p>
135 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
136 * This can be used to provide extended information to the component.
137 * For example, if we have a action to send an e-mail message, we could
138 * also include extra pieces of data here to supply a subject, body,
139 * etc.</p>
140 * </ul>
141 *
142 * <p>Here are some examples of other operations you can specify as intents
143 * using these additional parameters:</p>
144 *
145 * <ul>
146 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
147 * Launch the home screen.</p>
148 * </li>
149 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
150 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
151 * vnd.android.cursor.item/phone}</i></b>
152 * -- Display the list of people's phone numbers, allowing the user to
153 * browse through them and pick one and return it to the parent activity.</p>
154 * </li>
155 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
156 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
157 * -- Display all pickers for data that can be opened with
158 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
159 * allowing the user to pick one of them and then some data inside of it
160 * and returning the resulting URI to the caller. This can be used,
161 * for example, in an e-mail application to allow the user to pick some
162 * data to include as an attachment.</p>
163 * </li>
164 * </ul>
165 *
166 * <p>There are a variety of standard Intent action and category constants
167 * defined in the Intent class, but applications can also define their own.
168 * These strings use java style scoping, to ensure they are unique -- for
169 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700170 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700171 *
172 * <p>Put together, the set of actions, data types, categories, and extra data
173 * defines a language for the system allowing for the expression of phrases
174 * such as "call john smith's cell". As applications are added to the system,
175 * they can extend this language by adding new actions, types, and categories, or
176 * they can modify the behavior of existing phrases by supplying their own
177 * activities that handle them.</p>
178 *
179 * <a name="IntentResolution"></a>
180 * <h3>Intent Resolution</h3>
181 *
182 * <p>There are two primary forms of intents you will use.
183 *
184 * <ul>
185 * <li> <p><b>Explicit Intents</b> have specified a component (via
186 * {@link #setComponent} or {@link #setClass}), which provides the exact
187 * class to be run. Often these will not include any other information,
188 * simply being a way for an application to launch various internal
189 * activities it has as the user interacts with the application.
190 *
191 * <li> <p><b>Implicit Intents</b> have not specified a component;
192 * instead, they must include enough information for the system to
193 * determine which of the available components is best to run for that
194 * intent.
195 * </ul>
196 *
197 * <p>When using implicit intents, given such an arbitrary intent we need to
198 * know what to do with it. This is handled by the process of <em>Intent
199 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
200 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
201 * more activities/receivers) that can handle it.</p>
202 *
203 * <p>The intent resolution mechanism basically revolves around matching an
204 * Intent against all of the &lt;intent-filter&gt; descriptions in the
205 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
206 * objects explicitly registered with {@link Context#registerReceiver}.) More
207 * details on this can be found in the documentation on the {@link
208 * IntentFilter} class.</p>
209 *
210 * <p>There are three pieces of information in the Intent that are used for
211 * resolution: the action, type, and category. Using this information, a query
212 * is done on the {@link PackageManager} for a component that can handle the
213 * intent. The appropriate component is determined based on the intent
214 * information supplied in the <code>AndroidManifest.xml</code> file as
215 * follows:</p>
216 *
217 * <ul>
218 * <li> <p>The <b>action</b>, if given, must be listed by the component as
219 * one it handles.</p>
220 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
221 * already supplied in the Intent. Like the action, if a type is
222 * included in the intent (either explicitly or implicitly in its
223 * data), then this must be listed by the component as one it handles.</p>
224 * <li> For data that is not a <code>content:</code> URI and where no explicit
225 * type is included in the Intent, instead the <b>scheme</b> of the
226 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
227 * considered. Again like the action, if we are matching a scheme it
228 * must be listed by the component as one it can handle.
229 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
230 * by the activity as categories it handles. That is, if you include
231 * the categories {@link #CATEGORY_LAUNCHER} and
232 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
233 * with an intent that lists <em>both</em> of those categories.
234 * Activities will very often need to support the
235 * {@link #CATEGORY_DEFAULT} so that they can be found by
236 * {@link Context#startActivity Context.startActivity()}.</p>
237 * </ul>
238 *
239 * <p>For example, consider the Note Pad sample application that
240 * allows user to browse through a list of notes data and view details about
241 * individual items. Text in italics indicate places were you would replace a
242 * name with one specific to your own package.</p>
243 *
244 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
245 * package="<i>com.android.notepad</i>"&gt;
246 * &lt;application android:icon="@drawable/app_notes"
247 * android:label="@string/app_name"&gt;
248 *
249 * &lt;provider class=".NotePadProvider"
250 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
251 *
252 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
253 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700254 * &lt;action android:name="android.intent.action.MAIN" /&gt;
255 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700256 * &lt;/intent-filter&gt;
257 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700258 * &lt;action android:name="android.intent.action.VIEW" /&gt;
259 * &lt;action android:name="android.intent.action.EDIT" /&gt;
260 * &lt;action android:name="android.intent.action.PICK" /&gt;
261 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
262 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700263 * &lt;/intent-filter&gt;
264 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700265 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
266 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
267 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700268 * &lt;/intent-filter&gt;
269 * &lt;/activity&gt;
270 *
271 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
272 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700273 * &lt;action android:name="android.intent.action.VIEW" /&gt;
274 * &lt;action android:name="android.intent.action.EDIT" /&gt;
275 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
276 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 *
279 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700280 * &lt;action android:name="android.intent.action.INSERT" /&gt;
281 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
282 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700283 * &lt;/intent-filter&gt;
284 *
285 * &lt;/activity&gt;
286 *
287 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
288 * android:theme="@android:style/Theme.Dialog"&gt;
289 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
293 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 * &lt;/activity&gt;
297 *
298 * &lt;/application&gt;
299 * &lt;/manifest&gt;</pre>
300 *
301 * <p>The first activity,
302 * <code>com.android.notepad.NotesList</code>, serves as our main
303 * entry into the app. It can do three things as described by its three intent
304 * templates:
305 * <ol>
306 * <li><pre>
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
309 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700310 * &lt;/intent-filter&gt;</pre>
311 * <p>This provides a top-level entry into the NotePad application: the standard
312 * MAIN action is a main entry point (not requiring any other information in
313 * the Intent), and the LAUNCHER category says that this entry point should be
314 * listed in the application launcher.</p>
315 * <li><pre>
316 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700317 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
318 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
319 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
320 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
321 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700322 * &lt;/intent-filter&gt;</pre>
323 * <p>This declares the things that the activity can do on a directory of
324 * notes. The type being supported is given with the &lt;type&gt; tag, where
325 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
326 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
327 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
328 * The activity allows the user to view or edit the directory of data (via
329 * the VIEW and EDIT actions), or to pick a particular note and return it
330 * to the caller (via the PICK action). Note also the DEFAULT category
331 * supplied here: this is <em>required</em> for the
332 * {@link Context#startActivity Context.startActivity} method to resolve your
333 * activity when its component name is not explicitly specified.</p>
334 * <li><pre>
335 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700336 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
337 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
338 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700339 * &lt;/intent-filter&gt;</pre>
340 * <p>This filter describes the ability return to the caller a note selected by
341 * the user without needing to know where it came from. The data type
342 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
343 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
344 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
345 * The GET_CONTENT action is similar to the PICK action, where the activity
346 * will return to its caller a piece of data selected by the user. Here,
347 * however, the caller specifies the type of data they desire instead of
348 * the type of data the user will be picking from.</p>
349 * </ol>
350 *
351 * <p>Given these capabilities, the following intents will resolve to the
352 * NotesList activity:</p>
353 *
354 * <ul>
355 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
356 * activities that can be used as top-level entry points into an
357 * application.</p>
358 * <li> <p><b>{ action=android.app.action.MAIN,
359 * category=android.app.category.LAUNCHER }</b> is the actual intent
360 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700361 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * data=content://com.google.provider.NotePad/notes }</b>
363 * displays a list of all the notes under
364 * "content://com.google.provider.NotePad/notes", which
365 * the user can browse through and see the details on.</p>
366 * <li> <p><b>{ action=android.app.action.PICK
367 * data=content://com.google.provider.NotePad/notes }</b>
368 * provides a list of the notes under
369 * "content://com.google.provider.NotePad/notes", from which
370 * the user can pick a note whose data URL is returned back to the caller.</p>
371 * <li> <p><b>{ action=android.app.action.GET_CONTENT
372 * type=vnd.android.cursor.item/vnd.google.note }</b>
373 * is similar to the pick action, but allows the caller to specify the
374 * kind of data they want back so that the system can find the appropriate
375 * activity to pick something of that data type.</p>
376 * </ul>
377 *
378 * <p>The second activity,
379 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
380 * note entry and allows them to edit it. It can do two things as described
381 * by its two intent templates:
382 * <ol>
383 * <li><pre>
384 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700385 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
386 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
387 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
388 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700389 * &lt;/intent-filter&gt;</pre>
390 * <p>The first, primary, purpose of this activity is to let the user interact
391 * with a single note, as decribed by the MIME type
392 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
393 * either VIEW a note or allow the user to EDIT it. Again we support the
394 * DEFAULT category to allow the activity to be launched without explicitly
395 * specifying its component.</p>
396 * <li><pre>
397 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700398 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
399 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
400 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700401 * &lt;/intent-filter&gt;</pre>
402 * <p>The secondary use of this activity is to insert a new note entry into
403 * an existing directory of notes. This is used when the user creates a new
404 * note: the INSERT action is executed on the directory of notes, causing
405 * this activity to run and have the user create the new note data which
406 * it then adds to the content provider.</p>
407 * </ol>
408 *
409 * <p>Given these capabilities, the following intents will resolve to the
410 * NoteEditor activity:</p>
411 *
412 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700413 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700414 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
415 * shows the user the content of note <var>{ID}</var>.</p>
416 * <li> <p><b>{ action=android.app.action.EDIT
417 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
418 * allows the user to edit the content of note <var>{ID}</var>.</p>
419 * <li> <p><b>{ action=android.app.action.INSERT
420 * data=content://com.google.provider.NotePad/notes }</b>
421 * creates a new, empty note in the notes list at
422 * "content://com.google.provider.NotePad/notes"
423 * and allows the user to edit it. If they keep their changes, the URI
424 * of the newly created note is returned to the caller.</p>
425 * </ul>
426 *
427 * <p>The last activity,
428 * <code>com.android.notepad.TitleEditor</code>, allows the user to
429 * edit the title of a note. This could be implemented as a class that the
430 * application directly invokes (by explicitly setting its component in
431 * the Intent), but here we show a way you can publish alternative
432 * operations on existing data:</p>
433 *
434 * <pre>
435 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700436 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
437 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
438 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
439 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
440 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700441 * &lt;/intent-filter&gt;</pre>
442 *
443 * <p>In the single intent template here, we
444 * have created our own private action called
445 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
446 * edit the title of a note. It must be invoked on a specific note
447 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
448 * view and edit actions, but here displays and edits the title contained
449 * in the note data.
450 *
451 * <p>In addition to supporting the default category as usual, our title editor
452 * also supports two other standard categories: ALTERNATIVE and
453 * SELECTED_ALTERNATIVE. Implementing
454 * these categories allows others to find the special action it provides
455 * without directly knowing about it, through the
456 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
457 * more often to build dynamic menu items with
458 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
459 * template here was also supply an explicit name for the template
460 * (via <code>android:label="@string/resolve_title"</code>) to better control
461 * what the user sees when presented with this activity as an alternative
462 * action to the data they are viewing.
463 *
464 * <p>Given these capabilities, the following intent will resolve to the
465 * TitleEditor activity:</p>
466 *
467 * <ul>
468 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
469 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
470 * displays and allows the user to edit the title associated
471 * with note <var>{ID}</var>.</p>
472 * </ul>
473 *
474 * <h3>Standard Activity Actions</h3>
475 *
476 * <p>These are the current standard actions that Intent defines for launching
477 * activities (usually through {@link Context#startActivity}. The most
478 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
479 * {@link #ACTION_EDIT}.
480 *
481 * <ul>
482 * <li> {@link #ACTION_MAIN}
483 * <li> {@link #ACTION_VIEW}
484 * <li> {@link #ACTION_ATTACH_DATA}
485 * <li> {@link #ACTION_EDIT}
486 * <li> {@link #ACTION_PICK}
487 * <li> {@link #ACTION_CHOOSER}
488 * <li> {@link #ACTION_GET_CONTENT}
489 * <li> {@link #ACTION_DIAL}
490 * <li> {@link #ACTION_CALL}
491 * <li> {@link #ACTION_SEND}
492 * <li> {@link #ACTION_SENDTO}
493 * <li> {@link #ACTION_ANSWER}
494 * <li> {@link #ACTION_INSERT}
495 * <li> {@link #ACTION_DELETE}
496 * <li> {@link #ACTION_RUN}
497 * <li> {@link #ACTION_SYNC}
498 * <li> {@link #ACTION_PICK_ACTIVITY}
499 * <li> {@link #ACTION_SEARCH}
500 * <li> {@link #ACTION_WEB_SEARCH}
501 * <li> {@link #ACTION_FACTORY_TEST}
502 * </ul>
503 *
504 * <h3>Standard Broadcast Actions</h3>
505 *
506 * <p>These are the current standard actions that Intent defines for receiving
507 * broadcasts (usually through {@link Context#registerReceiver} or a
508 * &lt;receiver&gt; tag in a manifest).
509 *
510 * <ul>
511 * <li> {@link #ACTION_TIME_TICK}
512 * <li> {@link #ACTION_TIME_CHANGED}
513 * <li> {@link #ACTION_TIMEZONE_CHANGED}
514 * <li> {@link #ACTION_BOOT_COMPLETED}
515 * <li> {@link #ACTION_PACKAGE_ADDED}
516 * <li> {@link #ACTION_PACKAGE_CHANGED}
517 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800518 * <li> {@link #ACTION_PACKAGE_RESTARTED}
519 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700520 * <li> {@link #ACTION_UID_REMOVED}
521 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700522 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700523 * <li> {@link #ACTION_POWER_DISCONNECTED}
524 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700525 * </ul>
526 *
527 * <h3>Standard Categories</h3>
528 *
529 * <p>These are the current standard categories that can be used to further
530 * clarify an Intent via {@link #addCategory}.
531 *
532 * <ul>
533 * <li> {@link #CATEGORY_DEFAULT}
534 * <li> {@link #CATEGORY_BROWSABLE}
535 * <li> {@link #CATEGORY_TAB}
536 * <li> {@link #CATEGORY_ALTERNATIVE}
537 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
538 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700540 * <li> {@link #CATEGORY_HOME}
541 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700542 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400543 * <li> {@link #CATEGORY_CAR_DOCK}
544 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500545 * <li> {@link #CATEGORY_LE_DESK_DOCK}
546 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200547 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700548 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * </ul>
550 *
551 * <h3>Standard Extra Data</h3>
552 *
553 * <p>These are the current standard fields that can be used as extra data via
554 * {@link #putExtra}.
555 *
556 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800557 * <li> {@link #EXTRA_ALARM_COUNT}
558 * <li> {@link #EXTRA_BCC}
559 * <li> {@link #EXTRA_CC}
560 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
561 * <li> {@link #EXTRA_DATA_REMOVED}
562 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500563 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
564 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800565 * <li> {@link #EXTRA_DOCK_STATE_CAR}
566 * <li> {@link #EXTRA_DOCK_STATE_DESK}
567 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
568 * <li> {@link #EXTRA_DONT_KILL_APP}
569 * <li> {@link #EXTRA_EMAIL}
570 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800572 * <li> {@link #EXTRA_KEY_EVENT}
573 * <li> {@link #EXTRA_PHONE_NUMBER}
574 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
575 * <li> {@link #EXTRA_REPLACING}
576 * <li> {@link #EXTRA_SHORTCUT_ICON}
577 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
578 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700579 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800580 * <li> {@link #EXTRA_SHORTCUT_NAME}
581 * <li> {@link #EXTRA_SUBJECT}
582 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700583 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800584 * <li> {@link #EXTRA_TITLE}
585 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700586 * </ul>
587 *
588 * <h3>Flags</h3>
589 *
590 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800591 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
592 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700593 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800594public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 // ---------------------------------------------------------------------
596 // ---------------------------------------------------------------------
597 // Standard intent activity actions (see action variable).
598
599 /**
600 * Activity Action: Start as a main entry point, does not expect to
601 * receive data.
602 * <p>Input: nothing
603 * <p>Output: nothing
604 */
605 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
606 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800607
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 /**
609 * Activity Action: Display the data to the user. This is the most common
610 * action performed on data -- it is the generic action you can use on
611 * a piece of data to get the most reasonable thing to occur. For example,
612 * when used on a contacts entry it will view the entry; when used on a
613 * mailto: URI it will bring up a compose window filled with the information
614 * supplied by the URI; when used with a tel: URI it will invoke the
615 * dialer.
616 * <p>Input: {@link #getData} is URI from which to retrieve data.
617 * <p>Output: nothing.
618 */
619 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
620 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800621
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700622 /**
623 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
624 * performed on a piece of data.
625 */
626 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800627
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700628 /**
629 * Used to indicate that some piece of data should be attached to some other
630 * place. For example, image data could be attached to a contact. It is up
631 * to the recipient to decide where the data should be attached; the intent
632 * does not specify the ultimate destination.
633 * <p>Input: {@link #getData} is URI of data to be attached.
634 * <p>Output: nothing.
635 */
636 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
637 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800638
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700639 /**
640 * Activity Action: Provide explicit editable access to the given data.
641 * <p>Input: {@link #getData} is URI of data to be edited.
642 * <p>Output: nothing.
643 */
644 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
645 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800646
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700647 /**
648 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
649 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
650 * The extras can contain type specific data to pass through to the editing/creating
651 * activity.
652 * <p>Output: The URI of the item that was picked. This must be a content:
653 * URI so that any receiver can access it.
654 */
655 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
656 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800657
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700658 /**
659 * Activity Action: Pick an item from the data, returning what was selected.
660 * <p>Input: {@link #getData} is URI containing a directory of data
661 * (vnd.android.cursor.dir/*) from which to pick an item.
662 * <p>Output: The URI of the item that was picked.
663 */
664 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
665 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800666
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700667 /**
668 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800669 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700670 * <p>Output: An Intent representing the shortcut. The intent must contain three
671 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
672 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800673 * (value: ShortcutIconResource).</p>
674 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700675 * @see #EXTRA_SHORTCUT_INTENT
676 * @see #EXTRA_SHORTCUT_NAME
677 * @see #EXTRA_SHORTCUT_ICON
678 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
679 * @see android.content.Intent.ShortcutIconResource
680 */
681 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
682 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
683
684 /**
685 * The name of the extra used to define the Intent of a shortcut.
686 *
687 * @see #ACTION_CREATE_SHORTCUT
688 */
689 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
690 /**
691 * The name of the extra used to define the name of a shortcut.
692 *
693 * @see #ACTION_CREATE_SHORTCUT
694 */
695 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
696 /**
697 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
698 *
699 * @see #ACTION_CREATE_SHORTCUT
700 */
701 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
702 /**
703 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
704 *
705 * @see #ACTION_CREATE_SHORTCUT
706 * @see android.content.Intent.ShortcutIconResource
707 */
708 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
709 "android.intent.extra.shortcut.ICON_RESOURCE";
710
711 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800712 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700713 *
714 * @see Intent#ACTION_CREATE_SHORTCUT
715 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800716 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
717 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700718 */
719 public static class ShortcutIconResource implements Parcelable {
720 /**
721 * The package name of the application containing the icon.
722 */
723 public String packageName;
724
725 /**
726 * The resource name of the icon, including package, name and type.
727 */
728 public String resourceName;
729
730 /**
731 * Creates a new ShortcutIconResource for the specified context and resource
732 * identifier.
733 *
734 * @param context The context of the application.
735 * @param resourceId The resource idenfitier for the icon.
736 * @return A new ShortcutIconResource with the specified's context package name
737 * and icon resource idenfitier.
738 */
739 public static ShortcutIconResource fromContext(Context context, int resourceId) {
740 ShortcutIconResource icon = new ShortcutIconResource();
741 icon.packageName = context.getPackageName();
742 icon.resourceName = context.getResources().getResourceName(resourceId);
743 return icon;
744 }
745
746 /**
747 * Used to read a ShortcutIconResource from a Parcel.
748 */
749 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
750 new Parcelable.Creator<ShortcutIconResource>() {
751
752 public ShortcutIconResource createFromParcel(Parcel source) {
753 ShortcutIconResource icon = new ShortcutIconResource();
754 icon.packageName = source.readString();
755 icon.resourceName = source.readString();
756 return icon;
757 }
758
759 public ShortcutIconResource[] newArray(int size) {
760 return new ShortcutIconResource[size];
761 }
762 };
763
764 /**
765 * No special parcel contents.
766 */
767 public int describeContents() {
768 return 0;
769 }
770
771 public void writeToParcel(Parcel dest, int flags) {
772 dest.writeString(packageName);
773 dest.writeString(resourceName);
774 }
775
776 @Override
777 public String toString() {
778 return resourceName;
779 }
780 }
781
782 /**
783 * Activity Action: Display an activity chooser, allowing the user to pick
784 * what they want to before proceeding. This can be used as an alternative
785 * to the standard activity picker that is displayed by the system when
786 * you try to start an activity with multiple possible matches, with these
787 * differences in behavior:
788 * <ul>
789 * <li>You can specify the title that will appear in the activity chooser.
790 * <li>The user does not have the option to make one of the matching
791 * activities a preferred activity, and all possible activities will
792 * always be shown even if one of them is currently marked as the
793 * preferred activity.
794 * </ul>
795 * <p>
796 * This action should be used when the user will naturally expect to
797 * select an activity in order to proceed. An example if when not to use
798 * it is when the user clicks on a "mailto:" link. They would naturally
799 * expect to go directly to their mail app, so startActivity() should be
800 * called directly: it will
801 * either launch the current preferred app, or put up a dialog allowing the
802 * user to pick an app to use and optionally marking that as preferred.
803 * <p>
804 * In contrast, if the user is selecting a menu item to send a picture
805 * they are viewing to someone else, there are many different things they
806 * may want to do at this point: send it through e-mail, upload it to a
807 * web service, etc. In this case the CHOOSER action should be used, to
808 * always present to the user a list of the things they can do, with a
809 * nice title given by the caller such as "Send this photo with:".
810 * <p>
811 * As a convenience, an Intent of this form can be created with the
812 * {@link #createChooser} function.
813 * <p>Input: No data should be specified. get*Extra must have
814 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
815 * and can optionally have a {@link #EXTRA_TITLE} field containing the
816 * title text to display in the chooser.
817 * <p>Output: Depends on the protocol of {@link #EXTRA_INTENT}.
818 */
819 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
820 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
821
822 /**
823 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
824 *
825 * @param target The Intent that the user will be selecting an activity
826 * to perform.
827 * @param title Optional title that will be displayed in the chooser.
828 * @return Return a new Intent object that you can hand to
829 * {@link Context#startActivity(Intent) Context.startActivity()} and
830 * related methods.
831 */
832 public static Intent createChooser(Intent target, CharSequence title) {
833 Intent intent = new Intent(ACTION_CHOOSER);
834 intent.putExtra(EXTRA_INTENT, target);
835 if (title != null) {
836 intent.putExtra(EXTRA_TITLE, title);
837 }
838 return intent;
839 }
840 /**
841 * Activity Action: Allow the user to select a particular kind of data and
842 * return it. This is different than {@link #ACTION_PICK} in that here we
843 * just say what kind of data is desired, not a URI of existing data from
844 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
845 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900846 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700847 * etc.
848 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900849 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700850 * of data, such as a person contact, you set the MIME type to the kind of
851 * data you want and launch it with {@link Context#startActivity(Intent)}.
852 * The system will then launch the best application to select that kind
853 * of data for you.
854 * <p>
855 * You may also be interested in any of a set of types of content the user
856 * can pick. For example, an e-mail application that wants to allow the
857 * user to add an attachment to an e-mail message can use this action to
858 * bring up a list of all of the types of content the user can attach.
859 * <p>
860 * In this case, you should wrap the GET_CONTENT intent with a chooser
861 * (through {@link #createChooser}), which will give the proper interface
862 * for the user to pick how to send your data and allow you to specify
863 * a prompt indicating what they are doing. You will usually specify a
864 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
865 * broad range of content types the user can select from.
866 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900867 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700868 * only pick from data that can be represented as a stream. This is
869 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
870 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800871 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900872 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800873 * is locally available on the device. For example, if this extra is set
874 * to true then an image picker should not show any pictures that are available
875 * from a remote server but not already on the local device (thus requiring
876 * they be downloaded when opened).
877 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700878 * Input: {@link #getType} is the desired MIME type to retrieve. Note
879 * that no URI is supplied in the intent, as there are no constraints on
880 * where the returned data originally comes from. You may also include the
881 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800882 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
883 * selection to local data.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700884 * <p>
885 * Output: The URI of the item that was picked. This must be a content:
886 * URI so that any receiver can access it.
887 */
888 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
889 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
890 /**
891 * Activity Action: Dial a number as specified by the data. This shows a
892 * UI with the number being dialed, allowing the user to explicitly
893 * initiate the call.
894 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
895 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
896 * number.
897 * <p>Output: nothing.
898 */
899 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
900 public static final String ACTION_DIAL = "android.intent.action.DIAL";
901 /**
902 * Activity Action: Perform a call to someone specified by the data.
903 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
904 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
905 * number.
906 * <p>Output: nothing.
907 *
908 * <p>Note: there will be restrictions on which applications can initiate a
909 * call; most applications should use the {@link #ACTION_DIAL}.
910 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
911 * numbers. Applications can <strong>dial</strong> emergency numbers using
912 * {@link #ACTION_DIAL}, however.
913 */
914 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
915 public static final String ACTION_CALL = "android.intent.action.CALL";
916 /**
917 * Activity Action: Perform a call to an emergency number specified by the
918 * data.
919 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
920 * tel: URI of an explicit phone number.
921 * <p>Output: nothing.
922 * @hide
923 */
924 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
925 /**
926 * Activity action: Perform a call to any number (emergency or not)
927 * specified by the data.
928 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
929 * tel: URI of an explicit phone number.
930 * <p>Output: nothing.
931 * @hide
932 */
933 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
934 /**
935 * Activity Action: Send a message to someone specified by the data.
936 * <p>Input: {@link #getData} is URI describing the target.
937 * <p>Output: nothing.
938 */
939 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
940 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
941 /**
942 * Activity Action: Deliver some data to someone else. Who the data is
943 * being delivered to is not specified; it is up to the receiver of this
944 * action to ask the user where the data should be sent.
945 * <p>
946 * When launching a SEND intent, you should usually wrap it in a chooser
947 * (through {@link #createChooser}), which will give the proper interface
948 * for the user to pick how to send your data and allow you to specify
949 * a prompt indicating what they are doing.
950 * <p>
951 * Input: {@link #getType} is the MIME type of the data being sent.
952 * get*Extra can have either a {@link #EXTRA_TEXT}
953 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
954 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
955 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
956 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700957 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
958 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
959 * your text with HTML formatting.
960 * <p>
961 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
962 * being sent can be supplied through {@link #setClipData(ClipData)}. This
963 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
964 * content: URIs and other advanced features of {@link ClipData}. If
965 * using this approach, you still must supply the same data through the
966 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
967 * for compatibility with old applications. If you don't set a ClipData,
968 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700969 * <p>
970 * Optional standard extras, which may be interpreted by some recipients as
971 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
972 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
973 * <p>
974 * Output: nothing.
975 */
976 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
977 public static final String ACTION_SEND = "android.intent.action.SEND";
978 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800979 * Activity Action: Deliver multiple data to someone else.
980 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700981 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800982 * <p>
983 * Input: {@link #getType} is the MIME type of the data being sent.
984 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700985 * #EXTRA_STREAM} field, containing the data to be sent. If using
986 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
987 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800988 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +0800989 * Multiple types are supported, and receivers should handle mixed types
990 * whenever possible. The right way for the receiver to check them is to
991 * use the content resolver on each URI. The intent sender should try to
992 * put the most concrete mime type in the intent type, but it can fall
993 * back to {@literal <type>/*} or {@literal *}/* as needed.
994 * <p>
995 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
996 * be image/jpg, but if you are sending image/jpg and image/png, then the
997 * intent's type should be image/*.
998 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700999 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1000 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1001 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1002 * content: URIs and other advanced features of {@link ClipData}. If
1003 * using this approach, you still must supply the same data through the
1004 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1005 * for compatibility with old applications. If you don't set a ClipData,
1006 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1007 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001008 * Optional standard extras, which may be interpreted by some recipients as
1009 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1010 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1011 * <p>
1012 * Output: nothing.
1013 */
1014 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1015 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1016 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001017 * Activity Action: Handle an incoming phone call.
1018 * <p>Input: nothing.
1019 * <p>Output: nothing.
1020 */
1021 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1022 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1023 /**
1024 * Activity Action: Insert an empty item into the given container.
1025 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1026 * in which to place the data.
1027 * <p>Output: URI of the new data that was created.
1028 */
1029 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1030 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1031 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001032 * Activity Action: Create a new item in the given container, initializing it
1033 * from the current contents of the clipboard.
1034 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1035 * in which to place the data.
1036 * <p>Output: URI of the new data that was created.
1037 */
1038 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1039 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1040 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001041 * Activity Action: Delete the given data from its container.
1042 * <p>Input: {@link #getData} is URI of data to be deleted.
1043 * <p>Output: nothing.
1044 */
1045 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1046 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1047 /**
1048 * Activity Action: Run the data, whatever that means.
1049 * <p>Input: ? (Note: this is currently specific to the test harness.)
1050 * <p>Output: nothing.
1051 */
1052 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1053 public static final String ACTION_RUN = "android.intent.action.RUN";
1054 /**
1055 * Activity Action: Perform a data synchronization.
1056 * <p>Input: ?
1057 * <p>Output: ?
1058 */
1059 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1060 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1061 /**
1062 * Activity Action: Pick an activity given an intent, returning the class
1063 * selected.
1064 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1065 * used with {@link PackageManager#queryIntentActivities} to determine the
1066 * set of activities from which to pick.
1067 * <p>Output: Class name of the activity that was selected.
1068 */
1069 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1070 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1071 /**
1072 * Activity Action: Perform a search.
1073 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1074 * is the text to search for. If empty, simply
1075 * enter your search results Activity with the search UI activated.
1076 * <p>Output: nothing.
1077 */
1078 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1079 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1080 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001081 * Activity Action: Start the platform-defined tutorial
1082 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1083 * is the text to search for. If empty, simply
1084 * enter your search results Activity with the search UI activated.
1085 * <p>Output: nothing.
1086 */
1087 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1088 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1089 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001090 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001091 * <p>
1092 * Input: {@link android.app.SearchManager#QUERY
1093 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1094 * a url starts with http or https, the site will be opened. If it is plain
1095 * text, Google search will be applied.
1096 * <p>
1097 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001098 */
1099 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1100 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1101 /**
1102 * Activity Action: List all available applications
1103 * <p>Input: Nothing.
1104 * <p>Output: nothing.
1105 */
1106 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1107 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1108 /**
1109 * Activity Action: Show settings for choosing wallpaper
1110 * <p>Input: Nothing.
1111 * <p>Output: Nothing.
1112 */
1113 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1114 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1115
1116 /**
1117 * Activity Action: Show activity for reporting a bug.
1118 * <p>Input: Nothing.
1119 * <p>Output: Nothing.
1120 */
1121 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1122 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1123
1124 /**
1125 * Activity Action: Main entry point for factory tests. Only used when
1126 * the device is booting in factory test node. The implementing package
1127 * must be installed in the system image.
1128 * <p>Input: nothing
1129 * <p>Output: nothing
1130 */
1131 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1132
1133 /**
1134 * Activity Action: The user pressed the "call" button to go to the dialer
1135 * or other appropriate UI for placing a call.
1136 * <p>Input: Nothing.
1137 * <p>Output: Nothing.
1138 */
1139 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1140 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1141
1142 /**
1143 * Activity Action: Start Voice Command.
1144 * <p>Input: Nothing.
1145 * <p>Output: Nothing.
1146 */
1147 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1148 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001149
1150 /**
1151 * Activity Action: Start action associated with long pressing on the
1152 * search key.
1153 * <p>Input: Nothing.
1154 * <p>Output: Nothing.
1155 */
1156 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1157 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001158
Jacek Surazski86b6c532009-05-13 14:38:28 +02001159 /**
1160 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1161 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001162 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001163 * <p>Input: No data is specified. The bug report is passed in using
1164 * an {@link #EXTRA_BUG_REPORT} field.
1165 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001166 *
1167 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001168 */
1169 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1170 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001171
1172 /**
1173 * Activity Action: Show power usage information to the user.
1174 * <p>Input: Nothing.
1175 * <p>Output: Nothing.
1176 */
1177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1178 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001179
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001180 /**
1181 * Activity Action: Setup wizard to launch after a platform update. This
1182 * activity should have a string meta-data field associated with it,
1183 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1184 * the platform for setup. The activity will be launched only if
1185 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1186 * same value.
1187 * <p>Input: Nothing.
1188 * <p>Output: Nothing.
1189 * @hide
1190 */
1191 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1192 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001193
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001194 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001195 * Activity Action: Show settings for managing network data usage of a
1196 * specific application. Applications should define an activity that offers
1197 * options to control data usage.
1198 */
1199 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1200 public static final String ACTION_MANAGE_NETWORK_USAGE =
1201 "android.intent.action.MANAGE_NETWORK_USAGE";
1202
1203 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001204 * Activity Action: Launch application installer.
1205 * <p>
1206 * Input: The data must be a content: or file: URI at which the application
1207 * can be retrieved. You can optionally supply
1208 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1209 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1210 * <p>
1211 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1212 * succeeded.
1213 *
1214 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1215 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1216 * @see #EXTRA_RETURN_RESULT
1217 */
1218 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1219 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1220
1221 /**
1222 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1223 * package. Specifies the installer package name; this package will receive the
1224 * {@link #ACTION_APP_ERROR} intent.
1225 */
1226 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1227 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1228
1229 /**
1230 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1231 * package. Specifies that the application being installed should not be
1232 * treated as coming from an unknown source, but as coming from the app
1233 * invoking the Intent. For this to work you must start the installer with
1234 * startActivityForResult().
1235 */
1236 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1237 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1238
1239 /**
1240 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1241 * package. Tells the installer UI to skip the confirmation with the user
1242 * if the .apk is replacing an existing one.
1243 */
1244 public static final String EXTRA_ALLOW_REPLACE
1245 = "android.intent.extra.ALLOW_REPLACE";
1246
1247 /**
1248 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1249 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1250 * return to the application the result code of the install/uninstall. The returned result
1251 * code will be {@link android.app.Activity#RESULT_OK} on success or
1252 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1253 */
1254 public static final String EXTRA_RETURN_RESULT
1255 = "android.intent.extra.RETURN_RESULT";
1256
1257 /**
1258 * Package manager install result code. @hide because result codes are not
1259 * yet ready to be exposed.
1260 */
1261 public static final String EXTRA_INSTALL_RESULT
1262 = "android.intent.extra.INSTALL_RESULT";
1263
1264 /**
1265 * Activity Action: Launch application uninstaller.
1266 * <p>
1267 * Input: The data must be a package: URI whose scheme specific part is
1268 * the package name of the current installed package to be uninstalled.
1269 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1270 * <p>
1271 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1272 * succeeded.
1273 */
1274 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1275 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1276
1277 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001278 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1279 * describing the last run version of the platform that was setup.
1280 * @hide
1281 */
1282 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1283
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001284 // ---------------------------------------------------------------------
1285 // ---------------------------------------------------------------------
1286 // Standard intent broadcast actions (see action variable).
1287
1288 /**
1289 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001290 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001291 * <p class="note">This is a protected intent that can only be sent
1292 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001293 */
1294 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1295 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1296 /**
1297 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001298 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001299 * <p class="note">This is a protected intent that can only be sent
1300 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001301 */
1302 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1303 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001304
1305 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001306 * Broadcast Action: Sent when the user is present after device wakes up (e.g when the
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001307 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001308 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001309 * <p class="note">This is a protected intent that can only be sent
1310 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001311 */
1312 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001313 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001314
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001315 /**
1316 * Broadcast Action: The current time has changed. Sent every
1317 * minute. You can <em>not</em> receive this through components declared
1318 * in manifests, only by exlicitly registering for it with
1319 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1320 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001321 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001322 * <p class="note">This is a protected intent that can only be sent
1323 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001324 */
1325 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1326 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1327 /**
1328 * Broadcast Action: The time was set.
1329 */
1330 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1331 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1332 /**
1333 * Broadcast Action: The date has changed.
1334 */
1335 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1336 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1337 /**
1338 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1339 * <ul>
1340 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1341 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001342 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001343 * <p class="note">This is a protected intent that can only be sent
1344 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001345 */
1346 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1347 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1348 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001349 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1350 * DNS entries should be tossed.
1351 * @hide
1352 */
1353 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1354 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1355 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001356 * Alarm Changed Action: This is broadcast when the AlarmClock
1357 * application's alarm is set or unset. It is used by the
1358 * AlarmClock application and the StatusBar service.
1359 * @hide
1360 */
1361 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1362 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1363 /**
1364 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1365 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1366 * @hide
1367 */
1368 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1369 public static final String ACTION_SYNC_STATE_CHANGED
1370 = "android.intent.action.SYNC_STATE_CHANGED";
1371 /**
1372 * Broadcast Action: This is broadcast once, after the system has finished
1373 * booting. It can be used to perform application-specific initialization,
1374 * such as installing alarms. You must hold the
1375 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1376 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001377 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001378 * <p class="note">This is a protected intent that can only be sent
1379 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001380 */
1381 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1382 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1383 /**
1384 * Broadcast Action: This is broadcast when a user action should request a
1385 * temporary system dialog to dismiss. Some examples of temporary system
1386 * dialogs are the notification window-shade and the recent tasks dialog.
1387 */
1388 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1389 /**
1390 * Broadcast Action: Trigger the download and eventual installation
1391 * of a package.
1392 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001393 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001394 * <p class="note">This is a protected intent that can only be sent
1395 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001396 *
1397 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001398 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001399 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001400 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1401 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1402 /**
1403 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001404 * device. The data contains the name of the package. Note that the
1405 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001406 * <p>My include the following extras:
1407 * <ul>
1408 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1409 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1410 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1411 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001412 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001413 * <p class="note">This is a protected intent that can only be sent
1414 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001415 */
1416 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1417 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1418 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001419 * Broadcast Action: A new version of an application package has been
1420 * installed, replacing an existing version that was previously installed.
1421 * The data contains the name of the package.
1422 * <p>My include the following extras:
1423 * <ul>
1424 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1425 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001426 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001427 * <p class="note">This is a protected intent that can only be sent
1428 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001429 */
1430 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1431 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1432 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001433 * Broadcast Action: A new version of your application has been installed
1434 * over an existing one. This is only sent to the application that was
1435 * replaced. It does not contain any additional data; to receive it, just
1436 * use an intent filter for this action.
1437 *
1438 * <p class="note">This is a protected intent that can only be sent
1439 * by the system.
1440 */
1441 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1442 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1443 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001444 * Broadcast Action: An existing application package has been removed from
1445 * the device. The data contains the name of the package. The package
1446 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001447 * <ul>
1448 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1449 * to the package.
1450 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1451 * application -- data and code -- is being removed.
1452 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1453 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1454 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001455 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001456 * <p class="note">This is a protected intent that can only be sent
1457 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001458 */
1459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1460 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1461 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001462 * Broadcast Action: An existing application package has been completely
1463 * removed from the device. The data contains the name of the package.
1464 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1465 * {@link #EXTRA_DATA_REMOVED} is true and
1466 * {@link #EXTRA_REPLACING} is false of that broadcast.
1467 *
1468 * <ul>
1469 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1470 * to the package.
1471 * </ul>
1472 *
1473 * <p class="note">This is a protected intent that can only be sent
1474 * by the system.
1475 */
1476 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1477 public static final String ACTION_PACKAGE_FULLY_REMOVED
1478 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1479 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001480 * Broadcast Action: An existing application package has been changed (e.g.
1481 * a component has been enabled or disabled). The data contains the name of
1482 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001483 * <ul>
1484 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001485 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1486 * of the changed components.
1487 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1488 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001489 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001490 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001491 * <p class="note">This is a protected intent that can only be sent
1492 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001493 */
1494 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1495 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1496 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001497 * @hide
1498 * Broadcast Action: Ask system services if there is any reason to
1499 * restart the given package. The data contains the name of the
1500 * package.
1501 * <ul>
1502 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1503 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1504 * </ul>
1505 *
1506 * <p class="note">This is a protected intent that can only be sent
1507 * by the system.
1508 */
1509 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1510 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1511 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001512 * Broadcast Action: The user has restarted a package, and all of its
1513 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001514 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001515 * be removed. Note that the restarted package does <em>not</em>
1516 * receive this broadcast.
1517 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001518 * <ul>
1519 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1520 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001521 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001522 * <p class="note">This is a protected intent that can only be sent
1523 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001524 */
1525 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1526 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1527 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001528 * Broadcast Action: The user has cleared the data of a package. This should
1529 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001530 * its persistent data is erased and this broadcast sent.
1531 * Note that the cleared package does <em>not</em>
1532 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001533 * <ul>
1534 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1535 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001536 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001537 * <p class="note">This is a protected intent that can only be sent
1538 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001539 */
1540 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1541 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1542 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001543 * Broadcast Action: A user ID has been removed from the system. The user
1544 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001545 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001546 * <p class="note">This is a protected intent that can only be sent
1547 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001548 */
1549 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1550 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001551
1552 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001553 * Broadcast Action: Sent to the installer package of an application
1554 * when that application is first launched (that is the first time it
1555 * is moved out of the stopped state). The data contains the name of the package.
1556 *
1557 * <p class="note">This is a protected intent that can only be sent
1558 * by the system.
1559 */
1560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1561 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1562
1563 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001564 * Broadcast Action: Sent to the system package verifier when a package
1565 * needs to be verified. The data contains the package URI.
1566 * <p class="note">
1567 * This is a protected intent that can only be sent by the system.
1568 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001569 */
1570 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1571 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1572
1573 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001574 * Broadcast Action: Resources for a set of packages (which were
1575 * previously unavailable) are currently
1576 * available since the media on which they exist is available.
1577 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1578 * list of packages whose availability changed.
1579 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1580 * list of uids of packages whose availability changed.
1581 * Note that the
1582 * packages in this list do <em>not</em> receive this broadcast.
1583 * The specified set of packages are now available on the system.
1584 * <p>Includes the following extras:
1585 * <ul>
1586 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1587 * whose resources(were previously unavailable) are currently available.
1588 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1589 * packages whose resources(were previously unavailable)
1590 * are currently available.
1591 * </ul>
1592 *
1593 * <p class="note">This is a protected intent that can only be sent
1594 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001595 */
1596 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001597 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1598 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001599
1600 /**
1601 * Broadcast Action: Resources for a set of packages are currently
1602 * unavailable since the media on which they exist is unavailable.
1603 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1604 * list of packages whose availability changed.
1605 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1606 * list of uids of packages whose availability changed.
1607 * The specified set of packages can no longer be
1608 * launched and are practically unavailable on the system.
1609 * <p>Inclues the following extras:
1610 * <ul>
1611 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1612 * whose resources are no longer available.
1613 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1614 * whose resources are no longer available.
1615 * </ul>
1616 *
1617 * <p class="note">This is a protected intent that can only be sent
1618 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001619 */
1620 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001621 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001622 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001624 /**
1625 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001626 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001627 */
1628 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1629 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1630 /**
1631 * Broadcast Action: The current device {@link android.content.res.Configuration}
1632 * (orientation, locale, etc) has changed. When such a change happens, the
1633 * UIs (view hierarchy) will need to be rebuilt based on this new
1634 * information; for the most part, applications don't need to worry about
1635 * this, because the system will take care of stopping and restarting the
1636 * application to make sure it sees the new changes. Some system code that
1637 * can not be restarted will need to watch for this action and handle it
1638 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001639 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001640 * <p class="note">
1641 * You can <em>not</em> receive this through components declared
1642 * in manifests, only by explicitly registering for it with
1643 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1644 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001645 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001646 * <p class="note">This is a protected intent that can only be sent
1647 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001648 *
1649 * @see android.content.res.Configuration
1650 */
1651 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1652 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1653 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001654 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001655 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001656 * <p class="note">This is a protected intent that can only be sent
1657 * by the system.
1658 */
1659 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1660 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1661 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001662 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1663 * charging state, level, and other information about the battery.
1664 * See {@link android.os.BatteryManager} for documentation on the
1665 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001666 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001667 * <p class="note">
1668 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001669 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001670 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001671 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1672 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1673 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1674 * broadcasts that are sent and can be received through manifest
1675 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001676 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001677 * <p class="note">This is a protected intent that can only be sent
1678 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001679 */
1680 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1681 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1682 /**
1683 * Broadcast Action: Indicates low battery condition on the device.
1684 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001685 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001686 * <p class="note">This is a protected intent that can only be sent
1687 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001688 */
1689 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1690 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1691 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001692 * Broadcast Action: Indicates the battery is now okay after being low.
1693 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1694 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001695 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001696 * <p class="note">This is a protected intent that can only be sent
1697 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001698 */
1699 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1700 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1701 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001702 * Broadcast Action: External power has been connected to the device.
1703 * This is intended for applications that wish to register specifically to this notification.
1704 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1705 * stay active to receive this notification. This action can be used to implement actions
1706 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001707 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001708 * <p class="note">This is a protected intent that can only be sent
1709 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001710 */
1711 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001712 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001713 /**
1714 * Broadcast Action: External power has been removed from the device.
1715 * This is intended for applications that wish to register specifically to this notification.
1716 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1717 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001718 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001719 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001720 * <p class="note">This is a protected intent that can only be sent
1721 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001722 */
1723 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001724 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001725 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001726 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001727 * Broadcast Action: Device is shutting down.
1728 * This is broadcast when the device is being shut down (completely turned
1729 * off, not sleeping). Once the broadcast is complete, the final shutdown
1730 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001731 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001732 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001733 * <p class="note">This is a protected intent that can only be sent
1734 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001735 */
1736 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001737 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001738 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001739 * Activity Action: Start this activity to request system shutdown.
1740 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1741 * to request confirmation from the user before shutting down.
1742 *
1743 * <p class="note">This is a protected intent that can only be sent
1744 * by the system.
1745 *
1746 * {@hide}
1747 */
1748 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1749 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001750 * Broadcast Action: A sticky broadcast that indicates low memory
1751 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001752 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001753 * <p class="note">This is a protected intent that can only be sent
1754 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001755 */
1756 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1757 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1758 /**
1759 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001760 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001761 * <p class="note">This is a protected intent that can only be sent
1762 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001763 */
1764 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1765 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1766 /**
Jake Hambybb371632010-08-23 18:16:48 -07001767 * Broadcast Action: A sticky broadcast that indicates a memory full
1768 * condition on the device. This is intended for activities that want
1769 * to be able to fill the data partition completely, leaving only
1770 * enough free space to prevent system-wide SQLite failures.
1771 *
1772 * <p class="note">This is a protected intent that can only be sent
1773 * by the system.
1774 *
1775 * {@hide}
1776 */
1777 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1778 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1779 /**
1780 * Broadcast Action: Indicates memory full condition on the device
1781 * no longer exists.
1782 *
1783 * <p class="note">This is a protected intent that can only be sent
1784 * by the system.
1785 *
1786 * {@hide}
1787 */
1788 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1789 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1790 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001791 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1792 * and package management should be started.
1793 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1794 * notification.
1795 */
1796 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1797 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1798 /**
1799 * Broadcast Action: The device has entered USB Mass Storage mode.
1800 * This is used mainly for the USB Settings panel.
1801 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1802 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001803 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001804 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001805 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001806 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1807
1808 /**
1809 * Broadcast Action: The device has exited USB Mass Storage mode.
1810 * This is used mainly for the USB Settings panel.
1811 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1812 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001813 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001814 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001815 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001816 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1817
1818 /**
1819 * Broadcast Action: External media has been removed.
1820 * The path to the mount point for the removed media is contained in the Intent.mData field.
1821 */
1822 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1823 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1824
1825 /**
1826 * Broadcast Action: External media is present, but not mounted at its mount point.
1827 * The path to the mount point for the removed media is contained in the Intent.mData field.
1828 */
1829 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1830 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1831
1832 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001833 * Broadcast Action: External media is present, and being disk-checked
1834 * 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 -08001835 */
1836 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1837 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1838
1839 /**
1840 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1841 * 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 -08001842 */
1843 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1844 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1845
1846 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001847 * Broadcast Action: External media is present and mounted at its mount point.
1848 * The path to the mount point for the removed media is contained in the Intent.mData field.
1849 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1850 * media was mounted read only.
1851 */
1852 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1853 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1854
1855 /**
1856 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001857 * 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 -07001858 */
1859 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1860 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1861
1862 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001863 * Broadcast Action: External media is no longer being shared via USB mass storage.
1864 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1865 *
1866 * @hide
1867 */
1868 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1869
1870 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001871 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1872 * The path to the mount point for the removed media is contained in the Intent.mData field.
1873 */
1874 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1875 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1876
1877 /**
1878 * Broadcast Action: External media is present but cannot be mounted.
1879 * The path to the mount point for the removed media is contained in the Intent.mData field.
1880 */
1881 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1882 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1883
1884 /**
1885 * Broadcast Action: User has expressed the desire to remove the external storage media.
1886 * Applications should close all files they have open within the mount point when they receive this intent.
1887 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1888 */
1889 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1890 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1891
1892 /**
1893 * Broadcast Action: The media scanner has started scanning a directory.
1894 * The path to the directory being scanned is contained in the Intent.mData field.
1895 */
1896 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1897 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1898
1899 /**
1900 * Broadcast Action: The media scanner has finished scanning a directory.
1901 * The path to the scanned directory is contained in the Intent.mData field.
1902 */
1903 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1904 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1905
1906 /**
1907 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1908 * The path to the file is contained in the Intent.mData field.
1909 */
1910 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1911 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1912
1913 /**
1914 * Broadcast Action: The "Media Button" was pressed. Includes a single
1915 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1916 * caused the broadcast.
1917 */
1918 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1919 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1920
1921 /**
1922 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1923 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1924 * caused the broadcast.
1925 */
1926 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1927 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1928
1929 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1930 // location; they are not general-purpose actions.
1931
1932 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001933 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001934 */
1935 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1936 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1937 "android.intent.action.GTALK_CONNECTED";
1938
1939 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001940 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001941 */
1942 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1943 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1944 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001945
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001946 /**
1947 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001948 */
1949 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1950 public static final String ACTION_INPUT_METHOD_CHANGED =
1951 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001952
1953 /**
1954 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1955 * more radios have been turned off or on. The intent will have the following extra value:</p>
1956 * <ul>
1957 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1958 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1959 * turned off</li>
1960 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001961 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001962 * <p class="note">This is a protected intent that can only be sent
1963 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001964 */
1965 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1966 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1967
1968 /**
1969 * Broadcast Action: Some content providers have parts of their namespace
1970 * where they publish new events or items that the user may be especially
1971 * interested in. For these things, they may broadcast this action when the
1972 * set of interesting items change.
1973 *
1974 * For example, GmailProvider sends this notification when the set of unread
1975 * mail in the inbox changes.
1976 *
1977 * <p>The data of the intent identifies which part of which provider
1978 * changed. When queried through the content resolver, the data URI will
1979 * return the data set in question.
1980 *
1981 * <p>The intent will have the following extra values:
1982 * <ul>
1983 * <li><em>count</em> - The number of items in the data set. This is the
1984 * same as the number of items in the cursor returned by querying the
1985 * data URI. </li>
1986 * </ul>
1987 *
1988 * This intent will be sent at boot (if the count is non-zero) and when the
1989 * data set changes. It is possible for the data set to change without the
1990 * count changing (for example, if a new unread message arrives in the same
1991 * sync operation in which a message is archived). The phone should still
1992 * ring/vibrate/etc as normal in this case.
1993 */
1994 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1995 public static final String ACTION_PROVIDER_CHANGED =
1996 "android.intent.action.PROVIDER_CHANGED";
1997
1998 /**
1999 * Broadcast Action: Wired Headset plugged in or unplugged.
2000 *
2001 * <p>The intent will have the following extra values:
2002 * <ul>
2003 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2004 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002005 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002006 * </ul>
2007 * </ul>
2008 */
2009 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2010 public static final String ACTION_HEADSET_PLUG =
2011 "android.intent.action.HEADSET_PLUG";
2012
2013 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002014 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2015 *
2016 * <p>The intent will have the following extra values:
2017 * <ul>
2018 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2019 * <li><em>name</em> - Headset type, human readable string </li>
2020 * </ul>
2021 * </ul>
2022 * @hide
2023 */
2024 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002025 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2026 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002027
2028 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002029 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002030 *
2031 * <p>The intent will have the following extra values:
2032 * <ul>
2033 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2034 * <li><em>name</em> - Headset type, human readable string </li>
2035 * </ul>
2036 * </ul>
2037 * @hide
2038 */
2039 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002040 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2041 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002042
2043 /**
2044 * Broadcast Action: A HMDI cable was plugged or unplugged
2045 *
2046 * <p>The intent will have the following extra values:
2047 * <ul>
2048 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2049 * <li><em>name</em> - HDMI cable, human readable string </li>
2050 * </ul>
2051 * </ul>
2052 * @hide
2053 */
2054 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2055 public static final String ACTION_HDMI_AUDIO_PLUG =
2056 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002057
2058 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002059 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2060 *
2061 * <p>The intent will have the following extra values:
2062 * <ul>
2063 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2064 * <li><em>card</em> - ALSA card number (integer) </li>
2065 * <li><em>device</em> - ALSA device number (integer) </li>
2066 * </ul>
2067 * </ul>
2068 * @hide
2069 */
2070 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2071 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2072 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2073
2074 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002075 * Broadcast Action: A USB audio device was plugged in or unplugged.
2076 *
2077 * <p>The intent will have the following extra values:
2078 * <ul>
2079 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2080 * <li><em>card</em> - ALSA card number (integer) </li>
2081 * <li><em>device</em> - ALSA device number (integer) </li>
2082 * </ul>
2083 * </ul>
2084 * @hide
2085 */
2086 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2087 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2088 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2089
2090 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002091 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2092 * <ul>
2093 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2094 * </ul>
2095 *
2096 * <p class="note">This is a protected intent that can only be sent
2097 * by the system.
2098 *
2099 * @hide
2100 */
2101 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2102 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2103 = "android.intent.action.ADVANCED_SETTINGS";
2104
2105 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002106 * Broadcast Action: An outgoing call is about to be placed.
2107 *
2108 * <p>The Intent will have the following extra value:
2109 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002110 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002111 * the phone number originally intended to be dialed.</li>
2112 * </ul>
2113 * <p>Once the broadcast is finished, the resultData is used as the actual
2114 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002115 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002116 * outgoing call in turn: for example, a parental control application
2117 * might verify that the user is authorized to place the call at that
2118 * time, then a number-rewriting application might add an area code if
2119 * one was not specified.</p>
2120 * <p>For consistency, any receiver whose purpose is to prohibit phone
2121 * calls should have a priority of 0, to ensure it will see the final
2122 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002123 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002124 * should have a positive priority.
2125 * Negative priorities are reserved for the system for this broadcast;
2126 * using them may cause problems.</p>
2127 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2128 * abort the broadcast.</p>
2129 * <p>Emergency calls cannot be intercepted using this mechanism, and
2130 * other calls cannot be modified to call emergency numbers using this
2131 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002132 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002133 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2134 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002135 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002136 * <p class="note">This is a protected intent that can only be sent
2137 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002138 */
2139 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2140 public static final String ACTION_NEW_OUTGOING_CALL =
2141 "android.intent.action.NEW_OUTGOING_CALL";
2142
2143 /**
2144 * Broadcast Action: Have the device reboot. This is only for use by
2145 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002146 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002147 * <p class="note">This is a protected intent that can only be sent
2148 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002149 */
2150 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2151 public static final String ACTION_REBOOT =
2152 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002153
Wei Huang97ecc9c2009-05-11 17:44:20 -07002154 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002155 * Broadcast Action: A sticky broadcast for changes in the physical
2156 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002157 *
2158 * <p>The intent will have the following extra values:
2159 * <ul>
2160 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002161 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002162 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002163 * <p>This is intended for monitoring the current physical dock state.
2164 * See {@link android.app.UiModeManager} for the normal API dealing with
2165 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002166 */
2167 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2168 public static final String ACTION_DOCK_EVENT =
2169 "android.intent.action.DOCK_EVENT";
2170
2171 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002172 * Broadcast Action: a remote intent is to be broadcasted.
2173 *
2174 * A remote intent is used for remote RPC between devices. The remote intent
2175 * is serialized and sent from one device to another device. The receiving
2176 * device parses the remote intent and broadcasts it. Note that anyone can
2177 * broadcast a remote intent. However, if the intent receiver of the remote intent
2178 * does not trust intent broadcasts from arbitrary intent senders, it should require
2179 * the sender to hold certain permissions so only trusted sender's broadcast will be
2180 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002181 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002182 */
2183 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002184 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002185
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002186 /**
2187 * Broadcast Action: hook for permforming cleanup after a system update.
2188 *
2189 * The broadcast is sent when the system is booting, before the
2190 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2191 * image. A receiver for this should do its work and then disable itself
2192 * so that it does not get run again at the next boot.
2193 * @hide
2194 */
2195 public static final String ACTION_PRE_BOOT_COMPLETED =
2196 "android.intent.action.PRE_BOOT_COMPLETED";
2197
Amith Yamasani13593602012-03-22 16:16:17 -07002198 /**
2199 * Broadcast sent to the system when a user is added. Carries an extra EXTRA_USERID that has the
2200 * userid of the new user.
2201 * @hide
2202 */
2203 public static final String ACTION_USER_ADDED =
2204 "android.intent.action.USER_ADDED";
2205
2206 /**
2207 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USERID that has
2208 * the userid of the user.
2209 * @hide
2210 */
2211 public static final String ACTION_USER_REMOVED =
2212 "android.intent.action.USER_REMOVED";
2213
2214 /**
2215 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USERID that has
2216 * the userid of the user to become the current one.
2217 * @hide
2218 */
2219 public static final String ACTION_USER_SWITCHED =
2220 "android.intent.action.USER_SWITCHED";
2221
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002222 // ---------------------------------------------------------------------
2223 // ---------------------------------------------------------------------
2224 // Standard intent categories (see addCategory()).
2225
2226 /**
2227 * Set if the activity should be an option for the default action
2228 * (center press) to perform on a piece of data. Setting this will
2229 * hide from the user any activities without it set when performing an
2230 * action on some data. Note that this is normal -not- set in the
2231 * Intent when initiating an action -- it is for use in intent filters
2232 * specified in packages.
2233 */
2234 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2235 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2236 /**
2237 * Activities that can be safely invoked from a browser must support this
2238 * category. For example, if the user is viewing a web page or an e-mail
2239 * and clicks on a link in the text, the Intent generated execute that
2240 * link will require the BROWSABLE category, so that only activities
2241 * supporting this category will be considered as possible actions. By
2242 * supporting this category, you are promising that there is nothing
2243 * damaging (without user intervention) that can happen by invoking any
2244 * matching Intent.
2245 */
2246 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2247 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2248 /**
2249 * Set if the activity should be considered as an alternative action to
2250 * the data the user is currently viewing. See also
2251 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2252 * applies to the selection in a list of items.
2253 *
2254 * <p>Supporting this category means that you would like your activity to be
2255 * displayed in the set of alternative things the user can do, usually as
2256 * part of the current activity's options menu. You will usually want to
2257 * include a specific label in the &lt;intent-filter&gt; of this action
2258 * describing to the user what it does.
2259 *
2260 * <p>The action of IntentFilter with this category is important in that it
2261 * describes the specific action the target will perform. This generally
2262 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2263 * a specific name such as "com.android.camera.action.CROP. Only one
2264 * alternative of any particular action will be shown to the user, so using
2265 * a specific action like this makes sure that your alternative will be
2266 * displayed while also allowing other applications to provide their own
2267 * overrides of that particular action.
2268 */
2269 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2270 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2271 /**
2272 * Set if the activity should be considered as an alternative selection
2273 * action to the data the user has currently selected. This is like
2274 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2275 * of items from which the user can select, giving them alternatives to the
2276 * default action that will be performed on it.
2277 */
2278 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2279 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2280 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002281 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002282 */
2283 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2284 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2285 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002286 * Should be displayed in the top-level launcher.
2287 */
2288 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2289 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2290 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002291 * Provides information about the package it is in; typically used if
2292 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2293 * a front-door to the user without having to be shown in the all apps list.
2294 */
2295 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2296 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2297 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002298 * This is the home activity, that is the first activity that is displayed
2299 * when the device boots.
2300 */
2301 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2302 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2303 /**
2304 * This activity is a preference panel.
2305 */
2306 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2307 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2308 /**
2309 * This activity is a development preference panel.
2310 */
2311 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2312 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2313 /**
2314 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002315 */
2316 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2317 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2318 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002319 * This activity allows the user to browse and download new applications.
2320 */
2321 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2322 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2323 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002324 * This activity may be exercised by the monkey or other automated test tools.
2325 */
2326 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2327 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2328 /**
2329 * To be used as a test (not part of the normal user experience).
2330 */
2331 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2332 /**
2333 * To be used as a unit test (run through the Test Harness).
2334 */
2335 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2336 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002337 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002338 * experience).
2339 */
2340 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2341 /**
2342 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2343 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2344 * when queried, though it is allowable for those columns to be blank.
2345 */
2346 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2347 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2348
2349 /**
2350 * To be used as code under test for framework instrumentation tests.
2351 */
2352 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2353 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002354 /**
2355 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002356 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2357 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002358 */
2359 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2360 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2361 /**
2362 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002363 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2364 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002365 */
2366 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2367 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002368 /**
2369 * An activity to run when device is inserted into a analog (low end) dock.
2370 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2371 * information, see {@link android.app.UiModeManager}.
2372 */
2373 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2374 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2375
2376 /**
2377 * An activity to run when device is inserted into a digital (high end) dock.
2378 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2379 * information, see {@link android.app.UiModeManager}.
2380 */
2381 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2382 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002383
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002384 /**
2385 * Used to indicate that the activity can be used in a car environment.
2386 */
2387 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2388 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2389
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002390 // ---------------------------------------------------------------------
2391 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002392 // Application launch intent categories (see addCategory()).
2393
2394 /**
2395 * Used with {@link #ACTION_MAIN} to launch the browser application.
2396 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002397 * <p>NOTE: This should not be used as the primary key of an Intent,
2398 * since it will not result in the app launching with the correct
2399 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002400 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002401 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002402 */
2403 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2404 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2405
2406 /**
2407 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2408 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002409 * <p>NOTE: This should not be used as the primary key of an Intent,
2410 * since it will not result in the app launching with the correct
2411 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002412 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002413 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002414 */
2415 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2416 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2417
2418 /**
2419 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2420 * The activity should be able to view and manipulate calendar entries.
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_CALENDAR = "android.intent.category.APP_CALENDAR";
2429
2430 /**
2431 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2432 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002433 * <p>NOTE: This should not be used as the primary key of an Intent,
2434 * since it will not result in the app launching with the correct
2435 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002436 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002437 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002438 */
2439 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2440 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2441
2442 /**
2443 * Used with {@link #ACTION_MAIN} to launch the email application.
2444 * The activity should be able to send and receive email.
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_EMAIL = "android.intent.category.APP_EMAIL";
2453
2454 /**
2455 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2456 * The activity should be able to view and manipulate image and video files
2457 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002458 * <p>NOTE: This should not be used as the primary key of an Intent,
2459 * since it will not result in the app launching with the correct
2460 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002461 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002462 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002463 */
2464 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2465 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2466
2467 /**
2468 * Used with {@link #ACTION_MAIN} to launch the maps application.
2469 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002470 * <p>NOTE: This should not be used as the primary key of an Intent,
2471 * since it will not result in the app launching with the correct
2472 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002473 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002474 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002475 */
2476 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2477 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2478
2479 /**
2480 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2481 * The activity should be able to send and receive text messages.
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_MESSAGING = "android.intent.category.APP_MESSAGING";
2490
2491 /**
2492 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002493 * The activity should be able to play, browse, or manipulate music files
2494 * stored on the device.
2495 * <p>NOTE: This should not be used as the primary key of an Intent,
2496 * since it will not result in the app launching with the correct
2497 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002498 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002499 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002500 */
2501 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2502 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2503
2504 // ---------------------------------------------------------------------
2505 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002506 // Standard extra data keys.
2507
2508 /**
2509 * The initial data to place in a newly created record. Use with
2510 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2511 * fields as would be given to the underlying ContentProvider.insert()
2512 * call.
2513 */
2514 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2515
2516 /**
2517 * A constant CharSequence that is associated with the Intent, used with
2518 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2519 * this may be a styled CharSequence, so you must use
2520 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2521 * retrieve it.
2522 */
2523 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2524
2525 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002526 * A constant String that is associated with the Intent, used with
2527 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2528 * as HTML formatted text. Note that you <em>must</em> also supply
2529 * {@link #EXTRA_TEXT}.
2530 */
2531 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2532
2533 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002534 * A content: URI holding a stream of data associated with the Intent,
2535 * used with {@link #ACTION_SEND} to supply the data being sent.
2536 */
2537 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2538
2539 /**
2540 * A String[] holding e-mail addresses that should be delivered to.
2541 */
2542 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2543
2544 /**
2545 * A String[] holding e-mail addresses that should be carbon copied.
2546 */
2547 public static final String EXTRA_CC = "android.intent.extra.CC";
2548
2549 /**
2550 * A String[] holding e-mail addresses that should be blind carbon copied.
2551 */
2552 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2553
2554 /**
2555 * A constant string holding the desired subject line of a message.
2556 */
2557 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2558
2559 /**
2560 * An Intent describing the choices you would like shown with
2561 * {@link #ACTION_PICK_ACTIVITY}.
2562 */
2563 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2564
2565 /**
2566 * A CharSequence dialog title to provide to the user when used with a
2567 * {@link #ACTION_CHOOSER}.
2568 */
2569 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2570
2571 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002572 * A Parcelable[] of {@link Intent} or
2573 * {@link android.content.pm.LabeledIntent} objects as set with
2574 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2575 * a the front of the list of choices, when shown to the user with a
2576 * {@link #ACTION_CHOOSER}.
2577 */
2578 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2579
2580 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002581 * A {@link android.view.KeyEvent} object containing the event that
2582 * triggered the creation of the Intent it is in.
2583 */
2584 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2585
2586 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002587 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2588 * before shutting down.
2589 *
2590 * {@hide}
2591 */
2592 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2593
2594 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002595 * 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 -07002596 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2597 * of restarting the application.
2598 */
2599 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2600
2601 /**
2602 * A String holding the phone number originally entered in
2603 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2604 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2605 */
2606 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002607
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002608 /**
2609 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2610 * intents to supply the uid the package had been assigned. Also an optional
2611 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2612 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2613 * purpose.
2614 */
2615 public static final String EXTRA_UID = "android.intent.extra.UID";
2616
2617 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002618 * @hide String array of package names.
2619 */
2620 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2621
2622 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002623 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2624 * intents to indicate whether this represents a full uninstall (removing
2625 * both the code and its data) or a partial uninstall (leaving its data,
2626 * implying that this is an update).
2627 */
2628 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002629
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002630 /**
2631 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2632 * intents to indicate that this is a replacement of the package, so this
2633 * broadcast will immediately be followed by an add broadcast for a
2634 * different version of the same package.
2635 */
2636 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002637
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002638 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002639 * Used as an int extra field in {@link android.app.AlarmManager} intents
2640 * to tell the application being invoked how many pending alarms are being
2641 * delievered with the intent. For one-shot alarms this will always be 1.
2642 * For recurring alarms, this might be greater than 1 if the device was
2643 * asleep or powered off at the time an earlier alarm would have been
2644 * delivered.
2645 */
2646 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002647
Jacek Surazski86b6c532009-05-13 14:38:28 +02002648 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002649 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2650 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002651 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2652 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002653 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2654 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2655 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002656 */
2657 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2658
2659 /**
2660 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2661 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002662 */
2663 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2664
2665 /**
2666 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2667 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002668 */
2669 public static final int EXTRA_DOCK_STATE_DESK = 1;
2670
2671 /**
2672 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2673 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002674 */
2675 public static final int EXTRA_DOCK_STATE_CAR = 2;
2676
2677 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002678 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2679 * to represent that the phone is in a analog (low end) dock.
2680 */
2681 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2682
2683 /**
2684 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2685 * to represent that the phone is in a digital (high end) dock.
2686 */
2687 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2688
2689 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002690 * Boolean that can be supplied as meta-data with a dock activity, to
2691 * indicate that the dock should take over the home key when it is active.
2692 */
2693 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002694
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002695 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002696 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2697 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002698 */
2699 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2700
2701 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002702 * Used in the extra field in the remote intent. It's astring token passed with the
2703 * remote intent.
2704 */
2705 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2706 "android.intent.extra.remote_intent_token";
2707
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002708 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002709 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002710 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002711 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002712 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002713 "android.intent.extra.changed_component_name";
2714
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002715 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002716 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002717 * and contains a string array of all of the components that have changed.
2718 */
2719 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2720 "android.intent.extra.changed_component_name_list";
2721
2722 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002723 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002724 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2725 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002726 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002727 */
2728 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2729 "android.intent.extra.changed_package_list";
2730
2731 /**
2732 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002733 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2734 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002735 * and contains an integer array of uids of all of the components
2736 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002737 */
2738 public static final String EXTRA_CHANGED_UID_LIST =
2739 "android.intent.extra.changed_uid_list";
2740
2741 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002742 * @hide
2743 * Magic extra system code can use when binding, to give a label for
2744 * who it is that has bound to a service. This is an integer giving
2745 * a framework string resource that can be displayed to the user.
2746 */
2747 public static final String EXTRA_CLIENT_LABEL =
2748 "android.intent.extra.client_label";
2749
2750 /**
2751 * @hide
2752 * Magic extra system code can use when binding, to give a PendingIntent object
2753 * that can be launched for the user to disable the system's use of this
2754 * service.
2755 */
2756 public static final String EXTRA_CLIENT_INTENT =
2757 "android.intent.extra.client_intent";
2758
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002759 /**
2760 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2761 * data that is on the local device. This is a boolean extra; the default
2762 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2763 * the user to select media that is already on the device, not requiring it
2764 * be downloaded from a remote service when opened. Another way to look
2765 * at it is that such content should generally have a "_data" column to the
2766 * path of the content on local external storage.
2767 */
2768 public static final String EXTRA_LOCAL_ONLY =
2769 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07002770
Amith Yamasani13593602012-03-22 16:16:17 -07002771 /**
2772 * The userid carried with broadcast intents related to addition, removal and switching of users
2773 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
2774 * @hide
2775 */
2776 public static final String EXTRA_USERID =
2777 "android.intent.extra.user_id";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002778 // ---------------------------------------------------------------------
2779 // ---------------------------------------------------------------------
2780 // Intent flags (see mFlags variable).
2781
2782 /**
2783 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002784 * perform read operations on the Uri in the Intent's data and any URIs
2785 * specified in its ClipData. When applying to an Intent's ClipData,
2786 * all URIs as well as recursive traversals through data or other ClipData
2787 * in Intent items will be granted; only the grant flags of the top-level
2788 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002789 */
2790 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2791 /**
2792 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002793 * perform write operations on the Uri in the Intent's data and any URIs
2794 * specified in its ClipData. When applying to an Intent's ClipData,
2795 * all URIs as well as recursive traversals through data or other ClipData
2796 * in Intent items will be granted; only the grant flags of the top-level
2797 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002798 */
2799 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2800 /**
2801 * Can be set by the caller to indicate that this Intent is coming from
2802 * a background operation, not from direct user interaction.
2803 */
2804 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2805 /**
2806 * A flag you can enable for debugging: when set, log messages will be
2807 * printed during the resolution of this intent to show you what has
2808 * been found to create the final resolved list.
2809 */
2810 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002811 /**
2812 * If set, this intent will not match any components in packages that
2813 * are currently stopped. If this is not set, then the default behavior
2814 * is to include such applications in the result.
2815 */
2816 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2817 /**
2818 * If set, this intent will always match any components in packages that
2819 * are currently stopped. This is the default behavior when
2820 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2821 * flags are set, this one wins (it allows overriding of exclude for
2822 * places where the framework may automatically set the exclude flag).
2823 */
2824 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002825
2826 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002827 * If set, the new activity is not kept in the history stack. As soon as
2828 * the user navigates away from it, the activity is finished. This may also
2829 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2830 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002831 */
2832 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2833 /**
2834 * If set, the activity will not be launched if it is already running
2835 * at the top of the history stack.
2836 */
2837 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2838 /**
2839 * If set, this activity will become the start of a new task on this
2840 * history stack. A task (from the activity that started it to the
2841 * next task activity) defines an atomic group of activities that the
2842 * user can move to. Tasks can be moved to the foreground and background;
2843 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002844 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002845 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2846 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002847 *
2848 * <p>This flag is generally used by activities that want
2849 * to present a "launcher" style behavior: they give the user a list of
2850 * separate things that can be done, which otherwise run completely
2851 * independently of the activity launching them.
2852 *
2853 * <p>When using this flag, if a task is already running for the activity
2854 * you are now starting, then a new activity will not be started; instead,
2855 * the current task will simply be brought to the front of the screen with
2856 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2857 * to disable this behavior.
2858 *
2859 * <p>This flag can not be used when the caller is requesting a result from
2860 * the activity being launched.
2861 */
2862 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2863 /**
2864 * <strong>Do not use this flag unless you are implementing your own
2865 * top-level application launcher.</strong> Used in conjunction with
2866 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2867 * behavior of bringing an existing task to the foreground. When set,
2868 * a new task is <em>always</em> started to host the Activity for the
2869 * Intent, regardless of whether there is already an existing task running
2870 * the same thing.
2871 *
2872 * <p><strong>Because the default system does not include graphical task management,
2873 * you should not use this flag unless you provide some way for a user to
2874 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002875 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002876 * <p>This flag is ignored if
2877 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2878 *
Scott Main7aee61f2011-02-08 11:25:01 -08002879 * <p>See
2880 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2881 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002882 */
2883 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2884 /**
2885 * If set, and the activity being launched is already running in the
2886 * current task, then instead of launching a new instance of that activity,
2887 * all of the other activities on top of it will be closed and this Intent
2888 * will be delivered to the (now on top) old activity as a new Intent.
2889 *
2890 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2891 * If D calls startActivity() with an Intent that resolves to the component
2892 * of activity B, then C and D will be finished and B receive the given
2893 * Intent, resulting in the stack now being: A, B.
2894 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002895 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002896 * either receive the new intent you are starting here in its
2897 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002898 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002899 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2900 * the same intent, then it will be finished and re-created; for all other
2901 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2902 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002903 *
2904 * <p>This launch mode can also be used to good effect in conjunction with
2905 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2906 * of a task, it will bring any currently running instance of that task
2907 * to the foreground, and then clear it to its root state. This is
2908 * especially useful, for example, when launching an activity from the
2909 * notification manager.
2910 *
Scott Main7aee61f2011-02-08 11:25:01 -08002911 * <p>See
2912 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2913 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002914 */
2915 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2916 /**
2917 * If set and this intent is being used to launch a new activity from an
2918 * existing one, then the reply target of the existing activity will be
2919 * transfered to the new activity. This way the new activity can call
2920 * {@link android.app.Activity#setResult} and have that result sent back to
2921 * the reply target of the original activity.
2922 */
2923 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2924 /**
2925 * If set and this intent is being used to launch a new activity from an
2926 * existing one, the current activity will not be counted as the top
2927 * activity for deciding whether the new intent should be delivered to
2928 * the top instead of starting a new one. The previous activity will
2929 * be used as the top, with the assumption being that the current activity
2930 * will finish itself immediately.
2931 */
2932 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2933 /**
2934 * If set, the new activity is not kept in the list of recently launched
2935 * activities.
2936 */
2937 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2938 /**
2939 * This flag is not normally set by application code, but set for you by
2940 * the system as described in the
2941 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2942 * launchMode} documentation for the singleTask mode.
2943 */
2944 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2945 /**
2946 * If set, and this activity is either being started in a new task or
2947 * bringing to the top an existing task, then it will be launched as
2948 * the front door of the task. This will result in the application of
2949 * any affinities needed to have that task in the proper state (either
2950 * moving activities to or from it), or simply resetting that task to
2951 * its initial state if needed.
2952 */
2953 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2954 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002955 * This flag is not normally set by application code, but set for you by
2956 * the system if this activity is being launched from history
2957 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002958 */
2959 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002960 /**
2961 * If set, this marks a point in the task's activity stack that should
2962 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002963 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002964 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2965 * the user re-launching it from home), this activity and all on top of
2966 * it will be finished so that the user does not return to them, but
2967 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002968 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002969 * <p>This is useful for cases where you have a logical break in your
2970 * application. For example, an e-mail application may have a command
2971 * to view an attachment, which launches an image view activity to
2972 * display it. This activity should be part of the e-mail application's
2973 * task, since it is a part of the task the user is involved in. However,
2974 * if the user leaves that task, and later selects the e-mail app from
2975 * home, we may like them to return to the conversation they were
2976 * viewing, not the picture attachment, since that is confusing. By
2977 * setting this flag when launching the image viewer, that viewer and
2978 * any activities it starts will be removed the next time the user returns
2979 * to mail.
2980 */
2981 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002982 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002983 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002984 * callback from occurring on the current frontmost activity before it is
2985 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002986 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002987 * <p>Typically, an activity can rely on that callback to indicate that an
2988 * explicit user action has caused their activity to be moved out of the
2989 * foreground. The callback marks an appropriate point in the activity's
2990 * lifecycle for it to dismiss any notifications that it intends to display
2991 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002992 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002993 * <p>If an activity is ever started via any non-user-driven events such as
2994 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2995 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002996 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002997 */
2998 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002999 /**
3000 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3001 * this flag will cause the launched activity to be brought to the front of its
3002 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003003 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003004 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3005 * If D calls startActivity() with an Intent that resolves to the component
3006 * of activity B, then B will be brought to the front of the history stack,
3007 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003008 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003009 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003010 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003011 */
3012 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003013 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003014 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3015 * this flag will prevent the system from applying an activity transition
3016 * animation to go to the next activity state. This doesn't mean an
3017 * animation will never run -- if another activity change happens that doesn't
3018 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003019 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003020 * when you are going to do a series of activity operations but the
3021 * animation seen by the user shouldn't be driven by the first activity
3022 * change but rather a later one.
3023 */
3024 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3025 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003026 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3027 * this flag will cause any existing task that would be associated with the
3028 * activity to be cleared before the activity is started. That is, the activity
3029 * becomes the new root of an otherwise empty task, and any old activities
3030 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3031 */
3032 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3033 /**
3034 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3035 * this flag will cause a newly launching task to be placed on top of the current
3036 * home activity task (if there is one). That is, pressing back from the task
3037 * will always return the user to home even if that was not the last activity they
3038 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3039 */
3040 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3041 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003042 * If set, when sending a broadcast only registered receivers will be
3043 * called -- no BroadcastReceiver components will be launched.
3044 */
3045 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003046 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003047 * If set, when sending a broadcast the new broadcast will replace
3048 * any existing pending broadcast that matches it. Matching is defined
3049 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3050 * true for the intents of the two broadcasts. When a match is found,
3051 * the new broadcast (and receivers associated with it) will replace the
3052 * existing one in the pending broadcast list, remaining at the same
3053 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003054 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003055 * <p>This flag is most typically used with sticky broadcasts, which
3056 * only care about delivering the most recent values of the broadcast
3057 * to their receivers.
3058 */
3059 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3060 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003061 * If set, when sending a broadcast the recipient is allowed to run at
3062 * foreground priority, with a shorter timeout interval. During normal
3063 * broadcasts the receivers are not automatically hoisted out of the
3064 * background priority class.
3065 */
3066 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3067 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003068 * If set, when sending a broadcast <i>before boot has completed</i> only
3069 * registered receivers will be called -- no BroadcastReceiver components
3070 * will be launched. Sticky intent state will be recorded properly even
3071 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3072 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003073 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003074 * <p>This flag is only for use by system sevices as a convenience to
3075 * avoid having to implement a more complex mechanism around detection
3076 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003077 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003078 * @hide
3079 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003080 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003081 /**
3082 * Set when this broadcast is for a boot upgrade, a special mode that
3083 * allows the broadcast to be sent before the system is ready and launches
3084 * the app process with no providers running in it.
3085 * @hide
3086 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003087 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003088
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003089 /**
3090 * @hide Flags that can't be changed with PendingIntent.
3091 */
3092 public static final int IMMUTABLE_FLAGS =
3093 FLAG_GRANT_READ_URI_PERMISSION
3094 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003095
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003096 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003097 // ---------------------------------------------------------------------
3098 // toUri() and parseUri() options.
3099
3100 /**
3101 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3102 * always has the "intent:" scheme. This syntax can be used when you want
3103 * to later disambiguate between URIs that are intended to describe an
3104 * Intent vs. all others that should be treated as raw URIs. When used
3105 * with {@link #parseUri}, any other scheme will result in a generic
3106 * VIEW action for that raw URI.
3107 */
3108 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003109
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003110 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003111
3112 private String mAction;
3113 private Uri mData;
3114 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003115 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003116 private ComponentName mComponent;
3117 private int mFlags;
3118 private HashSet<String> mCategories;
3119 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003120 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003121 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003122 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003123
3124 // ---------------------------------------------------------------------
3125
3126 /**
3127 * Create an empty intent.
3128 */
3129 public Intent() {
3130 }
3131
3132 /**
3133 * Copy constructor.
3134 */
3135 public Intent(Intent o) {
3136 this.mAction = o.mAction;
3137 this.mData = o.mData;
3138 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003139 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003140 this.mComponent = o.mComponent;
3141 this.mFlags = o.mFlags;
3142 if (o.mCategories != null) {
3143 this.mCategories = new HashSet<String>(o.mCategories);
3144 }
3145 if (o.mExtras != null) {
3146 this.mExtras = new Bundle(o.mExtras);
3147 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003148 if (o.mSourceBounds != null) {
3149 this.mSourceBounds = new Rect(o.mSourceBounds);
3150 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003151 if (o.mSelector != null) {
3152 this.mSelector = new Intent(o.mSelector);
3153 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003154 if (o.mClipData != null) {
3155 this.mClipData = new ClipData(o.mClipData);
3156 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003157 }
3158
3159 @Override
3160 public Object clone() {
3161 return new Intent(this);
3162 }
3163
3164 private Intent(Intent o, boolean all) {
3165 this.mAction = o.mAction;
3166 this.mData = o.mData;
3167 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003168 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003169 this.mComponent = o.mComponent;
3170 if (o.mCategories != null) {
3171 this.mCategories = new HashSet<String>(o.mCategories);
3172 }
3173 }
3174
3175 /**
3176 * Make a clone of only the parts of the Intent that are relevant for
3177 * filter matching: the action, data, type, component, and categories.
3178 */
3179 public Intent cloneFilter() {
3180 return new Intent(this, false);
3181 }
3182
3183 /**
3184 * Create an intent with a given action. All other fields (data, type,
3185 * class) are null. Note that the action <em>must</em> be in a
3186 * namespace because Intents are used globally in the system -- for
3187 * example the system VIEW action is android.intent.action.VIEW; an
3188 * application's custom action would be something like
3189 * com.google.app.myapp.CUSTOM_ACTION.
3190 *
3191 * @param action The Intent action, such as ACTION_VIEW.
3192 */
3193 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003194 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003195 }
3196
3197 /**
3198 * Create an intent with a given action and for a given data url. Note
3199 * that the action <em>must</em> be in a namespace because Intents are
3200 * used globally in the system -- for example the system VIEW action is
3201 * android.intent.action.VIEW; an application's custom action would be
3202 * something like com.google.app.myapp.CUSTOM_ACTION.
3203 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003204 * <p><em>Note: scheme and host name matching in the Android framework is
3205 * case-sensitive, unlike the formal RFC. As a result,
3206 * you should always ensure that you write your Uri with these elements
3207 * using lower case letters, and normalize any Uris you receive from
3208 * outside of Android to ensure the scheme and host is lower case.</em></p>
3209 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003210 * @param action The Intent action, such as ACTION_VIEW.
3211 * @param uri The Intent data URI.
3212 */
3213 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003214 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003215 mData = uri;
3216 }
3217
3218 /**
3219 * Create an intent for a specific component. All other fields (action, data,
3220 * type, class) are null, though they can be modified later with explicit
3221 * calls. This provides a convenient way to create an intent that is
3222 * intended to execute a hard-coded class name, rather than relying on the
3223 * system to find an appropriate class for you; see {@link #setComponent}
3224 * for more information on the repercussions of this.
3225 *
3226 * @param packageContext A Context of the application package implementing
3227 * this class.
3228 * @param cls The component class that is to be used for the intent.
3229 *
3230 * @see #setClass
3231 * @see #setComponent
3232 * @see #Intent(String, android.net.Uri , Context, Class)
3233 */
3234 public Intent(Context packageContext, Class<?> cls) {
3235 mComponent = new ComponentName(packageContext, cls);
3236 }
3237
3238 /**
3239 * Create an intent for a specific component with a specified action and data.
3240 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3241 * construct the Intent and then calling {@link #setClass} to set its
3242 * class.
3243 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003244 * <p><em>Note: scheme and host name matching in the Android framework is
3245 * case-sensitive, unlike the formal RFC. As a result,
3246 * you should always ensure that you write your Uri with these elements
3247 * using lower case letters, and normalize any Uris you receive from
3248 * outside of Android to ensure the scheme and host is lower case.</em></p>
3249 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003250 * @param action The Intent action, such as ACTION_VIEW.
3251 * @param uri The Intent data URI.
3252 * @param packageContext A Context of the application package implementing
3253 * this class.
3254 * @param cls The component class that is to be used for the intent.
3255 *
3256 * @see #Intent(String, android.net.Uri)
3257 * @see #Intent(Context, Class)
3258 * @see #setClass
3259 * @see #setComponent
3260 */
3261 public Intent(String action, Uri uri,
3262 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003263 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003264 mData = uri;
3265 mComponent = new ComponentName(packageContext, cls);
3266 }
3267
3268 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003269 * Create an intent to launch the main (root) activity of a task. This
3270 * is the Intent that is started when the application's is launched from
3271 * Home. For anything else that wants to launch an application in the
3272 * same way, it is important that they use an Intent structured the same
3273 * way, and can use this function to ensure this is the case.
3274 *
3275 * <p>The returned Intent has the given Activity component as its explicit
3276 * component, {@link #ACTION_MAIN} as its action, and includes the
3277 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3278 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3279 * to do that through {@link #addFlags(int)} on the returned Intent.
3280 *
3281 * @param mainActivity The main activity component that this Intent will
3282 * launch.
3283 * @return Returns a newly created Intent that can be used to launch the
3284 * activity as a main application entry.
3285 *
3286 * @see #setClass
3287 * @see #setComponent
3288 */
3289 public static Intent makeMainActivity(ComponentName mainActivity) {
3290 Intent intent = new Intent(ACTION_MAIN);
3291 intent.setComponent(mainActivity);
3292 intent.addCategory(CATEGORY_LAUNCHER);
3293 return intent;
3294 }
3295
3296 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003297 * Make an Intent for the main activity of an application, without
3298 * specifying a specific activity to run but giving a selector to find
3299 * the activity. This results in a final Intent that is structured
3300 * the same as when the application is launched from
3301 * Home. For anything else that wants to launch an application in the
3302 * same way, it is important that they use an Intent structured the same
3303 * way, and can use this function to ensure this is the case.
3304 *
3305 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3306 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3307 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3308 * to do that through {@link #addFlags(int)} on the returned Intent.
3309 *
3310 * @param selectorAction The action name of the Intent's selector.
3311 * @param selectorCategory The name of a category to add to the Intent's
3312 * selector.
3313 * @return Returns a newly created Intent that can be used to launch the
3314 * activity as a main application entry.
3315 *
3316 * @see #setSelector(Intent)
3317 */
3318 public static Intent makeMainSelectorActivity(String selectorAction,
3319 String selectorCategory) {
3320 Intent intent = new Intent(ACTION_MAIN);
3321 intent.addCategory(CATEGORY_LAUNCHER);
3322 Intent selector = new Intent();
3323 selector.setAction(selectorAction);
3324 selector.addCategory(selectorCategory);
3325 intent.setSelector(selector);
3326 return intent;
3327 }
3328
3329 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003330 * Make an Intent that can be used to re-launch an application's task
3331 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3332 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3333 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3334 *
3335 * @param mainActivity The activity component that is the root of the
3336 * task; this is the activity that has been published in the application's
3337 * manifest as the main launcher icon.
3338 *
3339 * @return Returns a newly created Intent that can be used to relaunch the
3340 * activity's task in its root state.
3341 */
3342 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3343 Intent intent = makeMainActivity(mainActivity);
3344 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3345 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3346 return intent;
3347 }
3348
3349 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003350 * Call {@link #parseUri} with 0 flags.
3351 * @deprecated Use {@link #parseUri} instead.
3352 */
3353 @Deprecated
3354 public static Intent getIntent(String uri) throws URISyntaxException {
3355 return parseUri(uri, 0);
3356 }
Tom Taylord4a47292009-12-21 13:59:18 -08003357
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003358 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003359 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003360 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003361 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003362 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003363 *
3364 * <p>The URI given here must not be relative -- that is, it must include
3365 * the scheme and full path.
3366 *
3367 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003368 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003369 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003370 *
3371 * @return Intent The newly created Intent object.
3372 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003373 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3374 * it bad (as parsed by the Uri class) or the Intent data within the
3375 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003376 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003377 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003378 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003379 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003380 int i = 0;
3381 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003382 // Validate intent scheme for if requested.
3383 if ((flags&URI_INTENT_SCHEME) != 0) {
3384 if (!uri.startsWith("intent:")) {
3385 Intent intent = new Intent(ACTION_VIEW);
3386 try {
3387 intent.setData(Uri.parse(uri));
3388 } catch (IllegalArgumentException e) {
3389 throw new URISyntaxException(uri, e.getMessage());
3390 }
3391 return intent;
3392 }
3393 }
Tom Taylord4a47292009-12-21 13:59:18 -08003394
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003395 // simple case
3396 i = uri.lastIndexOf("#");
3397 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3398
3399 // old format Intent URI
3400 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003401
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003402 // new format
3403 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003404 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003405
3406 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003407 String data = i >= 0 ? uri.substring(0, i) : null;
3408 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003409 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003410
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003411 // loop over contents of Intent, all name=value;
3412 while (!uri.startsWith("end", i)) {
3413 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003414 if (eq < 0) eq = i-1;
3415 int semi = uri.indexOf(';', i);
3416 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003417
3418 // action
3419 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003420 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003421 }
3422
3423 // categories
3424 else if (uri.startsWith("category=", i)) {
3425 intent.addCategory(value);
3426 }
3427
3428 // type
3429 else if (uri.startsWith("type=", i)) {
3430 intent.mType = value;
3431 }
3432
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003433 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003434 else if (uri.startsWith("launchFlags=", i)) {
3435 intent.mFlags = Integer.decode(value).intValue();
3436 }
3437
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003438 // package
3439 else if (uri.startsWith("package=", i)) {
3440 intent.mPackage = value;
3441 }
3442
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003443 // component
3444 else if (uri.startsWith("component=", i)) {
3445 intent.mComponent = ComponentName.unflattenFromString(value);
3446 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003447
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003448 // scheme
3449 else if (uri.startsWith("scheme=", i)) {
3450 scheme = value;
3451 }
3452
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003453 // source bounds
3454 else if (uri.startsWith("sourceBounds=", i)) {
3455 intent.mSourceBounds = Rect.unflattenFromString(value);
3456 }
3457
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003458 // selector
3459 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3460 intent = new Intent();
3461 }
3462
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003463 // extra
3464 else {
3465 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003466 // create Bundle if it doesn't already exist
3467 if (intent.mExtras == null) intent.mExtras = new Bundle();
3468 Bundle b = intent.mExtras;
3469 // add EXTRA
3470 if (uri.startsWith("S.", i)) b.putString(key, value);
3471 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3472 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3473 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3474 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3475 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3476 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3477 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3478 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3479 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3480 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003481
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003482 // move to the next item
3483 i = semi + 1;
3484 }
3485
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003486 if (intent != baseIntent) {
3487 // The Intent had a selector; fix it up.
3488 baseIntent.setSelector(intent);
3489 intent = baseIntent;
3490 }
3491
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003492 if (data != null) {
3493 if (data.startsWith("intent:")) {
3494 data = data.substring(7);
3495 if (scheme != null) {
3496 data = scheme + ':' + data;
3497 }
3498 }
Tom Taylord4a47292009-12-21 13:59:18 -08003499
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003500 if (data.length() > 0) {
3501 try {
3502 intent.mData = Uri.parse(data);
3503 } catch (IllegalArgumentException e) {
3504 throw new URISyntaxException(uri, e.getMessage());
3505 }
3506 }
3507 }
Tom Taylord4a47292009-12-21 13:59:18 -08003508
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003509 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003510
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003511 } catch (IndexOutOfBoundsException e) {
3512 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3513 }
3514 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003515
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003516 public static Intent getIntentOld(String uri) throws URISyntaxException {
3517 Intent intent;
3518
3519 int i = uri.lastIndexOf('#');
3520 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003521 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003522 final int intentFragmentStart = i;
3523 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003524
3525 i++;
3526
3527 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003528 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003529 i += 7;
3530 int j = uri.indexOf(')', i);
3531 action = uri.substring(i, j);
3532 i = j + 1;
3533 }
3534
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003535 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003536
3537 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003538 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003539 i += 11;
3540 int j = uri.indexOf(')', i);
3541 while (i < j) {
3542 int sep = uri.indexOf('!', i);
3543 if (sep < 0) sep = j;
3544 if (i < sep) {
3545 intent.addCategory(uri.substring(i, sep));
3546 }
3547 i = sep + 1;
3548 }
3549 i = j + 1;
3550 }
3551
3552 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003553 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003554 i += 5;
3555 int j = uri.indexOf(')', i);
3556 intent.mType = uri.substring(i, j);
3557 i = j + 1;
3558 }
3559
3560 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003561 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003562 i += 12;
3563 int j = uri.indexOf(')', i);
3564 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3565 i = j + 1;
3566 }
3567
3568 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003569 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003570 i += 10;
3571 int j = uri.indexOf(')', i);
3572 int sep = uri.indexOf('!', i);
3573 if (sep >= 0 && sep < j) {
3574 String pkg = uri.substring(i, sep);
3575 String cls = uri.substring(sep + 1, j);
3576 intent.mComponent = new ComponentName(pkg, cls);
3577 }
3578 i = j + 1;
3579 }
3580
3581 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003582 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003583 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003584
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003585 final int closeParen = uri.indexOf(')', i);
3586 if (closeParen == -1) throw new URISyntaxException(uri,
3587 "EXTRA missing trailing ')'", i);
3588
3589 while (i < closeParen) {
3590 // fetch the key value
3591 int j = uri.indexOf('=', i);
3592 if (j <= i + 1 || i >= closeParen) {
3593 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3594 }
3595 char type = uri.charAt(i);
3596 i++;
3597 String key = uri.substring(i, j);
3598 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003599
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003600 // get type-value
3601 j = uri.indexOf('!', i);
3602 if (j == -1 || j >= closeParen) j = closeParen;
3603 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3604 String value = uri.substring(i, j);
3605 i = j;
3606
3607 // create Bundle if it doesn't already exist
3608 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003609
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003610 // add item to bundle
3611 try {
3612 switch (type) {
3613 case 'S':
3614 intent.mExtras.putString(key, Uri.decode(value));
3615 break;
3616 case 'B':
3617 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3618 break;
3619 case 'b':
3620 intent.mExtras.putByte(key, Byte.parseByte(value));
3621 break;
3622 case 'c':
3623 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3624 break;
3625 case 'd':
3626 intent.mExtras.putDouble(key, Double.parseDouble(value));
3627 break;
3628 case 'f':
3629 intent.mExtras.putFloat(key, Float.parseFloat(value));
3630 break;
3631 case 'i':
3632 intent.mExtras.putInt(key, Integer.parseInt(value));
3633 break;
3634 case 'l':
3635 intent.mExtras.putLong(key, Long.parseLong(value));
3636 break;
3637 case 's':
3638 intent.mExtras.putShort(key, Short.parseShort(value));
3639 break;
3640 default:
3641 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3642 }
3643 } catch (NumberFormatException e) {
3644 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3645 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003646
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003647 char ch = uri.charAt(i);
3648 if (ch == ')') break;
3649 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3650 i++;
3651 }
3652 }
3653
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003654 if (isIntentFragment) {
3655 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3656 } else {
3657 intent.mData = Uri.parse(uri);
3658 }
Tom Taylord4a47292009-12-21 13:59:18 -08003659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003660 if (intent.mAction == null) {
3661 // By default, if no action is specified, then use VIEW.
3662 intent.mAction = ACTION_VIEW;
3663 }
3664
3665 } else {
3666 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3667 }
3668
3669 return intent;
3670 }
3671
3672 /**
3673 * Retrieve the general action to be performed, such as
3674 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3675 * the information in the intent should be interpreted -- most importantly,
3676 * what to do with the data returned by {@link #getData}.
3677 *
3678 * @return The action of this intent or null if none is specified.
3679 *
3680 * @see #setAction
3681 */
3682 public String getAction() {
3683 return mAction;
3684 }
3685
3686 /**
3687 * Retrieve data this intent is operating on. This URI specifies the name
3688 * of the data; often it uses the content: scheme, specifying data in a
3689 * content provider. Other schemes may be handled by specific activities,
3690 * such as http: by the web browser.
3691 *
3692 * @return The URI of the data this intent is targeting or null.
3693 *
3694 * @see #getScheme
3695 * @see #setData
3696 */
3697 public Uri getData() {
3698 return mData;
3699 }
3700
3701 /**
3702 * The same as {@link #getData()}, but returns the URI as an encoded
3703 * String.
3704 */
3705 public String getDataString() {
3706 return mData != null ? mData.toString() : null;
3707 }
3708
3709 /**
3710 * Return the scheme portion of the intent's data. If the data is null or
3711 * does not include a scheme, null is returned. Otherwise, the scheme
3712 * prefix without the final ':' is returned, i.e. "http".
3713 *
3714 * <p>This is the same as calling getData().getScheme() (and checking for
3715 * null data).
3716 *
3717 * @return The scheme of this intent.
3718 *
3719 * @see #getData
3720 */
3721 public String getScheme() {
3722 return mData != null ? mData.getScheme() : null;
3723 }
3724
3725 /**
3726 * Retrieve any explicit MIME type included in the intent. This is usually
3727 * null, as the type is determined by the intent data.
3728 *
3729 * @return If a type was manually set, it is returned; else null is
3730 * returned.
3731 *
3732 * @see #resolveType(ContentResolver)
3733 * @see #setType
3734 */
3735 public String getType() {
3736 return mType;
3737 }
3738
3739 /**
3740 * Return the MIME data type of this intent. If the type field is
3741 * explicitly set, that is simply returned. Otherwise, if the data is set,
3742 * the type of that data is returned. If neither fields are set, a null is
3743 * returned.
3744 *
3745 * @return The MIME type of this intent.
3746 *
3747 * @see #getType
3748 * @see #resolveType(ContentResolver)
3749 */
3750 public String resolveType(Context context) {
3751 return resolveType(context.getContentResolver());
3752 }
3753
3754 /**
3755 * Return the MIME data type of this intent. If the type field is
3756 * explicitly set, that is simply returned. Otherwise, if the data is set,
3757 * the type of that data is returned. If neither fields are set, a null is
3758 * returned.
3759 *
3760 * @param resolver A ContentResolver that can be used to determine the MIME
3761 * type of the intent's data.
3762 *
3763 * @return The MIME type of this intent.
3764 *
3765 * @see #getType
3766 * @see #resolveType(Context)
3767 */
3768 public String resolveType(ContentResolver resolver) {
3769 if (mType != null) {
3770 return mType;
3771 }
3772 if (mData != null) {
3773 if ("content".equals(mData.getScheme())) {
3774 return resolver.getType(mData);
3775 }
3776 }
3777 return null;
3778 }
3779
3780 /**
3781 * Return the MIME data type of this intent, only if it will be needed for
3782 * intent resolution. This is not generally useful for application code;
3783 * it is used by the frameworks for communicating with back-end system
3784 * services.
3785 *
3786 * @param resolver A ContentResolver that can be used to determine the MIME
3787 * type of the intent's data.
3788 *
3789 * @return The MIME type of this intent, or null if it is unknown or not
3790 * needed.
3791 */
3792 public String resolveTypeIfNeeded(ContentResolver resolver) {
3793 if (mComponent != null) {
3794 return mType;
3795 }
3796 return resolveType(resolver);
3797 }
3798
3799 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003800 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003801 *
3802 * @param category The category to check.
3803 *
3804 * @return boolean True if the intent contains the category, else false.
3805 *
3806 * @see #getCategories
3807 * @see #addCategory
3808 */
3809 public boolean hasCategory(String category) {
3810 return mCategories != null && mCategories.contains(category);
3811 }
3812
3813 /**
3814 * Return the set of all categories in the intent. If there are no categories,
3815 * returns NULL.
3816 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003817 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003818 *
3819 * @see #hasCategory
3820 * @see #addCategory
3821 */
3822 public Set<String> getCategories() {
3823 return mCategories;
3824 }
3825
3826 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003827 * Return the specific selector associated with this Intent. If there is
3828 * none, returns null. See {@link #setSelector} for more information.
3829 *
3830 * @see #setSelector
3831 */
3832 public Intent getSelector() {
3833 return mSelector;
3834 }
3835
3836 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003837 * Return the {@link ClipData} associated with this Intent. If there is
3838 * none, returns null. See {@link #setClipData} for more information.
3839 *
3840 * @see #setClipData;
3841 */
3842 public ClipData getClipData() {
3843 return mClipData;
3844 }
3845
3846 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003847 * Sets the ClassLoader that will be used when unmarshalling
3848 * any Parcelable values from the extras of this Intent.
3849 *
3850 * @param loader a ClassLoader, or null to use the default loader
3851 * at the time of unmarshalling.
3852 */
3853 public void setExtrasClassLoader(ClassLoader loader) {
3854 if (mExtras != null) {
3855 mExtras.setClassLoader(loader);
3856 }
3857 }
3858
3859 /**
3860 * Returns true if an extra value is associated with the given name.
3861 * @param name the extra's name
3862 * @return true if the given extra is present.
3863 */
3864 public boolean hasExtra(String name) {
3865 return mExtras != null && mExtras.containsKey(name);
3866 }
3867
3868 /**
3869 * Returns true if the Intent's extras contain a parcelled file descriptor.
3870 * @return true if the Intent contains a parcelled file descriptor.
3871 */
3872 public boolean hasFileDescriptors() {
3873 return mExtras != null && mExtras.hasFileDescriptors();
3874 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003875
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003876 /** @hide */
3877 public void setAllowFds(boolean allowFds) {
3878 if (mExtras != null) {
3879 mExtras.setAllowFds(allowFds);
3880 }
3881 }
3882
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003883 /**
3884 * Retrieve extended data from the intent.
3885 *
3886 * @param name The name of the desired item.
3887 *
3888 * @return the value of an item that previously added with putExtra()
3889 * or null if none was found.
3890 *
3891 * @deprecated
3892 * @hide
3893 */
3894 @Deprecated
3895 public Object getExtra(String name) {
3896 return getExtra(name, null);
3897 }
3898
3899 /**
3900 * Retrieve extended data from the intent.
3901 *
3902 * @param name The name of the desired item.
3903 * @param defaultValue the value to be returned if no value of the desired
3904 * type is stored with the given name.
3905 *
3906 * @return the value of an item that previously added with putExtra()
3907 * or the default value if none was found.
3908 *
3909 * @see #putExtra(String, boolean)
3910 */
3911 public boolean getBooleanExtra(String name, boolean defaultValue) {
3912 return mExtras == null ? defaultValue :
3913 mExtras.getBoolean(name, defaultValue);
3914 }
3915
3916 /**
3917 * Retrieve extended data from the intent.
3918 *
3919 * @param name The name of the desired item.
3920 * @param defaultValue the value to be returned if no value of the desired
3921 * type is stored with the given name.
3922 *
3923 * @return the value of an item that previously added with putExtra()
3924 * or the default value if none was found.
3925 *
3926 * @see #putExtra(String, byte)
3927 */
3928 public byte getByteExtra(String name, byte defaultValue) {
3929 return mExtras == null ? defaultValue :
3930 mExtras.getByte(name, defaultValue);
3931 }
3932
3933 /**
3934 * Retrieve extended data from the intent.
3935 *
3936 * @param name The name of the desired item.
3937 * @param defaultValue the value to be returned if no value of the desired
3938 * type is stored with the given name.
3939 *
3940 * @return the value of an item that previously added with putExtra()
3941 * or the default value if none was found.
3942 *
3943 * @see #putExtra(String, short)
3944 */
3945 public short getShortExtra(String name, short defaultValue) {
3946 return mExtras == null ? defaultValue :
3947 mExtras.getShort(name, defaultValue);
3948 }
3949
3950 /**
3951 * Retrieve extended data from the intent.
3952 *
3953 * @param name The name of the desired item.
3954 * @param defaultValue the value to be returned if no value of the desired
3955 * type is stored with the given name.
3956 *
3957 * @return the value of an item that previously added with putExtra()
3958 * or the default value if none was found.
3959 *
3960 * @see #putExtra(String, char)
3961 */
3962 public char getCharExtra(String name, char defaultValue) {
3963 return mExtras == null ? defaultValue :
3964 mExtras.getChar(name, defaultValue);
3965 }
3966
3967 /**
3968 * Retrieve extended data from the intent.
3969 *
3970 * @param name The name of the desired item.
3971 * @param defaultValue the value to be returned if no value of the desired
3972 * type is stored with the given name.
3973 *
3974 * @return the value of an item that previously added with putExtra()
3975 * or the default value if none was found.
3976 *
3977 * @see #putExtra(String, int)
3978 */
3979 public int getIntExtra(String name, int defaultValue) {
3980 return mExtras == null ? defaultValue :
3981 mExtras.getInt(name, defaultValue);
3982 }
3983
3984 /**
3985 * Retrieve extended data from the intent.
3986 *
3987 * @param name The name of the desired item.
3988 * @param defaultValue the value to be returned if no value of the desired
3989 * type is stored with the given name.
3990 *
3991 * @return the value of an item that previously added with putExtra()
3992 * or the default value if none was found.
3993 *
3994 * @see #putExtra(String, long)
3995 */
3996 public long getLongExtra(String name, long defaultValue) {
3997 return mExtras == null ? defaultValue :
3998 mExtras.getLong(name, defaultValue);
3999 }
4000
4001 /**
4002 * Retrieve extended data from the intent.
4003 *
4004 * @param name The name of the desired item.
4005 * @param defaultValue the value to be returned if no value of the desired
4006 * type is stored with the given name.
4007 *
4008 * @return the value of an item that previously added with putExtra(),
4009 * or the default value if no such item is present
4010 *
4011 * @see #putExtra(String, float)
4012 */
4013 public float getFloatExtra(String name, float defaultValue) {
4014 return mExtras == null ? defaultValue :
4015 mExtras.getFloat(name, defaultValue);
4016 }
4017
4018 /**
4019 * Retrieve extended data from the intent.
4020 *
4021 * @param name The name of the desired item.
4022 * @param defaultValue the value to be returned if no value of the desired
4023 * type is stored with the given name.
4024 *
4025 * @return the value of an item that previously added with putExtra()
4026 * or the default value if none was found.
4027 *
4028 * @see #putExtra(String, double)
4029 */
4030 public double getDoubleExtra(String name, double defaultValue) {
4031 return mExtras == null ? defaultValue :
4032 mExtras.getDouble(name, defaultValue);
4033 }
4034
4035 /**
4036 * Retrieve extended data from the intent.
4037 *
4038 * @param name The name of the desired item.
4039 *
4040 * @return the value of an item that previously added with putExtra()
4041 * or null if no String value was found.
4042 *
4043 * @see #putExtra(String, String)
4044 */
4045 public String getStringExtra(String name) {
4046 return mExtras == null ? null : mExtras.getString(name);
4047 }
4048
4049 /**
4050 * Retrieve extended data from the intent.
4051 *
4052 * @param name The name of the desired item.
4053 *
4054 * @return the value of an item that previously added with putExtra()
4055 * or null if no CharSequence value was found.
4056 *
4057 * @see #putExtra(String, CharSequence)
4058 */
4059 public CharSequence getCharSequenceExtra(String name) {
4060 return mExtras == null ? null : mExtras.getCharSequence(name);
4061 }
4062
4063 /**
4064 * Retrieve extended data from the intent.
4065 *
4066 * @param name The name of the desired item.
4067 *
4068 * @return the value of an item that previously added with putExtra()
4069 * or null if no Parcelable value was found.
4070 *
4071 * @see #putExtra(String, Parcelable)
4072 */
4073 public <T extends Parcelable> T getParcelableExtra(String name) {
4074 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4075 }
4076
4077 /**
4078 * Retrieve extended data from the intent.
4079 *
4080 * @param name The name of the desired item.
4081 *
4082 * @return the value of an item that previously added with putExtra()
4083 * or null if no Parcelable[] value was found.
4084 *
4085 * @see #putExtra(String, Parcelable[])
4086 */
4087 public Parcelable[] getParcelableArrayExtra(String name) {
4088 return mExtras == null ? null : mExtras.getParcelableArray(name);
4089 }
4090
4091 /**
4092 * Retrieve extended data from the intent.
4093 *
4094 * @param name The name of the desired item.
4095 *
4096 * @return the value of an item that previously added with putExtra()
4097 * or null if no ArrayList<Parcelable> value was found.
4098 *
4099 * @see #putParcelableArrayListExtra(String, ArrayList)
4100 */
4101 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4102 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4103 }
4104
4105 /**
4106 * Retrieve extended data from the intent.
4107 *
4108 * @param name The name of the desired item.
4109 *
4110 * @return the value of an item that previously added with putExtra()
4111 * or null if no Serializable value was found.
4112 *
4113 * @see #putExtra(String, Serializable)
4114 */
4115 public Serializable getSerializableExtra(String name) {
4116 return mExtras == null ? null : mExtras.getSerializable(name);
4117 }
4118
4119 /**
4120 * Retrieve extended data from the intent.
4121 *
4122 * @param name The name of the desired item.
4123 *
4124 * @return the value of an item that previously added with putExtra()
4125 * or null if no ArrayList<Integer> value was found.
4126 *
4127 * @see #putIntegerArrayListExtra(String, ArrayList)
4128 */
4129 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4130 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4131 }
4132
4133 /**
4134 * Retrieve extended data from the intent.
4135 *
4136 * @param name The name of the desired item.
4137 *
4138 * @return the value of an item that previously added with putExtra()
4139 * or null if no ArrayList<String> value was found.
4140 *
4141 * @see #putStringArrayListExtra(String, ArrayList)
4142 */
4143 public ArrayList<String> getStringArrayListExtra(String name) {
4144 return mExtras == null ? null : mExtras.getStringArrayList(name);
4145 }
4146
4147 /**
4148 * Retrieve extended data from the intent.
4149 *
4150 * @param name The name of the desired item.
4151 *
4152 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004153 * or null if no ArrayList<CharSequence> value was found.
4154 *
4155 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4156 */
4157 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4158 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4159 }
4160
4161 /**
4162 * Retrieve extended data from the intent.
4163 *
4164 * @param name The name of the desired item.
4165 *
4166 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004167 * or null if no boolean array value was found.
4168 *
4169 * @see #putExtra(String, boolean[])
4170 */
4171 public boolean[] getBooleanArrayExtra(String name) {
4172 return mExtras == null ? null : mExtras.getBooleanArray(name);
4173 }
4174
4175 /**
4176 * Retrieve extended data from the intent.
4177 *
4178 * @param name The name of the desired item.
4179 *
4180 * @return the value of an item that previously added with putExtra()
4181 * or null if no byte array value was found.
4182 *
4183 * @see #putExtra(String, byte[])
4184 */
4185 public byte[] getByteArrayExtra(String name) {
4186 return mExtras == null ? null : mExtras.getByteArray(name);
4187 }
4188
4189 /**
4190 * Retrieve extended data from the intent.
4191 *
4192 * @param name The name of the desired item.
4193 *
4194 * @return the value of an item that previously added with putExtra()
4195 * or null if no short array value was found.
4196 *
4197 * @see #putExtra(String, short[])
4198 */
4199 public short[] getShortArrayExtra(String name) {
4200 return mExtras == null ? null : mExtras.getShortArray(name);
4201 }
4202
4203 /**
4204 * Retrieve extended data from the intent.
4205 *
4206 * @param name The name of the desired item.
4207 *
4208 * @return the value of an item that previously added with putExtra()
4209 * or null if no char array value was found.
4210 *
4211 * @see #putExtra(String, char[])
4212 */
4213 public char[] getCharArrayExtra(String name) {
4214 return mExtras == null ? null : mExtras.getCharArray(name);
4215 }
4216
4217 /**
4218 * Retrieve extended data from the intent.
4219 *
4220 * @param name The name of the desired item.
4221 *
4222 * @return the value of an item that previously added with putExtra()
4223 * or null if no int array value was found.
4224 *
4225 * @see #putExtra(String, int[])
4226 */
4227 public int[] getIntArrayExtra(String name) {
4228 return mExtras == null ? null : mExtras.getIntArray(name);
4229 }
4230
4231 /**
4232 * Retrieve extended data from the intent.
4233 *
4234 * @param name The name of the desired item.
4235 *
4236 * @return the value of an item that previously added with putExtra()
4237 * or null if no long array value was found.
4238 *
4239 * @see #putExtra(String, long[])
4240 */
4241 public long[] getLongArrayExtra(String name) {
4242 return mExtras == null ? null : mExtras.getLongArray(name);
4243 }
4244
4245 /**
4246 * Retrieve extended data from the intent.
4247 *
4248 * @param name The name of the desired item.
4249 *
4250 * @return the value of an item that previously added with putExtra()
4251 * or null if no float array value was found.
4252 *
4253 * @see #putExtra(String, float[])
4254 */
4255 public float[] getFloatArrayExtra(String name) {
4256 return mExtras == null ? null : mExtras.getFloatArray(name);
4257 }
4258
4259 /**
4260 * Retrieve extended data from the intent.
4261 *
4262 * @param name The name of the desired item.
4263 *
4264 * @return the value of an item that previously added with putExtra()
4265 * or null if no double array value was found.
4266 *
4267 * @see #putExtra(String, double[])
4268 */
4269 public double[] getDoubleArrayExtra(String name) {
4270 return mExtras == null ? null : mExtras.getDoubleArray(name);
4271 }
4272
4273 /**
4274 * Retrieve extended data from the intent.
4275 *
4276 * @param name The name of the desired item.
4277 *
4278 * @return the value of an item that previously added with putExtra()
4279 * or null if no String array value was found.
4280 *
4281 * @see #putExtra(String, String[])
4282 */
4283 public String[] getStringArrayExtra(String name) {
4284 return mExtras == null ? null : mExtras.getStringArray(name);
4285 }
4286
4287 /**
4288 * Retrieve extended data from the intent.
4289 *
4290 * @param name The name of the desired item.
4291 *
4292 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004293 * or null if no CharSequence array value was found.
4294 *
4295 * @see #putExtra(String, CharSequence[])
4296 */
4297 public CharSequence[] getCharSequenceArrayExtra(String name) {
4298 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4299 }
4300
4301 /**
4302 * Retrieve extended data from the intent.
4303 *
4304 * @param name The name of the desired item.
4305 *
4306 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004307 * or null if no Bundle value was found.
4308 *
4309 * @see #putExtra(String, Bundle)
4310 */
4311 public Bundle getBundleExtra(String name) {
4312 return mExtras == null ? null : mExtras.getBundle(name);
4313 }
4314
4315 /**
4316 * Retrieve extended data from the intent.
4317 *
4318 * @param name The name of the desired item.
4319 *
4320 * @return the value of an item that previously added with putExtra()
4321 * or null if no IBinder value was found.
4322 *
4323 * @see #putExtra(String, IBinder)
4324 *
4325 * @deprecated
4326 * @hide
4327 */
4328 @Deprecated
4329 public IBinder getIBinderExtra(String name) {
4330 return mExtras == null ? null : mExtras.getIBinder(name);
4331 }
4332
4333 /**
4334 * Retrieve extended data from the intent.
4335 *
4336 * @param name The name of the desired item.
4337 * @param defaultValue The default value to return in case no item is
4338 * associated with the key 'name'
4339 *
4340 * @return the value of an item that previously added with putExtra()
4341 * or defaultValue if none was found.
4342 *
4343 * @see #putExtra
4344 *
4345 * @deprecated
4346 * @hide
4347 */
4348 @Deprecated
4349 public Object getExtra(String name, Object defaultValue) {
4350 Object result = defaultValue;
4351 if (mExtras != null) {
4352 Object result2 = mExtras.get(name);
4353 if (result2 != null) {
4354 result = result2;
4355 }
4356 }
4357
4358 return result;
4359 }
4360
4361 /**
4362 * Retrieves a map of extended data from the intent.
4363 *
4364 * @return the map of all extras previously added with putExtra(),
4365 * or null if none have been added.
4366 */
4367 public Bundle getExtras() {
4368 return (mExtras != null)
4369 ? new Bundle(mExtras)
4370 : null;
4371 }
4372
4373 /**
4374 * Retrieve any special flags associated with this intent. You will
4375 * normally just set them with {@link #setFlags} and let the system
4376 * take the appropriate action with them.
4377 *
4378 * @return int The currently set flags.
4379 *
4380 * @see #setFlags
4381 */
4382 public int getFlags() {
4383 return mFlags;
4384 }
4385
Dianne Hackborne7f97212011-02-24 14:40:20 -08004386 /** @hide */
4387 public boolean isExcludingStopped() {
4388 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4389 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4390 }
4391
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004392 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004393 * Retrieve the application package name this Intent is limited to. When
4394 * resolving an Intent, if non-null this limits the resolution to only
4395 * components in the given application package.
4396 *
4397 * @return The name of the application package for the Intent.
4398 *
4399 * @see #resolveActivity
4400 * @see #setPackage
4401 */
4402 public String getPackage() {
4403 return mPackage;
4404 }
4405
4406 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004407 * Retrieve the concrete component associated with the intent. When receiving
4408 * an intent, this is the component that was found to best handle it (that is,
4409 * yourself) and will always be non-null; in all other cases it will be
4410 * null unless explicitly set.
4411 *
4412 * @return The name of the application component to handle the intent.
4413 *
4414 * @see #resolveActivity
4415 * @see #setComponent
4416 */
4417 public ComponentName getComponent() {
4418 return mComponent;
4419 }
4420
4421 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004422 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4423 * used as a hint to the receiver for animations and the like. Null means that there
4424 * is no source bounds.
4425 */
4426 public Rect getSourceBounds() {
4427 return mSourceBounds;
4428 }
4429
4430 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004431 * Return the Activity component that should be used to handle this intent.
4432 * The appropriate component is determined based on the information in the
4433 * intent, evaluated as follows:
4434 *
4435 * <p>If {@link #getComponent} returns an explicit class, that is returned
4436 * without any further consideration.
4437 *
4438 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4439 * category to be considered.
4440 *
4441 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4442 * action.
4443 *
4444 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4445 * this type.
4446 *
4447 * <p>If {@link #addCategory} has added any categories, the activity must
4448 * handle ALL of the categories specified.
4449 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004450 * <p>If {@link #getPackage} is non-NULL, only activity components in
4451 * that application package will be considered.
4452 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004453 * <p>If there are no activities that satisfy all of these conditions, a
4454 * null string is returned.
4455 *
4456 * <p>If multiple activities are found to satisfy the intent, the one with
4457 * the highest priority will be used. If there are multiple activities
4458 * with the same priority, the system will either pick the best activity
4459 * based on user preference, or resolve to a system class that will allow
4460 * the user to pick an activity and forward from there.
4461 *
4462 * <p>This method is implemented simply by calling
4463 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4464 * true.</p>
4465 * <p> This API is called for you as part of starting an activity from an
4466 * intent. You do not normally need to call it yourself.</p>
4467 *
4468 * @param pm The package manager with which to resolve the Intent.
4469 *
4470 * @return Name of the component implementing an activity that can
4471 * display the intent.
4472 *
4473 * @see #setComponent
4474 * @see #getComponent
4475 * @see #resolveActivityInfo
4476 */
4477 public ComponentName resolveActivity(PackageManager pm) {
4478 if (mComponent != null) {
4479 return mComponent;
4480 }
4481
4482 ResolveInfo info = pm.resolveActivity(
4483 this, PackageManager.MATCH_DEFAULT_ONLY);
4484 if (info != null) {
4485 return new ComponentName(
4486 info.activityInfo.applicationInfo.packageName,
4487 info.activityInfo.name);
4488 }
4489
4490 return null;
4491 }
4492
4493 /**
4494 * Resolve the Intent into an {@link ActivityInfo}
4495 * describing the activity that should execute the intent. Resolution
4496 * follows the same rules as described for {@link #resolveActivity}, but
4497 * you get back the completely information about the resolved activity
4498 * instead of just its class name.
4499 *
4500 * @param pm The package manager with which to resolve the Intent.
4501 * @param flags Addition information to retrieve as per
4502 * {@link PackageManager#getActivityInfo(ComponentName, int)
4503 * PackageManager.getActivityInfo()}.
4504 *
4505 * @return PackageManager.ActivityInfo
4506 *
4507 * @see #resolveActivity
4508 */
4509 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4510 ActivityInfo ai = null;
4511 if (mComponent != null) {
4512 try {
4513 ai = pm.getActivityInfo(mComponent, flags);
4514 } catch (PackageManager.NameNotFoundException e) {
4515 // ignore
4516 }
4517 } else {
4518 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004519 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004520 if (info != null) {
4521 ai = info.activityInfo;
4522 }
4523 }
4524
4525 return ai;
4526 }
4527
4528 /**
4529 * Set the general action to be performed.
4530 *
4531 * @param action An action name, such as ACTION_VIEW. Application-specific
4532 * actions should be prefixed with the vendor's package name.
4533 *
4534 * @return Returns the same Intent object, for chaining multiple calls
4535 * into a single statement.
4536 *
4537 * @see #getAction
4538 */
4539 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004540 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004541 return this;
4542 }
4543
4544 /**
4545 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004546 * clears any type that was previously set by {@link #setType} or
4547 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004548 *
Nick Pellyccae4122012-01-09 14:12:58 -08004549 * <p><em>Note: scheme matching in the Android framework is
4550 * case-sensitive, unlike the formal RFC. As a result,
4551 * you should always write your Uri with a lower case scheme,
4552 * or use {@link Uri#normalize} or
4553 * {@link #setDataAndNormalize}
4554 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004555 *
Nick Pellyccae4122012-01-09 14:12:58 -08004556 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004557 *
4558 * @return Returns the same Intent object, for chaining multiple calls
4559 * into a single statement.
4560 *
4561 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004562 * @see #setDataAndNormalize
4563 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004564 */
4565 public Intent setData(Uri data) {
4566 mData = data;
4567 mType = null;
4568 return this;
4569 }
4570
4571 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004572 * Normalize and set the data this intent is operating on.
4573 *
4574 * <p>This method automatically clears any type that was
4575 * previously set (for example, by {@link #setType}).
4576 *
4577 * <p>The data Uri is normalized using
4578 * {@link android.net.Uri#normalize} before it is set,
4579 * so really this is just a convenience method for
4580 * <pre>
4581 * setData(data.normalize())
4582 * </pre>
4583 *
4584 * @param data The Uri of the data this intent is now targeting.
4585 *
4586 * @return Returns the same Intent object, for chaining multiple calls
4587 * into a single statement.
4588 *
4589 * @see #getData
4590 * @see #setType
4591 * @see android.net.Uri#normalize
4592 */
4593 public Intent setDataAndNormalize(Uri data) {
4594 return setData(data.normalize());
4595 }
4596
4597 /**
4598 * Set an explicit MIME data type.
4599 *
4600 * <p>This is used to create intents that only specify a type and not data,
4601 * for example to indicate the type of data to return.
4602 *
4603 * <p>This method automatically clears any data that was
4604 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004605 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004606 * <p><em>Note: MIME type matching in the Android framework is
4607 * case-sensitive, unlike formal RFC MIME types. As a result,
4608 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004609 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4610 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004611 *
4612 * @param type The MIME type of the data being handled by this intent.
4613 *
4614 * @return Returns the same Intent object, for chaining multiple calls
4615 * into a single statement.
4616 *
4617 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004618 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004619 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004620 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004621 */
4622 public Intent setType(String type) {
4623 mData = null;
4624 mType = type;
4625 return this;
4626 }
4627
4628 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004629 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004630 *
Nick Pellyccae4122012-01-09 14:12:58 -08004631 * <p>This is used to create intents that only specify a type and not data,
4632 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004633 *
Nick Pellyccae4122012-01-09 14:12:58 -08004634 * <p>This method automatically clears any data that was
4635 * previously set (for example by {@link #setData}).
4636 *
4637 * <p>The MIME type is normalized using
4638 * {@link #normalizeMimeType} before it is set,
4639 * so really this is just a convenience method for
4640 * <pre>
4641 * setType(Intent.normalizeMimeType(type))
4642 * </pre>
4643 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004644 * @param type The MIME type of the data being handled by this intent.
4645 *
4646 * @return Returns the same Intent object, for chaining multiple calls
4647 * into a single statement.
4648 *
Nick Pellyccae4122012-01-09 14:12:58 -08004649 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004650 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004651 * @see #normalizeMimeType
4652 */
4653 public Intent setTypeAndNormalize(String type) {
4654 return setType(normalizeMimeType(type));
4655 }
4656
4657 /**
4658 * (Usually optional) Set the data for the intent along with an explicit
4659 * MIME data type. This method should very rarely be used -- it allows you
4660 * to override the MIME type that would ordinarily be inferred from the
4661 * data with your own type given here.
4662 *
4663 * <p><em>Note: MIME type and Uri scheme matching in the
4664 * Android framework is case-sensitive, unlike the formal RFC definitions.
4665 * As a result, you should always write these elements with lower case letters,
4666 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalize} or
4667 * {@link #setDataAndTypeAndNormalize}
4668 * to ensure that they are converted to lower case.</em>
4669 *
4670 * @param data The Uri of the data this intent is now targeting.
4671 * @param type The MIME type of the data being handled by this intent.
4672 *
4673 * @return Returns the same Intent object, for chaining multiple calls
4674 * into a single statement.
4675 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004676 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004677 * @see #setData
4678 * @see #normalizeMimeType
4679 * @see android.net.Uri#normalize
4680 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004681 */
4682 public Intent setDataAndType(Uri data, String type) {
4683 mData = data;
4684 mType = type;
4685 return this;
4686 }
4687
4688 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004689 * (Usually optional) Normalize and set both the data Uri and an explicit
4690 * MIME data type. This method should very rarely be used -- it allows you
4691 * to override the MIME type that would ordinarily be inferred from the
4692 * data with your own type given here.
4693 *
4694 * <p>The data Uri and the MIME type are normalize using
4695 * {@link android.net.Uri#normalize} and {@link #normalizeMimeType}
4696 * before they are set, so really this is just a convenience method for
4697 * <pre>
4698 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4699 * </pre>
4700 *
4701 * @param data The Uri of the data this intent is now targeting.
4702 * @param type The MIME type of the data being handled by this intent.
4703 *
4704 * @return Returns the same Intent object, for chaining multiple calls
4705 * into a single statement.
4706 *
4707 * @see #setType
4708 * @see #setData
4709 * @see #setDataAndType
4710 * @see #normalizeMimeType
4711 * @see android.net.Uri#normalize
4712 */
4713 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
4714 return setDataAndType(data.normalize(), normalizeMimeType(type));
4715 }
4716
4717 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004718 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004719 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004720 * activities that provide <em>all</em> of the requested categories will be
4721 * used.
4722 *
4723 * @param category The desired category. This can be either one of the
4724 * predefined Intent categories, or a custom category in your own
4725 * namespace.
4726 *
4727 * @return Returns the same Intent object, for chaining multiple calls
4728 * into a single statement.
4729 *
4730 * @see #hasCategory
4731 * @see #removeCategory
4732 */
4733 public Intent addCategory(String category) {
4734 if (mCategories == null) {
4735 mCategories = new HashSet<String>();
4736 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004737 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004738 return this;
4739 }
4740
4741 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004742 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004743 *
4744 * @param category The category to remove.
4745 *
4746 * @see #addCategory
4747 */
4748 public void removeCategory(String category) {
4749 if (mCategories != null) {
4750 mCategories.remove(category);
4751 if (mCategories.size() == 0) {
4752 mCategories = null;
4753 }
4754 }
4755 }
4756
4757 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004758 * Set a selector for this Intent. This is a modification to the kinds of
4759 * things the Intent will match. If the selector is set, it will be used
4760 * when trying to find entities that can handle the Intent, instead of the
4761 * main contents of the Intent. This allows you build an Intent containing
4762 * a generic protocol while targeting it more specifically.
4763 *
4764 * <p>An example of where this may be used is with things like
4765 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
4766 * Intent that will launch the Browser application. However, the correct
4767 * main entry point of an application is actually {@link #ACTION_MAIN}
4768 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
4769 * used to specify the actual Activity to launch. If you launch the browser
4770 * with something different, undesired behavior may happen if the user has
4771 * previously or later launches it the normal way, since they do not match.
4772 * Instead, you can build an Intent with the MAIN action (but no ComponentName
4773 * yet specified) and set a selector with {@link #ACTION_MAIN} and
4774 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
4775 *
4776 * <p>Setting a selector does not impact the behavior of
4777 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
4778 * desired behavior of a selector -- it does not impact the base meaning
4779 * of the Intent, just what kinds of things will be matched against it
4780 * when determining who can handle it.</p>
4781 *
4782 * <p>You can not use both a selector and {@link #setPackage(String)} on
4783 * the same base Intent.</p>
4784 *
4785 * @param selector The desired selector Intent; set to null to not use
4786 * a special selector.
4787 */
4788 public void setSelector(Intent selector) {
4789 if (selector == this) {
4790 throw new IllegalArgumentException(
4791 "Intent being set as a selector of itself");
4792 }
4793 if (selector != null && mPackage != null) {
4794 throw new IllegalArgumentException(
4795 "Can't set selector when package name is already set");
4796 }
4797 mSelector = selector;
4798 }
4799
4800 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004801 * Set a {@link ClipData} associated with this Intent. This replaces any
4802 * previously set ClipData.
4803 *
4804 * <p>The ClipData in an intent is not used for Intent matching or other
4805 * such operations. Semantically it is like extras, used to transmit
4806 * additional data with the Intent. The main feature of using this over
4807 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
4808 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
4809 * items included in the clip data. This is useful, in particular, if
4810 * you want to transmit an Intent containing multiple <code>content:</code>
4811 * URIs for which the recipient may not have global permission to access the
4812 * content provider.
4813 *
4814 * <p>If the ClipData contains items that are themselves Intents, any
4815 * grant flags in those Intents will be ignored. Only the top-level flags
4816 * of the main Intent are respected, and will be applied to all Uri or
4817 * Intent items in the clip (or sub-items of the clip).
4818 *
4819 * <p>The MIME type, label, and icon in the ClipData object are not
4820 * directly used by Intent. Applications should generally rely on the
4821 * MIME type of the Intent itself, not what it may find in the ClipData.
4822 * A common practice is to construct a ClipData for use with an Intent
4823 * with a MIME type of "*\/*".
4824 *
4825 * @param clip The new clip to set. May be null to clear the current clip.
4826 */
4827 public void setClipData(ClipData clip) {
4828 mClipData = clip;
4829 }
4830
4831 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004832 * Add extended data to the intent. The name must include a package
4833 * prefix, for example the app com.android.contacts would use names
4834 * like "com.android.contacts.ShowAll".
4835 *
4836 * @param name The name of the extra data, with package prefix.
4837 * @param value The boolean data value.
4838 *
4839 * @return Returns the same Intent object, for chaining multiple calls
4840 * into a single statement.
4841 *
4842 * @see #putExtras
4843 * @see #removeExtra
4844 * @see #getBooleanExtra(String, boolean)
4845 */
4846 public Intent putExtra(String name, boolean value) {
4847 if (mExtras == null) {
4848 mExtras = new Bundle();
4849 }
4850 mExtras.putBoolean(name, value);
4851 return this;
4852 }
4853
4854 /**
4855 * Add extended data to the intent. The name must include a package
4856 * prefix, for example the app com.android.contacts would use names
4857 * like "com.android.contacts.ShowAll".
4858 *
4859 * @param name The name of the extra data, with package prefix.
4860 * @param value The byte data value.
4861 *
4862 * @return Returns the same Intent object, for chaining multiple calls
4863 * into a single statement.
4864 *
4865 * @see #putExtras
4866 * @see #removeExtra
4867 * @see #getByteExtra(String, byte)
4868 */
4869 public Intent putExtra(String name, byte value) {
4870 if (mExtras == null) {
4871 mExtras = new Bundle();
4872 }
4873 mExtras.putByte(name, value);
4874 return this;
4875 }
4876
4877 /**
4878 * Add extended data to the intent. The name must include a package
4879 * prefix, for example the app com.android.contacts would use names
4880 * like "com.android.contacts.ShowAll".
4881 *
4882 * @param name The name of the extra data, with package prefix.
4883 * @param value The char data value.
4884 *
4885 * @return Returns the same Intent object, for chaining multiple calls
4886 * into a single statement.
4887 *
4888 * @see #putExtras
4889 * @see #removeExtra
4890 * @see #getCharExtra(String, char)
4891 */
4892 public Intent putExtra(String name, char value) {
4893 if (mExtras == null) {
4894 mExtras = new Bundle();
4895 }
4896 mExtras.putChar(name, value);
4897 return this;
4898 }
4899
4900 /**
4901 * Add extended data to the intent. The name must include a package
4902 * prefix, for example the app com.android.contacts would use names
4903 * like "com.android.contacts.ShowAll".
4904 *
4905 * @param name The name of the extra data, with package prefix.
4906 * @param value The short data value.
4907 *
4908 * @return Returns the same Intent object, for chaining multiple calls
4909 * into a single statement.
4910 *
4911 * @see #putExtras
4912 * @see #removeExtra
4913 * @see #getShortExtra(String, short)
4914 */
4915 public Intent putExtra(String name, short value) {
4916 if (mExtras == null) {
4917 mExtras = new Bundle();
4918 }
4919 mExtras.putShort(name, value);
4920 return this;
4921 }
4922
4923 /**
4924 * Add extended data to the intent. The name must include a package
4925 * prefix, for example the app com.android.contacts would use names
4926 * like "com.android.contacts.ShowAll".
4927 *
4928 * @param name The name of the extra data, with package prefix.
4929 * @param value The integer data value.
4930 *
4931 * @return Returns the same Intent object, for chaining multiple calls
4932 * into a single statement.
4933 *
4934 * @see #putExtras
4935 * @see #removeExtra
4936 * @see #getIntExtra(String, int)
4937 */
4938 public Intent putExtra(String name, int value) {
4939 if (mExtras == null) {
4940 mExtras = new Bundle();
4941 }
4942 mExtras.putInt(name, value);
4943 return this;
4944 }
4945
4946 /**
4947 * Add extended data to the intent. The name must include a package
4948 * prefix, for example the app com.android.contacts would use names
4949 * like "com.android.contacts.ShowAll".
4950 *
4951 * @param name The name of the extra data, with package prefix.
4952 * @param value The long data value.
4953 *
4954 * @return Returns the same Intent object, for chaining multiple calls
4955 * into a single statement.
4956 *
4957 * @see #putExtras
4958 * @see #removeExtra
4959 * @see #getLongExtra(String, long)
4960 */
4961 public Intent putExtra(String name, long value) {
4962 if (mExtras == null) {
4963 mExtras = new Bundle();
4964 }
4965 mExtras.putLong(name, value);
4966 return this;
4967 }
4968
4969 /**
4970 * Add extended data to the intent. The name must include a package
4971 * prefix, for example the app com.android.contacts would use names
4972 * like "com.android.contacts.ShowAll".
4973 *
4974 * @param name The name of the extra data, with package prefix.
4975 * @param value The float data value.
4976 *
4977 * @return Returns the same Intent object, for chaining multiple calls
4978 * into a single statement.
4979 *
4980 * @see #putExtras
4981 * @see #removeExtra
4982 * @see #getFloatExtra(String, float)
4983 */
4984 public Intent putExtra(String name, float value) {
4985 if (mExtras == null) {
4986 mExtras = new Bundle();
4987 }
4988 mExtras.putFloat(name, value);
4989 return this;
4990 }
4991
4992 /**
4993 * Add extended data to the intent. The name must include a package
4994 * prefix, for example the app com.android.contacts would use names
4995 * like "com.android.contacts.ShowAll".
4996 *
4997 * @param name The name of the extra data, with package prefix.
4998 * @param value The double data value.
4999 *
5000 * @return Returns the same Intent object, for chaining multiple calls
5001 * into a single statement.
5002 *
5003 * @see #putExtras
5004 * @see #removeExtra
5005 * @see #getDoubleExtra(String, double)
5006 */
5007 public Intent putExtra(String name, double value) {
5008 if (mExtras == null) {
5009 mExtras = new Bundle();
5010 }
5011 mExtras.putDouble(name, value);
5012 return this;
5013 }
5014
5015 /**
5016 * Add extended data to the intent. The name must include a package
5017 * prefix, for example the app com.android.contacts would use names
5018 * like "com.android.contacts.ShowAll".
5019 *
5020 * @param name The name of the extra data, with package prefix.
5021 * @param value The String data value.
5022 *
5023 * @return Returns the same Intent object, for chaining multiple calls
5024 * into a single statement.
5025 *
5026 * @see #putExtras
5027 * @see #removeExtra
5028 * @see #getStringExtra(String)
5029 */
5030 public Intent putExtra(String name, String value) {
5031 if (mExtras == null) {
5032 mExtras = new Bundle();
5033 }
5034 mExtras.putString(name, value);
5035 return this;
5036 }
5037
5038 /**
5039 * Add extended data to the intent. The name must include a package
5040 * prefix, for example the app com.android.contacts would use names
5041 * like "com.android.contacts.ShowAll".
5042 *
5043 * @param name The name of the extra data, with package prefix.
5044 * @param value The CharSequence data value.
5045 *
5046 * @return Returns the same Intent object, for chaining multiple calls
5047 * into a single statement.
5048 *
5049 * @see #putExtras
5050 * @see #removeExtra
5051 * @see #getCharSequenceExtra(String)
5052 */
5053 public Intent putExtra(String name, CharSequence value) {
5054 if (mExtras == null) {
5055 mExtras = new Bundle();
5056 }
5057 mExtras.putCharSequence(name, value);
5058 return this;
5059 }
5060
5061 /**
5062 * Add extended data to the intent. The name must include a package
5063 * prefix, for example the app com.android.contacts would use names
5064 * like "com.android.contacts.ShowAll".
5065 *
5066 * @param name The name of the extra data, with package prefix.
5067 * @param value The Parcelable data value.
5068 *
5069 * @return Returns the same Intent object, for chaining multiple calls
5070 * into a single statement.
5071 *
5072 * @see #putExtras
5073 * @see #removeExtra
5074 * @see #getParcelableExtra(String)
5075 */
5076 public Intent putExtra(String name, Parcelable value) {
5077 if (mExtras == null) {
5078 mExtras = new Bundle();
5079 }
5080 mExtras.putParcelable(name, value);
5081 return this;
5082 }
5083
5084 /**
5085 * Add extended data to the intent. The name must include a package
5086 * prefix, for example the app com.android.contacts would use names
5087 * like "com.android.contacts.ShowAll".
5088 *
5089 * @param name The name of the extra data, with package prefix.
5090 * @param value The Parcelable[] data value.
5091 *
5092 * @return Returns the same Intent object, for chaining multiple calls
5093 * into a single statement.
5094 *
5095 * @see #putExtras
5096 * @see #removeExtra
5097 * @see #getParcelableArrayExtra(String)
5098 */
5099 public Intent putExtra(String name, Parcelable[] value) {
5100 if (mExtras == null) {
5101 mExtras = new Bundle();
5102 }
5103 mExtras.putParcelableArray(name, value);
5104 return this;
5105 }
5106
5107 /**
5108 * Add extended data to the intent. The name must include a package
5109 * prefix, for example the app com.android.contacts would use names
5110 * like "com.android.contacts.ShowAll".
5111 *
5112 * @param name The name of the extra data, with package prefix.
5113 * @param value The ArrayList<Parcelable> data value.
5114 *
5115 * @return Returns the same Intent object, for chaining multiple calls
5116 * into a single statement.
5117 *
5118 * @see #putExtras
5119 * @see #removeExtra
5120 * @see #getParcelableArrayListExtra(String)
5121 */
5122 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5123 if (mExtras == null) {
5124 mExtras = new Bundle();
5125 }
5126 mExtras.putParcelableArrayList(name, value);
5127 return this;
5128 }
5129
5130 /**
5131 * Add extended data to the intent. The name must include a package
5132 * prefix, for example the app com.android.contacts would use names
5133 * like "com.android.contacts.ShowAll".
5134 *
5135 * @param name The name of the extra data, with package prefix.
5136 * @param value The ArrayList<Integer> data value.
5137 *
5138 * @return Returns the same Intent object, for chaining multiple calls
5139 * into a single statement.
5140 *
5141 * @see #putExtras
5142 * @see #removeExtra
5143 * @see #getIntegerArrayListExtra(String)
5144 */
5145 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5146 if (mExtras == null) {
5147 mExtras = new Bundle();
5148 }
5149 mExtras.putIntegerArrayList(name, value);
5150 return this;
5151 }
5152
5153 /**
5154 * Add extended data to the intent. The name must include a package
5155 * prefix, for example the app com.android.contacts would use names
5156 * like "com.android.contacts.ShowAll".
5157 *
5158 * @param name The name of the extra data, with package prefix.
5159 * @param value The ArrayList<String> data value.
5160 *
5161 * @return Returns the same Intent object, for chaining multiple calls
5162 * into a single statement.
5163 *
5164 * @see #putExtras
5165 * @see #removeExtra
5166 * @see #getStringArrayListExtra(String)
5167 */
5168 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5169 if (mExtras == null) {
5170 mExtras = new Bundle();
5171 }
5172 mExtras.putStringArrayList(name, value);
5173 return this;
5174 }
5175
5176 /**
5177 * Add extended data to the intent. The name must include a package
5178 * prefix, for example the app com.android.contacts would use names
5179 * like "com.android.contacts.ShowAll".
5180 *
5181 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005182 * @param value The ArrayList<CharSequence> data value.
5183 *
5184 * @return Returns the same Intent object, for chaining multiple calls
5185 * into a single statement.
5186 *
5187 * @see #putExtras
5188 * @see #removeExtra
5189 * @see #getCharSequenceArrayListExtra(String)
5190 */
5191 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5192 if (mExtras == null) {
5193 mExtras = new Bundle();
5194 }
5195 mExtras.putCharSequenceArrayList(name, value);
5196 return this;
5197 }
5198
5199 /**
5200 * Add extended data to the intent. The name must include a package
5201 * prefix, for example the app com.android.contacts would use names
5202 * like "com.android.contacts.ShowAll".
5203 *
5204 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005205 * @param value The Serializable data value.
5206 *
5207 * @return Returns the same Intent object, for chaining multiple calls
5208 * into a single statement.
5209 *
5210 * @see #putExtras
5211 * @see #removeExtra
5212 * @see #getSerializableExtra(String)
5213 */
5214 public Intent putExtra(String name, Serializable value) {
5215 if (mExtras == null) {
5216 mExtras = new Bundle();
5217 }
5218 mExtras.putSerializable(name, value);
5219 return this;
5220 }
5221
5222 /**
5223 * Add extended data to the intent. The name must include a package
5224 * prefix, for example the app com.android.contacts would use names
5225 * like "com.android.contacts.ShowAll".
5226 *
5227 * @param name The name of the extra data, with package prefix.
5228 * @param value The boolean array data value.
5229 *
5230 * @return Returns the same Intent object, for chaining multiple calls
5231 * into a single statement.
5232 *
5233 * @see #putExtras
5234 * @see #removeExtra
5235 * @see #getBooleanArrayExtra(String)
5236 */
5237 public Intent putExtra(String name, boolean[] value) {
5238 if (mExtras == null) {
5239 mExtras = new Bundle();
5240 }
5241 mExtras.putBooleanArray(name, value);
5242 return this;
5243 }
5244
5245 /**
5246 * Add extended data to the intent. The name must include a package
5247 * prefix, for example the app com.android.contacts would use names
5248 * like "com.android.contacts.ShowAll".
5249 *
5250 * @param name The name of the extra data, with package prefix.
5251 * @param value The byte array data value.
5252 *
5253 * @return Returns the same Intent object, for chaining multiple calls
5254 * into a single statement.
5255 *
5256 * @see #putExtras
5257 * @see #removeExtra
5258 * @see #getByteArrayExtra(String)
5259 */
5260 public Intent putExtra(String name, byte[] value) {
5261 if (mExtras == null) {
5262 mExtras = new Bundle();
5263 }
5264 mExtras.putByteArray(name, value);
5265 return this;
5266 }
5267
5268 /**
5269 * Add extended data to the intent. The name must include a package
5270 * prefix, for example the app com.android.contacts would use names
5271 * like "com.android.contacts.ShowAll".
5272 *
5273 * @param name The name of the extra data, with package prefix.
5274 * @param value The short array data value.
5275 *
5276 * @return Returns the same Intent object, for chaining multiple calls
5277 * into a single statement.
5278 *
5279 * @see #putExtras
5280 * @see #removeExtra
5281 * @see #getShortArrayExtra(String)
5282 */
5283 public Intent putExtra(String name, short[] value) {
5284 if (mExtras == null) {
5285 mExtras = new Bundle();
5286 }
5287 mExtras.putShortArray(name, value);
5288 return this;
5289 }
5290
5291 /**
5292 * Add extended data to the intent. The name must include a package
5293 * prefix, for example the app com.android.contacts would use names
5294 * like "com.android.contacts.ShowAll".
5295 *
5296 * @param name The name of the extra data, with package prefix.
5297 * @param value The char array data value.
5298 *
5299 * @return Returns the same Intent object, for chaining multiple calls
5300 * into a single statement.
5301 *
5302 * @see #putExtras
5303 * @see #removeExtra
5304 * @see #getCharArrayExtra(String)
5305 */
5306 public Intent putExtra(String name, char[] value) {
5307 if (mExtras == null) {
5308 mExtras = new Bundle();
5309 }
5310 mExtras.putCharArray(name, value);
5311 return this;
5312 }
5313
5314 /**
5315 * Add extended data to the intent. The name must include a package
5316 * prefix, for example the app com.android.contacts would use names
5317 * like "com.android.contacts.ShowAll".
5318 *
5319 * @param name The name of the extra data, with package prefix.
5320 * @param value The int array data value.
5321 *
5322 * @return Returns the same Intent object, for chaining multiple calls
5323 * into a single statement.
5324 *
5325 * @see #putExtras
5326 * @see #removeExtra
5327 * @see #getIntArrayExtra(String)
5328 */
5329 public Intent putExtra(String name, int[] value) {
5330 if (mExtras == null) {
5331 mExtras = new Bundle();
5332 }
5333 mExtras.putIntArray(name, value);
5334 return this;
5335 }
5336
5337 /**
5338 * Add extended data to the intent. The name must include a package
5339 * prefix, for example the app com.android.contacts would use names
5340 * like "com.android.contacts.ShowAll".
5341 *
5342 * @param name The name of the extra data, with package prefix.
5343 * @param value The byte array data value.
5344 *
5345 * @return Returns the same Intent object, for chaining multiple calls
5346 * into a single statement.
5347 *
5348 * @see #putExtras
5349 * @see #removeExtra
5350 * @see #getLongArrayExtra(String)
5351 */
5352 public Intent putExtra(String name, long[] value) {
5353 if (mExtras == null) {
5354 mExtras = new Bundle();
5355 }
5356 mExtras.putLongArray(name, value);
5357 return this;
5358 }
5359
5360 /**
5361 * Add extended data to the intent. The name must include a package
5362 * prefix, for example the app com.android.contacts would use names
5363 * like "com.android.contacts.ShowAll".
5364 *
5365 * @param name The name of the extra data, with package prefix.
5366 * @param value The float array data value.
5367 *
5368 * @return Returns the same Intent object, for chaining multiple calls
5369 * into a single statement.
5370 *
5371 * @see #putExtras
5372 * @see #removeExtra
5373 * @see #getFloatArrayExtra(String)
5374 */
5375 public Intent putExtra(String name, float[] value) {
5376 if (mExtras == null) {
5377 mExtras = new Bundle();
5378 }
5379 mExtras.putFloatArray(name, value);
5380 return this;
5381 }
5382
5383 /**
5384 * Add extended data to the intent. The name must include a package
5385 * prefix, for example the app com.android.contacts would use names
5386 * like "com.android.contacts.ShowAll".
5387 *
5388 * @param name The name of the extra data, with package prefix.
5389 * @param value The double array data value.
5390 *
5391 * @return Returns the same Intent object, for chaining multiple calls
5392 * into a single statement.
5393 *
5394 * @see #putExtras
5395 * @see #removeExtra
5396 * @see #getDoubleArrayExtra(String)
5397 */
5398 public Intent putExtra(String name, double[] value) {
5399 if (mExtras == null) {
5400 mExtras = new Bundle();
5401 }
5402 mExtras.putDoubleArray(name, value);
5403 return this;
5404 }
5405
5406 /**
5407 * Add extended data to the intent. The name must include a package
5408 * prefix, for example the app com.android.contacts would use names
5409 * like "com.android.contacts.ShowAll".
5410 *
5411 * @param name The name of the extra data, with package prefix.
5412 * @param value The String array data value.
5413 *
5414 * @return Returns the same Intent object, for chaining multiple calls
5415 * into a single statement.
5416 *
5417 * @see #putExtras
5418 * @see #removeExtra
5419 * @see #getStringArrayExtra(String)
5420 */
5421 public Intent putExtra(String name, String[] value) {
5422 if (mExtras == null) {
5423 mExtras = new Bundle();
5424 }
5425 mExtras.putStringArray(name, value);
5426 return this;
5427 }
5428
5429 /**
5430 * Add extended data to the intent. The name must include a package
5431 * prefix, for example the app com.android.contacts would use names
5432 * like "com.android.contacts.ShowAll".
5433 *
5434 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005435 * @param value The CharSequence array data value.
5436 *
5437 * @return Returns the same Intent object, for chaining multiple calls
5438 * into a single statement.
5439 *
5440 * @see #putExtras
5441 * @see #removeExtra
5442 * @see #getCharSequenceArrayExtra(String)
5443 */
5444 public Intent putExtra(String name, CharSequence[] value) {
5445 if (mExtras == null) {
5446 mExtras = new Bundle();
5447 }
5448 mExtras.putCharSequenceArray(name, value);
5449 return this;
5450 }
5451
5452 /**
5453 * Add extended data to the intent. The name must include a package
5454 * prefix, for example the app com.android.contacts would use names
5455 * like "com.android.contacts.ShowAll".
5456 *
5457 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005458 * @param value The Bundle data value.
5459 *
5460 * @return Returns the same Intent object, for chaining multiple calls
5461 * into a single statement.
5462 *
5463 * @see #putExtras
5464 * @see #removeExtra
5465 * @see #getBundleExtra(String)
5466 */
5467 public Intent putExtra(String name, Bundle value) {
5468 if (mExtras == null) {
5469 mExtras = new Bundle();
5470 }
5471 mExtras.putBundle(name, value);
5472 return this;
5473 }
5474
5475 /**
5476 * Add extended data to the intent. The name must include a package
5477 * prefix, for example the app com.android.contacts would use names
5478 * like "com.android.contacts.ShowAll".
5479 *
5480 * @param name The name of the extra data, with package prefix.
5481 * @param value The IBinder data value.
5482 *
5483 * @return Returns the same Intent object, for chaining multiple calls
5484 * into a single statement.
5485 *
5486 * @see #putExtras
5487 * @see #removeExtra
5488 * @see #getIBinderExtra(String)
5489 *
5490 * @deprecated
5491 * @hide
5492 */
5493 @Deprecated
5494 public Intent putExtra(String name, IBinder value) {
5495 if (mExtras == null) {
5496 mExtras = new Bundle();
5497 }
5498 mExtras.putIBinder(name, value);
5499 return this;
5500 }
5501
5502 /**
5503 * Copy all extras in 'src' in to this intent.
5504 *
5505 * @param src Contains the extras to copy.
5506 *
5507 * @see #putExtra
5508 */
5509 public Intent putExtras(Intent src) {
5510 if (src.mExtras != null) {
5511 if (mExtras == null) {
5512 mExtras = new Bundle(src.mExtras);
5513 } else {
5514 mExtras.putAll(src.mExtras);
5515 }
5516 }
5517 return this;
5518 }
5519
5520 /**
5521 * Add a set of extended data to the intent. The keys must include a package
5522 * prefix, for example the app com.android.contacts would use names
5523 * like "com.android.contacts.ShowAll".
5524 *
5525 * @param extras The Bundle of extras to add to this intent.
5526 *
5527 * @see #putExtra
5528 * @see #removeExtra
5529 */
5530 public Intent putExtras(Bundle extras) {
5531 if (mExtras == null) {
5532 mExtras = new Bundle();
5533 }
5534 mExtras.putAll(extras);
5535 return this;
5536 }
5537
5538 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005539 * Completely replace the extras in the Intent with the extras in the
5540 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005541 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005542 * @param src The exact extras contained in this Intent are copied
5543 * into the target intent, replacing any that were previously there.
5544 */
5545 public Intent replaceExtras(Intent src) {
5546 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5547 return this;
5548 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005549
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005550 /**
5551 * Completely replace the extras in the Intent with the given Bundle of
5552 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005553 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005554 * @param extras The new set of extras in the Intent, or null to erase
5555 * all extras.
5556 */
5557 public Intent replaceExtras(Bundle extras) {
5558 mExtras = extras != null ? new Bundle(extras) : null;
5559 return this;
5560 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005561
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005562 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005563 * Remove extended data from the intent.
5564 *
5565 * @see #putExtra
5566 */
5567 public void removeExtra(String name) {
5568 if (mExtras != null) {
5569 mExtras.remove(name);
5570 if (mExtras.size() == 0) {
5571 mExtras = null;
5572 }
5573 }
5574 }
5575
5576 /**
5577 * Set special flags controlling how this intent is handled. Most values
5578 * here depend on the type of component being executed by the Intent,
5579 * specifically the FLAG_ACTIVITY_* flags are all for use with
5580 * {@link Context#startActivity Context.startActivity()} and the
5581 * FLAG_RECEIVER_* flags are all for use with
5582 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5583 *
Scott Main7aee61f2011-02-08 11:25:01 -08005584 * <p>See the
5585 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5586 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005587 * the behavior of your application.
5588 *
5589 * @param flags The desired flags.
5590 *
5591 * @return Returns the same Intent object, for chaining multiple calls
5592 * into a single statement.
5593 *
5594 * @see #getFlags
5595 * @see #addFlags
5596 *
5597 * @see #FLAG_GRANT_READ_URI_PERMISSION
5598 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5599 * @see #FLAG_DEBUG_LOG_RESOLUTION
5600 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005601 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005602 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005603 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005604 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005605 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5606 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005607 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005608 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5609 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005610 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005611 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005612 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005613 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5614 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005615 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005616 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005617 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005618 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5619 */
5620 public Intent setFlags(int flags) {
5621 mFlags = flags;
5622 return this;
5623 }
5624
5625 /**
5626 * Add additional flags to the intent (or with existing flags
5627 * value).
5628 *
5629 * @param flags The new flags to set.
5630 *
5631 * @return Returns the same Intent object, for chaining multiple calls
5632 * into a single statement.
5633 *
5634 * @see #setFlags
5635 */
5636 public Intent addFlags(int flags) {
5637 mFlags |= flags;
5638 return this;
5639 }
5640
5641 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005642 * (Usually optional) Set an explicit application package name that limits
5643 * the components this Intent will resolve to. If left to the default
5644 * value of null, all components in all applications will considered.
5645 * If non-null, the Intent can only match the components in the given
5646 * application package.
5647 *
5648 * @param packageName The name of the application package to handle the
5649 * intent, or null to allow any application package.
5650 *
5651 * @return Returns the same Intent object, for chaining multiple calls
5652 * into a single statement.
5653 *
5654 * @see #getPackage
5655 * @see #resolveActivity
5656 */
5657 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005658 if (packageName != null && mSelector != null) {
5659 throw new IllegalArgumentException(
5660 "Can't set package name when selector is already set");
5661 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005662 mPackage = packageName;
5663 return this;
5664 }
5665
5666 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005667 * (Usually optional) Explicitly set the component to handle the intent.
5668 * If left with the default value of null, the system will determine the
5669 * appropriate class to use based on the other fields (action, data,
5670 * type, categories) in the Intent. If this class is defined, the
5671 * specified class will always be used regardless of the other fields. You
5672 * should only set this value when you know you absolutely want a specific
5673 * class to be used; otherwise it is better to let the system find the
5674 * appropriate class so that you will respect the installed applications
5675 * and user preferences.
5676 *
5677 * @param component The name of the application component to handle the
5678 * intent, or null to let the system find one for you.
5679 *
5680 * @return Returns the same Intent object, for chaining multiple calls
5681 * into a single statement.
5682 *
5683 * @see #setClass
5684 * @see #setClassName(Context, String)
5685 * @see #setClassName(String, String)
5686 * @see #getComponent
5687 * @see #resolveActivity
5688 */
5689 public Intent setComponent(ComponentName component) {
5690 mComponent = component;
5691 return this;
5692 }
5693
5694 /**
5695 * Convenience for calling {@link #setComponent} with an
5696 * explicit class name.
5697 *
5698 * @param packageContext A Context of the application package implementing
5699 * this class.
5700 * @param className The name of a class inside of the application package
5701 * that will be used as the component for this Intent.
5702 *
5703 * @return Returns the same Intent object, for chaining multiple calls
5704 * into a single statement.
5705 *
5706 * @see #setComponent
5707 * @see #setClass
5708 */
5709 public Intent setClassName(Context packageContext, String className) {
5710 mComponent = new ComponentName(packageContext, className);
5711 return this;
5712 }
5713
5714 /**
5715 * Convenience for calling {@link #setComponent} with an
5716 * explicit application package name and class name.
5717 *
5718 * @param packageName The name of the package implementing the desired
5719 * component.
5720 * @param className The name of a class inside of the application package
5721 * that will be used as the component for this Intent.
5722 *
5723 * @return Returns the same Intent object, for chaining multiple calls
5724 * into a single statement.
5725 *
5726 * @see #setComponent
5727 * @see #setClass
5728 */
5729 public Intent setClassName(String packageName, String className) {
5730 mComponent = new ComponentName(packageName, className);
5731 return this;
5732 }
5733
5734 /**
5735 * Convenience for calling {@link #setComponent(ComponentName)} with the
5736 * name returned by a {@link Class} object.
5737 *
5738 * @param packageContext A Context of the application package implementing
5739 * this class.
5740 * @param cls The class name to set, equivalent to
5741 * <code>setClassName(context, cls.getName())</code>.
5742 *
5743 * @return Returns the same Intent object, for chaining multiple calls
5744 * into a single statement.
5745 *
5746 * @see #setComponent
5747 */
5748 public Intent setClass(Context packageContext, Class<?> cls) {
5749 mComponent = new ComponentName(packageContext, cls);
5750 return this;
5751 }
5752
5753 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005754 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5755 * used as a hint to the receiver for animations and the like. Null means that there
5756 * is no source bounds.
5757 */
5758 public void setSourceBounds(Rect r) {
5759 if (r != null) {
5760 mSourceBounds = new Rect(r);
5761 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005762 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005763 }
5764 }
5765
5766 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005767 * Use with {@link #fillIn} to allow the current action value to be
5768 * overwritten, even if it is already set.
5769 */
5770 public static final int FILL_IN_ACTION = 1<<0;
5771
5772 /**
5773 * Use with {@link #fillIn} to allow the current data or type value
5774 * overwritten, even if it is already set.
5775 */
5776 public static final int FILL_IN_DATA = 1<<1;
5777
5778 /**
5779 * Use with {@link #fillIn} to allow the current categories to be
5780 * overwritten, even if they are already set.
5781 */
5782 public static final int FILL_IN_CATEGORIES = 1<<2;
5783
5784 /**
5785 * Use with {@link #fillIn} to allow the current component value to be
5786 * overwritten, even if it is already set.
5787 */
5788 public static final int FILL_IN_COMPONENT = 1<<3;
5789
5790 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005791 * Use with {@link #fillIn} to allow the current package value to be
5792 * overwritten, even if it is already set.
5793 */
5794 public static final int FILL_IN_PACKAGE = 1<<4;
5795
5796 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005797 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005798 * overwritten, even if it is already set.
5799 */
5800 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5801
5802 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005803 * Use with {@link #fillIn} to allow the current selector to be
5804 * overwritten, even if it is already set.
5805 */
5806 public static final int FILL_IN_SELECTOR = 1<<6;
5807
5808 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005809 * Use with {@link #fillIn} to allow the current ClipData to be
5810 * overwritten, even if it is already set.
5811 */
5812 public static final int FILL_IN_CLIP_DATA = 1<<7;
5813
5814 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005815 * Copy the contents of <var>other</var> in to this object, but only
5816 * where fields are not defined by this object. For purposes of a field
5817 * being defined, the following pieces of data in the Intent are
5818 * considered to be separate fields:
5819 *
5820 * <ul>
5821 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08005822 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005823 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5824 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005825 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005826 * <li> component, as set by {@link #setComponent(ComponentName)} or
5827 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005828 * <li> source bounds, as set by {@link #setSourceBounds}.
5829 * <li> selector, as set by {@link #setSelector(Intent)}.
5830 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005831 * <li> each top-level name in the associated extras.
5832 * </ul>
5833 *
5834 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005835 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005836 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
5837 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
5838 * the restriction where the corresponding field will not be replaced if
5839 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005840 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005841 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
5842 * is explicitly specified. The selector will only be copied if
5843 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07005844 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005845 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5846 * and Intent B with {action="gotit", data-type="some/thing",
5847 * categories="one","two"}.
5848 *
5849 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5850 * containing: {action="gotit", data-type="some/thing",
5851 * categories="bar"}.
5852 *
5853 * @param other Another Intent whose values are to be used to fill in
5854 * the current one.
5855 * @param flags Options to control which fields can be filled in.
5856 *
5857 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005858 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005859 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
5860 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005861 */
5862 public int fillIn(Intent other, int flags) {
5863 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005864 if (other.mAction != null
5865 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005866 mAction = other.mAction;
5867 changes |= FILL_IN_ACTION;
5868 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005869 if ((other.mData != null || other.mType != null)
5870 && ((mData == null && mType == null)
5871 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005872 mData = other.mData;
5873 mType = other.mType;
5874 changes |= FILL_IN_DATA;
5875 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005876 if (other.mCategories != null
5877 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005878 if (other.mCategories != null) {
5879 mCategories = new HashSet<String>(other.mCategories);
5880 }
5881 changes |= FILL_IN_CATEGORIES;
5882 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005883 if (other.mPackage != null
5884 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005885 // Only do this if mSelector is not set.
5886 if (mSelector == null) {
5887 mPackage = other.mPackage;
5888 changes |= FILL_IN_PACKAGE;
5889 }
5890 }
5891 // Selector is special: it can only be set if explicitly allowed,
5892 // for the same reason as the component name.
5893 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
5894 if (mPackage == null) {
5895 mSelector = new Intent(other.mSelector);
5896 mPackage = null;
5897 changes |= FILL_IN_SELECTOR;
5898 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005899 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005900 if (other.mClipData != null
5901 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
5902 mClipData = other.mClipData;
5903 changes |= FILL_IN_CLIP_DATA;
5904 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005905 // Component is special: it can -only- be set if explicitly allowed,
5906 // since otherwise the sender could force the intent somewhere the
5907 // originator didn't intend.
5908 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005909 mComponent = other.mComponent;
5910 changes |= FILL_IN_COMPONENT;
5911 }
5912 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005913 if (other.mSourceBounds != null
5914 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5915 mSourceBounds = new Rect(other.mSourceBounds);
5916 changes |= FILL_IN_SOURCE_BOUNDS;
5917 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005918 if (mExtras == null) {
5919 if (other.mExtras != null) {
5920 mExtras = new Bundle(other.mExtras);
5921 }
5922 } else if (other.mExtras != null) {
5923 try {
5924 Bundle newb = new Bundle(other.mExtras);
5925 newb.putAll(mExtras);
5926 mExtras = newb;
5927 } catch (RuntimeException e) {
5928 // Modifying the extras can cause us to unparcel the contents
5929 // of the bundle, and if we do this in the system process that
5930 // may fail. We really should handle this (i.e., the Bundle
5931 // impl shouldn't be on top of a plain map), but for now just
5932 // ignore it and keep the original contents. :(
5933 Log.w("Intent", "Failure filling in extras", e);
5934 }
5935 }
5936 return changes;
5937 }
5938
5939 /**
5940 * Wrapper class holding an Intent and implementing comparisons on it for
5941 * the purpose of filtering. The class implements its
5942 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5943 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5944 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5945 * on the wrapped Intent.
5946 */
5947 public static final class FilterComparison {
5948 private final Intent mIntent;
5949 private final int mHashCode;
5950
5951 public FilterComparison(Intent intent) {
5952 mIntent = intent;
5953 mHashCode = intent.filterHashCode();
5954 }
5955
5956 /**
5957 * Return the Intent that this FilterComparison represents.
5958 * @return Returns the Intent held by the FilterComparison. Do
5959 * not modify!
5960 */
5961 public Intent getIntent() {
5962 return mIntent;
5963 }
5964
5965 @Override
5966 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005967 if (obj instanceof FilterComparison) {
5968 Intent other = ((FilterComparison)obj).mIntent;
5969 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005970 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005971 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005972 }
5973
5974 @Override
5975 public int hashCode() {
5976 return mHashCode;
5977 }
5978 }
5979
5980 /**
5981 * Determine if two intents are the same for the purposes of intent
5982 * resolution (filtering). That is, if their action, data, type,
5983 * class, and categories are the same. This does <em>not</em> compare
5984 * any extra data included in the intents.
5985 *
5986 * @param other The other Intent to compare against.
5987 *
5988 * @return Returns true if action, data, type, class, and categories
5989 * are the same.
5990 */
5991 public boolean filterEquals(Intent other) {
5992 if (other == null) {
5993 return false;
5994 }
5995 if (mAction != other.mAction) {
5996 if (mAction != null) {
5997 if (!mAction.equals(other.mAction)) {
5998 return false;
5999 }
6000 } else {
6001 if (!other.mAction.equals(mAction)) {
6002 return false;
6003 }
6004 }
6005 }
6006 if (mData != other.mData) {
6007 if (mData != null) {
6008 if (!mData.equals(other.mData)) {
6009 return false;
6010 }
6011 } else {
6012 if (!other.mData.equals(mData)) {
6013 return false;
6014 }
6015 }
6016 }
6017 if (mType != other.mType) {
6018 if (mType != null) {
6019 if (!mType.equals(other.mType)) {
6020 return false;
6021 }
6022 } else {
6023 if (!other.mType.equals(mType)) {
6024 return false;
6025 }
6026 }
6027 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006028 if (mPackage != other.mPackage) {
6029 if (mPackage != null) {
6030 if (!mPackage.equals(other.mPackage)) {
6031 return false;
6032 }
6033 } else {
6034 if (!other.mPackage.equals(mPackage)) {
6035 return false;
6036 }
6037 }
6038 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006039 if (mComponent != other.mComponent) {
6040 if (mComponent != null) {
6041 if (!mComponent.equals(other.mComponent)) {
6042 return false;
6043 }
6044 } else {
6045 if (!other.mComponent.equals(mComponent)) {
6046 return false;
6047 }
6048 }
6049 }
6050 if (mCategories != other.mCategories) {
6051 if (mCategories != null) {
6052 if (!mCategories.equals(other.mCategories)) {
6053 return false;
6054 }
6055 } else {
6056 if (!other.mCategories.equals(mCategories)) {
6057 return false;
6058 }
6059 }
6060 }
6061
6062 return true;
6063 }
6064
6065 /**
6066 * Generate hash code that matches semantics of filterEquals().
6067 *
6068 * @return Returns the hash value of the action, data, type, class, and
6069 * categories.
6070 *
6071 * @see #filterEquals
6072 */
6073 public int filterHashCode() {
6074 int code = 0;
6075 if (mAction != null) {
6076 code += mAction.hashCode();
6077 }
6078 if (mData != null) {
6079 code += mData.hashCode();
6080 }
6081 if (mType != null) {
6082 code += mType.hashCode();
6083 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006084 if (mPackage != null) {
6085 code += mPackage.hashCode();
6086 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006087 if (mComponent != null) {
6088 code += mComponent.hashCode();
6089 }
6090 if (mCategories != null) {
6091 code += mCategories.hashCode();
6092 }
6093 return code;
6094 }
6095
6096 @Override
6097 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006098 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006099
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006100 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006101 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006102 b.append(" }");
6103
6104 return b.toString();
6105 }
6106
6107 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006108 public String toInsecureString() {
6109 StringBuilder b = new StringBuilder(128);
6110
6111 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006112 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006113 b.append(" }");
6114
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006115 return b.toString();
6116 }
Romain Guy4969af72009-06-17 10:53:19 -07006117
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006118 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006119 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006120 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006121
6122 b.append("Intent { ");
6123 toShortString(b, false, true, true, true);
6124 b.append(" }");
6125
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006126 return b.toString();
6127 }
6128
6129 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006130 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6131 StringBuilder b = new StringBuilder(128);
6132 toShortString(b, secure, comp, extras, clip);
6133 return b.toString();
6134 }
6135
6136 /** @hide */
6137 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6138 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006139 boolean first = true;
6140 if (mAction != null) {
6141 b.append("act=").append(mAction);
6142 first = false;
6143 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006144 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006145 if (!first) {
6146 b.append(' ');
6147 }
6148 first = false;
6149 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006150 Iterator<String> i = mCategories.iterator();
6151 boolean didone = false;
6152 while (i.hasNext()) {
6153 if (didone) b.append(",");
6154 didone = true;
6155 b.append(i.next());
6156 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006157 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006158 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006159 if (mData != null) {
6160 if (!first) {
6161 b.append(' ');
6162 }
6163 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006164 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006165 if (secure) {
6166 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006167 } else {
6168 b.append(mData);
6169 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006170 }
6171 if (mType != null) {
6172 if (!first) {
6173 b.append(' ');
6174 }
6175 first = false;
6176 b.append("typ=").append(mType);
6177 }
6178 if (mFlags != 0) {
6179 if (!first) {
6180 b.append(' ');
6181 }
6182 first = false;
6183 b.append("flg=0x").append(Integer.toHexString(mFlags));
6184 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006185 if (mPackage != null) {
6186 if (!first) {
6187 b.append(' ');
6188 }
6189 first = false;
6190 b.append("pkg=").append(mPackage);
6191 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006192 if (comp && mComponent != null) {
6193 if (!first) {
6194 b.append(' ');
6195 }
6196 first = false;
6197 b.append("cmp=").append(mComponent.flattenToShortString());
6198 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006199 if (mSourceBounds != null) {
6200 if (!first) {
6201 b.append(' ');
6202 }
6203 first = false;
6204 b.append("bnds=").append(mSourceBounds.toShortString());
6205 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006206 if (mClipData != null) {
6207 if (!first) {
6208 b.append(' ');
6209 }
6210 first = false;
6211 if (clip) {
6212 b.append("clip={");
6213 mClipData.toShortString(b);
6214 b.append('}');
6215 } else {
6216 b.append("(has clip)");
6217 }
6218 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006219 if (extras && mExtras != null) {
6220 if (!first) {
6221 b.append(' ');
6222 }
6223 first = false;
6224 b.append("(has extras)");
6225 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006226 if (mSelector != null) {
6227 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006228 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006229 b.append("}");
6230 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006231 }
6232
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006233 /**
6234 * Call {@link #toUri} with 0 flags.
6235 * @deprecated Use {@link #toUri} instead.
6236 */
6237 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006238 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006239 return toUri(0);
6240 }
6241
6242 /**
6243 * Convert this Intent into a String holding a URI representation of it.
6244 * The returned URI string has been properly URI encoded, so it can be
6245 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6246 * Intent's data as the base URI, with an additional fragment describing
6247 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006248 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006249 * <p>You can convert the returned string back to an Intent with
6250 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006251 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006252 * @param flags Additional operating flags. Either 0 or
6253 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006254 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006255 * @return Returns a URI encoding URI string describing the entire contents
6256 * of the Intent.
6257 */
6258 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006259 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006260 String scheme = null;
6261 if (mData != null) {
6262 String data = mData.toString();
6263 if ((flags&URI_INTENT_SCHEME) != 0) {
6264 final int N = data.length();
6265 for (int i=0; i<N; i++) {
6266 char c = data.charAt(i);
6267 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6268 || c == '.' || c == '-') {
6269 continue;
6270 }
6271 if (c == ':' && i > 0) {
6272 // Valid scheme.
6273 scheme = data.substring(0, i);
6274 uri.append("intent:");
6275 data = data.substring(i+1);
6276 break;
6277 }
Tom Taylord4a47292009-12-21 13:59:18 -08006278
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006279 // No scheme.
6280 break;
6281 }
6282 }
6283 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006284
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006285 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6286 uri.append("intent:");
6287 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006288
6289 uri.append("#Intent;");
6290
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006291 toUriInner(uri, scheme, flags);
6292 if (mSelector != null) {
6293 uri.append("SEL;");
6294 // Note that for now we are not going to try to handle the
6295 // data part; not clear how to represent this as a URI, and
6296 // not much utility in it.
6297 mSelector.toUriInner(uri, null, flags);
6298 }
6299
6300 uri.append("end");
6301
6302 return uri.toString();
6303 }
6304
6305 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006306 if (scheme != null) {
6307 uri.append("scheme=").append(scheme).append(';');
6308 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006309 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006310 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006311 }
6312 if (mCategories != null) {
6313 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006314 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006315 }
6316 }
6317 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006318 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006319 }
6320 if (mFlags != 0) {
6321 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6322 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006323 if (mPackage != null) {
6324 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6325 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006326 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006327 uri.append("component=").append(Uri.encode(
6328 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006329 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006330 if (mSourceBounds != null) {
6331 uri.append("sourceBounds=")
6332 .append(Uri.encode(mSourceBounds.flattenToString()))
6333 .append(';');
6334 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006335 if (mExtras != null) {
6336 for (String key : mExtras.keySet()) {
6337 final Object value = mExtras.get(key);
6338 char entryType =
6339 value instanceof String ? 'S' :
6340 value instanceof Boolean ? 'B' :
6341 value instanceof Byte ? 'b' :
6342 value instanceof Character ? 'c' :
6343 value instanceof Double ? 'd' :
6344 value instanceof Float ? 'f' :
6345 value instanceof Integer ? 'i' :
6346 value instanceof Long ? 'l' :
6347 value instanceof Short ? 's' :
6348 '\0';
6349
6350 if (entryType != '\0') {
6351 uri.append(entryType);
6352 uri.append('.');
6353 uri.append(Uri.encode(key));
6354 uri.append('=');
6355 uri.append(Uri.encode(value.toString()));
6356 uri.append(';');
6357 }
6358 }
6359 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006360 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006361
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006362 public int describeContents() {
6363 return (mExtras != null) ? mExtras.describeContents() : 0;
6364 }
6365
6366 public void writeToParcel(Parcel out, int flags) {
6367 out.writeString(mAction);
6368 Uri.writeToParcel(out, mData);
6369 out.writeString(mType);
6370 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006371 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006372 ComponentName.writeToParcel(mComponent, out);
6373
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006374 if (mSourceBounds != null) {
6375 out.writeInt(1);
6376 mSourceBounds.writeToParcel(out, flags);
6377 } else {
6378 out.writeInt(0);
6379 }
6380
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006381 if (mCategories != null) {
6382 out.writeInt(mCategories.size());
6383 for (String category : mCategories) {
6384 out.writeString(category);
6385 }
6386 } else {
6387 out.writeInt(0);
6388 }
6389
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006390 if (mSelector != null) {
6391 out.writeInt(1);
6392 mSelector.writeToParcel(out, flags);
6393 } else {
6394 out.writeInt(0);
6395 }
6396
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006397 if (mClipData != null) {
6398 out.writeInt(1);
6399 mClipData.writeToParcel(out, flags);
6400 } else {
6401 out.writeInt(0);
6402 }
6403
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006404 out.writeBundle(mExtras);
6405 }
6406
6407 public static final Parcelable.Creator<Intent> CREATOR
6408 = new Parcelable.Creator<Intent>() {
6409 public Intent createFromParcel(Parcel in) {
6410 return new Intent(in);
6411 }
6412 public Intent[] newArray(int size) {
6413 return new Intent[size];
6414 }
6415 };
6416
Dianne Hackborneb034652009-09-07 00:49:58 -07006417 /** @hide */
6418 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006419 readFromParcel(in);
6420 }
6421
6422 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006423 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006424 mData = Uri.CREATOR.createFromParcel(in);
6425 mType = in.readString();
6426 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006427 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006428 mComponent = ComponentName.readFromParcel(in);
6429
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006430 if (in.readInt() != 0) {
6431 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6432 }
6433
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006434 int N = in.readInt();
6435 if (N > 0) {
6436 mCategories = new HashSet<String>();
6437 int i;
6438 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006439 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006440 }
6441 } else {
6442 mCategories = null;
6443 }
6444
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006445 if (in.readInt() != 0) {
6446 mSelector = new Intent(in);
6447 }
6448
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006449 if (in.readInt() != 0) {
6450 mClipData = new ClipData(in);
6451 }
6452
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006453 mExtras = in.readBundle();
6454 }
6455
6456 /**
6457 * Parses the "intent" element (and its children) from XML and instantiates
6458 * an Intent object. The given XML parser should be located at the tag
6459 * where parsing should start (often named "intent"), from which the
6460 * basic action, data, type, and package and class name will be
6461 * retrieved. The function will then parse in to any child elements,
6462 * looking for <category android:name="xxx"> tags to add categories and
6463 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6464 * to the intent.
6465 *
6466 * @param resources The Resources to use when inflating resources.
6467 * @param parser The XML parser pointing at an "intent" tag.
6468 * @param attrs The AttributeSet interface for retrieving extended
6469 * attribute data at the current <var>parser</var> location.
6470 * @return An Intent object matching the XML data.
6471 * @throws XmlPullParserException If there was an XML parsing error.
6472 * @throws IOException If there was an I/O error.
6473 */
6474 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6475 throws XmlPullParserException, IOException {
6476 Intent intent = new Intent();
6477
6478 TypedArray sa = resources.obtainAttributes(attrs,
6479 com.android.internal.R.styleable.Intent);
6480
6481 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6482
6483 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6484 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6485 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6486
6487 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6488 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6489 if (packageName != null && className != null) {
6490 intent.setComponent(new ComponentName(packageName, className));
6491 }
6492
6493 sa.recycle();
6494
6495 int outerDepth = parser.getDepth();
6496 int type;
6497 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6498 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6499 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6500 continue;
6501 }
6502
6503 String nodeName = parser.getName();
6504 if (nodeName.equals("category")) {
6505 sa = resources.obtainAttributes(attrs,
6506 com.android.internal.R.styleable.IntentCategory);
6507 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6508 sa.recycle();
6509
6510 if (cat != null) {
6511 intent.addCategory(cat);
6512 }
6513 XmlUtils.skipCurrentTag(parser);
6514
6515 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006516 if (intent.mExtras == null) {
6517 intent.mExtras = new Bundle();
6518 }
6519 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6520 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006521
6522 } else {
6523 XmlUtils.skipCurrentTag(parser);
6524 }
6525 }
6526
6527 return intent;
6528 }
Nick Pellyccae4122012-01-09 14:12:58 -08006529
6530 /**
6531 * Normalize a MIME data type.
6532 *
6533 * <p>A normalized MIME type has white-space trimmed,
6534 * content-type parameters removed, and is lower-case.
6535 * This aligns the type with Android best practices for
6536 * intent filtering.
6537 *
6538 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6539 * "text/x-vCard" becomes "text/x-vcard".
6540 *
6541 * <p>All MIME types received from outside Android (such as user input,
6542 * or external sources like Bluetooth, NFC, or the Internet) should
6543 * be normalized before they are used to create an Intent.
6544 *
6545 * @param type MIME data type to normalize
6546 * @return normalized MIME data type, or null if the input was null
6547 * @see {@link #setType}
6548 * @see {@link #setTypeAndNormalize}
6549 */
6550 public static String normalizeMimeType(String type) {
6551 if (type == null) {
6552 return null;
6553 }
6554
6555 type = type.trim().toLowerCase(Locale.US);
6556
6557 final int semicolonIndex = type.indexOf(';');
6558 if (semicolonIndex != -1) {
6559 type = type.substring(0, semicolonIndex);
6560 }
6561 return type;
6562 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006563
6564 /**
6565 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
6566 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}.
6567 *
6568 * @hide
6569 */
6570 public void migrateExtraStreamToClipData() {
6571 // Refuse to touch if extras already parcelled
6572 if (mExtras != null && mExtras.isParcelled()) return;
6573
6574 // Bail when someone already gave us ClipData
6575 if (getClipData() != null) return;
6576
6577 final String action = getAction();
6578 if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006579 final Uri stream;
6580 try {
6581 stream = getParcelableExtra(EXTRA_STREAM);
6582 } catch (ClassCastException e) {
6583 return;
6584 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006585 if (stream != null) {
6586 final ClipData clipData = new ClipData(
6587 null, new String[] { getType() }, new ClipData.Item(stream));
6588
6589 setClipData(clipData);
6590 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
6591 }
6592
6593 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006594 final ArrayList<Uri> streams;
6595 try {
6596 streams = getParcelableArrayListExtra(EXTRA_STREAM);
6597 } catch (ClassCastException e) {
6598 return;
6599 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006600 if (streams != null && streams.size() > 0) {
6601 final Uri firstStream = streams.get(0);
6602 final ClipData clipData = new ClipData(
6603 null, new String[] { getType() }, new ClipData.Item(firstStream));
6604
6605 final int size = streams.size();
6606 for (int i = 1; i < size; i++) {
6607 clipData.addItem(new ClipData.Item(streams.get(i)));
6608 }
6609
6610 setClipData(clipData);
6611 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
6612 }
6613 }
6614 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006615}