blob: 18d682dd588ef356bb2e287ec130bef9c52e9347 [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
957 * handle generic data streams).
958 * <p>
959 * Optional standard extras, which may be interpreted by some recipients as
960 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
961 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
962 * <p>
963 * Output: nothing.
964 */
965 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
966 public static final String ACTION_SEND = "android.intent.action.SEND";
967 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800968 * Activity Action: Deliver multiple data to someone else.
969 * <p>
970 * Like ACTION_SEND, except the data is multiple.
971 * <p>
972 * Input: {@link #getType} is the MIME type of the data being sent.
973 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
974 * #EXTRA_STREAM} field, containing the data to be sent.
975 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +0800976 * Multiple types are supported, and receivers should handle mixed types
977 * whenever possible. The right way for the receiver to check them is to
978 * use the content resolver on each URI. The intent sender should try to
979 * put the most concrete mime type in the intent type, but it can fall
980 * back to {@literal <type>/*} or {@literal *}/* as needed.
981 * <p>
982 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
983 * be image/jpg, but if you are sending image/jpg and image/png, then the
984 * intent's type should be image/*.
985 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800986 * Optional standard extras, which may be interpreted by some recipients as
987 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
988 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
989 * <p>
990 * Output: nothing.
991 */
992 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
993 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
994 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700995 * Activity Action: Handle an incoming phone call.
996 * <p>Input: nothing.
997 * <p>Output: nothing.
998 */
999 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1000 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1001 /**
1002 * Activity Action: Insert an empty item into the given container.
1003 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1004 * in which to place the data.
1005 * <p>Output: URI of the new data that was created.
1006 */
1007 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1008 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1009 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001010 * Activity Action: Create a new item in the given container, initializing it
1011 * from the current contents of the clipboard.
1012 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1013 * in which to place the data.
1014 * <p>Output: URI of the new data that was created.
1015 */
1016 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1017 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1018 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001019 * Activity Action: Delete the given data from its container.
1020 * <p>Input: {@link #getData} is URI of data to be deleted.
1021 * <p>Output: nothing.
1022 */
1023 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1024 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1025 /**
1026 * Activity Action: Run the data, whatever that means.
1027 * <p>Input: ? (Note: this is currently specific to the test harness.)
1028 * <p>Output: nothing.
1029 */
1030 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1031 public static final String ACTION_RUN = "android.intent.action.RUN";
1032 /**
1033 * Activity Action: Perform a data synchronization.
1034 * <p>Input: ?
1035 * <p>Output: ?
1036 */
1037 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1038 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1039 /**
1040 * Activity Action: Pick an activity given an intent, returning the class
1041 * selected.
1042 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1043 * used with {@link PackageManager#queryIntentActivities} to determine the
1044 * set of activities from which to pick.
1045 * <p>Output: Class name of the activity that was selected.
1046 */
1047 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1048 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1049 /**
1050 * Activity Action: Perform a search.
1051 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1052 * is the text to search for. If empty, simply
1053 * enter your search results Activity with the search UI activated.
1054 * <p>Output: nothing.
1055 */
1056 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1057 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1058 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001059 * Activity Action: Start the platform-defined tutorial
1060 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1061 * is the text to search for. If empty, simply
1062 * enter your search results Activity with the search UI activated.
1063 * <p>Output: nothing.
1064 */
1065 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1066 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1067 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001068 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001069 * <p>
1070 * Input: {@link android.app.SearchManager#QUERY
1071 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1072 * a url starts with http or https, the site will be opened. If it is plain
1073 * text, Google search will be applied.
1074 * <p>
1075 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001076 */
1077 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1078 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1079 /**
1080 * Activity Action: List all available applications
1081 * <p>Input: Nothing.
1082 * <p>Output: nothing.
1083 */
1084 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1085 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1086 /**
1087 * Activity Action: Show settings for choosing wallpaper
1088 * <p>Input: Nothing.
1089 * <p>Output: Nothing.
1090 */
1091 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1092 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1093
1094 /**
1095 * Activity Action: Show activity for reporting a bug.
1096 * <p>Input: Nothing.
1097 * <p>Output: Nothing.
1098 */
1099 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1100 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1101
1102 /**
1103 * Activity Action: Main entry point for factory tests. Only used when
1104 * the device is booting in factory test node. The implementing package
1105 * must be installed in the system image.
1106 * <p>Input: nothing
1107 * <p>Output: nothing
1108 */
1109 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1110
1111 /**
1112 * Activity Action: The user pressed the "call" button to go to the dialer
1113 * or other appropriate UI for placing a call.
1114 * <p>Input: Nothing.
1115 * <p>Output: Nothing.
1116 */
1117 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1118 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1119
1120 /**
1121 * Activity Action: Start Voice Command.
1122 * <p>Input: Nothing.
1123 * <p>Output: Nothing.
1124 */
1125 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1126 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001127
1128 /**
1129 * Activity Action: Start action associated with long pressing on the
1130 * search key.
1131 * <p>Input: Nothing.
1132 * <p>Output: Nothing.
1133 */
1134 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1135 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001136
Jacek Surazski86b6c532009-05-13 14:38:28 +02001137 /**
1138 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1139 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001140 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001141 * <p>Input: No data is specified. The bug report is passed in using
1142 * an {@link #EXTRA_BUG_REPORT} field.
1143 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001144 *
1145 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001146 */
1147 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1148 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001149
1150 /**
1151 * Activity Action: Show power usage information to the user.
1152 * <p>Input: Nothing.
1153 * <p>Output: Nothing.
1154 */
1155 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1156 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001157
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001158 /**
1159 * Activity Action: Setup wizard to launch after a platform update. This
1160 * activity should have a string meta-data field associated with it,
1161 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1162 * the platform for setup. The activity will be launched only if
1163 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1164 * same value.
1165 * <p>Input: Nothing.
1166 * <p>Output: Nothing.
1167 * @hide
1168 */
1169 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1170 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001171
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001172 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001173 * Activity Action: Show settings for managing network data usage of a
1174 * specific application. Applications should define an activity that offers
1175 * options to control data usage.
1176 */
1177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1178 public static final String ACTION_MANAGE_NETWORK_USAGE =
1179 "android.intent.action.MANAGE_NETWORK_USAGE";
1180
1181 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001182 * Activity Action: Launch application installer.
1183 * <p>
1184 * Input: The data must be a content: or file: URI at which the application
1185 * can be retrieved. You can optionally supply
1186 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1187 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1188 * <p>
1189 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1190 * succeeded.
1191 *
1192 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1193 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1194 * @see #EXTRA_RETURN_RESULT
1195 */
1196 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1197 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1198
1199 /**
1200 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1201 * package. Specifies the installer package name; this package will receive the
1202 * {@link #ACTION_APP_ERROR} intent.
1203 */
1204 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1205 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1206
1207 /**
1208 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1209 * package. Specifies that the application being installed should not be
1210 * treated as coming from an unknown source, but as coming from the app
1211 * invoking the Intent. For this to work you must start the installer with
1212 * startActivityForResult().
1213 */
1214 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1215 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1216
1217 /**
1218 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1219 * package. Tells the installer UI to skip the confirmation with the user
1220 * if the .apk is replacing an existing one.
1221 */
1222 public static final String EXTRA_ALLOW_REPLACE
1223 = "android.intent.extra.ALLOW_REPLACE";
1224
1225 /**
1226 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1227 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1228 * return to the application the result code of the install/uninstall. The returned result
1229 * code will be {@link android.app.Activity#RESULT_OK} on success or
1230 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1231 */
1232 public static final String EXTRA_RETURN_RESULT
1233 = "android.intent.extra.RETURN_RESULT";
1234
1235 /**
1236 * Package manager install result code. @hide because result codes are not
1237 * yet ready to be exposed.
1238 */
1239 public static final String EXTRA_INSTALL_RESULT
1240 = "android.intent.extra.INSTALL_RESULT";
1241
1242 /**
1243 * Activity Action: Launch application uninstaller.
1244 * <p>
1245 * Input: The data must be a package: URI whose scheme specific part is
1246 * the package name of the current installed package to be uninstalled.
1247 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1248 * <p>
1249 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1250 * succeeded.
1251 */
1252 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1253 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1254
1255 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001256 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1257 * describing the last run version of the platform that was setup.
1258 * @hide
1259 */
1260 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1261
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001262 // ---------------------------------------------------------------------
1263 // ---------------------------------------------------------------------
1264 // Standard intent broadcast actions (see action variable).
1265
1266 /**
1267 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001268 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001269 * <p class="note">This is a protected intent that can only be sent
1270 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001271 */
1272 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1273 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1274 /**
1275 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001276 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001277 * <p class="note">This is a protected intent that can only be sent
1278 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001279 */
1280 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1281 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001282
1283 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001284 * 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 -07001285 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001286 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001287 * <p class="note">This is a protected intent that can only be sent
1288 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001289 */
1290 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001291 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001292
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001293 /**
1294 * Broadcast Action: The current time has changed. Sent every
1295 * minute. You can <em>not</em> receive this through components declared
1296 * in manifests, only by exlicitly registering for it with
1297 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1298 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001299 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001300 * <p class="note">This is a protected intent that can only be sent
1301 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001302 */
1303 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1304 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1305 /**
1306 * Broadcast Action: The time was set.
1307 */
1308 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1309 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1310 /**
1311 * Broadcast Action: The date has changed.
1312 */
1313 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1314 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1315 /**
1316 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1317 * <ul>
1318 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1319 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001320 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001321 * <p class="note">This is a protected intent that can only be sent
1322 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001323 */
1324 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1325 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1326 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001327 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1328 * DNS entries should be tossed.
1329 * @hide
1330 */
1331 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1332 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1333 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001334 * Alarm Changed Action: This is broadcast when the AlarmClock
1335 * application's alarm is set or unset. It is used by the
1336 * AlarmClock application and the StatusBar service.
1337 * @hide
1338 */
1339 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1340 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1341 /**
1342 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1343 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1344 * @hide
1345 */
1346 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1347 public static final String ACTION_SYNC_STATE_CHANGED
1348 = "android.intent.action.SYNC_STATE_CHANGED";
1349 /**
1350 * Broadcast Action: This is broadcast once, after the system has finished
1351 * booting. It can be used to perform application-specific initialization,
1352 * such as installing alarms. You must hold the
1353 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1354 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001355 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001356 * <p class="note">This is a protected intent that can only be sent
1357 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001358 */
1359 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1360 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1361 /**
1362 * Broadcast Action: This is broadcast when a user action should request a
1363 * temporary system dialog to dismiss. Some examples of temporary system
1364 * dialogs are the notification window-shade and the recent tasks dialog.
1365 */
1366 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1367 /**
1368 * Broadcast Action: Trigger the download and eventual installation
1369 * of a package.
1370 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001371 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001372 * <p class="note">This is a protected intent that can only be sent
1373 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001374 *
1375 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001376 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001377 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001378 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1379 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1380 /**
1381 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001382 * device. The data contains the name of the package. Note that the
1383 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001384 * <p>My include the following extras:
1385 * <ul>
1386 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1387 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1388 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1389 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001390 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001391 * <p class="note">This is a protected intent that can only be sent
1392 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001393 */
1394 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1395 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1396 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001397 * Broadcast Action: A new version of an application package has been
1398 * installed, replacing an existing version that was previously installed.
1399 * The data contains the name of the package.
1400 * <p>My include the following extras:
1401 * <ul>
1402 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1403 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001404 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001405 * <p class="note">This is a protected intent that can only be sent
1406 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001407 */
1408 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1409 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1410 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001411 * Broadcast Action: A new version of your application has been installed
1412 * over an existing one. This is only sent to the application that was
1413 * replaced. It does not contain any additional data; to receive it, just
1414 * use an intent filter for this action.
1415 *
1416 * <p class="note">This is a protected intent that can only be sent
1417 * by the system.
1418 */
1419 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1420 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1421 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001422 * Broadcast Action: An existing application package has been removed from
1423 * the device. The data contains the name of the package. The package
1424 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001425 * <ul>
1426 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1427 * to the package.
1428 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1429 * application -- data and code -- is being removed.
1430 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1431 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1432 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001433 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001434 * <p class="note">This is a protected intent that can only be sent
1435 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001436 */
1437 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1438 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1439 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001440 * Broadcast Action: An existing application package has been completely
1441 * removed from the device. The data contains the name of the package.
1442 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1443 * {@link #EXTRA_DATA_REMOVED} is true and
1444 * {@link #EXTRA_REPLACING} is false of that broadcast.
1445 *
1446 * <ul>
1447 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1448 * to the package.
1449 * </ul>
1450 *
1451 * <p class="note">This is a protected intent that can only be sent
1452 * by the system.
1453 */
1454 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1455 public static final String ACTION_PACKAGE_FULLY_REMOVED
1456 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1457 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001458 * Broadcast Action: An existing application package has been changed (e.g.
1459 * a component has been enabled or disabled). The data contains the name of
1460 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001461 * <ul>
1462 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001463 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1464 * of the changed components.
1465 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1466 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001467 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001468 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001469 * <p class="note">This is a protected intent that can only be sent
1470 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001471 */
1472 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1473 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1474 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001475 * @hide
1476 * Broadcast Action: Ask system services if there is any reason to
1477 * restart the given package. The data contains the name of the
1478 * package.
1479 * <ul>
1480 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1481 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1482 * </ul>
1483 *
1484 * <p class="note">This is a protected intent that can only be sent
1485 * by the system.
1486 */
1487 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1488 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1489 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001490 * Broadcast Action: The user has restarted a package, and all of its
1491 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001492 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001493 * be removed. Note that the restarted package does <em>not</em>
1494 * receive this broadcast.
1495 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001496 * <ul>
1497 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1498 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001499 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001500 * <p class="note">This is a protected intent that can only be sent
1501 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001502 */
1503 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1504 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1505 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001506 * Broadcast Action: The user has cleared the data of a package. This should
1507 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001508 * its persistent data is erased and this broadcast sent.
1509 * Note that the cleared package does <em>not</em>
1510 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001511 * <ul>
1512 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1513 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001514 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001515 * <p class="note">This is a protected intent that can only be sent
1516 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001517 */
1518 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1519 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1520 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001521 * Broadcast Action: A user ID has been removed from the system. The user
1522 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001523 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001524 * <p class="note">This is a protected intent that can only be sent
1525 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001526 */
1527 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1528 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001529
1530 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001531 * Broadcast Action: Sent to the installer package of an application
1532 * when that application is first launched (that is the first time it
1533 * is moved out of the stopped state). The data contains the name of the package.
1534 *
1535 * <p class="note">This is a protected intent that can only be sent
1536 * by the system.
1537 */
1538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1539 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1540
1541 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001542 * Broadcast Action: Sent to the system package verifier when a package
1543 * needs to be verified. The data contains the package URI.
1544 * <p class="note">
1545 * This is a protected intent that can only be sent by the system.
1546 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001547 */
1548 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1549 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1550
1551 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001552 * Broadcast Action: Resources for a set of packages (which were
1553 * previously unavailable) are currently
1554 * available since the media on which they exist is available.
1555 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1556 * list of packages whose availability changed.
1557 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1558 * list of uids of packages whose availability changed.
1559 * Note that the
1560 * packages in this list do <em>not</em> receive this broadcast.
1561 * The specified set of packages are now available on the system.
1562 * <p>Includes the following extras:
1563 * <ul>
1564 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1565 * whose resources(were previously unavailable) are currently available.
1566 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1567 * packages whose resources(were previously unavailable)
1568 * are currently available.
1569 * </ul>
1570 *
1571 * <p class="note">This is a protected intent that can only be sent
1572 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001573 */
1574 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001575 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1576 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001577
1578 /**
1579 * Broadcast Action: Resources for a set of packages are currently
1580 * unavailable since the media on which they exist is unavailable.
1581 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1582 * list of packages whose availability changed.
1583 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1584 * list of uids of packages whose availability changed.
1585 * The specified set of packages can no longer be
1586 * launched and are practically unavailable on the system.
1587 * <p>Inclues the following extras:
1588 * <ul>
1589 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1590 * whose resources are no longer available.
1591 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1592 * whose resources are no longer available.
1593 * </ul>
1594 *
1595 * <p class="note">This is a protected intent that can only be sent
1596 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001597 */
1598 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001599 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001600 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001601
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001602 /**
1603 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001604 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001605 */
1606 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1607 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1608 /**
1609 * Broadcast Action: The current device {@link android.content.res.Configuration}
1610 * (orientation, locale, etc) has changed. When such a change happens, the
1611 * UIs (view hierarchy) will need to be rebuilt based on this new
1612 * information; for the most part, applications don't need to worry about
1613 * this, because the system will take care of stopping and restarting the
1614 * application to make sure it sees the new changes. Some system code that
1615 * can not be restarted will need to watch for this action and handle it
1616 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001617 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001618 * <p class="note">
1619 * You can <em>not</em> receive this through components declared
1620 * in manifests, only by explicitly registering for it with
1621 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1622 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001623 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001624 * <p class="note">This is a protected intent that can only be sent
1625 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001626 *
1627 * @see android.content.res.Configuration
1628 */
1629 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1630 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1631 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001632 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001633 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001634 * <p class="note">This is a protected intent that can only be sent
1635 * by the system.
1636 */
1637 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1638 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1639 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001640 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1641 * charging state, level, and other information about the battery.
1642 * See {@link android.os.BatteryManager} for documentation on the
1643 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001644 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001645 * <p class="note">
1646 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001647 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001648 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001649 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1650 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1651 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1652 * broadcasts that are sent and can be received through manifest
1653 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001654 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001655 * <p class="note">This is a protected intent that can only be sent
1656 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001657 */
1658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1659 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1660 /**
1661 * Broadcast Action: Indicates low battery condition on the device.
1662 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001663 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001664 * <p class="note">This is a protected intent that can only be sent
1665 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001666 */
1667 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1668 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1669 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001670 * Broadcast Action: Indicates the battery is now okay after being low.
1671 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1672 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001673 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001674 * <p class="note">This is a protected intent that can only be sent
1675 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001676 */
1677 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1678 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1679 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001680 * Broadcast Action: External power has been connected to the device.
1681 * This is intended for applications that wish to register specifically to this notification.
1682 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1683 * stay active to receive this notification. This action can be used to implement actions
1684 * that wait until power is available to trigger.
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.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001688 */
1689 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001690 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001691 /**
1692 * Broadcast Action: External power has been removed from the device.
1693 * This is intended for applications that wish to register specifically to this notification.
1694 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1695 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001696 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001697 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001698 * <p class="note">This is a protected intent that can only be sent
1699 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001700 */
1701 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001702 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001703 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001704 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001705 * Broadcast Action: Device is shutting down.
1706 * This is broadcast when the device is being shut down (completely turned
1707 * off, not sleeping). Once the broadcast is complete, the final shutdown
1708 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001709 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001710 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001711 * <p class="note">This is a protected intent that can only be sent
1712 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001713 */
1714 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001715 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001716 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001717 * Activity Action: Start this activity to request system shutdown.
1718 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1719 * to request confirmation from the user before shutting down.
1720 *
1721 * <p class="note">This is a protected intent that can only be sent
1722 * by the system.
1723 *
1724 * {@hide}
1725 */
1726 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1727 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001728 * Broadcast Action: A sticky broadcast that indicates low memory
1729 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001730 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001731 * <p class="note">This is a protected intent that can only be sent
1732 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001733 */
1734 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1735 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1736 /**
1737 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001738 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001739 * <p class="note">This is a protected intent that can only be sent
1740 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001741 */
1742 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1743 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1744 /**
Jake Hambybb371632010-08-23 18:16:48 -07001745 * Broadcast Action: A sticky broadcast that indicates a memory full
1746 * condition on the device. This is intended for activities that want
1747 * to be able to fill the data partition completely, leaving only
1748 * enough free space to prevent system-wide SQLite failures.
1749 *
1750 * <p class="note">This is a protected intent that can only be sent
1751 * by the system.
1752 *
1753 * {@hide}
1754 */
1755 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1756 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1757 /**
1758 * Broadcast Action: Indicates memory full condition on the device
1759 * no longer exists.
1760 *
1761 * <p class="note">This is a protected intent that can only be sent
1762 * by the system.
1763 *
1764 * {@hide}
1765 */
1766 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1767 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1768 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001769 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1770 * and package management should be started.
1771 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1772 * notification.
1773 */
1774 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1775 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1776 /**
1777 * Broadcast Action: The device has entered USB Mass Storage mode.
1778 * This is used mainly for the USB Settings panel.
1779 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1780 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001781 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001782 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001783 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001784 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1785
1786 /**
1787 * Broadcast Action: The device has exited USB Mass Storage mode.
1788 * This is used mainly for the USB Settings panel.
1789 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1790 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001791 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001792 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001793 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001794 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1795
1796 /**
1797 * Broadcast Action: External media has been removed.
1798 * The path to the mount point for the removed media is contained in the Intent.mData field.
1799 */
1800 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1801 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1802
1803 /**
1804 * Broadcast Action: External media is present, but not mounted at its mount point.
1805 * The path to the mount point for the removed media is contained in the Intent.mData field.
1806 */
1807 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1808 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1809
1810 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001811 * Broadcast Action: External media is present, and being disk-checked
1812 * 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 -08001813 */
1814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1815 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1816
1817 /**
1818 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1819 * 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 -08001820 */
1821 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1822 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1823
1824 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001825 * Broadcast Action: External media is present and mounted at its mount point.
1826 * The path to the mount point for the removed media is contained in the Intent.mData field.
1827 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1828 * media was mounted read only.
1829 */
1830 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1831 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1832
1833 /**
1834 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001835 * 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 -07001836 */
1837 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1838 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1839
1840 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001841 * Broadcast Action: External media is no longer being shared via USB mass storage.
1842 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1843 *
1844 * @hide
1845 */
1846 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1847
1848 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001849 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1850 * The path to the mount point for the removed media is contained in the Intent.mData field.
1851 */
1852 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1853 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1854
1855 /**
1856 * Broadcast Action: External media is present but cannot be mounted.
1857 * The path to the mount point for the removed media is contained in the Intent.mData field.
1858 */
1859 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1860 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1861
1862 /**
1863 * Broadcast Action: User has expressed the desire to remove the external storage media.
1864 * Applications should close all files they have open within the mount point when they receive this intent.
1865 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1866 */
1867 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1868 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1869
1870 /**
1871 * Broadcast Action: The media scanner has started scanning a directory.
1872 * The path to the directory being scanned is contained in the Intent.mData field.
1873 */
1874 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1875 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1876
1877 /**
1878 * Broadcast Action: The media scanner has finished scanning a directory.
1879 * The path to the scanned directory is contained in the Intent.mData field.
1880 */
1881 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1882 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1883
1884 /**
1885 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1886 * The path to the file is contained in the Intent.mData field.
1887 */
1888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1889 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1890
1891 /**
1892 * Broadcast Action: The "Media Button" was pressed. Includes a single
1893 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1894 * caused the broadcast.
1895 */
1896 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1897 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1898
1899 /**
1900 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1901 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1902 * caused the broadcast.
1903 */
1904 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1905 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1906
1907 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1908 // location; they are not general-purpose actions.
1909
1910 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001911 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001912 */
1913 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1914 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1915 "android.intent.action.GTALK_CONNECTED";
1916
1917 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001918 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001919 */
1920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1921 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1922 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001923
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001924 /**
1925 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_INPUT_METHOD_CHANGED =
1929 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001930
1931 /**
1932 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1933 * more radios have been turned off or on. The intent will have the following extra value:</p>
1934 * <ul>
1935 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1936 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1937 * turned off</li>
1938 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001939 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001940 * <p class="note">This is a protected intent that can only be sent
1941 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001942 */
1943 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1944 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1945
1946 /**
1947 * Broadcast Action: Some content providers have parts of their namespace
1948 * where they publish new events or items that the user may be especially
1949 * interested in. For these things, they may broadcast this action when the
1950 * set of interesting items change.
1951 *
1952 * For example, GmailProvider sends this notification when the set of unread
1953 * mail in the inbox changes.
1954 *
1955 * <p>The data of the intent identifies which part of which provider
1956 * changed. When queried through the content resolver, the data URI will
1957 * return the data set in question.
1958 *
1959 * <p>The intent will have the following extra values:
1960 * <ul>
1961 * <li><em>count</em> - The number of items in the data set. This is the
1962 * same as the number of items in the cursor returned by querying the
1963 * data URI. </li>
1964 * </ul>
1965 *
1966 * This intent will be sent at boot (if the count is non-zero) and when the
1967 * data set changes. It is possible for the data set to change without the
1968 * count changing (for example, if a new unread message arrives in the same
1969 * sync operation in which a message is archived). The phone should still
1970 * ring/vibrate/etc as normal in this case.
1971 */
1972 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1973 public static final String ACTION_PROVIDER_CHANGED =
1974 "android.intent.action.PROVIDER_CHANGED";
1975
1976 /**
1977 * Broadcast Action: Wired Headset plugged in or unplugged.
1978 *
1979 * <p>The intent will have the following extra values:
1980 * <ul>
1981 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1982 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08001983 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001984 * </ul>
1985 * </ul>
1986 */
1987 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1988 public static final String ACTION_HEADSET_PLUG =
1989 "android.intent.action.HEADSET_PLUG";
1990
1991 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001992 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
1993 *
1994 * <p>The intent will have the following extra values:
1995 * <ul>
1996 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1997 * <li><em>name</em> - Headset type, human readable string </li>
1998 * </ul>
1999 * </ul>
2000 * @hide
2001 */
2002 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002003 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2004 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002005
2006 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002007 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002008 *
2009 * <p>The intent will have the following extra values:
2010 * <ul>
2011 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2012 * <li><em>name</em> - Headset type, human readable string </li>
2013 * </ul>
2014 * </ul>
2015 * @hide
2016 */
2017 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002018 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2019 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002020
2021 /**
2022 * Broadcast Action: A HMDI cable was plugged or unplugged
2023 *
2024 * <p>The intent will have the following extra values:
2025 * <ul>
2026 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2027 * <li><em>name</em> - HDMI cable, human readable string </li>
2028 * </ul>
2029 * </ul>
2030 * @hide
2031 */
2032 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2033 public static final String ACTION_HDMI_AUDIO_PLUG =
2034 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002035
2036 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002037 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2038 *
2039 * <p>The intent will have the following extra values:
2040 * <ul>
2041 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2042 * <li><em>card</em> - ALSA card number (integer) </li>
2043 * <li><em>device</em> - ALSA device number (integer) </li>
2044 * </ul>
2045 * </ul>
2046 * @hide
2047 */
2048 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2049 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2050 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2051
2052 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002053 * Broadcast Action: A USB audio device was plugged in or unplugged.
2054 *
2055 * <p>The intent will have the following extra values:
2056 * <ul>
2057 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2058 * <li><em>card</em> - ALSA card number (integer) </li>
2059 * <li><em>device</em> - ALSA device number (integer) </li>
2060 * </ul>
2061 * </ul>
2062 * @hide
2063 */
2064 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2065 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2066 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2067
2068 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002069 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2070 * <ul>
2071 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2072 * </ul>
2073 *
2074 * <p class="note">This is a protected intent that can only be sent
2075 * by the system.
2076 *
2077 * @hide
2078 */
2079 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2080 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2081 = "android.intent.action.ADVANCED_SETTINGS";
2082
2083 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002084 * Broadcast Action: An outgoing call is about to be placed.
2085 *
2086 * <p>The Intent will have the following extra value:
2087 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002088 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002089 * the phone number originally intended to be dialed.</li>
2090 * </ul>
2091 * <p>Once the broadcast is finished, the resultData is used as the actual
2092 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002093 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002094 * outgoing call in turn: for example, a parental control application
2095 * might verify that the user is authorized to place the call at that
2096 * time, then a number-rewriting application might add an area code if
2097 * one was not specified.</p>
2098 * <p>For consistency, any receiver whose purpose is to prohibit phone
2099 * calls should have a priority of 0, to ensure it will see the final
2100 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002101 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002102 * should have a positive priority.
2103 * Negative priorities are reserved for the system for this broadcast;
2104 * using them may cause problems.</p>
2105 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2106 * abort the broadcast.</p>
2107 * <p>Emergency calls cannot be intercepted using this mechanism, and
2108 * other calls cannot be modified to call emergency numbers using this
2109 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002110 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002111 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2112 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002113 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002114 * <p class="note">This is a protected intent that can only be sent
2115 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002116 */
2117 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2118 public static final String ACTION_NEW_OUTGOING_CALL =
2119 "android.intent.action.NEW_OUTGOING_CALL";
2120
2121 /**
2122 * Broadcast Action: Have the device reboot. This is only for use by
2123 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002124 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002125 * <p class="note">This is a protected intent that can only be sent
2126 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002127 */
2128 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2129 public static final String ACTION_REBOOT =
2130 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002131
Wei Huang97ecc9c2009-05-11 17:44:20 -07002132 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002133 * Broadcast Action: A sticky broadcast for changes in the physical
2134 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002135 *
2136 * <p>The intent will have the following extra values:
2137 * <ul>
2138 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002139 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002140 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002141 * <p>This is intended for monitoring the current physical dock state.
2142 * See {@link android.app.UiModeManager} for the normal API dealing with
2143 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002144 */
2145 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2146 public static final String ACTION_DOCK_EVENT =
2147 "android.intent.action.DOCK_EVENT";
2148
2149 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002150 * Broadcast Action: a remote intent is to be broadcasted.
2151 *
2152 * A remote intent is used for remote RPC between devices. The remote intent
2153 * is serialized and sent from one device to another device. The receiving
2154 * device parses the remote intent and broadcasts it. Note that anyone can
2155 * broadcast a remote intent. However, if the intent receiver of the remote intent
2156 * does not trust intent broadcasts from arbitrary intent senders, it should require
2157 * the sender to hold certain permissions so only trusted sender's broadcast will be
2158 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002159 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002160 */
2161 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002162 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002163
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002164 /**
2165 * Broadcast Action: hook for permforming cleanup after a system update.
2166 *
2167 * The broadcast is sent when the system is booting, before the
2168 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2169 * image. A receiver for this should do its work and then disable itself
2170 * so that it does not get run again at the next boot.
2171 * @hide
2172 */
2173 public static final String ACTION_PRE_BOOT_COMPLETED =
2174 "android.intent.action.PRE_BOOT_COMPLETED";
2175
Amith Yamasani13593602012-03-22 16:16:17 -07002176 /**
2177 * Broadcast sent to the system when a user is added. Carries an extra EXTRA_USERID that has the
2178 * userid of the new user.
2179 * @hide
2180 */
2181 public static final String ACTION_USER_ADDED =
2182 "android.intent.action.USER_ADDED";
2183
2184 /**
2185 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USERID that has
2186 * the userid of the user.
2187 * @hide
2188 */
2189 public static final String ACTION_USER_REMOVED =
2190 "android.intent.action.USER_REMOVED";
2191
2192 /**
2193 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USERID that has
2194 * the userid of the user to become the current one.
2195 * @hide
2196 */
2197 public static final String ACTION_USER_SWITCHED =
2198 "android.intent.action.USER_SWITCHED";
2199
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002200 // ---------------------------------------------------------------------
2201 // ---------------------------------------------------------------------
2202 // Standard intent categories (see addCategory()).
2203
2204 /**
2205 * Set if the activity should be an option for the default action
2206 * (center press) to perform on a piece of data. Setting this will
2207 * hide from the user any activities without it set when performing an
2208 * action on some data. Note that this is normal -not- set in the
2209 * Intent when initiating an action -- it is for use in intent filters
2210 * specified in packages.
2211 */
2212 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2213 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2214 /**
2215 * Activities that can be safely invoked from a browser must support this
2216 * category. For example, if the user is viewing a web page or an e-mail
2217 * and clicks on a link in the text, the Intent generated execute that
2218 * link will require the BROWSABLE category, so that only activities
2219 * supporting this category will be considered as possible actions. By
2220 * supporting this category, you are promising that there is nothing
2221 * damaging (without user intervention) that can happen by invoking any
2222 * matching Intent.
2223 */
2224 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2225 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2226 /**
2227 * Set if the activity should be considered as an alternative action to
2228 * the data the user is currently viewing. See also
2229 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2230 * applies to the selection in a list of items.
2231 *
2232 * <p>Supporting this category means that you would like your activity to be
2233 * displayed in the set of alternative things the user can do, usually as
2234 * part of the current activity's options menu. You will usually want to
2235 * include a specific label in the &lt;intent-filter&gt; of this action
2236 * describing to the user what it does.
2237 *
2238 * <p>The action of IntentFilter with this category is important in that it
2239 * describes the specific action the target will perform. This generally
2240 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2241 * a specific name such as "com.android.camera.action.CROP. Only one
2242 * alternative of any particular action will be shown to the user, so using
2243 * a specific action like this makes sure that your alternative will be
2244 * displayed while also allowing other applications to provide their own
2245 * overrides of that particular action.
2246 */
2247 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2248 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2249 /**
2250 * Set if the activity should be considered as an alternative selection
2251 * action to the data the user has currently selected. This is like
2252 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2253 * of items from which the user can select, giving them alternatives to the
2254 * default action that will be performed on it.
2255 */
2256 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2257 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2258 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002259 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002260 */
2261 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2262 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2263 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002264 * Should be displayed in the top-level launcher.
2265 */
2266 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2267 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2268 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002269 * Provides information about the package it is in; typically used if
2270 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2271 * a front-door to the user without having to be shown in the all apps list.
2272 */
2273 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2274 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2275 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002276 * This is the home activity, that is the first activity that is displayed
2277 * when the device boots.
2278 */
2279 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2280 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2281 /**
2282 * This activity is a preference panel.
2283 */
2284 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2285 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2286 /**
2287 * This activity is a development preference panel.
2288 */
2289 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2290 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2291 /**
2292 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002293 */
2294 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2295 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2296 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002297 * This activity allows the user to browse and download new applications.
2298 */
2299 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2300 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2301 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002302 * This activity may be exercised by the monkey or other automated test tools.
2303 */
2304 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2305 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2306 /**
2307 * To be used as a test (not part of the normal user experience).
2308 */
2309 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2310 /**
2311 * To be used as a unit test (run through the Test Harness).
2312 */
2313 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2314 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002315 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002316 * experience).
2317 */
2318 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2319 /**
2320 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2321 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2322 * when queried, though it is allowable for those columns to be blank.
2323 */
2324 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2325 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2326
2327 /**
2328 * To be used as code under test for framework instrumentation tests.
2329 */
2330 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2331 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002332 /**
2333 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002334 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2335 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002336 */
2337 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2338 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2339 /**
2340 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002341 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2342 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002343 */
2344 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2345 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002346 /**
2347 * An activity to run when device is inserted into a analog (low end) dock.
2348 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2349 * information, see {@link android.app.UiModeManager}.
2350 */
2351 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2352 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2353
2354 /**
2355 * An activity to run when device is inserted into a digital (high end) dock.
2356 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2357 * information, see {@link android.app.UiModeManager}.
2358 */
2359 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2360 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002361
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002362 /**
2363 * Used to indicate that the activity can be used in a car environment.
2364 */
2365 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2366 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2367
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002368 // ---------------------------------------------------------------------
2369 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002370 // Application launch intent categories (see addCategory()).
2371
2372 /**
2373 * Used with {@link #ACTION_MAIN} to launch the browser application.
2374 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002375 * <p>NOTE: This should not be used as the primary key of an Intent,
2376 * since it will not result in the app launching with the correct
2377 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002378 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002379 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002380 */
2381 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2382 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2383
2384 /**
2385 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2386 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002387 * <p>NOTE: This should not be used as the primary key of an Intent,
2388 * since it will not result in the app launching with the correct
2389 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002390 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002391 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002392 */
2393 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2394 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2395
2396 /**
2397 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2398 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002399 * <p>NOTE: This should not be used as the primary key of an Intent,
2400 * since it will not result in the app launching with the correct
2401 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002402 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002403 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002404 */
2405 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2406 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2407
2408 /**
2409 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2410 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002411 * <p>NOTE: This should not be used as the primary key of an Intent,
2412 * since it will not result in the app launching with the correct
2413 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002414 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002415 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002416 */
2417 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2418 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2419
2420 /**
2421 * Used with {@link #ACTION_MAIN} to launch the email application.
2422 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002423 * <p>NOTE: This should not be used as the primary key of an Intent,
2424 * since it will not result in the app launching with the correct
2425 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002426 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002427 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002428 */
2429 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2430 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2431
2432 /**
2433 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2434 * The activity should be able to view and manipulate image and video files
2435 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002436 * <p>NOTE: This should not be used as the primary key of an Intent,
2437 * since it will not result in the app launching with the correct
2438 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002439 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002440 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002441 */
2442 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2443 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2444
2445 /**
2446 * Used with {@link #ACTION_MAIN} to launch the maps application.
2447 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002448 * <p>NOTE: This should not be used as the primary key of an Intent,
2449 * since it will not result in the app launching with the correct
2450 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002451 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002452 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002453 */
2454 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2455 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2456
2457 /**
2458 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2459 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002460 * <p>NOTE: This should not be used as the primary key of an Intent,
2461 * since it will not result in the app launching with the correct
2462 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002463 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002464 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002465 */
2466 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2467 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2468
2469 /**
2470 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002471 * The activity should be able to play, browse, or manipulate music files
2472 * stored on the device.
2473 * <p>NOTE: This should not be used as the primary key of an Intent,
2474 * since it will not result in the app launching with the correct
2475 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002476 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002477 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002478 */
2479 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2480 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2481
2482 // ---------------------------------------------------------------------
2483 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002484 // Standard extra data keys.
2485
2486 /**
2487 * The initial data to place in a newly created record. Use with
2488 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2489 * fields as would be given to the underlying ContentProvider.insert()
2490 * call.
2491 */
2492 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2493
2494 /**
2495 * A constant CharSequence that is associated with the Intent, used with
2496 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2497 * this may be a styled CharSequence, so you must use
2498 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2499 * retrieve it.
2500 */
2501 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2502
2503 /**
2504 * A content: URI holding a stream of data associated with the Intent,
2505 * used with {@link #ACTION_SEND} to supply the data being sent.
2506 */
2507 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2508
2509 /**
2510 * A String[] holding e-mail addresses that should be delivered to.
2511 */
2512 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2513
2514 /**
2515 * A String[] holding e-mail addresses that should be carbon copied.
2516 */
2517 public static final String EXTRA_CC = "android.intent.extra.CC";
2518
2519 /**
2520 * A String[] holding e-mail addresses that should be blind carbon copied.
2521 */
2522 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2523
2524 /**
2525 * A constant string holding the desired subject line of a message.
2526 */
2527 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2528
2529 /**
2530 * An Intent describing the choices you would like shown with
2531 * {@link #ACTION_PICK_ACTIVITY}.
2532 */
2533 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2534
2535 /**
2536 * A CharSequence dialog title to provide to the user when used with a
2537 * {@link #ACTION_CHOOSER}.
2538 */
2539 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2540
2541 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002542 * A Parcelable[] of {@link Intent} or
2543 * {@link android.content.pm.LabeledIntent} objects as set with
2544 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2545 * a the front of the list of choices, when shown to the user with a
2546 * {@link #ACTION_CHOOSER}.
2547 */
2548 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2549
2550 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002551 * A {@link android.view.KeyEvent} object containing the event that
2552 * triggered the creation of the Intent it is in.
2553 */
2554 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2555
2556 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002557 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2558 * before shutting down.
2559 *
2560 * {@hide}
2561 */
2562 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2563
2564 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002565 * 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 -07002566 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2567 * of restarting the application.
2568 */
2569 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2570
2571 /**
2572 * A String holding the phone number originally entered in
2573 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2574 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2575 */
2576 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002577
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002578 /**
2579 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2580 * intents to supply the uid the package had been assigned. Also an optional
2581 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2582 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2583 * purpose.
2584 */
2585 public static final String EXTRA_UID = "android.intent.extra.UID";
2586
2587 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002588 * @hide String array of package names.
2589 */
2590 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2591
2592 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002593 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2594 * intents to indicate whether this represents a full uninstall (removing
2595 * both the code and its data) or a partial uninstall (leaving its data,
2596 * implying that this is an update).
2597 */
2598 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002599
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002600 /**
2601 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2602 * intents to indicate that this is a replacement of the package, so this
2603 * broadcast will immediately be followed by an add broadcast for a
2604 * different version of the same package.
2605 */
2606 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002607
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002608 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002609 * Used as an int extra field in {@link android.app.AlarmManager} intents
2610 * to tell the application being invoked how many pending alarms are being
2611 * delievered with the intent. For one-shot alarms this will always be 1.
2612 * For recurring alarms, this might be greater than 1 if the device was
2613 * asleep or powered off at the time an earlier alarm would have been
2614 * delivered.
2615 */
2616 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002617
Jacek Surazski86b6c532009-05-13 14:38:28 +02002618 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002619 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2620 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002621 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2622 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002623 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2624 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2625 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002626 */
2627 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2628
2629 /**
2630 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2631 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002632 */
2633 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2634
2635 /**
2636 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2637 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002638 */
2639 public static final int EXTRA_DOCK_STATE_DESK = 1;
2640
2641 /**
2642 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2643 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002644 */
2645 public static final int EXTRA_DOCK_STATE_CAR = 2;
2646
2647 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002648 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2649 * to represent that the phone is in a analog (low end) dock.
2650 */
2651 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2652
2653 /**
2654 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2655 * to represent that the phone is in a digital (high end) dock.
2656 */
2657 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2658
2659 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002660 * Boolean that can be supplied as meta-data with a dock activity, to
2661 * indicate that the dock should take over the home key when it is active.
2662 */
2663 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002664
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002665 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002666 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2667 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002668 */
2669 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2670
2671 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002672 * Used in the extra field in the remote intent. It's astring token passed with the
2673 * remote intent.
2674 */
2675 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2676 "android.intent.extra.remote_intent_token";
2677
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002678 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002679 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002680 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002681 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002682 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002683 "android.intent.extra.changed_component_name";
2684
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002685 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002686 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002687 * and contains a string array of all of the components that have changed.
2688 */
2689 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2690 "android.intent.extra.changed_component_name_list";
2691
2692 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002693 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002694 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2695 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002696 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002697 */
2698 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2699 "android.intent.extra.changed_package_list";
2700
2701 /**
2702 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002703 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2704 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002705 * and contains an integer array of uids of all of the components
2706 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002707 */
2708 public static final String EXTRA_CHANGED_UID_LIST =
2709 "android.intent.extra.changed_uid_list";
2710
2711 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002712 * @hide
2713 * Magic extra system code can use when binding, to give a label for
2714 * who it is that has bound to a service. This is an integer giving
2715 * a framework string resource that can be displayed to the user.
2716 */
2717 public static final String EXTRA_CLIENT_LABEL =
2718 "android.intent.extra.client_label";
2719
2720 /**
2721 * @hide
2722 * Magic extra system code can use when binding, to give a PendingIntent object
2723 * that can be launched for the user to disable the system's use of this
2724 * service.
2725 */
2726 public static final String EXTRA_CLIENT_INTENT =
2727 "android.intent.extra.client_intent";
2728
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002729 /**
2730 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2731 * data that is on the local device. This is a boolean extra; the default
2732 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2733 * the user to select media that is already on the device, not requiring it
2734 * be downloaded from a remote service when opened. Another way to look
2735 * at it is that such content should generally have a "_data" column to the
2736 * path of the content on local external storage.
2737 */
2738 public static final String EXTRA_LOCAL_ONLY =
2739 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07002740
Amith Yamasani13593602012-03-22 16:16:17 -07002741 /**
2742 * The userid carried with broadcast intents related to addition, removal and switching of users
2743 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
2744 * @hide
2745 */
2746 public static final String EXTRA_USERID =
2747 "android.intent.extra.user_id";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002748 // ---------------------------------------------------------------------
2749 // ---------------------------------------------------------------------
2750 // Intent flags (see mFlags variable).
2751
2752 /**
2753 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002754 * perform read operations on the Uri in the Intent's data and any URIs
2755 * specified in its ClipData. When applying to an Intent's ClipData,
2756 * all URIs as well as recursive traversals through data or other ClipData
2757 * in Intent items will be granted; only the grant flags of the top-level
2758 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002759 */
2760 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2761 /**
2762 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002763 * perform write operations on the Uri in the Intent's data and any URIs
2764 * specified in its ClipData. When applying to an Intent's ClipData,
2765 * all URIs as well as recursive traversals through data or other ClipData
2766 * in Intent items will be granted; only the grant flags of the top-level
2767 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002768 */
2769 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2770 /**
2771 * Can be set by the caller to indicate that this Intent is coming from
2772 * a background operation, not from direct user interaction.
2773 */
2774 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2775 /**
2776 * A flag you can enable for debugging: when set, log messages will be
2777 * printed during the resolution of this intent to show you what has
2778 * been found to create the final resolved list.
2779 */
2780 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002781 /**
2782 * If set, this intent will not match any components in packages that
2783 * are currently stopped. If this is not set, then the default behavior
2784 * is to include such applications in the result.
2785 */
2786 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2787 /**
2788 * If set, this intent will always match any components in packages that
2789 * are currently stopped. This is the default behavior when
2790 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2791 * flags are set, this one wins (it allows overriding of exclude for
2792 * places where the framework may automatically set the exclude flag).
2793 */
2794 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002795
2796 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002797 * If set, the new activity is not kept in the history stack. As soon as
2798 * the user navigates away from it, the activity is finished. This may also
2799 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2800 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002801 */
2802 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2803 /**
2804 * If set, the activity will not be launched if it is already running
2805 * at the top of the history stack.
2806 */
2807 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2808 /**
2809 * If set, this activity will become the start of a new task on this
2810 * history stack. A task (from the activity that started it to the
2811 * next task activity) defines an atomic group of activities that the
2812 * user can move to. Tasks can be moved to the foreground and background;
2813 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002814 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002815 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2816 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002817 *
2818 * <p>This flag is generally used by activities that want
2819 * to present a "launcher" style behavior: they give the user a list of
2820 * separate things that can be done, which otherwise run completely
2821 * independently of the activity launching them.
2822 *
2823 * <p>When using this flag, if a task is already running for the activity
2824 * you are now starting, then a new activity will not be started; instead,
2825 * the current task will simply be brought to the front of the screen with
2826 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2827 * to disable this behavior.
2828 *
2829 * <p>This flag can not be used when the caller is requesting a result from
2830 * the activity being launched.
2831 */
2832 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2833 /**
2834 * <strong>Do not use this flag unless you are implementing your own
2835 * top-level application launcher.</strong> Used in conjunction with
2836 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2837 * behavior of bringing an existing task to the foreground. When set,
2838 * a new task is <em>always</em> started to host the Activity for the
2839 * Intent, regardless of whether there is already an existing task running
2840 * the same thing.
2841 *
2842 * <p><strong>Because the default system does not include graphical task management,
2843 * you should not use this flag unless you provide some way for a user to
2844 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002845 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002846 * <p>This flag is ignored if
2847 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2848 *
Scott Main7aee61f2011-02-08 11:25:01 -08002849 * <p>See
2850 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2851 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002852 */
2853 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2854 /**
2855 * If set, and the activity being launched is already running in the
2856 * current task, then instead of launching a new instance of that activity,
2857 * all of the other activities on top of it will be closed and this Intent
2858 * will be delivered to the (now on top) old activity as a new Intent.
2859 *
2860 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2861 * If D calls startActivity() with an Intent that resolves to the component
2862 * of activity B, then C and D will be finished and B receive the given
2863 * Intent, resulting in the stack now being: A, B.
2864 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002865 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002866 * either receive the new intent you are starting here in its
2867 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002868 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002869 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2870 * the same intent, then it will be finished and re-created; for all other
2871 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2872 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002873 *
2874 * <p>This launch mode can also be used to good effect in conjunction with
2875 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2876 * of a task, it will bring any currently running instance of that task
2877 * to the foreground, and then clear it to its root state. This is
2878 * especially useful, for example, when launching an activity from the
2879 * notification manager.
2880 *
Scott Main7aee61f2011-02-08 11:25:01 -08002881 * <p>See
2882 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2883 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002884 */
2885 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2886 /**
2887 * If set and this intent is being used to launch a new activity from an
2888 * existing one, then the reply target of the existing activity will be
2889 * transfered to the new activity. This way the new activity can call
2890 * {@link android.app.Activity#setResult} and have that result sent back to
2891 * the reply target of the original activity.
2892 */
2893 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2894 /**
2895 * If set and this intent is being used to launch a new activity from an
2896 * existing one, the current activity will not be counted as the top
2897 * activity for deciding whether the new intent should be delivered to
2898 * the top instead of starting a new one. The previous activity will
2899 * be used as the top, with the assumption being that the current activity
2900 * will finish itself immediately.
2901 */
2902 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2903 /**
2904 * If set, the new activity is not kept in the list of recently launched
2905 * activities.
2906 */
2907 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2908 /**
2909 * This flag is not normally set by application code, but set for you by
2910 * the system as described in the
2911 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2912 * launchMode} documentation for the singleTask mode.
2913 */
2914 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2915 /**
2916 * If set, and this activity is either being started in a new task or
2917 * bringing to the top an existing task, then it will be launched as
2918 * the front door of the task. This will result in the application of
2919 * any affinities needed to have that task in the proper state (either
2920 * moving activities to or from it), or simply resetting that task to
2921 * its initial state if needed.
2922 */
2923 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2924 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002925 * This flag is not normally set by application code, but set for you by
2926 * the system if this activity is being launched from history
2927 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002928 */
2929 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002930 /**
2931 * If set, this marks a point in the task's activity stack that should
2932 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002933 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002934 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2935 * the user re-launching it from home), this activity and all on top of
2936 * it will be finished so that the user does not return to them, but
2937 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002938 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002939 * <p>This is useful for cases where you have a logical break in your
2940 * application. For example, an e-mail application may have a command
2941 * to view an attachment, which launches an image view activity to
2942 * display it. This activity should be part of the e-mail application's
2943 * task, since it is a part of the task the user is involved in. However,
2944 * if the user leaves that task, and later selects the e-mail app from
2945 * home, we may like them to return to the conversation they were
2946 * viewing, not the picture attachment, since that is confusing. By
2947 * setting this flag when launching the image viewer, that viewer and
2948 * any activities it starts will be removed the next time the user returns
2949 * to mail.
2950 */
2951 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002952 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002953 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002954 * callback from occurring on the current frontmost activity before it is
2955 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002956 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002957 * <p>Typically, an activity can rely on that callback to indicate that an
2958 * explicit user action has caused their activity to be moved out of the
2959 * foreground. The callback marks an appropriate point in the activity's
2960 * lifecycle for it to dismiss any notifications that it intends to display
2961 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002962 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002963 * <p>If an activity is ever started via any non-user-driven events such as
2964 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2965 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002966 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002967 */
2968 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002969 /**
2970 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2971 * this flag will cause the launched activity to be brought to the front of its
2972 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002973 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002974 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2975 * If D calls startActivity() with an Intent that resolves to the component
2976 * of activity B, then B will be brought to the front of the history stack,
2977 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002978 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002979 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002980 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002981 */
2982 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002983 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002984 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2985 * this flag will prevent the system from applying an activity transition
2986 * animation to go to the next activity state. This doesn't mean an
2987 * animation will never run -- if another activity change happens that doesn't
2988 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08002989 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002990 * when you are going to do a series of activity operations but the
2991 * animation seen by the user shouldn't be driven by the first activity
2992 * change but rather a later one.
2993 */
2994 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
2995 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08002996 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2997 * this flag will cause any existing task that would be associated with the
2998 * activity to be cleared before the activity is started. That is, the activity
2999 * becomes the new root of an otherwise empty task, and any old activities
3000 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3001 */
3002 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3003 /**
3004 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3005 * this flag will cause a newly launching task to be placed on top of the current
3006 * home activity task (if there is one). That is, pressing back from the task
3007 * will always return the user to home even if that was not the last activity they
3008 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3009 */
3010 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3011 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003012 * If set, when sending a broadcast only registered receivers will be
3013 * called -- no BroadcastReceiver components will be launched.
3014 */
3015 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003016 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003017 * If set, when sending a broadcast the new broadcast will replace
3018 * any existing pending broadcast that matches it. Matching is defined
3019 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3020 * true for the intents of the two broadcasts. When a match is found,
3021 * the new broadcast (and receivers associated with it) will replace the
3022 * existing one in the pending broadcast list, remaining at the same
3023 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003024 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003025 * <p>This flag is most typically used with sticky broadcasts, which
3026 * only care about delivering the most recent values of the broadcast
3027 * to their receivers.
3028 */
3029 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3030 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003031 * If set, when sending a broadcast the recipient is allowed to run at
3032 * foreground priority, with a shorter timeout interval. During normal
3033 * broadcasts the receivers are not automatically hoisted out of the
3034 * background priority class.
3035 */
3036 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3037 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003038 * If set, when sending a broadcast <i>before boot has completed</i> only
3039 * registered receivers will be called -- no BroadcastReceiver components
3040 * will be launched. Sticky intent state will be recorded properly even
3041 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3042 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003043 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003044 * <p>This flag is only for use by system sevices as a convenience to
3045 * avoid having to implement a more complex mechanism around detection
3046 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003047 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003048 * @hide
3049 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003050 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003051 /**
3052 * Set when this broadcast is for a boot upgrade, a special mode that
3053 * allows the broadcast to be sent before the system is ready and launches
3054 * the app process with no providers running in it.
3055 * @hide
3056 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003057 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003058
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003059 /**
3060 * @hide Flags that can't be changed with PendingIntent.
3061 */
3062 public static final int IMMUTABLE_FLAGS =
3063 FLAG_GRANT_READ_URI_PERMISSION
3064 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003065
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003066 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003067 // ---------------------------------------------------------------------
3068 // toUri() and parseUri() options.
3069
3070 /**
3071 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3072 * always has the "intent:" scheme. This syntax can be used when you want
3073 * to later disambiguate between URIs that are intended to describe an
3074 * Intent vs. all others that should be treated as raw URIs. When used
3075 * with {@link #parseUri}, any other scheme will result in a generic
3076 * VIEW action for that raw URI.
3077 */
3078 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003079
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003080 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003081
3082 private String mAction;
3083 private Uri mData;
3084 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003085 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003086 private ComponentName mComponent;
3087 private int mFlags;
3088 private HashSet<String> mCategories;
3089 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003090 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003091 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003092 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003093
3094 // ---------------------------------------------------------------------
3095
3096 /**
3097 * Create an empty intent.
3098 */
3099 public Intent() {
3100 }
3101
3102 /**
3103 * Copy constructor.
3104 */
3105 public Intent(Intent o) {
3106 this.mAction = o.mAction;
3107 this.mData = o.mData;
3108 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003109 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003110 this.mComponent = o.mComponent;
3111 this.mFlags = o.mFlags;
3112 if (o.mCategories != null) {
3113 this.mCategories = new HashSet<String>(o.mCategories);
3114 }
3115 if (o.mExtras != null) {
3116 this.mExtras = new Bundle(o.mExtras);
3117 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003118 if (o.mSourceBounds != null) {
3119 this.mSourceBounds = new Rect(o.mSourceBounds);
3120 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003121 if (o.mSelector != null) {
3122 this.mSelector = new Intent(o.mSelector);
3123 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003124 if (o.mClipData != null) {
3125 this.mClipData = new ClipData(o.mClipData);
3126 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003127 }
3128
3129 @Override
3130 public Object clone() {
3131 return new Intent(this);
3132 }
3133
3134 private Intent(Intent o, boolean all) {
3135 this.mAction = o.mAction;
3136 this.mData = o.mData;
3137 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003138 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003139 this.mComponent = o.mComponent;
3140 if (o.mCategories != null) {
3141 this.mCategories = new HashSet<String>(o.mCategories);
3142 }
3143 }
3144
3145 /**
3146 * Make a clone of only the parts of the Intent that are relevant for
3147 * filter matching: the action, data, type, component, and categories.
3148 */
3149 public Intent cloneFilter() {
3150 return new Intent(this, false);
3151 }
3152
3153 /**
3154 * Create an intent with a given action. All other fields (data, type,
3155 * class) are null. Note that the action <em>must</em> be in a
3156 * namespace because Intents are used globally in the system -- for
3157 * example the system VIEW action is android.intent.action.VIEW; an
3158 * application's custom action would be something like
3159 * com.google.app.myapp.CUSTOM_ACTION.
3160 *
3161 * @param action The Intent action, such as ACTION_VIEW.
3162 */
3163 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003164 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003165 }
3166
3167 /**
3168 * Create an intent with a given action and for a given data url. Note
3169 * that the action <em>must</em> be in a namespace because Intents are
3170 * used globally in the system -- for example the system VIEW action is
3171 * android.intent.action.VIEW; an application's custom action would be
3172 * something like com.google.app.myapp.CUSTOM_ACTION.
3173 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003174 * <p><em>Note: scheme and host name matching in the Android framework is
3175 * case-sensitive, unlike the formal RFC. As a result,
3176 * you should always ensure that you write your Uri with these elements
3177 * using lower case letters, and normalize any Uris you receive from
3178 * outside of Android to ensure the scheme and host is lower case.</em></p>
3179 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003180 * @param action The Intent action, such as ACTION_VIEW.
3181 * @param uri The Intent data URI.
3182 */
3183 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003184 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003185 mData = uri;
3186 }
3187
3188 /**
3189 * Create an intent for a specific component. All other fields (action, data,
3190 * type, class) are null, though they can be modified later with explicit
3191 * calls. This provides a convenient way to create an intent that is
3192 * intended to execute a hard-coded class name, rather than relying on the
3193 * system to find an appropriate class for you; see {@link #setComponent}
3194 * for more information on the repercussions of this.
3195 *
3196 * @param packageContext A Context of the application package implementing
3197 * this class.
3198 * @param cls The component class that is to be used for the intent.
3199 *
3200 * @see #setClass
3201 * @see #setComponent
3202 * @see #Intent(String, android.net.Uri , Context, Class)
3203 */
3204 public Intent(Context packageContext, Class<?> cls) {
3205 mComponent = new ComponentName(packageContext, cls);
3206 }
3207
3208 /**
3209 * Create an intent for a specific component with a specified action and data.
3210 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3211 * construct the Intent and then calling {@link #setClass} to set its
3212 * class.
3213 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003214 * <p><em>Note: scheme and host name matching in the Android framework is
3215 * case-sensitive, unlike the formal RFC. As a result,
3216 * you should always ensure that you write your Uri with these elements
3217 * using lower case letters, and normalize any Uris you receive from
3218 * outside of Android to ensure the scheme and host is lower case.</em></p>
3219 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003220 * @param action The Intent action, such as ACTION_VIEW.
3221 * @param uri The Intent data URI.
3222 * @param packageContext A Context of the application package implementing
3223 * this class.
3224 * @param cls The component class that is to be used for the intent.
3225 *
3226 * @see #Intent(String, android.net.Uri)
3227 * @see #Intent(Context, Class)
3228 * @see #setClass
3229 * @see #setComponent
3230 */
3231 public Intent(String action, Uri uri,
3232 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003233 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003234 mData = uri;
3235 mComponent = new ComponentName(packageContext, cls);
3236 }
3237
3238 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003239 * Create an intent to launch the main (root) activity of a task. This
3240 * is the Intent that is started when the application's is launched from
3241 * Home. For anything else that wants to launch an application in the
3242 * same way, it is important that they use an Intent structured the same
3243 * way, and can use this function to ensure this is the case.
3244 *
3245 * <p>The returned Intent has the given Activity component as its explicit
3246 * component, {@link #ACTION_MAIN} as its action, and includes the
3247 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3248 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3249 * to do that through {@link #addFlags(int)} on the returned Intent.
3250 *
3251 * @param mainActivity The main activity component that this Intent will
3252 * launch.
3253 * @return Returns a newly created Intent that can be used to launch the
3254 * activity as a main application entry.
3255 *
3256 * @see #setClass
3257 * @see #setComponent
3258 */
3259 public static Intent makeMainActivity(ComponentName mainActivity) {
3260 Intent intent = new Intent(ACTION_MAIN);
3261 intent.setComponent(mainActivity);
3262 intent.addCategory(CATEGORY_LAUNCHER);
3263 return intent;
3264 }
3265
3266 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003267 * Make an Intent for the main activity of an application, without
3268 * specifying a specific activity to run but giving a selector to find
3269 * the activity. This results in a final Intent that is structured
3270 * the same as when the application 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 {@link #ACTION_MAIN} as its action, and includes the
3276 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3277 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3278 * to do that through {@link #addFlags(int)} on the returned Intent.
3279 *
3280 * @param selectorAction The action name of the Intent's selector.
3281 * @param selectorCategory The name of a category to add to the Intent's
3282 * selector.
3283 * @return Returns a newly created Intent that can be used to launch the
3284 * activity as a main application entry.
3285 *
3286 * @see #setSelector(Intent)
3287 */
3288 public static Intent makeMainSelectorActivity(String selectorAction,
3289 String selectorCategory) {
3290 Intent intent = new Intent(ACTION_MAIN);
3291 intent.addCategory(CATEGORY_LAUNCHER);
3292 Intent selector = new Intent();
3293 selector.setAction(selectorAction);
3294 selector.addCategory(selectorCategory);
3295 intent.setSelector(selector);
3296 return intent;
3297 }
3298
3299 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003300 * Make an Intent that can be used to re-launch an application's task
3301 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3302 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3303 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3304 *
3305 * @param mainActivity The activity component that is the root of the
3306 * task; this is the activity that has been published in the application's
3307 * manifest as the main launcher icon.
3308 *
3309 * @return Returns a newly created Intent that can be used to relaunch the
3310 * activity's task in its root state.
3311 */
3312 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3313 Intent intent = makeMainActivity(mainActivity);
3314 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3315 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3316 return intent;
3317 }
3318
3319 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003320 * Call {@link #parseUri} with 0 flags.
3321 * @deprecated Use {@link #parseUri} instead.
3322 */
3323 @Deprecated
3324 public static Intent getIntent(String uri) throws URISyntaxException {
3325 return parseUri(uri, 0);
3326 }
Tom Taylord4a47292009-12-21 13:59:18 -08003327
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003328 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003329 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003330 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003331 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003332 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003333 *
3334 * <p>The URI given here must not be relative -- that is, it must include
3335 * the scheme and full path.
3336 *
3337 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003338 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003339 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003340 *
3341 * @return Intent The newly created Intent object.
3342 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003343 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3344 * it bad (as parsed by the Uri class) or the Intent data within the
3345 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003346 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003347 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003348 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003349 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003350 int i = 0;
3351 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003352 // Validate intent scheme for if requested.
3353 if ((flags&URI_INTENT_SCHEME) != 0) {
3354 if (!uri.startsWith("intent:")) {
3355 Intent intent = new Intent(ACTION_VIEW);
3356 try {
3357 intent.setData(Uri.parse(uri));
3358 } catch (IllegalArgumentException e) {
3359 throw new URISyntaxException(uri, e.getMessage());
3360 }
3361 return intent;
3362 }
3363 }
Tom Taylord4a47292009-12-21 13:59:18 -08003364
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003365 // simple case
3366 i = uri.lastIndexOf("#");
3367 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3368
3369 // old format Intent URI
3370 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003371
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003372 // new format
3373 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003374 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003375
3376 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003377 String data = i >= 0 ? uri.substring(0, i) : null;
3378 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003379 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003380
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003381 // loop over contents of Intent, all name=value;
3382 while (!uri.startsWith("end", i)) {
3383 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003384 if (eq < 0) eq = i-1;
3385 int semi = uri.indexOf(';', i);
3386 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003387
3388 // action
3389 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003390 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003391 }
3392
3393 // categories
3394 else if (uri.startsWith("category=", i)) {
3395 intent.addCategory(value);
3396 }
3397
3398 // type
3399 else if (uri.startsWith("type=", i)) {
3400 intent.mType = value;
3401 }
3402
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003403 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003404 else if (uri.startsWith("launchFlags=", i)) {
3405 intent.mFlags = Integer.decode(value).intValue();
3406 }
3407
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003408 // package
3409 else if (uri.startsWith("package=", i)) {
3410 intent.mPackage = value;
3411 }
3412
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003413 // component
3414 else if (uri.startsWith("component=", i)) {
3415 intent.mComponent = ComponentName.unflattenFromString(value);
3416 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003417
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003418 // scheme
3419 else if (uri.startsWith("scheme=", i)) {
3420 scheme = value;
3421 }
3422
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003423 // source bounds
3424 else if (uri.startsWith("sourceBounds=", i)) {
3425 intent.mSourceBounds = Rect.unflattenFromString(value);
3426 }
3427
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003428 // selector
3429 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3430 intent = new Intent();
3431 }
3432
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003433 // extra
3434 else {
3435 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003436 // create Bundle if it doesn't already exist
3437 if (intent.mExtras == null) intent.mExtras = new Bundle();
3438 Bundle b = intent.mExtras;
3439 // add EXTRA
3440 if (uri.startsWith("S.", i)) b.putString(key, value);
3441 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3442 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3443 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3444 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3445 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3446 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3447 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3448 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3449 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3450 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003451
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003452 // move to the next item
3453 i = semi + 1;
3454 }
3455
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003456 if (intent != baseIntent) {
3457 // The Intent had a selector; fix it up.
3458 baseIntent.setSelector(intent);
3459 intent = baseIntent;
3460 }
3461
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003462 if (data != null) {
3463 if (data.startsWith("intent:")) {
3464 data = data.substring(7);
3465 if (scheme != null) {
3466 data = scheme + ':' + data;
3467 }
3468 }
Tom Taylord4a47292009-12-21 13:59:18 -08003469
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003470 if (data.length() > 0) {
3471 try {
3472 intent.mData = Uri.parse(data);
3473 } catch (IllegalArgumentException e) {
3474 throw new URISyntaxException(uri, e.getMessage());
3475 }
3476 }
3477 }
Tom Taylord4a47292009-12-21 13:59:18 -08003478
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003479 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003480
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003481 } catch (IndexOutOfBoundsException e) {
3482 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3483 }
3484 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003485
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003486 public static Intent getIntentOld(String uri) throws URISyntaxException {
3487 Intent intent;
3488
3489 int i = uri.lastIndexOf('#');
3490 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003491 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003492 final int intentFragmentStart = i;
3493 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003494
3495 i++;
3496
3497 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003498 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003499 i += 7;
3500 int j = uri.indexOf(')', i);
3501 action = uri.substring(i, j);
3502 i = j + 1;
3503 }
3504
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003505 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003506
3507 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003508 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003509 i += 11;
3510 int j = uri.indexOf(')', i);
3511 while (i < j) {
3512 int sep = uri.indexOf('!', i);
3513 if (sep < 0) sep = j;
3514 if (i < sep) {
3515 intent.addCategory(uri.substring(i, sep));
3516 }
3517 i = sep + 1;
3518 }
3519 i = j + 1;
3520 }
3521
3522 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003523 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003524 i += 5;
3525 int j = uri.indexOf(')', i);
3526 intent.mType = uri.substring(i, j);
3527 i = j + 1;
3528 }
3529
3530 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003531 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003532 i += 12;
3533 int j = uri.indexOf(')', i);
3534 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3535 i = j + 1;
3536 }
3537
3538 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003539 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003540 i += 10;
3541 int j = uri.indexOf(')', i);
3542 int sep = uri.indexOf('!', i);
3543 if (sep >= 0 && sep < j) {
3544 String pkg = uri.substring(i, sep);
3545 String cls = uri.substring(sep + 1, j);
3546 intent.mComponent = new ComponentName(pkg, cls);
3547 }
3548 i = j + 1;
3549 }
3550
3551 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003552 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003553 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003554
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003555 final int closeParen = uri.indexOf(')', i);
3556 if (closeParen == -1) throw new URISyntaxException(uri,
3557 "EXTRA missing trailing ')'", i);
3558
3559 while (i < closeParen) {
3560 // fetch the key value
3561 int j = uri.indexOf('=', i);
3562 if (j <= i + 1 || i >= closeParen) {
3563 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3564 }
3565 char type = uri.charAt(i);
3566 i++;
3567 String key = uri.substring(i, j);
3568 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003569
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003570 // get type-value
3571 j = uri.indexOf('!', i);
3572 if (j == -1 || j >= closeParen) j = closeParen;
3573 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3574 String value = uri.substring(i, j);
3575 i = j;
3576
3577 // create Bundle if it doesn't already exist
3578 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003579
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003580 // add item to bundle
3581 try {
3582 switch (type) {
3583 case 'S':
3584 intent.mExtras.putString(key, Uri.decode(value));
3585 break;
3586 case 'B':
3587 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3588 break;
3589 case 'b':
3590 intent.mExtras.putByte(key, Byte.parseByte(value));
3591 break;
3592 case 'c':
3593 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3594 break;
3595 case 'd':
3596 intent.mExtras.putDouble(key, Double.parseDouble(value));
3597 break;
3598 case 'f':
3599 intent.mExtras.putFloat(key, Float.parseFloat(value));
3600 break;
3601 case 'i':
3602 intent.mExtras.putInt(key, Integer.parseInt(value));
3603 break;
3604 case 'l':
3605 intent.mExtras.putLong(key, Long.parseLong(value));
3606 break;
3607 case 's':
3608 intent.mExtras.putShort(key, Short.parseShort(value));
3609 break;
3610 default:
3611 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3612 }
3613 } catch (NumberFormatException e) {
3614 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3615 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003616
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003617 char ch = uri.charAt(i);
3618 if (ch == ')') break;
3619 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3620 i++;
3621 }
3622 }
3623
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003624 if (isIntentFragment) {
3625 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3626 } else {
3627 intent.mData = Uri.parse(uri);
3628 }
Tom Taylord4a47292009-12-21 13:59:18 -08003629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003630 if (intent.mAction == null) {
3631 // By default, if no action is specified, then use VIEW.
3632 intent.mAction = ACTION_VIEW;
3633 }
3634
3635 } else {
3636 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3637 }
3638
3639 return intent;
3640 }
3641
3642 /**
3643 * Retrieve the general action to be performed, such as
3644 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3645 * the information in the intent should be interpreted -- most importantly,
3646 * what to do with the data returned by {@link #getData}.
3647 *
3648 * @return The action of this intent or null if none is specified.
3649 *
3650 * @see #setAction
3651 */
3652 public String getAction() {
3653 return mAction;
3654 }
3655
3656 /**
3657 * Retrieve data this intent is operating on. This URI specifies the name
3658 * of the data; often it uses the content: scheme, specifying data in a
3659 * content provider. Other schemes may be handled by specific activities,
3660 * such as http: by the web browser.
3661 *
3662 * @return The URI of the data this intent is targeting or null.
3663 *
3664 * @see #getScheme
3665 * @see #setData
3666 */
3667 public Uri getData() {
3668 return mData;
3669 }
3670
3671 /**
3672 * The same as {@link #getData()}, but returns the URI as an encoded
3673 * String.
3674 */
3675 public String getDataString() {
3676 return mData != null ? mData.toString() : null;
3677 }
3678
3679 /**
3680 * Return the scheme portion of the intent's data. If the data is null or
3681 * does not include a scheme, null is returned. Otherwise, the scheme
3682 * prefix without the final ':' is returned, i.e. "http".
3683 *
3684 * <p>This is the same as calling getData().getScheme() (and checking for
3685 * null data).
3686 *
3687 * @return The scheme of this intent.
3688 *
3689 * @see #getData
3690 */
3691 public String getScheme() {
3692 return mData != null ? mData.getScheme() : null;
3693 }
3694
3695 /**
3696 * Retrieve any explicit MIME type included in the intent. This is usually
3697 * null, as the type is determined by the intent data.
3698 *
3699 * @return If a type was manually set, it is returned; else null is
3700 * returned.
3701 *
3702 * @see #resolveType(ContentResolver)
3703 * @see #setType
3704 */
3705 public String getType() {
3706 return mType;
3707 }
3708
3709 /**
3710 * Return the MIME data type of this intent. If the type field is
3711 * explicitly set, that is simply returned. Otherwise, if the data is set,
3712 * the type of that data is returned. If neither fields are set, a null is
3713 * returned.
3714 *
3715 * @return The MIME type of this intent.
3716 *
3717 * @see #getType
3718 * @see #resolveType(ContentResolver)
3719 */
3720 public String resolveType(Context context) {
3721 return resolveType(context.getContentResolver());
3722 }
3723
3724 /**
3725 * Return the MIME data type of this intent. If the type field is
3726 * explicitly set, that is simply returned. Otherwise, if the data is set,
3727 * the type of that data is returned. If neither fields are set, a null is
3728 * returned.
3729 *
3730 * @param resolver A ContentResolver that can be used to determine the MIME
3731 * type of the intent's data.
3732 *
3733 * @return The MIME type of this intent.
3734 *
3735 * @see #getType
3736 * @see #resolveType(Context)
3737 */
3738 public String resolveType(ContentResolver resolver) {
3739 if (mType != null) {
3740 return mType;
3741 }
3742 if (mData != null) {
3743 if ("content".equals(mData.getScheme())) {
3744 return resolver.getType(mData);
3745 }
3746 }
3747 return null;
3748 }
3749
3750 /**
3751 * Return the MIME data type of this intent, only if it will be needed for
3752 * intent resolution. This is not generally useful for application code;
3753 * it is used by the frameworks for communicating with back-end system
3754 * services.
3755 *
3756 * @param resolver A ContentResolver that can be used to determine the MIME
3757 * type of the intent's data.
3758 *
3759 * @return The MIME type of this intent, or null if it is unknown or not
3760 * needed.
3761 */
3762 public String resolveTypeIfNeeded(ContentResolver resolver) {
3763 if (mComponent != null) {
3764 return mType;
3765 }
3766 return resolveType(resolver);
3767 }
3768
3769 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003770 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003771 *
3772 * @param category The category to check.
3773 *
3774 * @return boolean True if the intent contains the category, else false.
3775 *
3776 * @see #getCategories
3777 * @see #addCategory
3778 */
3779 public boolean hasCategory(String category) {
3780 return mCategories != null && mCategories.contains(category);
3781 }
3782
3783 /**
3784 * Return the set of all categories in the intent. If there are no categories,
3785 * returns NULL.
3786 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003787 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003788 *
3789 * @see #hasCategory
3790 * @see #addCategory
3791 */
3792 public Set<String> getCategories() {
3793 return mCategories;
3794 }
3795
3796 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003797 * Return the specific selector associated with this Intent. If there is
3798 * none, returns null. See {@link #setSelector} for more information.
3799 *
3800 * @see #setSelector
3801 */
3802 public Intent getSelector() {
3803 return mSelector;
3804 }
3805
3806 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003807 * Return the {@link ClipData} associated with this Intent. If there is
3808 * none, returns null. See {@link #setClipData} for more information.
3809 *
3810 * @see #setClipData;
3811 */
3812 public ClipData getClipData() {
3813 return mClipData;
3814 }
3815
3816 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003817 * Sets the ClassLoader that will be used when unmarshalling
3818 * any Parcelable values from the extras of this Intent.
3819 *
3820 * @param loader a ClassLoader, or null to use the default loader
3821 * at the time of unmarshalling.
3822 */
3823 public void setExtrasClassLoader(ClassLoader loader) {
3824 if (mExtras != null) {
3825 mExtras.setClassLoader(loader);
3826 }
3827 }
3828
3829 /**
3830 * Returns true if an extra value is associated with the given name.
3831 * @param name the extra's name
3832 * @return true if the given extra is present.
3833 */
3834 public boolean hasExtra(String name) {
3835 return mExtras != null && mExtras.containsKey(name);
3836 }
3837
3838 /**
3839 * Returns true if the Intent's extras contain a parcelled file descriptor.
3840 * @return true if the Intent contains a parcelled file descriptor.
3841 */
3842 public boolean hasFileDescriptors() {
3843 return mExtras != null && mExtras.hasFileDescriptors();
3844 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003845
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003846 /** @hide */
3847 public void setAllowFds(boolean allowFds) {
3848 if (mExtras != null) {
3849 mExtras.setAllowFds(allowFds);
3850 }
3851 }
3852
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003853 /**
3854 * Retrieve extended data from the intent.
3855 *
3856 * @param name The name of the desired item.
3857 *
3858 * @return the value of an item that previously added with putExtra()
3859 * or null if none was found.
3860 *
3861 * @deprecated
3862 * @hide
3863 */
3864 @Deprecated
3865 public Object getExtra(String name) {
3866 return getExtra(name, null);
3867 }
3868
3869 /**
3870 * Retrieve extended data from the intent.
3871 *
3872 * @param name The name of the desired item.
3873 * @param defaultValue the value to be returned if no value of the desired
3874 * type is stored with the given name.
3875 *
3876 * @return the value of an item that previously added with putExtra()
3877 * or the default value if none was found.
3878 *
3879 * @see #putExtra(String, boolean)
3880 */
3881 public boolean getBooleanExtra(String name, boolean defaultValue) {
3882 return mExtras == null ? defaultValue :
3883 mExtras.getBoolean(name, defaultValue);
3884 }
3885
3886 /**
3887 * Retrieve extended data from the intent.
3888 *
3889 * @param name The name of the desired item.
3890 * @param defaultValue the value to be returned if no value of the desired
3891 * type is stored with the given name.
3892 *
3893 * @return the value of an item that previously added with putExtra()
3894 * or the default value if none was found.
3895 *
3896 * @see #putExtra(String, byte)
3897 */
3898 public byte getByteExtra(String name, byte defaultValue) {
3899 return mExtras == null ? defaultValue :
3900 mExtras.getByte(name, defaultValue);
3901 }
3902
3903 /**
3904 * Retrieve extended data from the intent.
3905 *
3906 * @param name The name of the desired item.
3907 * @param defaultValue the value to be returned if no value of the desired
3908 * type is stored with the given name.
3909 *
3910 * @return the value of an item that previously added with putExtra()
3911 * or the default value if none was found.
3912 *
3913 * @see #putExtra(String, short)
3914 */
3915 public short getShortExtra(String name, short defaultValue) {
3916 return mExtras == null ? defaultValue :
3917 mExtras.getShort(name, defaultValue);
3918 }
3919
3920 /**
3921 * Retrieve extended data from the intent.
3922 *
3923 * @param name The name of the desired item.
3924 * @param defaultValue the value to be returned if no value of the desired
3925 * type is stored with the given name.
3926 *
3927 * @return the value of an item that previously added with putExtra()
3928 * or the default value if none was found.
3929 *
3930 * @see #putExtra(String, char)
3931 */
3932 public char getCharExtra(String name, char defaultValue) {
3933 return mExtras == null ? defaultValue :
3934 mExtras.getChar(name, defaultValue);
3935 }
3936
3937 /**
3938 * Retrieve extended data from the intent.
3939 *
3940 * @param name The name of the desired item.
3941 * @param defaultValue the value to be returned if no value of the desired
3942 * type is stored with the given name.
3943 *
3944 * @return the value of an item that previously added with putExtra()
3945 * or the default value if none was found.
3946 *
3947 * @see #putExtra(String, int)
3948 */
3949 public int getIntExtra(String name, int defaultValue) {
3950 return mExtras == null ? defaultValue :
3951 mExtras.getInt(name, defaultValue);
3952 }
3953
3954 /**
3955 * Retrieve extended data from the intent.
3956 *
3957 * @param name The name of the desired item.
3958 * @param defaultValue the value to be returned if no value of the desired
3959 * type is stored with the given name.
3960 *
3961 * @return the value of an item that previously added with putExtra()
3962 * or the default value if none was found.
3963 *
3964 * @see #putExtra(String, long)
3965 */
3966 public long getLongExtra(String name, long defaultValue) {
3967 return mExtras == null ? defaultValue :
3968 mExtras.getLong(name, defaultValue);
3969 }
3970
3971 /**
3972 * Retrieve extended data from the intent.
3973 *
3974 * @param name The name of the desired item.
3975 * @param defaultValue the value to be returned if no value of the desired
3976 * type is stored with the given name.
3977 *
3978 * @return the value of an item that previously added with putExtra(),
3979 * or the default value if no such item is present
3980 *
3981 * @see #putExtra(String, float)
3982 */
3983 public float getFloatExtra(String name, float defaultValue) {
3984 return mExtras == null ? defaultValue :
3985 mExtras.getFloat(name, defaultValue);
3986 }
3987
3988 /**
3989 * Retrieve extended data from the intent.
3990 *
3991 * @param name The name of the desired item.
3992 * @param defaultValue the value to be returned if no value of the desired
3993 * type is stored with the given name.
3994 *
3995 * @return the value of an item that previously added with putExtra()
3996 * or the default value if none was found.
3997 *
3998 * @see #putExtra(String, double)
3999 */
4000 public double getDoubleExtra(String name, double defaultValue) {
4001 return mExtras == null ? defaultValue :
4002 mExtras.getDouble(name, defaultValue);
4003 }
4004
4005 /**
4006 * Retrieve extended data from the intent.
4007 *
4008 * @param name The name of the desired item.
4009 *
4010 * @return the value of an item that previously added with putExtra()
4011 * or null if no String value was found.
4012 *
4013 * @see #putExtra(String, String)
4014 */
4015 public String getStringExtra(String name) {
4016 return mExtras == null ? null : mExtras.getString(name);
4017 }
4018
4019 /**
4020 * Retrieve extended data from the intent.
4021 *
4022 * @param name The name of the desired item.
4023 *
4024 * @return the value of an item that previously added with putExtra()
4025 * or null if no CharSequence value was found.
4026 *
4027 * @see #putExtra(String, CharSequence)
4028 */
4029 public CharSequence getCharSequenceExtra(String name) {
4030 return mExtras == null ? null : mExtras.getCharSequence(name);
4031 }
4032
4033 /**
4034 * Retrieve extended data from the intent.
4035 *
4036 * @param name The name of the desired item.
4037 *
4038 * @return the value of an item that previously added with putExtra()
4039 * or null if no Parcelable value was found.
4040 *
4041 * @see #putExtra(String, Parcelable)
4042 */
4043 public <T extends Parcelable> T getParcelableExtra(String name) {
4044 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4045 }
4046
4047 /**
4048 * Retrieve extended data from the intent.
4049 *
4050 * @param name The name of the desired item.
4051 *
4052 * @return the value of an item that previously added with putExtra()
4053 * or null if no Parcelable[] value was found.
4054 *
4055 * @see #putExtra(String, Parcelable[])
4056 */
4057 public Parcelable[] getParcelableArrayExtra(String name) {
4058 return mExtras == null ? null : mExtras.getParcelableArray(name);
4059 }
4060
4061 /**
4062 * Retrieve extended data from the intent.
4063 *
4064 * @param name The name of the desired item.
4065 *
4066 * @return the value of an item that previously added with putExtra()
4067 * or null if no ArrayList<Parcelable> value was found.
4068 *
4069 * @see #putParcelableArrayListExtra(String, ArrayList)
4070 */
4071 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4072 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4073 }
4074
4075 /**
4076 * Retrieve extended data from the intent.
4077 *
4078 * @param name The name of the desired item.
4079 *
4080 * @return the value of an item that previously added with putExtra()
4081 * or null if no Serializable value was found.
4082 *
4083 * @see #putExtra(String, Serializable)
4084 */
4085 public Serializable getSerializableExtra(String name) {
4086 return mExtras == null ? null : mExtras.getSerializable(name);
4087 }
4088
4089 /**
4090 * Retrieve extended data from the intent.
4091 *
4092 * @param name The name of the desired item.
4093 *
4094 * @return the value of an item that previously added with putExtra()
4095 * or null if no ArrayList<Integer> value was found.
4096 *
4097 * @see #putIntegerArrayListExtra(String, ArrayList)
4098 */
4099 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4100 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4101 }
4102
4103 /**
4104 * Retrieve extended data from the intent.
4105 *
4106 * @param name The name of the desired item.
4107 *
4108 * @return the value of an item that previously added with putExtra()
4109 * or null if no ArrayList<String> value was found.
4110 *
4111 * @see #putStringArrayListExtra(String, ArrayList)
4112 */
4113 public ArrayList<String> getStringArrayListExtra(String name) {
4114 return mExtras == null ? null : mExtras.getStringArrayList(name);
4115 }
4116
4117 /**
4118 * Retrieve extended data from the intent.
4119 *
4120 * @param name The name of the desired item.
4121 *
4122 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004123 * or null if no ArrayList<CharSequence> value was found.
4124 *
4125 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4126 */
4127 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4128 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4129 }
4130
4131 /**
4132 * Retrieve extended data from the intent.
4133 *
4134 * @param name The name of the desired item.
4135 *
4136 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004137 * or null if no boolean array value was found.
4138 *
4139 * @see #putExtra(String, boolean[])
4140 */
4141 public boolean[] getBooleanArrayExtra(String name) {
4142 return mExtras == null ? null : mExtras.getBooleanArray(name);
4143 }
4144
4145 /**
4146 * Retrieve extended data from the intent.
4147 *
4148 * @param name The name of the desired item.
4149 *
4150 * @return the value of an item that previously added with putExtra()
4151 * or null if no byte array value was found.
4152 *
4153 * @see #putExtra(String, byte[])
4154 */
4155 public byte[] getByteArrayExtra(String name) {
4156 return mExtras == null ? null : mExtras.getByteArray(name);
4157 }
4158
4159 /**
4160 * Retrieve extended data from the intent.
4161 *
4162 * @param name The name of the desired item.
4163 *
4164 * @return the value of an item that previously added with putExtra()
4165 * or null if no short array value was found.
4166 *
4167 * @see #putExtra(String, short[])
4168 */
4169 public short[] getShortArrayExtra(String name) {
4170 return mExtras == null ? null : mExtras.getShortArray(name);
4171 }
4172
4173 /**
4174 * Retrieve extended data from the intent.
4175 *
4176 * @param name The name of the desired item.
4177 *
4178 * @return the value of an item that previously added with putExtra()
4179 * or null if no char array value was found.
4180 *
4181 * @see #putExtra(String, char[])
4182 */
4183 public char[] getCharArrayExtra(String name) {
4184 return mExtras == null ? null : mExtras.getCharArray(name);
4185 }
4186
4187 /**
4188 * Retrieve extended data from the intent.
4189 *
4190 * @param name The name of the desired item.
4191 *
4192 * @return the value of an item that previously added with putExtra()
4193 * or null if no int array value was found.
4194 *
4195 * @see #putExtra(String, int[])
4196 */
4197 public int[] getIntArrayExtra(String name) {
4198 return mExtras == null ? null : mExtras.getIntArray(name);
4199 }
4200
4201 /**
4202 * Retrieve extended data from the intent.
4203 *
4204 * @param name The name of the desired item.
4205 *
4206 * @return the value of an item that previously added with putExtra()
4207 * or null if no long array value was found.
4208 *
4209 * @see #putExtra(String, long[])
4210 */
4211 public long[] getLongArrayExtra(String name) {
4212 return mExtras == null ? null : mExtras.getLongArray(name);
4213 }
4214
4215 /**
4216 * Retrieve extended data from the intent.
4217 *
4218 * @param name The name of the desired item.
4219 *
4220 * @return the value of an item that previously added with putExtra()
4221 * or null if no float array value was found.
4222 *
4223 * @see #putExtra(String, float[])
4224 */
4225 public float[] getFloatArrayExtra(String name) {
4226 return mExtras == null ? null : mExtras.getFloatArray(name);
4227 }
4228
4229 /**
4230 * Retrieve extended data from the intent.
4231 *
4232 * @param name The name of the desired item.
4233 *
4234 * @return the value of an item that previously added with putExtra()
4235 * or null if no double array value was found.
4236 *
4237 * @see #putExtra(String, double[])
4238 */
4239 public double[] getDoubleArrayExtra(String name) {
4240 return mExtras == null ? null : mExtras.getDoubleArray(name);
4241 }
4242
4243 /**
4244 * Retrieve extended data from the intent.
4245 *
4246 * @param name The name of the desired item.
4247 *
4248 * @return the value of an item that previously added with putExtra()
4249 * or null if no String array value was found.
4250 *
4251 * @see #putExtra(String, String[])
4252 */
4253 public String[] getStringArrayExtra(String name) {
4254 return mExtras == null ? null : mExtras.getStringArray(name);
4255 }
4256
4257 /**
4258 * Retrieve extended data from the intent.
4259 *
4260 * @param name The name of the desired item.
4261 *
4262 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004263 * or null if no CharSequence array value was found.
4264 *
4265 * @see #putExtra(String, CharSequence[])
4266 */
4267 public CharSequence[] getCharSequenceArrayExtra(String name) {
4268 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4269 }
4270
4271 /**
4272 * Retrieve extended data from the intent.
4273 *
4274 * @param name The name of the desired item.
4275 *
4276 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004277 * or null if no Bundle value was found.
4278 *
4279 * @see #putExtra(String, Bundle)
4280 */
4281 public Bundle getBundleExtra(String name) {
4282 return mExtras == null ? null : mExtras.getBundle(name);
4283 }
4284
4285 /**
4286 * Retrieve extended data from the intent.
4287 *
4288 * @param name The name of the desired item.
4289 *
4290 * @return the value of an item that previously added with putExtra()
4291 * or null if no IBinder value was found.
4292 *
4293 * @see #putExtra(String, IBinder)
4294 *
4295 * @deprecated
4296 * @hide
4297 */
4298 @Deprecated
4299 public IBinder getIBinderExtra(String name) {
4300 return mExtras == null ? null : mExtras.getIBinder(name);
4301 }
4302
4303 /**
4304 * Retrieve extended data from the intent.
4305 *
4306 * @param name The name of the desired item.
4307 * @param defaultValue The default value to return in case no item is
4308 * associated with the key 'name'
4309 *
4310 * @return the value of an item that previously added with putExtra()
4311 * or defaultValue if none was found.
4312 *
4313 * @see #putExtra
4314 *
4315 * @deprecated
4316 * @hide
4317 */
4318 @Deprecated
4319 public Object getExtra(String name, Object defaultValue) {
4320 Object result = defaultValue;
4321 if (mExtras != null) {
4322 Object result2 = mExtras.get(name);
4323 if (result2 != null) {
4324 result = result2;
4325 }
4326 }
4327
4328 return result;
4329 }
4330
4331 /**
4332 * Retrieves a map of extended data from the intent.
4333 *
4334 * @return the map of all extras previously added with putExtra(),
4335 * or null if none have been added.
4336 */
4337 public Bundle getExtras() {
4338 return (mExtras != null)
4339 ? new Bundle(mExtras)
4340 : null;
4341 }
4342
4343 /**
4344 * Retrieve any special flags associated with this intent. You will
4345 * normally just set them with {@link #setFlags} and let the system
4346 * take the appropriate action with them.
4347 *
4348 * @return int The currently set flags.
4349 *
4350 * @see #setFlags
4351 */
4352 public int getFlags() {
4353 return mFlags;
4354 }
4355
Dianne Hackborne7f97212011-02-24 14:40:20 -08004356 /** @hide */
4357 public boolean isExcludingStopped() {
4358 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4359 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4360 }
4361
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004362 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004363 * Retrieve the application package name this Intent is limited to. When
4364 * resolving an Intent, if non-null this limits the resolution to only
4365 * components in the given application package.
4366 *
4367 * @return The name of the application package for the Intent.
4368 *
4369 * @see #resolveActivity
4370 * @see #setPackage
4371 */
4372 public String getPackage() {
4373 return mPackage;
4374 }
4375
4376 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004377 * Retrieve the concrete component associated with the intent. When receiving
4378 * an intent, this is the component that was found to best handle it (that is,
4379 * yourself) and will always be non-null; in all other cases it will be
4380 * null unless explicitly set.
4381 *
4382 * @return The name of the application component to handle the intent.
4383 *
4384 * @see #resolveActivity
4385 * @see #setComponent
4386 */
4387 public ComponentName getComponent() {
4388 return mComponent;
4389 }
4390
4391 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004392 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4393 * used as a hint to the receiver for animations and the like. Null means that there
4394 * is no source bounds.
4395 */
4396 public Rect getSourceBounds() {
4397 return mSourceBounds;
4398 }
4399
4400 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004401 * Return the Activity component that should be used to handle this intent.
4402 * The appropriate component is determined based on the information in the
4403 * intent, evaluated as follows:
4404 *
4405 * <p>If {@link #getComponent} returns an explicit class, that is returned
4406 * without any further consideration.
4407 *
4408 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4409 * category to be considered.
4410 *
4411 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4412 * action.
4413 *
4414 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4415 * this type.
4416 *
4417 * <p>If {@link #addCategory} has added any categories, the activity must
4418 * handle ALL of the categories specified.
4419 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004420 * <p>If {@link #getPackage} is non-NULL, only activity components in
4421 * that application package will be considered.
4422 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004423 * <p>If there are no activities that satisfy all of these conditions, a
4424 * null string is returned.
4425 *
4426 * <p>If multiple activities are found to satisfy the intent, the one with
4427 * the highest priority will be used. If there are multiple activities
4428 * with the same priority, the system will either pick the best activity
4429 * based on user preference, or resolve to a system class that will allow
4430 * the user to pick an activity and forward from there.
4431 *
4432 * <p>This method is implemented simply by calling
4433 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4434 * true.</p>
4435 * <p> This API is called for you as part of starting an activity from an
4436 * intent. You do not normally need to call it yourself.</p>
4437 *
4438 * @param pm The package manager with which to resolve the Intent.
4439 *
4440 * @return Name of the component implementing an activity that can
4441 * display the intent.
4442 *
4443 * @see #setComponent
4444 * @see #getComponent
4445 * @see #resolveActivityInfo
4446 */
4447 public ComponentName resolveActivity(PackageManager pm) {
4448 if (mComponent != null) {
4449 return mComponent;
4450 }
4451
4452 ResolveInfo info = pm.resolveActivity(
4453 this, PackageManager.MATCH_DEFAULT_ONLY);
4454 if (info != null) {
4455 return new ComponentName(
4456 info.activityInfo.applicationInfo.packageName,
4457 info.activityInfo.name);
4458 }
4459
4460 return null;
4461 }
4462
4463 /**
4464 * Resolve the Intent into an {@link ActivityInfo}
4465 * describing the activity that should execute the intent. Resolution
4466 * follows the same rules as described for {@link #resolveActivity}, but
4467 * you get back the completely information about the resolved activity
4468 * instead of just its class name.
4469 *
4470 * @param pm The package manager with which to resolve the Intent.
4471 * @param flags Addition information to retrieve as per
4472 * {@link PackageManager#getActivityInfo(ComponentName, int)
4473 * PackageManager.getActivityInfo()}.
4474 *
4475 * @return PackageManager.ActivityInfo
4476 *
4477 * @see #resolveActivity
4478 */
4479 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4480 ActivityInfo ai = null;
4481 if (mComponent != null) {
4482 try {
4483 ai = pm.getActivityInfo(mComponent, flags);
4484 } catch (PackageManager.NameNotFoundException e) {
4485 // ignore
4486 }
4487 } else {
4488 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004489 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004490 if (info != null) {
4491 ai = info.activityInfo;
4492 }
4493 }
4494
4495 return ai;
4496 }
4497
4498 /**
4499 * Set the general action to be performed.
4500 *
4501 * @param action An action name, such as ACTION_VIEW. Application-specific
4502 * actions should be prefixed with the vendor's package name.
4503 *
4504 * @return Returns the same Intent object, for chaining multiple calls
4505 * into a single statement.
4506 *
4507 * @see #getAction
4508 */
4509 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004510 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004511 return this;
4512 }
4513
4514 /**
4515 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004516 * clears any type that was previously set by {@link #setType} or
4517 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004518 *
Nick Pellyccae4122012-01-09 14:12:58 -08004519 * <p><em>Note: scheme matching in the Android framework is
4520 * case-sensitive, unlike the formal RFC. As a result,
4521 * you should always write your Uri with a lower case scheme,
4522 * or use {@link Uri#normalize} or
4523 * {@link #setDataAndNormalize}
4524 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004525 *
Nick Pellyccae4122012-01-09 14:12:58 -08004526 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004527 *
4528 * @return Returns the same Intent object, for chaining multiple calls
4529 * into a single statement.
4530 *
4531 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004532 * @see #setDataAndNormalize
4533 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004534 */
4535 public Intent setData(Uri data) {
4536 mData = data;
4537 mType = null;
4538 return this;
4539 }
4540
4541 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004542 * Normalize and set the data this intent is operating on.
4543 *
4544 * <p>This method automatically clears any type that was
4545 * previously set (for example, by {@link #setType}).
4546 *
4547 * <p>The data Uri is normalized using
4548 * {@link android.net.Uri#normalize} before it is set,
4549 * so really this is just a convenience method for
4550 * <pre>
4551 * setData(data.normalize())
4552 * </pre>
4553 *
4554 * @param data The Uri of the data this intent is now targeting.
4555 *
4556 * @return Returns the same Intent object, for chaining multiple calls
4557 * into a single statement.
4558 *
4559 * @see #getData
4560 * @see #setType
4561 * @see android.net.Uri#normalize
4562 */
4563 public Intent setDataAndNormalize(Uri data) {
4564 return setData(data.normalize());
4565 }
4566
4567 /**
4568 * Set an explicit MIME data type.
4569 *
4570 * <p>This is used to create intents that only specify a type and not data,
4571 * for example to indicate the type of data to return.
4572 *
4573 * <p>This method automatically clears any data that was
4574 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004575 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004576 * <p><em>Note: MIME type matching in the Android framework is
4577 * case-sensitive, unlike formal RFC MIME types. As a result,
4578 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004579 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4580 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004581 *
4582 * @param type The MIME type of the data being handled by this intent.
4583 *
4584 * @return Returns the same Intent object, for chaining multiple calls
4585 * into a single statement.
4586 *
4587 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004588 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004589 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004590 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004591 */
4592 public Intent setType(String type) {
4593 mData = null;
4594 mType = type;
4595 return this;
4596 }
4597
4598 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004599 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004600 *
Nick Pellyccae4122012-01-09 14:12:58 -08004601 * <p>This is used to create intents that only specify a type and not data,
4602 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004603 *
Nick Pellyccae4122012-01-09 14:12:58 -08004604 * <p>This method automatically clears any data that was
4605 * previously set (for example by {@link #setData}).
4606 *
4607 * <p>The MIME type is normalized using
4608 * {@link #normalizeMimeType} before it is set,
4609 * so really this is just a convenience method for
4610 * <pre>
4611 * setType(Intent.normalizeMimeType(type))
4612 * </pre>
4613 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004614 * @param type The MIME type of the data being handled by this intent.
4615 *
4616 * @return Returns the same Intent object, for chaining multiple calls
4617 * into a single statement.
4618 *
Nick Pellyccae4122012-01-09 14:12:58 -08004619 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004620 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004621 * @see #normalizeMimeType
4622 */
4623 public Intent setTypeAndNormalize(String type) {
4624 return setType(normalizeMimeType(type));
4625 }
4626
4627 /**
4628 * (Usually optional) Set the data for the intent along with an explicit
4629 * MIME data type. This method should very rarely be used -- it allows you
4630 * to override the MIME type that would ordinarily be inferred from the
4631 * data with your own type given here.
4632 *
4633 * <p><em>Note: MIME type and Uri scheme matching in the
4634 * Android framework is case-sensitive, unlike the formal RFC definitions.
4635 * As a result, you should always write these elements with lower case letters,
4636 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalize} or
4637 * {@link #setDataAndTypeAndNormalize}
4638 * to ensure that they are converted to lower case.</em>
4639 *
4640 * @param data The Uri of the data this intent is now targeting.
4641 * @param type The MIME type of the data being handled by this intent.
4642 *
4643 * @return Returns the same Intent object, for chaining multiple calls
4644 * into a single statement.
4645 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004646 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004647 * @see #setData
4648 * @see #normalizeMimeType
4649 * @see android.net.Uri#normalize
4650 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004651 */
4652 public Intent setDataAndType(Uri data, String type) {
4653 mData = data;
4654 mType = type;
4655 return this;
4656 }
4657
4658 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004659 * (Usually optional) Normalize and set both the data Uri and an explicit
4660 * MIME data type. This method should very rarely be used -- it allows you
4661 * to override the MIME type that would ordinarily be inferred from the
4662 * data with your own type given here.
4663 *
4664 * <p>The data Uri and the MIME type are normalize using
4665 * {@link android.net.Uri#normalize} and {@link #normalizeMimeType}
4666 * before they are set, so really this is just a convenience method for
4667 * <pre>
4668 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4669 * </pre>
4670 *
4671 * @param data The Uri of the data this intent is now targeting.
4672 * @param type The MIME type of the data being handled by this intent.
4673 *
4674 * @return Returns the same Intent object, for chaining multiple calls
4675 * into a single statement.
4676 *
4677 * @see #setType
4678 * @see #setData
4679 * @see #setDataAndType
4680 * @see #normalizeMimeType
4681 * @see android.net.Uri#normalize
4682 */
4683 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
4684 return setDataAndType(data.normalize(), normalizeMimeType(type));
4685 }
4686
4687 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004688 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004689 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004690 * activities that provide <em>all</em> of the requested categories will be
4691 * used.
4692 *
4693 * @param category The desired category. This can be either one of the
4694 * predefined Intent categories, or a custom category in your own
4695 * namespace.
4696 *
4697 * @return Returns the same Intent object, for chaining multiple calls
4698 * into a single statement.
4699 *
4700 * @see #hasCategory
4701 * @see #removeCategory
4702 */
4703 public Intent addCategory(String category) {
4704 if (mCategories == null) {
4705 mCategories = new HashSet<String>();
4706 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004707 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004708 return this;
4709 }
4710
4711 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004712 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004713 *
4714 * @param category The category to remove.
4715 *
4716 * @see #addCategory
4717 */
4718 public void removeCategory(String category) {
4719 if (mCategories != null) {
4720 mCategories.remove(category);
4721 if (mCategories.size() == 0) {
4722 mCategories = null;
4723 }
4724 }
4725 }
4726
4727 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004728 * Set a selector for this Intent. This is a modification to the kinds of
4729 * things the Intent will match. If the selector is set, it will be used
4730 * when trying to find entities that can handle the Intent, instead of the
4731 * main contents of the Intent. This allows you build an Intent containing
4732 * a generic protocol while targeting it more specifically.
4733 *
4734 * <p>An example of where this may be used is with things like
4735 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
4736 * Intent that will launch the Browser application. However, the correct
4737 * main entry point of an application is actually {@link #ACTION_MAIN}
4738 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
4739 * used to specify the actual Activity to launch. If you launch the browser
4740 * with something different, undesired behavior may happen if the user has
4741 * previously or later launches it the normal way, since they do not match.
4742 * Instead, you can build an Intent with the MAIN action (but no ComponentName
4743 * yet specified) and set a selector with {@link #ACTION_MAIN} and
4744 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
4745 *
4746 * <p>Setting a selector does not impact the behavior of
4747 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
4748 * desired behavior of a selector -- it does not impact the base meaning
4749 * of the Intent, just what kinds of things will be matched against it
4750 * when determining who can handle it.</p>
4751 *
4752 * <p>You can not use both a selector and {@link #setPackage(String)} on
4753 * the same base Intent.</p>
4754 *
4755 * @param selector The desired selector Intent; set to null to not use
4756 * a special selector.
4757 */
4758 public void setSelector(Intent selector) {
4759 if (selector == this) {
4760 throw new IllegalArgumentException(
4761 "Intent being set as a selector of itself");
4762 }
4763 if (selector != null && mPackage != null) {
4764 throw new IllegalArgumentException(
4765 "Can't set selector when package name is already set");
4766 }
4767 mSelector = selector;
4768 }
4769
4770 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004771 * Set a {@link ClipData} associated with this Intent. This replaces any
4772 * previously set ClipData.
4773 *
4774 * <p>The ClipData in an intent is not used for Intent matching or other
4775 * such operations. Semantically it is like extras, used to transmit
4776 * additional data with the Intent. The main feature of using this over
4777 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
4778 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
4779 * items included in the clip data. This is useful, in particular, if
4780 * you want to transmit an Intent containing multiple <code>content:</code>
4781 * URIs for which the recipient may not have global permission to access the
4782 * content provider.
4783 *
4784 * <p>If the ClipData contains items that are themselves Intents, any
4785 * grant flags in those Intents will be ignored. Only the top-level flags
4786 * of the main Intent are respected, and will be applied to all Uri or
4787 * Intent items in the clip (or sub-items of the clip).
4788 *
4789 * <p>The MIME type, label, and icon in the ClipData object are not
4790 * directly used by Intent. Applications should generally rely on the
4791 * MIME type of the Intent itself, not what it may find in the ClipData.
4792 * A common practice is to construct a ClipData for use with an Intent
4793 * with a MIME type of "*\/*".
4794 *
4795 * @param clip The new clip to set. May be null to clear the current clip.
4796 */
4797 public void setClipData(ClipData clip) {
4798 mClipData = clip;
4799 }
4800
4801 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004802 * Add extended data to the intent. The name must include a package
4803 * prefix, for example the app com.android.contacts would use names
4804 * like "com.android.contacts.ShowAll".
4805 *
4806 * @param name The name of the extra data, with package prefix.
4807 * @param value The boolean data value.
4808 *
4809 * @return Returns the same Intent object, for chaining multiple calls
4810 * into a single statement.
4811 *
4812 * @see #putExtras
4813 * @see #removeExtra
4814 * @see #getBooleanExtra(String, boolean)
4815 */
4816 public Intent putExtra(String name, boolean value) {
4817 if (mExtras == null) {
4818 mExtras = new Bundle();
4819 }
4820 mExtras.putBoolean(name, value);
4821 return this;
4822 }
4823
4824 /**
4825 * Add extended data to the intent. The name must include a package
4826 * prefix, for example the app com.android.contacts would use names
4827 * like "com.android.contacts.ShowAll".
4828 *
4829 * @param name The name of the extra data, with package prefix.
4830 * @param value The byte data value.
4831 *
4832 * @return Returns the same Intent object, for chaining multiple calls
4833 * into a single statement.
4834 *
4835 * @see #putExtras
4836 * @see #removeExtra
4837 * @see #getByteExtra(String, byte)
4838 */
4839 public Intent putExtra(String name, byte value) {
4840 if (mExtras == null) {
4841 mExtras = new Bundle();
4842 }
4843 mExtras.putByte(name, value);
4844 return this;
4845 }
4846
4847 /**
4848 * Add extended data to the intent. The name must include a package
4849 * prefix, for example the app com.android.contacts would use names
4850 * like "com.android.contacts.ShowAll".
4851 *
4852 * @param name The name of the extra data, with package prefix.
4853 * @param value The char data value.
4854 *
4855 * @return Returns the same Intent object, for chaining multiple calls
4856 * into a single statement.
4857 *
4858 * @see #putExtras
4859 * @see #removeExtra
4860 * @see #getCharExtra(String, char)
4861 */
4862 public Intent putExtra(String name, char value) {
4863 if (mExtras == null) {
4864 mExtras = new Bundle();
4865 }
4866 mExtras.putChar(name, value);
4867 return this;
4868 }
4869
4870 /**
4871 * Add extended data to the intent. The name must include a package
4872 * prefix, for example the app com.android.contacts would use names
4873 * like "com.android.contacts.ShowAll".
4874 *
4875 * @param name The name of the extra data, with package prefix.
4876 * @param value The short data value.
4877 *
4878 * @return Returns the same Intent object, for chaining multiple calls
4879 * into a single statement.
4880 *
4881 * @see #putExtras
4882 * @see #removeExtra
4883 * @see #getShortExtra(String, short)
4884 */
4885 public Intent putExtra(String name, short value) {
4886 if (mExtras == null) {
4887 mExtras = new Bundle();
4888 }
4889 mExtras.putShort(name, value);
4890 return this;
4891 }
4892
4893 /**
4894 * Add extended data to the intent. The name must include a package
4895 * prefix, for example the app com.android.contacts would use names
4896 * like "com.android.contacts.ShowAll".
4897 *
4898 * @param name The name of the extra data, with package prefix.
4899 * @param value The integer data value.
4900 *
4901 * @return Returns the same Intent object, for chaining multiple calls
4902 * into a single statement.
4903 *
4904 * @see #putExtras
4905 * @see #removeExtra
4906 * @see #getIntExtra(String, int)
4907 */
4908 public Intent putExtra(String name, int value) {
4909 if (mExtras == null) {
4910 mExtras = new Bundle();
4911 }
4912 mExtras.putInt(name, value);
4913 return this;
4914 }
4915
4916 /**
4917 * Add extended data to the intent. The name must include a package
4918 * prefix, for example the app com.android.contacts would use names
4919 * like "com.android.contacts.ShowAll".
4920 *
4921 * @param name The name of the extra data, with package prefix.
4922 * @param value The long data value.
4923 *
4924 * @return Returns the same Intent object, for chaining multiple calls
4925 * into a single statement.
4926 *
4927 * @see #putExtras
4928 * @see #removeExtra
4929 * @see #getLongExtra(String, long)
4930 */
4931 public Intent putExtra(String name, long value) {
4932 if (mExtras == null) {
4933 mExtras = new Bundle();
4934 }
4935 mExtras.putLong(name, value);
4936 return this;
4937 }
4938
4939 /**
4940 * Add extended data to the intent. The name must include a package
4941 * prefix, for example the app com.android.contacts would use names
4942 * like "com.android.contacts.ShowAll".
4943 *
4944 * @param name The name of the extra data, with package prefix.
4945 * @param value The float data value.
4946 *
4947 * @return Returns the same Intent object, for chaining multiple calls
4948 * into a single statement.
4949 *
4950 * @see #putExtras
4951 * @see #removeExtra
4952 * @see #getFloatExtra(String, float)
4953 */
4954 public Intent putExtra(String name, float value) {
4955 if (mExtras == null) {
4956 mExtras = new Bundle();
4957 }
4958 mExtras.putFloat(name, value);
4959 return this;
4960 }
4961
4962 /**
4963 * Add extended data to the intent. The name must include a package
4964 * prefix, for example the app com.android.contacts would use names
4965 * like "com.android.contacts.ShowAll".
4966 *
4967 * @param name The name of the extra data, with package prefix.
4968 * @param value The double data value.
4969 *
4970 * @return Returns the same Intent object, for chaining multiple calls
4971 * into a single statement.
4972 *
4973 * @see #putExtras
4974 * @see #removeExtra
4975 * @see #getDoubleExtra(String, double)
4976 */
4977 public Intent putExtra(String name, double value) {
4978 if (mExtras == null) {
4979 mExtras = new Bundle();
4980 }
4981 mExtras.putDouble(name, value);
4982 return this;
4983 }
4984
4985 /**
4986 * Add extended data to the intent. The name must include a package
4987 * prefix, for example the app com.android.contacts would use names
4988 * like "com.android.contacts.ShowAll".
4989 *
4990 * @param name The name of the extra data, with package prefix.
4991 * @param value The String data value.
4992 *
4993 * @return Returns the same Intent object, for chaining multiple calls
4994 * into a single statement.
4995 *
4996 * @see #putExtras
4997 * @see #removeExtra
4998 * @see #getStringExtra(String)
4999 */
5000 public Intent putExtra(String name, String value) {
5001 if (mExtras == null) {
5002 mExtras = new Bundle();
5003 }
5004 mExtras.putString(name, value);
5005 return this;
5006 }
5007
5008 /**
5009 * Add extended data to the intent. The name must include a package
5010 * prefix, for example the app com.android.contacts would use names
5011 * like "com.android.contacts.ShowAll".
5012 *
5013 * @param name The name of the extra data, with package prefix.
5014 * @param value The CharSequence data value.
5015 *
5016 * @return Returns the same Intent object, for chaining multiple calls
5017 * into a single statement.
5018 *
5019 * @see #putExtras
5020 * @see #removeExtra
5021 * @see #getCharSequenceExtra(String)
5022 */
5023 public Intent putExtra(String name, CharSequence value) {
5024 if (mExtras == null) {
5025 mExtras = new Bundle();
5026 }
5027 mExtras.putCharSequence(name, value);
5028 return this;
5029 }
5030
5031 /**
5032 * Add extended data to the intent. The name must include a package
5033 * prefix, for example the app com.android.contacts would use names
5034 * like "com.android.contacts.ShowAll".
5035 *
5036 * @param name The name of the extra data, with package prefix.
5037 * @param value The Parcelable data value.
5038 *
5039 * @return Returns the same Intent object, for chaining multiple calls
5040 * into a single statement.
5041 *
5042 * @see #putExtras
5043 * @see #removeExtra
5044 * @see #getParcelableExtra(String)
5045 */
5046 public Intent putExtra(String name, Parcelable value) {
5047 if (mExtras == null) {
5048 mExtras = new Bundle();
5049 }
5050 mExtras.putParcelable(name, value);
5051 return this;
5052 }
5053
5054 /**
5055 * Add extended data to the intent. The name must include a package
5056 * prefix, for example the app com.android.contacts would use names
5057 * like "com.android.contacts.ShowAll".
5058 *
5059 * @param name The name of the extra data, with package prefix.
5060 * @param value The Parcelable[] data value.
5061 *
5062 * @return Returns the same Intent object, for chaining multiple calls
5063 * into a single statement.
5064 *
5065 * @see #putExtras
5066 * @see #removeExtra
5067 * @see #getParcelableArrayExtra(String)
5068 */
5069 public Intent putExtra(String name, Parcelable[] value) {
5070 if (mExtras == null) {
5071 mExtras = new Bundle();
5072 }
5073 mExtras.putParcelableArray(name, value);
5074 return this;
5075 }
5076
5077 /**
5078 * Add extended data to the intent. The name must include a package
5079 * prefix, for example the app com.android.contacts would use names
5080 * like "com.android.contacts.ShowAll".
5081 *
5082 * @param name The name of the extra data, with package prefix.
5083 * @param value The ArrayList<Parcelable> data value.
5084 *
5085 * @return Returns the same Intent object, for chaining multiple calls
5086 * into a single statement.
5087 *
5088 * @see #putExtras
5089 * @see #removeExtra
5090 * @see #getParcelableArrayListExtra(String)
5091 */
5092 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5093 if (mExtras == null) {
5094 mExtras = new Bundle();
5095 }
5096 mExtras.putParcelableArrayList(name, value);
5097 return this;
5098 }
5099
5100 /**
5101 * Add extended data to the intent. The name must include a package
5102 * prefix, for example the app com.android.contacts would use names
5103 * like "com.android.contacts.ShowAll".
5104 *
5105 * @param name The name of the extra data, with package prefix.
5106 * @param value The ArrayList<Integer> data value.
5107 *
5108 * @return Returns the same Intent object, for chaining multiple calls
5109 * into a single statement.
5110 *
5111 * @see #putExtras
5112 * @see #removeExtra
5113 * @see #getIntegerArrayListExtra(String)
5114 */
5115 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5116 if (mExtras == null) {
5117 mExtras = new Bundle();
5118 }
5119 mExtras.putIntegerArrayList(name, value);
5120 return this;
5121 }
5122
5123 /**
5124 * Add extended data to the intent. The name must include a package
5125 * prefix, for example the app com.android.contacts would use names
5126 * like "com.android.contacts.ShowAll".
5127 *
5128 * @param name The name of the extra data, with package prefix.
5129 * @param value The ArrayList<String> data value.
5130 *
5131 * @return Returns the same Intent object, for chaining multiple calls
5132 * into a single statement.
5133 *
5134 * @see #putExtras
5135 * @see #removeExtra
5136 * @see #getStringArrayListExtra(String)
5137 */
5138 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5139 if (mExtras == null) {
5140 mExtras = new Bundle();
5141 }
5142 mExtras.putStringArrayList(name, value);
5143 return this;
5144 }
5145
5146 /**
5147 * Add extended data to the intent. The name must include a package
5148 * prefix, for example the app com.android.contacts would use names
5149 * like "com.android.contacts.ShowAll".
5150 *
5151 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005152 * @param value The ArrayList<CharSequence> data value.
5153 *
5154 * @return Returns the same Intent object, for chaining multiple calls
5155 * into a single statement.
5156 *
5157 * @see #putExtras
5158 * @see #removeExtra
5159 * @see #getCharSequenceArrayListExtra(String)
5160 */
5161 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5162 if (mExtras == null) {
5163 mExtras = new Bundle();
5164 }
5165 mExtras.putCharSequenceArrayList(name, value);
5166 return this;
5167 }
5168
5169 /**
5170 * Add extended data to the intent. The name must include a package
5171 * prefix, for example the app com.android.contacts would use names
5172 * like "com.android.contacts.ShowAll".
5173 *
5174 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005175 * @param value The Serializable data value.
5176 *
5177 * @return Returns the same Intent object, for chaining multiple calls
5178 * into a single statement.
5179 *
5180 * @see #putExtras
5181 * @see #removeExtra
5182 * @see #getSerializableExtra(String)
5183 */
5184 public Intent putExtra(String name, Serializable value) {
5185 if (mExtras == null) {
5186 mExtras = new Bundle();
5187 }
5188 mExtras.putSerializable(name, value);
5189 return this;
5190 }
5191
5192 /**
5193 * Add extended data to the intent. The name must include a package
5194 * prefix, for example the app com.android.contacts would use names
5195 * like "com.android.contacts.ShowAll".
5196 *
5197 * @param name The name of the extra data, with package prefix.
5198 * @param value The boolean array data value.
5199 *
5200 * @return Returns the same Intent object, for chaining multiple calls
5201 * into a single statement.
5202 *
5203 * @see #putExtras
5204 * @see #removeExtra
5205 * @see #getBooleanArrayExtra(String)
5206 */
5207 public Intent putExtra(String name, boolean[] value) {
5208 if (mExtras == null) {
5209 mExtras = new Bundle();
5210 }
5211 mExtras.putBooleanArray(name, value);
5212 return this;
5213 }
5214
5215 /**
5216 * Add extended data to the intent. The name must include a package
5217 * prefix, for example the app com.android.contacts would use names
5218 * like "com.android.contacts.ShowAll".
5219 *
5220 * @param name The name of the extra data, with package prefix.
5221 * @param value The byte array data value.
5222 *
5223 * @return Returns the same Intent object, for chaining multiple calls
5224 * into a single statement.
5225 *
5226 * @see #putExtras
5227 * @see #removeExtra
5228 * @see #getByteArrayExtra(String)
5229 */
5230 public Intent putExtra(String name, byte[] value) {
5231 if (mExtras == null) {
5232 mExtras = new Bundle();
5233 }
5234 mExtras.putByteArray(name, value);
5235 return this;
5236 }
5237
5238 /**
5239 * Add extended data to the intent. The name must include a package
5240 * prefix, for example the app com.android.contacts would use names
5241 * like "com.android.contacts.ShowAll".
5242 *
5243 * @param name The name of the extra data, with package prefix.
5244 * @param value The short array data value.
5245 *
5246 * @return Returns the same Intent object, for chaining multiple calls
5247 * into a single statement.
5248 *
5249 * @see #putExtras
5250 * @see #removeExtra
5251 * @see #getShortArrayExtra(String)
5252 */
5253 public Intent putExtra(String name, short[] value) {
5254 if (mExtras == null) {
5255 mExtras = new Bundle();
5256 }
5257 mExtras.putShortArray(name, value);
5258 return this;
5259 }
5260
5261 /**
5262 * Add extended data to the intent. The name must include a package
5263 * prefix, for example the app com.android.contacts would use names
5264 * like "com.android.contacts.ShowAll".
5265 *
5266 * @param name The name of the extra data, with package prefix.
5267 * @param value The char array data value.
5268 *
5269 * @return Returns the same Intent object, for chaining multiple calls
5270 * into a single statement.
5271 *
5272 * @see #putExtras
5273 * @see #removeExtra
5274 * @see #getCharArrayExtra(String)
5275 */
5276 public Intent putExtra(String name, char[] value) {
5277 if (mExtras == null) {
5278 mExtras = new Bundle();
5279 }
5280 mExtras.putCharArray(name, value);
5281 return this;
5282 }
5283
5284 /**
5285 * Add extended data to the intent. The name must include a package
5286 * prefix, for example the app com.android.contacts would use names
5287 * like "com.android.contacts.ShowAll".
5288 *
5289 * @param name The name of the extra data, with package prefix.
5290 * @param value The int array data value.
5291 *
5292 * @return Returns the same Intent object, for chaining multiple calls
5293 * into a single statement.
5294 *
5295 * @see #putExtras
5296 * @see #removeExtra
5297 * @see #getIntArrayExtra(String)
5298 */
5299 public Intent putExtra(String name, int[] value) {
5300 if (mExtras == null) {
5301 mExtras = new Bundle();
5302 }
5303 mExtras.putIntArray(name, value);
5304 return this;
5305 }
5306
5307 /**
5308 * Add extended data to the intent. The name must include a package
5309 * prefix, for example the app com.android.contacts would use names
5310 * like "com.android.contacts.ShowAll".
5311 *
5312 * @param name The name of the extra data, with package prefix.
5313 * @param value The byte array data value.
5314 *
5315 * @return Returns the same Intent object, for chaining multiple calls
5316 * into a single statement.
5317 *
5318 * @see #putExtras
5319 * @see #removeExtra
5320 * @see #getLongArrayExtra(String)
5321 */
5322 public Intent putExtra(String name, long[] value) {
5323 if (mExtras == null) {
5324 mExtras = new Bundle();
5325 }
5326 mExtras.putLongArray(name, value);
5327 return this;
5328 }
5329
5330 /**
5331 * Add extended data to the intent. The name must include a package
5332 * prefix, for example the app com.android.contacts would use names
5333 * like "com.android.contacts.ShowAll".
5334 *
5335 * @param name The name of the extra data, with package prefix.
5336 * @param value The float array data value.
5337 *
5338 * @return Returns the same Intent object, for chaining multiple calls
5339 * into a single statement.
5340 *
5341 * @see #putExtras
5342 * @see #removeExtra
5343 * @see #getFloatArrayExtra(String)
5344 */
5345 public Intent putExtra(String name, float[] value) {
5346 if (mExtras == null) {
5347 mExtras = new Bundle();
5348 }
5349 mExtras.putFloatArray(name, value);
5350 return this;
5351 }
5352
5353 /**
5354 * Add extended data to the intent. The name must include a package
5355 * prefix, for example the app com.android.contacts would use names
5356 * like "com.android.contacts.ShowAll".
5357 *
5358 * @param name The name of the extra data, with package prefix.
5359 * @param value The double array data value.
5360 *
5361 * @return Returns the same Intent object, for chaining multiple calls
5362 * into a single statement.
5363 *
5364 * @see #putExtras
5365 * @see #removeExtra
5366 * @see #getDoubleArrayExtra(String)
5367 */
5368 public Intent putExtra(String name, double[] value) {
5369 if (mExtras == null) {
5370 mExtras = new Bundle();
5371 }
5372 mExtras.putDoubleArray(name, value);
5373 return this;
5374 }
5375
5376 /**
5377 * Add extended data to the intent. The name must include a package
5378 * prefix, for example the app com.android.contacts would use names
5379 * like "com.android.contacts.ShowAll".
5380 *
5381 * @param name The name of the extra data, with package prefix.
5382 * @param value The String array data value.
5383 *
5384 * @return Returns the same Intent object, for chaining multiple calls
5385 * into a single statement.
5386 *
5387 * @see #putExtras
5388 * @see #removeExtra
5389 * @see #getStringArrayExtra(String)
5390 */
5391 public Intent putExtra(String name, String[] value) {
5392 if (mExtras == null) {
5393 mExtras = new Bundle();
5394 }
5395 mExtras.putStringArray(name, value);
5396 return this;
5397 }
5398
5399 /**
5400 * Add extended data to the intent. The name must include a package
5401 * prefix, for example the app com.android.contacts would use names
5402 * like "com.android.contacts.ShowAll".
5403 *
5404 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005405 * @param value The CharSequence array data value.
5406 *
5407 * @return Returns the same Intent object, for chaining multiple calls
5408 * into a single statement.
5409 *
5410 * @see #putExtras
5411 * @see #removeExtra
5412 * @see #getCharSequenceArrayExtra(String)
5413 */
5414 public Intent putExtra(String name, CharSequence[] value) {
5415 if (mExtras == null) {
5416 mExtras = new Bundle();
5417 }
5418 mExtras.putCharSequenceArray(name, value);
5419 return this;
5420 }
5421
5422 /**
5423 * Add extended data to the intent. The name must include a package
5424 * prefix, for example the app com.android.contacts would use names
5425 * like "com.android.contacts.ShowAll".
5426 *
5427 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005428 * @param value The Bundle data value.
5429 *
5430 * @return Returns the same Intent object, for chaining multiple calls
5431 * into a single statement.
5432 *
5433 * @see #putExtras
5434 * @see #removeExtra
5435 * @see #getBundleExtra(String)
5436 */
5437 public Intent putExtra(String name, Bundle value) {
5438 if (mExtras == null) {
5439 mExtras = new Bundle();
5440 }
5441 mExtras.putBundle(name, value);
5442 return this;
5443 }
5444
5445 /**
5446 * Add extended data to the intent. The name must include a package
5447 * prefix, for example the app com.android.contacts would use names
5448 * like "com.android.contacts.ShowAll".
5449 *
5450 * @param name The name of the extra data, with package prefix.
5451 * @param value The IBinder data value.
5452 *
5453 * @return Returns the same Intent object, for chaining multiple calls
5454 * into a single statement.
5455 *
5456 * @see #putExtras
5457 * @see #removeExtra
5458 * @see #getIBinderExtra(String)
5459 *
5460 * @deprecated
5461 * @hide
5462 */
5463 @Deprecated
5464 public Intent putExtra(String name, IBinder value) {
5465 if (mExtras == null) {
5466 mExtras = new Bundle();
5467 }
5468 mExtras.putIBinder(name, value);
5469 return this;
5470 }
5471
5472 /**
5473 * Copy all extras in 'src' in to this intent.
5474 *
5475 * @param src Contains the extras to copy.
5476 *
5477 * @see #putExtra
5478 */
5479 public Intent putExtras(Intent src) {
5480 if (src.mExtras != null) {
5481 if (mExtras == null) {
5482 mExtras = new Bundle(src.mExtras);
5483 } else {
5484 mExtras.putAll(src.mExtras);
5485 }
5486 }
5487 return this;
5488 }
5489
5490 /**
5491 * Add a set of extended data to the intent. The keys must include a package
5492 * prefix, for example the app com.android.contacts would use names
5493 * like "com.android.contacts.ShowAll".
5494 *
5495 * @param extras The Bundle of extras to add to this intent.
5496 *
5497 * @see #putExtra
5498 * @see #removeExtra
5499 */
5500 public Intent putExtras(Bundle extras) {
5501 if (mExtras == null) {
5502 mExtras = new Bundle();
5503 }
5504 mExtras.putAll(extras);
5505 return this;
5506 }
5507
5508 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005509 * Completely replace the extras in the Intent with the extras in the
5510 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005511 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005512 * @param src The exact extras contained in this Intent are copied
5513 * into the target intent, replacing any that were previously there.
5514 */
5515 public Intent replaceExtras(Intent src) {
5516 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5517 return this;
5518 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005519
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005520 /**
5521 * Completely replace the extras in the Intent with the given Bundle of
5522 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005523 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005524 * @param extras The new set of extras in the Intent, or null to erase
5525 * all extras.
5526 */
5527 public Intent replaceExtras(Bundle extras) {
5528 mExtras = extras != null ? new Bundle(extras) : null;
5529 return this;
5530 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005531
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005532 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005533 * Remove extended data from the intent.
5534 *
5535 * @see #putExtra
5536 */
5537 public void removeExtra(String name) {
5538 if (mExtras != null) {
5539 mExtras.remove(name);
5540 if (mExtras.size() == 0) {
5541 mExtras = null;
5542 }
5543 }
5544 }
5545
5546 /**
5547 * Set special flags controlling how this intent is handled. Most values
5548 * here depend on the type of component being executed by the Intent,
5549 * specifically the FLAG_ACTIVITY_* flags are all for use with
5550 * {@link Context#startActivity Context.startActivity()} and the
5551 * FLAG_RECEIVER_* flags are all for use with
5552 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5553 *
Scott Main7aee61f2011-02-08 11:25:01 -08005554 * <p>See the
5555 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5556 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005557 * the behavior of your application.
5558 *
5559 * @param flags The desired flags.
5560 *
5561 * @return Returns the same Intent object, for chaining multiple calls
5562 * into a single statement.
5563 *
5564 * @see #getFlags
5565 * @see #addFlags
5566 *
5567 * @see #FLAG_GRANT_READ_URI_PERMISSION
5568 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5569 * @see #FLAG_DEBUG_LOG_RESOLUTION
5570 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005571 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005572 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005573 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005574 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005575 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5576 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005577 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005578 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5579 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005580 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005581 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005582 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005583 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5584 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005585 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005586 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005587 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005588 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5589 */
5590 public Intent setFlags(int flags) {
5591 mFlags = flags;
5592 return this;
5593 }
5594
5595 /**
5596 * Add additional flags to the intent (or with existing flags
5597 * value).
5598 *
5599 * @param flags The new flags to set.
5600 *
5601 * @return Returns the same Intent object, for chaining multiple calls
5602 * into a single statement.
5603 *
5604 * @see #setFlags
5605 */
5606 public Intent addFlags(int flags) {
5607 mFlags |= flags;
5608 return this;
5609 }
5610
5611 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005612 * (Usually optional) Set an explicit application package name that limits
5613 * the components this Intent will resolve to. If left to the default
5614 * value of null, all components in all applications will considered.
5615 * If non-null, the Intent can only match the components in the given
5616 * application package.
5617 *
5618 * @param packageName The name of the application package to handle the
5619 * intent, or null to allow any application package.
5620 *
5621 * @return Returns the same Intent object, for chaining multiple calls
5622 * into a single statement.
5623 *
5624 * @see #getPackage
5625 * @see #resolveActivity
5626 */
5627 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005628 if (packageName != null && mSelector != null) {
5629 throw new IllegalArgumentException(
5630 "Can't set package name when selector is already set");
5631 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005632 mPackage = packageName;
5633 return this;
5634 }
5635
5636 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005637 * (Usually optional) Explicitly set the component to handle the intent.
5638 * If left with the default value of null, the system will determine the
5639 * appropriate class to use based on the other fields (action, data,
5640 * type, categories) in the Intent. If this class is defined, the
5641 * specified class will always be used regardless of the other fields. You
5642 * should only set this value when you know you absolutely want a specific
5643 * class to be used; otherwise it is better to let the system find the
5644 * appropriate class so that you will respect the installed applications
5645 * and user preferences.
5646 *
5647 * @param component The name of the application component to handle the
5648 * intent, or null to let the system find one for you.
5649 *
5650 * @return Returns the same Intent object, for chaining multiple calls
5651 * into a single statement.
5652 *
5653 * @see #setClass
5654 * @see #setClassName(Context, String)
5655 * @see #setClassName(String, String)
5656 * @see #getComponent
5657 * @see #resolveActivity
5658 */
5659 public Intent setComponent(ComponentName component) {
5660 mComponent = component;
5661 return this;
5662 }
5663
5664 /**
5665 * Convenience for calling {@link #setComponent} with an
5666 * explicit class name.
5667 *
5668 * @param packageContext A Context of the application package implementing
5669 * this class.
5670 * @param className The name of a class inside of the application package
5671 * that will be used as the component for this Intent.
5672 *
5673 * @return Returns the same Intent object, for chaining multiple calls
5674 * into a single statement.
5675 *
5676 * @see #setComponent
5677 * @see #setClass
5678 */
5679 public Intent setClassName(Context packageContext, String className) {
5680 mComponent = new ComponentName(packageContext, className);
5681 return this;
5682 }
5683
5684 /**
5685 * Convenience for calling {@link #setComponent} with an
5686 * explicit application package name and class name.
5687 *
5688 * @param packageName The name of the package implementing the desired
5689 * component.
5690 * @param className The name of a class inside of the application package
5691 * that will be used as the component for this Intent.
5692 *
5693 * @return Returns the same Intent object, for chaining multiple calls
5694 * into a single statement.
5695 *
5696 * @see #setComponent
5697 * @see #setClass
5698 */
5699 public Intent setClassName(String packageName, String className) {
5700 mComponent = new ComponentName(packageName, className);
5701 return this;
5702 }
5703
5704 /**
5705 * Convenience for calling {@link #setComponent(ComponentName)} with the
5706 * name returned by a {@link Class} object.
5707 *
5708 * @param packageContext A Context of the application package implementing
5709 * this class.
5710 * @param cls The class name to set, equivalent to
5711 * <code>setClassName(context, cls.getName())</code>.
5712 *
5713 * @return Returns the same Intent object, for chaining multiple calls
5714 * into a single statement.
5715 *
5716 * @see #setComponent
5717 */
5718 public Intent setClass(Context packageContext, Class<?> cls) {
5719 mComponent = new ComponentName(packageContext, cls);
5720 return this;
5721 }
5722
5723 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005724 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5725 * used as a hint to the receiver for animations and the like. Null means that there
5726 * is no source bounds.
5727 */
5728 public void setSourceBounds(Rect r) {
5729 if (r != null) {
5730 mSourceBounds = new Rect(r);
5731 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005732 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005733 }
5734 }
5735
5736 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005737 * Use with {@link #fillIn} to allow the current action value to be
5738 * overwritten, even if it is already set.
5739 */
5740 public static final int FILL_IN_ACTION = 1<<0;
5741
5742 /**
5743 * Use with {@link #fillIn} to allow the current data or type value
5744 * overwritten, even if it is already set.
5745 */
5746 public static final int FILL_IN_DATA = 1<<1;
5747
5748 /**
5749 * Use with {@link #fillIn} to allow the current categories to be
5750 * overwritten, even if they are already set.
5751 */
5752 public static final int FILL_IN_CATEGORIES = 1<<2;
5753
5754 /**
5755 * Use with {@link #fillIn} to allow the current component value to be
5756 * overwritten, even if it is already set.
5757 */
5758 public static final int FILL_IN_COMPONENT = 1<<3;
5759
5760 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005761 * Use with {@link #fillIn} to allow the current package value to be
5762 * overwritten, even if it is already set.
5763 */
5764 public static final int FILL_IN_PACKAGE = 1<<4;
5765
5766 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005767 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005768 * overwritten, even if it is already set.
5769 */
5770 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5771
5772 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005773 * Use with {@link #fillIn} to allow the current selector to be
5774 * overwritten, even if it is already set.
5775 */
5776 public static final int FILL_IN_SELECTOR = 1<<6;
5777
5778 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005779 * Use with {@link #fillIn} to allow the current ClipData to be
5780 * overwritten, even if it is already set.
5781 */
5782 public static final int FILL_IN_CLIP_DATA = 1<<7;
5783
5784 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005785 * Copy the contents of <var>other</var> in to this object, but only
5786 * where fields are not defined by this object. For purposes of a field
5787 * being defined, the following pieces of data in the Intent are
5788 * considered to be separate fields:
5789 *
5790 * <ul>
5791 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08005792 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005793 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5794 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005795 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005796 * <li> component, as set by {@link #setComponent(ComponentName)} or
5797 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005798 * <li> source bounds, as set by {@link #setSourceBounds}.
5799 * <li> selector, as set by {@link #setSelector(Intent)}.
5800 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005801 * <li> each top-level name in the associated extras.
5802 * </ul>
5803 *
5804 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005805 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005806 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
5807 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
5808 * the restriction where the corresponding field will not be replaced if
5809 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005810 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005811 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
5812 * is explicitly specified. The selector will only be copied if
5813 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07005814 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005815 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5816 * and Intent B with {action="gotit", data-type="some/thing",
5817 * categories="one","two"}.
5818 *
5819 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5820 * containing: {action="gotit", data-type="some/thing",
5821 * categories="bar"}.
5822 *
5823 * @param other Another Intent whose values are to be used to fill in
5824 * the current one.
5825 * @param flags Options to control which fields can be filled in.
5826 *
5827 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005828 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005829 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
5830 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005831 */
5832 public int fillIn(Intent other, int flags) {
5833 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005834 if (other.mAction != null
5835 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005836 mAction = other.mAction;
5837 changes |= FILL_IN_ACTION;
5838 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005839 if ((other.mData != null || other.mType != null)
5840 && ((mData == null && mType == null)
5841 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005842 mData = other.mData;
5843 mType = other.mType;
5844 changes |= FILL_IN_DATA;
5845 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005846 if (other.mCategories != null
5847 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005848 if (other.mCategories != null) {
5849 mCategories = new HashSet<String>(other.mCategories);
5850 }
5851 changes |= FILL_IN_CATEGORIES;
5852 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005853 if (other.mPackage != null
5854 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005855 // Only do this if mSelector is not set.
5856 if (mSelector == null) {
5857 mPackage = other.mPackage;
5858 changes |= FILL_IN_PACKAGE;
5859 }
5860 }
5861 // Selector is special: it can only be set if explicitly allowed,
5862 // for the same reason as the component name.
5863 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
5864 if (mPackage == null) {
5865 mSelector = new Intent(other.mSelector);
5866 mPackage = null;
5867 changes |= FILL_IN_SELECTOR;
5868 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005869 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005870 if (other.mClipData != null
5871 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
5872 mClipData = other.mClipData;
5873 changes |= FILL_IN_CLIP_DATA;
5874 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005875 // Component is special: it can -only- be set if explicitly allowed,
5876 // since otherwise the sender could force the intent somewhere the
5877 // originator didn't intend.
5878 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005879 mComponent = other.mComponent;
5880 changes |= FILL_IN_COMPONENT;
5881 }
5882 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005883 if (other.mSourceBounds != null
5884 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5885 mSourceBounds = new Rect(other.mSourceBounds);
5886 changes |= FILL_IN_SOURCE_BOUNDS;
5887 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005888 if (mExtras == null) {
5889 if (other.mExtras != null) {
5890 mExtras = new Bundle(other.mExtras);
5891 }
5892 } else if (other.mExtras != null) {
5893 try {
5894 Bundle newb = new Bundle(other.mExtras);
5895 newb.putAll(mExtras);
5896 mExtras = newb;
5897 } catch (RuntimeException e) {
5898 // Modifying the extras can cause us to unparcel the contents
5899 // of the bundle, and if we do this in the system process that
5900 // may fail. We really should handle this (i.e., the Bundle
5901 // impl shouldn't be on top of a plain map), but for now just
5902 // ignore it and keep the original contents. :(
5903 Log.w("Intent", "Failure filling in extras", e);
5904 }
5905 }
5906 return changes;
5907 }
5908
5909 /**
5910 * Wrapper class holding an Intent and implementing comparisons on it for
5911 * the purpose of filtering. The class implements its
5912 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5913 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5914 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5915 * on the wrapped Intent.
5916 */
5917 public static final class FilterComparison {
5918 private final Intent mIntent;
5919 private final int mHashCode;
5920
5921 public FilterComparison(Intent intent) {
5922 mIntent = intent;
5923 mHashCode = intent.filterHashCode();
5924 }
5925
5926 /**
5927 * Return the Intent that this FilterComparison represents.
5928 * @return Returns the Intent held by the FilterComparison. Do
5929 * not modify!
5930 */
5931 public Intent getIntent() {
5932 return mIntent;
5933 }
5934
5935 @Override
5936 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005937 if (obj instanceof FilterComparison) {
5938 Intent other = ((FilterComparison)obj).mIntent;
5939 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005940 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005941 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005942 }
5943
5944 @Override
5945 public int hashCode() {
5946 return mHashCode;
5947 }
5948 }
5949
5950 /**
5951 * Determine if two intents are the same for the purposes of intent
5952 * resolution (filtering). That is, if their action, data, type,
5953 * class, and categories are the same. This does <em>not</em> compare
5954 * any extra data included in the intents.
5955 *
5956 * @param other The other Intent to compare against.
5957 *
5958 * @return Returns true if action, data, type, class, and categories
5959 * are the same.
5960 */
5961 public boolean filterEquals(Intent other) {
5962 if (other == null) {
5963 return false;
5964 }
5965 if (mAction != other.mAction) {
5966 if (mAction != null) {
5967 if (!mAction.equals(other.mAction)) {
5968 return false;
5969 }
5970 } else {
5971 if (!other.mAction.equals(mAction)) {
5972 return false;
5973 }
5974 }
5975 }
5976 if (mData != other.mData) {
5977 if (mData != null) {
5978 if (!mData.equals(other.mData)) {
5979 return false;
5980 }
5981 } else {
5982 if (!other.mData.equals(mData)) {
5983 return false;
5984 }
5985 }
5986 }
5987 if (mType != other.mType) {
5988 if (mType != null) {
5989 if (!mType.equals(other.mType)) {
5990 return false;
5991 }
5992 } else {
5993 if (!other.mType.equals(mType)) {
5994 return false;
5995 }
5996 }
5997 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005998 if (mPackage != other.mPackage) {
5999 if (mPackage != null) {
6000 if (!mPackage.equals(other.mPackage)) {
6001 return false;
6002 }
6003 } else {
6004 if (!other.mPackage.equals(mPackage)) {
6005 return false;
6006 }
6007 }
6008 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006009 if (mComponent != other.mComponent) {
6010 if (mComponent != null) {
6011 if (!mComponent.equals(other.mComponent)) {
6012 return false;
6013 }
6014 } else {
6015 if (!other.mComponent.equals(mComponent)) {
6016 return false;
6017 }
6018 }
6019 }
6020 if (mCategories != other.mCategories) {
6021 if (mCategories != null) {
6022 if (!mCategories.equals(other.mCategories)) {
6023 return false;
6024 }
6025 } else {
6026 if (!other.mCategories.equals(mCategories)) {
6027 return false;
6028 }
6029 }
6030 }
6031
6032 return true;
6033 }
6034
6035 /**
6036 * Generate hash code that matches semantics of filterEquals().
6037 *
6038 * @return Returns the hash value of the action, data, type, class, and
6039 * categories.
6040 *
6041 * @see #filterEquals
6042 */
6043 public int filterHashCode() {
6044 int code = 0;
6045 if (mAction != null) {
6046 code += mAction.hashCode();
6047 }
6048 if (mData != null) {
6049 code += mData.hashCode();
6050 }
6051 if (mType != null) {
6052 code += mType.hashCode();
6053 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006054 if (mPackage != null) {
6055 code += mPackage.hashCode();
6056 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006057 if (mComponent != null) {
6058 code += mComponent.hashCode();
6059 }
6060 if (mCategories != null) {
6061 code += mCategories.hashCode();
6062 }
6063 return code;
6064 }
6065
6066 @Override
6067 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006068 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006069
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006070 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006071 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006072 b.append(" }");
6073
6074 return b.toString();
6075 }
6076
6077 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006078 public String toInsecureString() {
6079 StringBuilder b = new StringBuilder(128);
6080
6081 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006082 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006083 b.append(" }");
6084
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006085 return b.toString();
6086 }
Romain Guy4969af72009-06-17 10:53:19 -07006087
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006088 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006089 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006090 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006091
6092 b.append("Intent { ");
6093 toShortString(b, false, true, true, true);
6094 b.append(" }");
6095
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006096 return b.toString();
6097 }
6098
6099 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006100 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6101 StringBuilder b = new StringBuilder(128);
6102 toShortString(b, secure, comp, extras, clip);
6103 return b.toString();
6104 }
6105
6106 /** @hide */
6107 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6108 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006109 boolean first = true;
6110 if (mAction != null) {
6111 b.append("act=").append(mAction);
6112 first = false;
6113 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006114 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006115 if (!first) {
6116 b.append(' ');
6117 }
6118 first = false;
6119 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006120 Iterator<String> i = mCategories.iterator();
6121 boolean didone = false;
6122 while (i.hasNext()) {
6123 if (didone) b.append(",");
6124 didone = true;
6125 b.append(i.next());
6126 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006127 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006128 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006129 if (mData != null) {
6130 if (!first) {
6131 b.append(' ');
6132 }
6133 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006134 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006135 if (secure) {
6136 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006137 } else {
6138 b.append(mData);
6139 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006140 }
6141 if (mType != null) {
6142 if (!first) {
6143 b.append(' ');
6144 }
6145 first = false;
6146 b.append("typ=").append(mType);
6147 }
6148 if (mFlags != 0) {
6149 if (!first) {
6150 b.append(' ');
6151 }
6152 first = false;
6153 b.append("flg=0x").append(Integer.toHexString(mFlags));
6154 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006155 if (mPackage != null) {
6156 if (!first) {
6157 b.append(' ');
6158 }
6159 first = false;
6160 b.append("pkg=").append(mPackage);
6161 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006162 if (comp && mComponent != null) {
6163 if (!first) {
6164 b.append(' ');
6165 }
6166 first = false;
6167 b.append("cmp=").append(mComponent.flattenToShortString());
6168 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006169 if (mSourceBounds != null) {
6170 if (!first) {
6171 b.append(' ');
6172 }
6173 first = false;
6174 b.append("bnds=").append(mSourceBounds.toShortString());
6175 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006176 if (mClipData != null) {
6177 if (!first) {
6178 b.append(' ');
6179 }
6180 first = false;
6181 if (clip) {
6182 b.append("clip={");
6183 mClipData.toShortString(b);
6184 b.append('}');
6185 } else {
6186 b.append("(has clip)");
6187 }
6188 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006189 if (extras && mExtras != null) {
6190 if (!first) {
6191 b.append(' ');
6192 }
6193 first = false;
6194 b.append("(has extras)");
6195 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006196 if (mSelector != null) {
6197 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006198 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006199 b.append("}");
6200 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006201 }
6202
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006203 /**
6204 * Call {@link #toUri} with 0 flags.
6205 * @deprecated Use {@link #toUri} instead.
6206 */
6207 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006208 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006209 return toUri(0);
6210 }
6211
6212 /**
6213 * Convert this Intent into a String holding a URI representation of it.
6214 * The returned URI string has been properly URI encoded, so it can be
6215 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6216 * Intent's data as the base URI, with an additional fragment describing
6217 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006218 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006219 * <p>You can convert the returned string back to an Intent with
6220 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006221 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006222 * @param flags Additional operating flags. Either 0 or
6223 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006224 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006225 * @return Returns a URI encoding URI string describing the entire contents
6226 * of the Intent.
6227 */
6228 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006229 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006230 String scheme = null;
6231 if (mData != null) {
6232 String data = mData.toString();
6233 if ((flags&URI_INTENT_SCHEME) != 0) {
6234 final int N = data.length();
6235 for (int i=0; i<N; i++) {
6236 char c = data.charAt(i);
6237 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6238 || c == '.' || c == '-') {
6239 continue;
6240 }
6241 if (c == ':' && i > 0) {
6242 // Valid scheme.
6243 scheme = data.substring(0, i);
6244 uri.append("intent:");
6245 data = data.substring(i+1);
6246 break;
6247 }
Tom Taylord4a47292009-12-21 13:59:18 -08006248
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006249 // No scheme.
6250 break;
6251 }
6252 }
6253 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006254
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006255 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6256 uri.append("intent:");
6257 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006258
6259 uri.append("#Intent;");
6260
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006261 toUriInner(uri, scheme, flags);
6262 if (mSelector != null) {
6263 uri.append("SEL;");
6264 // Note that for now we are not going to try to handle the
6265 // data part; not clear how to represent this as a URI, and
6266 // not much utility in it.
6267 mSelector.toUriInner(uri, null, flags);
6268 }
6269
6270 uri.append("end");
6271
6272 return uri.toString();
6273 }
6274
6275 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006276 if (scheme != null) {
6277 uri.append("scheme=").append(scheme).append(';');
6278 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006279 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006280 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006281 }
6282 if (mCategories != null) {
6283 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006284 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006285 }
6286 }
6287 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006288 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006289 }
6290 if (mFlags != 0) {
6291 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6292 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006293 if (mPackage != null) {
6294 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6295 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006296 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006297 uri.append("component=").append(Uri.encode(
6298 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006299 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006300 if (mSourceBounds != null) {
6301 uri.append("sourceBounds=")
6302 .append(Uri.encode(mSourceBounds.flattenToString()))
6303 .append(';');
6304 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006305 if (mExtras != null) {
6306 for (String key : mExtras.keySet()) {
6307 final Object value = mExtras.get(key);
6308 char entryType =
6309 value instanceof String ? 'S' :
6310 value instanceof Boolean ? 'B' :
6311 value instanceof Byte ? 'b' :
6312 value instanceof Character ? 'c' :
6313 value instanceof Double ? 'd' :
6314 value instanceof Float ? 'f' :
6315 value instanceof Integer ? 'i' :
6316 value instanceof Long ? 'l' :
6317 value instanceof Short ? 's' :
6318 '\0';
6319
6320 if (entryType != '\0') {
6321 uri.append(entryType);
6322 uri.append('.');
6323 uri.append(Uri.encode(key));
6324 uri.append('=');
6325 uri.append(Uri.encode(value.toString()));
6326 uri.append(';');
6327 }
6328 }
6329 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006330 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006331
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006332 public int describeContents() {
6333 return (mExtras != null) ? mExtras.describeContents() : 0;
6334 }
6335
6336 public void writeToParcel(Parcel out, int flags) {
6337 out.writeString(mAction);
6338 Uri.writeToParcel(out, mData);
6339 out.writeString(mType);
6340 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006341 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006342 ComponentName.writeToParcel(mComponent, out);
6343
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006344 if (mSourceBounds != null) {
6345 out.writeInt(1);
6346 mSourceBounds.writeToParcel(out, flags);
6347 } else {
6348 out.writeInt(0);
6349 }
6350
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006351 if (mCategories != null) {
6352 out.writeInt(mCategories.size());
6353 for (String category : mCategories) {
6354 out.writeString(category);
6355 }
6356 } else {
6357 out.writeInt(0);
6358 }
6359
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006360 if (mSelector != null) {
6361 out.writeInt(1);
6362 mSelector.writeToParcel(out, flags);
6363 } else {
6364 out.writeInt(0);
6365 }
6366
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006367 if (mClipData != null) {
6368 out.writeInt(1);
6369 mClipData.writeToParcel(out, flags);
6370 } else {
6371 out.writeInt(0);
6372 }
6373
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006374 out.writeBundle(mExtras);
6375 }
6376
6377 public static final Parcelable.Creator<Intent> CREATOR
6378 = new Parcelable.Creator<Intent>() {
6379 public Intent createFromParcel(Parcel in) {
6380 return new Intent(in);
6381 }
6382 public Intent[] newArray(int size) {
6383 return new Intent[size];
6384 }
6385 };
6386
Dianne Hackborneb034652009-09-07 00:49:58 -07006387 /** @hide */
6388 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006389 readFromParcel(in);
6390 }
6391
6392 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006393 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006394 mData = Uri.CREATOR.createFromParcel(in);
6395 mType = in.readString();
6396 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006397 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006398 mComponent = ComponentName.readFromParcel(in);
6399
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006400 if (in.readInt() != 0) {
6401 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6402 }
6403
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006404 int N = in.readInt();
6405 if (N > 0) {
6406 mCategories = new HashSet<String>();
6407 int i;
6408 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006409 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006410 }
6411 } else {
6412 mCategories = null;
6413 }
6414
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006415 if (in.readInt() != 0) {
6416 mSelector = new Intent(in);
6417 }
6418
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006419 if (in.readInt() != 0) {
6420 mClipData = new ClipData(in);
6421 }
6422
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006423 mExtras = in.readBundle();
6424 }
6425
6426 /**
6427 * Parses the "intent" element (and its children) from XML and instantiates
6428 * an Intent object. The given XML parser should be located at the tag
6429 * where parsing should start (often named "intent"), from which the
6430 * basic action, data, type, and package and class name will be
6431 * retrieved. The function will then parse in to any child elements,
6432 * looking for <category android:name="xxx"> tags to add categories and
6433 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6434 * to the intent.
6435 *
6436 * @param resources The Resources to use when inflating resources.
6437 * @param parser The XML parser pointing at an "intent" tag.
6438 * @param attrs The AttributeSet interface for retrieving extended
6439 * attribute data at the current <var>parser</var> location.
6440 * @return An Intent object matching the XML data.
6441 * @throws XmlPullParserException If there was an XML parsing error.
6442 * @throws IOException If there was an I/O error.
6443 */
6444 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6445 throws XmlPullParserException, IOException {
6446 Intent intent = new Intent();
6447
6448 TypedArray sa = resources.obtainAttributes(attrs,
6449 com.android.internal.R.styleable.Intent);
6450
6451 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6452
6453 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6454 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6455 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6456
6457 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6458 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6459 if (packageName != null && className != null) {
6460 intent.setComponent(new ComponentName(packageName, className));
6461 }
6462
6463 sa.recycle();
6464
6465 int outerDepth = parser.getDepth();
6466 int type;
6467 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6468 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6469 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6470 continue;
6471 }
6472
6473 String nodeName = parser.getName();
6474 if (nodeName.equals("category")) {
6475 sa = resources.obtainAttributes(attrs,
6476 com.android.internal.R.styleable.IntentCategory);
6477 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6478 sa.recycle();
6479
6480 if (cat != null) {
6481 intent.addCategory(cat);
6482 }
6483 XmlUtils.skipCurrentTag(parser);
6484
6485 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006486 if (intent.mExtras == null) {
6487 intent.mExtras = new Bundle();
6488 }
6489 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6490 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006491
6492 } else {
6493 XmlUtils.skipCurrentTag(parser);
6494 }
6495 }
6496
6497 return intent;
6498 }
Nick Pellyccae4122012-01-09 14:12:58 -08006499
6500 /**
6501 * Normalize a MIME data type.
6502 *
6503 * <p>A normalized MIME type has white-space trimmed,
6504 * content-type parameters removed, and is lower-case.
6505 * This aligns the type with Android best practices for
6506 * intent filtering.
6507 *
6508 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6509 * "text/x-vCard" becomes "text/x-vcard".
6510 *
6511 * <p>All MIME types received from outside Android (such as user input,
6512 * or external sources like Bluetooth, NFC, or the Internet) should
6513 * be normalized before they are used to create an Intent.
6514 *
6515 * @param type MIME data type to normalize
6516 * @return normalized MIME data type, or null if the input was null
6517 * @see {@link #setType}
6518 * @see {@link #setTypeAndNormalize}
6519 */
6520 public static String normalizeMimeType(String type) {
6521 if (type == null) {
6522 return null;
6523 }
6524
6525 type = type.trim().toLowerCase(Locale.US);
6526
6527 final int semicolonIndex = type.indexOf(';');
6528 if (semicolonIndex != -1) {
6529 type = type.substring(0, semicolonIndex);
6530 }
6531 return type;
6532 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006533
6534 /**
6535 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
6536 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}.
6537 *
6538 * @hide
6539 */
6540 public void migrateExtraStreamToClipData() {
6541 // Refuse to touch if extras already parcelled
6542 if (mExtras != null && mExtras.isParcelled()) return;
6543
6544 // Bail when someone already gave us ClipData
6545 if (getClipData() != null) return;
6546
6547 final String action = getAction();
6548 if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006549 final Uri stream;
6550 try {
6551 stream = getParcelableExtra(EXTRA_STREAM);
6552 } catch (ClassCastException e) {
6553 return;
6554 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006555 if (stream != null) {
6556 final ClipData clipData = new ClipData(
6557 null, new String[] { getType() }, new ClipData.Item(stream));
6558
6559 setClipData(clipData);
6560 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
6561 }
6562
6563 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006564 final ArrayList<Uri> streams;
6565 try {
6566 streams = getParcelableArrayListExtra(EXTRA_STREAM);
6567 } catch (ClassCastException e) {
6568 return;
6569 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006570 if (streams != null && streams.size() > 0) {
6571 final Uri firstStream = streams.get(0);
6572 final ClipData clipData = new ClipData(
6573 null, new String[] { getType() }, new ClipData.Item(firstStream));
6574
6575 final int size = streams.size();
6576 for (int i = 1; i < size; i++) {
6577 clipData.addItem(new ClipData.Item(streams.get(i)));
6578 }
6579
6580 setClipData(clipData);
6581 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
6582 }
6583 }
6584 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006585}