blob: dcc63288afd9222a991e8ca5b40e40501204d017 [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
Dianne Hackborn221ea892013-08-04 16:50:16 -070019import android.content.pm.ApplicationInfo;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070020import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070021import org.xmlpull.v1.XmlPullParser;
22import org.xmlpull.v1.XmlPullParserException;
23
24import android.annotation.SdkConstant;
25import android.annotation.SdkConstant.SdkConstantType;
26import android.content.pm.ActivityInfo;
27import android.content.pm.PackageManager;
28import android.content.pm.ResolveInfo;
29import android.content.res.Resources;
30import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080031import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.net.Uri;
33import android.os.Bundle;
34import android.os.IBinder;
35import android.os.Parcel;
36import android.os.Parcelable;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070037import android.os.StrictMode;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070038import android.provider.DocumentsContract;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039import android.util.AttributeSet;
40import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080041
42import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070043
44import java.io.IOException;
45import java.io.Serializable;
46import java.net.URISyntaxException;
47import java.util.ArrayList;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070048import java.util.Iterator;
Dianne Hackborn221ea892013-08-04 16:50:16 -070049import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080050import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070051import java.util.Set;
52
53/**
54 * An intent is an abstract description of an operation to be performed. It
55 * can be used with {@link Context#startActivity(Intent) startActivity} to
56 * launch an {@link android.app.Activity},
57 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
58 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
59 * and {@link android.content.Context#startService} or
60 * {@link android.content.Context#bindService} to communicate with a
61 * background {@link android.app.Service}.
62 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070063 * <p>An Intent provides a facility for performing late runtime binding between the code in
64 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070065 * can be thought of as the glue between activities. It is basically a passive data structure
66 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070067 *
68 * <div class="special reference">
69 * <h3>Developer Guides</h3>
70 * <p>For information about how to create and resolve intents, read the
71 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
72 * developer guide.</p>
73 * </div>
74 *
75 * <a name="IntentStructure"></a>
76 * <h3>Intent Structure</h3>
77 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070078 *
79 * <ul>
80 * <li> <p><b>action</b> -- The general action to be performed, such as
81 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
82 * etc.</p>
83 * </li>
84 * <li> <p><b>data</b> -- The data to operate on, such as a person record
85 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
86 * </li>
87 * </ul>
88 *
89 *
90 * <p>Some examples of action/data pairs are:</p>
91 *
92 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070093 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070094 * information about the person whose identifier is "1".</p>
95 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070096 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070097 * the phone dialer with the person filled in.</p>
98 * </li>
99 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
100 * the phone dialer with the given number filled in. Note how the
101 * VIEW action does what what is considered the most reasonable thing for
102 * a particular URI.</p>
103 * </li>
104 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
105 * the phone dialer with the given number filled in.</p>
106 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700107 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700108 * information about the person whose identifier is "1".</p>
109 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700110 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700111 * a list of people, which the user can browse through. This example is a
112 * typical top-level entry into the Contacts application, showing you the
113 * list of people. Selecting a particular person to view would result in a
114 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
115 * being used to start an activity to display that person.</p>
116 * </li>
117 * </ul>
118 *
119 * <p>In addition to these primary attributes, there are a number of secondary
120 * attributes that you can also include with an intent:</p>
121 *
122 * <ul>
123 * <li> <p><b>category</b> -- Gives additional information about the action
124 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
125 * appear in the Launcher as a top-level application, while
126 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
127 * of alternative actions the user can perform on a piece of data.</p>
128 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
129 * intent data. Normally the type is inferred from the data itself.
130 * By setting this attribute, you disable that evaluation and force
131 * an explicit type.</p>
132 * <li> <p><b>component</b> -- Specifies an explicit name of a component
133 * class to use for the intent. Normally this is determined by looking
134 * at the other information in the intent (the action, data/type, and
135 * categories) and matching that with a component that can handle it.
136 * If this attribute is set then none of the evaluation is performed,
137 * and this component is used exactly as is. By specifying this attribute,
138 * all of the other Intent attributes become optional.</p>
139 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
140 * This can be used to provide extended information to the component.
141 * For example, if we have a action to send an e-mail message, we could
142 * also include extra pieces of data here to supply a subject, body,
143 * etc.</p>
144 * </ul>
145 *
146 * <p>Here are some examples of other operations you can specify as intents
147 * using these additional parameters:</p>
148 *
149 * <ul>
150 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
151 * Launch the home screen.</p>
152 * </li>
153 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
154 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
155 * vnd.android.cursor.item/phone}</i></b>
156 * -- Display the list of people's phone numbers, allowing the user to
157 * browse through them and pick one and return it to the parent activity.</p>
158 * </li>
159 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
160 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
161 * -- Display all pickers for data that can be opened with
162 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
163 * allowing the user to pick one of them and then some data inside of it
164 * and returning the resulting URI to the caller. This can be used,
165 * for example, in an e-mail application to allow the user to pick some
166 * data to include as an attachment.</p>
167 * </li>
168 * </ul>
169 *
170 * <p>There are a variety of standard Intent action and category constants
171 * defined in the Intent class, but applications can also define their own.
172 * These strings use java style scoping, to ensure they are unique -- for
173 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700174 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700175 *
176 * <p>Put together, the set of actions, data types, categories, and extra data
177 * defines a language for the system allowing for the expression of phrases
178 * such as "call john smith's cell". As applications are added to the system,
179 * they can extend this language by adding new actions, types, and categories, or
180 * they can modify the behavior of existing phrases by supplying their own
181 * activities that handle them.</p>
182 *
183 * <a name="IntentResolution"></a>
184 * <h3>Intent Resolution</h3>
185 *
186 * <p>There are two primary forms of intents you will use.
187 *
188 * <ul>
189 * <li> <p><b>Explicit Intents</b> have specified a component (via
190 * {@link #setComponent} or {@link #setClass}), which provides the exact
191 * class to be run. Often these will not include any other information,
192 * simply being a way for an application to launch various internal
193 * activities it has as the user interacts with the application.
194 *
195 * <li> <p><b>Implicit Intents</b> have not specified a component;
196 * instead, they must include enough information for the system to
197 * determine which of the available components is best to run for that
198 * intent.
199 * </ul>
200 *
201 * <p>When using implicit intents, given such an arbitrary intent we need to
202 * know what to do with it. This is handled by the process of <em>Intent
203 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
204 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
205 * more activities/receivers) that can handle it.</p>
206 *
207 * <p>The intent resolution mechanism basically revolves around matching an
208 * Intent against all of the &lt;intent-filter&gt; descriptions in the
209 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
210 * objects explicitly registered with {@link Context#registerReceiver}.) More
211 * details on this can be found in the documentation on the {@link
212 * IntentFilter} class.</p>
213 *
214 * <p>There are three pieces of information in the Intent that are used for
215 * resolution: the action, type, and category. Using this information, a query
216 * is done on the {@link PackageManager} for a component that can handle the
217 * intent. The appropriate component is determined based on the intent
218 * information supplied in the <code>AndroidManifest.xml</code> file as
219 * follows:</p>
220 *
221 * <ul>
222 * <li> <p>The <b>action</b>, if given, must be listed by the component as
223 * one it handles.</p>
224 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
225 * already supplied in the Intent. Like the action, if a type is
226 * included in the intent (either explicitly or implicitly in its
227 * data), then this must be listed by the component as one it handles.</p>
228 * <li> For data that is not a <code>content:</code> URI and where no explicit
229 * type is included in the Intent, instead the <b>scheme</b> of the
230 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
231 * considered. Again like the action, if we are matching a scheme it
232 * must be listed by the component as one it can handle.
233 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
234 * by the activity as categories it handles. That is, if you include
235 * the categories {@link #CATEGORY_LAUNCHER} and
236 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
237 * with an intent that lists <em>both</em> of those categories.
238 * Activities will very often need to support the
239 * {@link #CATEGORY_DEFAULT} so that they can be found by
240 * {@link Context#startActivity Context.startActivity()}.</p>
241 * </ul>
242 *
243 * <p>For example, consider the Note Pad sample application that
244 * allows user to browse through a list of notes data and view details about
245 * individual items. Text in italics indicate places were you would replace a
246 * name with one specific to your own package.</p>
247 *
248 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
249 * package="<i>com.android.notepad</i>"&gt;
250 * &lt;application android:icon="@drawable/app_notes"
251 * android:label="@string/app_name"&gt;
252 *
253 * &lt;provider class=".NotePadProvider"
254 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
255 *
256 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
257 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700258 * &lt;action android:name="android.intent.action.MAIN" /&gt;
259 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700260 * &lt;/intent-filter&gt;
261 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700262 * &lt;action android:name="android.intent.action.VIEW" /&gt;
263 * &lt;action android:name="android.intent.action.EDIT" /&gt;
264 * &lt;action android:name="android.intent.action.PICK" /&gt;
265 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
266 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700267 * &lt;/intent-filter&gt;
268 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700269 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
270 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
271 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700272 * &lt;/intent-filter&gt;
273 * &lt;/activity&gt;
274 *
275 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
276 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700277 * &lt;action android:name="android.intent.action.VIEW" /&gt;
278 * &lt;action android:name="android.intent.action.EDIT" /&gt;
279 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
280 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700281 * &lt;/intent-filter&gt;
282 *
283 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700284 * &lt;action android:name="android.intent.action.INSERT" /&gt;
285 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
286 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700287 * &lt;/intent-filter&gt;
288 *
289 * &lt;/activity&gt;
290 *
291 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
292 * android:theme="@android:style/Theme.Dialog"&gt;
293 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700294 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
295 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
296 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
297 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
298 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700299 * &lt;/intent-filter&gt;
300 * &lt;/activity&gt;
301 *
302 * &lt;/application&gt;
303 * &lt;/manifest&gt;</pre>
304 *
305 * <p>The first activity,
306 * <code>com.android.notepad.NotesList</code>, serves as our main
307 * entry into the app. It can do three things as described by its three intent
308 * templates:
309 * <ol>
310 * <li><pre>
311 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700312 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
313 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700314 * &lt;/intent-filter&gt;</pre>
315 * <p>This provides a top-level entry into the NotePad application: the standard
316 * MAIN action is a main entry point (not requiring any other information in
317 * the Intent), and the LAUNCHER category says that this entry point should be
318 * listed in the application launcher.</p>
319 * <li><pre>
320 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700321 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
322 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
323 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
324 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
325 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700326 * &lt;/intent-filter&gt;</pre>
327 * <p>This declares the things that the activity can do on a directory of
328 * notes. The type being supported is given with the &lt;type&gt; tag, where
329 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
330 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
331 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
332 * The activity allows the user to view or edit the directory of data (via
333 * the VIEW and EDIT actions), or to pick a particular note and return it
334 * to the caller (via the PICK action). Note also the DEFAULT category
335 * supplied here: this is <em>required</em> for the
336 * {@link Context#startActivity Context.startActivity} method to resolve your
337 * activity when its component name is not explicitly specified.</p>
338 * <li><pre>
339 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700340 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
341 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
342 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700343 * &lt;/intent-filter&gt;</pre>
344 * <p>This filter describes the ability return to the caller a note selected by
345 * the user without needing to know where it came from. The data type
346 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
347 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
348 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
349 * The GET_CONTENT action is similar to the PICK action, where the activity
350 * will return to its caller a piece of data selected by the user. Here,
351 * however, the caller specifies the type of data they desire instead of
352 * the type of data the user will be picking from.</p>
353 * </ol>
354 *
355 * <p>Given these capabilities, the following intents will resolve to the
356 * NotesList activity:</p>
357 *
358 * <ul>
359 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
360 * activities that can be used as top-level entry points into an
361 * application.</p>
362 * <li> <p><b>{ action=android.app.action.MAIN,
363 * category=android.app.category.LAUNCHER }</b> is the actual intent
364 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700365 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700366 * data=content://com.google.provider.NotePad/notes }</b>
367 * displays a list of all the notes under
368 * "content://com.google.provider.NotePad/notes", which
369 * the user can browse through and see the details on.</p>
370 * <li> <p><b>{ action=android.app.action.PICK
371 * data=content://com.google.provider.NotePad/notes }</b>
372 * provides a list of the notes under
373 * "content://com.google.provider.NotePad/notes", from which
374 * the user can pick a note whose data URL is returned back to the caller.</p>
375 * <li> <p><b>{ action=android.app.action.GET_CONTENT
376 * type=vnd.android.cursor.item/vnd.google.note }</b>
377 * is similar to the pick action, but allows the caller to specify the
378 * kind of data they want back so that the system can find the appropriate
379 * activity to pick something of that data type.</p>
380 * </ul>
381 *
382 * <p>The second activity,
383 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
384 * note entry and allows them to edit it. It can do two things as described
385 * by its two intent templates:
386 * <ol>
387 * <li><pre>
388 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700389 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
390 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
391 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
392 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700393 * &lt;/intent-filter&gt;</pre>
394 * <p>The first, primary, purpose of this activity is to let the user interact
395 * with a single note, as decribed by the MIME type
396 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
397 * either VIEW a note or allow the user to EDIT it. Again we support the
398 * DEFAULT category to allow the activity to be launched without explicitly
399 * specifying its component.</p>
400 * <li><pre>
401 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700402 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
403 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
404 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700405 * &lt;/intent-filter&gt;</pre>
406 * <p>The secondary use of this activity is to insert a new note entry into
407 * an existing directory of notes. This is used when the user creates a new
408 * note: the INSERT action is executed on the directory of notes, causing
409 * this activity to run and have the user create the new note data which
410 * it then adds to the content provider.</p>
411 * </ol>
412 *
413 * <p>Given these capabilities, the following intents will resolve to the
414 * NoteEditor activity:</p>
415 *
416 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700417 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700418 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
419 * shows the user the content of note <var>{ID}</var>.</p>
420 * <li> <p><b>{ action=android.app.action.EDIT
421 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
422 * allows the user to edit the content of note <var>{ID}</var>.</p>
423 * <li> <p><b>{ action=android.app.action.INSERT
424 * data=content://com.google.provider.NotePad/notes }</b>
425 * creates a new, empty note in the notes list at
426 * "content://com.google.provider.NotePad/notes"
427 * and allows the user to edit it. If they keep their changes, the URI
428 * of the newly created note is returned to the caller.</p>
429 * </ul>
430 *
431 * <p>The last activity,
432 * <code>com.android.notepad.TitleEditor</code>, allows the user to
433 * edit the title of a note. This could be implemented as a class that the
434 * application directly invokes (by explicitly setting its component in
435 * the Intent), but here we show a way you can publish alternative
436 * operations on existing data:</p>
437 *
438 * <pre>
439 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700440 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
441 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
442 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
443 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
444 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700445 * &lt;/intent-filter&gt;</pre>
446 *
447 * <p>In the single intent template here, we
448 * have created our own private action called
449 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
450 * edit the title of a note. It must be invoked on a specific note
451 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
452 * view and edit actions, but here displays and edits the title contained
453 * in the note data.
454 *
455 * <p>In addition to supporting the default category as usual, our title editor
456 * also supports two other standard categories: ALTERNATIVE and
457 * SELECTED_ALTERNATIVE. Implementing
458 * these categories allows others to find the special action it provides
459 * without directly knowing about it, through the
460 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
461 * more often to build dynamic menu items with
462 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
463 * template here was also supply an explicit name for the template
464 * (via <code>android:label="@string/resolve_title"</code>) to better control
465 * what the user sees when presented with this activity as an alternative
466 * action to the data they are viewing.
467 *
468 * <p>Given these capabilities, the following intent will resolve to the
469 * TitleEditor activity:</p>
470 *
471 * <ul>
472 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
473 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
474 * displays and allows the user to edit the title associated
475 * with note <var>{ID}</var>.</p>
476 * </ul>
477 *
478 * <h3>Standard Activity Actions</h3>
479 *
480 * <p>These are the current standard actions that Intent defines for launching
481 * activities (usually through {@link Context#startActivity}. The most
482 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
483 * {@link #ACTION_EDIT}.
484 *
485 * <ul>
486 * <li> {@link #ACTION_MAIN}
487 * <li> {@link #ACTION_VIEW}
488 * <li> {@link #ACTION_ATTACH_DATA}
489 * <li> {@link #ACTION_EDIT}
490 * <li> {@link #ACTION_PICK}
491 * <li> {@link #ACTION_CHOOSER}
492 * <li> {@link #ACTION_GET_CONTENT}
493 * <li> {@link #ACTION_DIAL}
494 * <li> {@link #ACTION_CALL}
495 * <li> {@link #ACTION_SEND}
496 * <li> {@link #ACTION_SENDTO}
497 * <li> {@link #ACTION_ANSWER}
498 * <li> {@link #ACTION_INSERT}
499 * <li> {@link #ACTION_DELETE}
500 * <li> {@link #ACTION_RUN}
501 * <li> {@link #ACTION_SYNC}
502 * <li> {@link #ACTION_PICK_ACTIVITY}
503 * <li> {@link #ACTION_SEARCH}
504 * <li> {@link #ACTION_WEB_SEARCH}
505 * <li> {@link #ACTION_FACTORY_TEST}
506 * </ul>
507 *
508 * <h3>Standard Broadcast Actions</h3>
509 *
510 * <p>These are the current standard actions that Intent defines for receiving
511 * broadcasts (usually through {@link Context#registerReceiver} or a
512 * &lt;receiver&gt; tag in a manifest).
513 *
514 * <ul>
515 * <li> {@link #ACTION_TIME_TICK}
516 * <li> {@link #ACTION_TIME_CHANGED}
517 * <li> {@link #ACTION_TIMEZONE_CHANGED}
518 * <li> {@link #ACTION_BOOT_COMPLETED}
519 * <li> {@link #ACTION_PACKAGE_ADDED}
520 * <li> {@link #ACTION_PACKAGE_CHANGED}
521 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800522 * <li> {@link #ACTION_PACKAGE_RESTARTED}
523 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700524 * <li> {@link #ACTION_UID_REMOVED}
525 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700526 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700527 * <li> {@link #ACTION_POWER_DISCONNECTED}
528 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700529 * </ul>
530 *
531 * <h3>Standard Categories</h3>
532 *
533 * <p>These are the current standard categories that can be used to further
534 * clarify an Intent via {@link #addCategory}.
535 *
536 * <ul>
537 * <li> {@link #CATEGORY_DEFAULT}
538 * <li> {@link #CATEGORY_BROWSABLE}
539 * <li> {@link #CATEGORY_TAB}
540 * <li> {@link #CATEGORY_ALTERNATIVE}
541 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
542 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800543 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700544 * <li> {@link #CATEGORY_HOME}
545 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700546 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400547 * <li> {@link #CATEGORY_CAR_DOCK}
548 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500549 * <li> {@link #CATEGORY_LE_DESK_DOCK}
550 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200551 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700552 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700553 * </ul>
554 *
555 * <h3>Standard Extra Data</h3>
556 *
557 * <p>These are the current standard fields that can be used as extra data via
558 * {@link #putExtra}.
559 *
560 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800561 * <li> {@link #EXTRA_ALARM_COUNT}
562 * <li> {@link #EXTRA_BCC}
563 * <li> {@link #EXTRA_CC}
564 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
565 * <li> {@link #EXTRA_DATA_REMOVED}
566 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500567 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
568 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800569 * <li> {@link #EXTRA_DOCK_STATE_CAR}
570 * <li> {@link #EXTRA_DOCK_STATE_DESK}
571 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
572 * <li> {@link #EXTRA_DONT_KILL_APP}
573 * <li> {@link #EXTRA_EMAIL}
574 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700575 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800576 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700577 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800578 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700579 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800580 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
581 * <li> {@link #EXTRA_REPLACING}
582 * <li> {@link #EXTRA_SHORTCUT_ICON}
583 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
584 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700585 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800586 * <li> {@link #EXTRA_SHORTCUT_NAME}
587 * <li> {@link #EXTRA_SUBJECT}
588 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700589 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800590 * <li> {@link #EXTRA_TITLE}
591 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700592 * </ul>
593 *
594 * <h3>Flags</h3>
595 *
596 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800597 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
598 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700599 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800600public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700601 // ---------------------------------------------------------------------
602 // ---------------------------------------------------------------------
603 // Standard intent activity actions (see action variable).
604
605 /**
606 * Activity Action: Start as a main entry point, does not expect to
607 * receive data.
608 * <p>Input: nothing
609 * <p>Output: nothing
610 */
611 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
612 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800613
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700614 /**
615 * Activity Action: Display the data to the user. This is the most common
616 * action performed on data -- it is the generic action you can use on
617 * a piece of data to get the most reasonable thing to occur. For example,
618 * when used on a contacts entry it will view the entry; when used on a
619 * mailto: URI it will bring up a compose window filled with the information
620 * supplied by the URI; when used with a tel: URI it will invoke the
621 * dialer.
622 * <p>Input: {@link #getData} is URI from which to retrieve data.
623 * <p>Output: nothing.
624 */
625 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
626 public static final String ACTION_VIEW = "android.intent.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 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
630 * performed on a piece of data.
631 */
632 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800633
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700634 /**
635 * Used to indicate that some piece of data should be attached to some other
636 * place. For example, image data could be attached to a contact. It is up
637 * to the recipient to decide where the data should be attached; the intent
638 * does not specify the ultimate destination.
639 * <p>Input: {@link #getData} is URI of data to be attached.
640 * <p>Output: nothing.
641 */
642 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
643 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800644
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700645 /**
646 * Activity Action: Provide explicit editable access to the given data.
647 * <p>Input: {@link #getData} is URI of data to be edited.
648 * <p>Output: nothing.
649 */
650 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
651 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800652
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700653 /**
654 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
655 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
656 * The extras can contain type specific data to pass through to the editing/creating
657 * activity.
658 * <p>Output: The URI of the item that was picked. This must be a content:
659 * URI so that any receiver can access it.
660 */
661 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
662 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800663
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700664 /**
665 * Activity Action: Pick an item from the data, returning what was selected.
666 * <p>Input: {@link #getData} is URI containing a directory of data
667 * (vnd.android.cursor.dir/*) from which to pick an item.
668 * <p>Output: The URI of the item that was picked.
669 */
670 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
671 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800672
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700673 /**
674 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800675 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700676 * <p>Output: An Intent representing the shortcut. The intent must contain three
677 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
678 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800679 * (value: ShortcutIconResource).</p>
680 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700681 * @see #EXTRA_SHORTCUT_INTENT
682 * @see #EXTRA_SHORTCUT_NAME
683 * @see #EXTRA_SHORTCUT_ICON
684 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
685 * @see android.content.Intent.ShortcutIconResource
686 */
687 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
688 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
689
690 /**
691 * The name of the extra used to define the Intent of a shortcut.
692 *
693 * @see #ACTION_CREATE_SHORTCUT
694 */
695 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
696 /**
697 * The name of the extra used to define the name of a shortcut.
698 *
699 * @see #ACTION_CREATE_SHORTCUT
700 */
701 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
702 /**
703 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
704 *
705 * @see #ACTION_CREATE_SHORTCUT
706 */
707 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
708 /**
709 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
710 *
711 * @see #ACTION_CREATE_SHORTCUT
712 * @see android.content.Intent.ShortcutIconResource
713 */
714 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
715 "android.intent.extra.shortcut.ICON_RESOURCE";
716
717 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800718 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700719 *
720 * @see Intent#ACTION_CREATE_SHORTCUT
721 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800722 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
723 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700724 */
725 public static class ShortcutIconResource implements Parcelable {
726 /**
727 * The package name of the application containing the icon.
728 */
729 public String packageName;
730
731 /**
732 * The resource name of the icon, including package, name and type.
733 */
734 public String resourceName;
735
736 /**
737 * Creates a new ShortcutIconResource for the specified context and resource
738 * identifier.
739 *
740 * @param context The context of the application.
741 * @param resourceId The resource idenfitier for the icon.
742 * @return A new ShortcutIconResource with the specified's context package name
743 * and icon resource idenfitier.
744 */
745 public static ShortcutIconResource fromContext(Context context, int resourceId) {
746 ShortcutIconResource icon = new ShortcutIconResource();
747 icon.packageName = context.getPackageName();
748 icon.resourceName = context.getResources().getResourceName(resourceId);
749 return icon;
750 }
751
752 /**
753 * Used to read a ShortcutIconResource from a Parcel.
754 */
755 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
756 new Parcelable.Creator<ShortcutIconResource>() {
757
758 public ShortcutIconResource createFromParcel(Parcel source) {
759 ShortcutIconResource icon = new ShortcutIconResource();
760 icon.packageName = source.readString();
761 icon.resourceName = source.readString();
762 return icon;
763 }
764
765 public ShortcutIconResource[] newArray(int size) {
766 return new ShortcutIconResource[size];
767 }
768 };
769
770 /**
771 * No special parcel contents.
772 */
773 public int describeContents() {
774 return 0;
775 }
776
777 public void writeToParcel(Parcel dest, int flags) {
778 dest.writeString(packageName);
779 dest.writeString(resourceName);
780 }
781
782 @Override
783 public String toString() {
784 return resourceName;
785 }
786 }
787
788 /**
789 * Activity Action: Display an activity chooser, allowing the user to pick
790 * what they want to before proceeding. This can be used as an alternative
791 * to the standard activity picker that is displayed by the system when
792 * you try to start an activity with multiple possible matches, with these
793 * differences in behavior:
794 * <ul>
795 * <li>You can specify the title that will appear in the activity chooser.
796 * <li>The user does not have the option to make one of the matching
797 * activities a preferred activity, and all possible activities will
798 * always be shown even if one of them is currently marked as the
799 * preferred activity.
800 * </ul>
801 * <p>
802 * This action should be used when the user will naturally expect to
803 * select an activity in order to proceed. An example if when not to use
804 * it is when the user clicks on a "mailto:" link. They would naturally
805 * expect to go directly to their mail app, so startActivity() should be
806 * called directly: it will
807 * either launch the current preferred app, or put up a dialog allowing the
808 * user to pick an app to use and optionally marking that as preferred.
809 * <p>
810 * In contrast, if the user is selecting a menu item to send a picture
811 * they are viewing to someone else, there are many different things they
812 * may want to do at this point: send it through e-mail, upload it to a
813 * web service, etc. In this case the CHOOSER action should be used, to
814 * always present to the user a list of the things they can do, with a
815 * nice title given by the caller such as "Send this photo with:".
816 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700817 * If you need to grant URI permissions through a chooser, you must specify
818 * the permissions to be granted on the ACTION_CHOOSER Intent
819 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
820 * {@link #setClipData} to specify the URIs to be granted as well as
821 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
822 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
823 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700824 * As a convenience, an Intent of this form can be created with the
825 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700826 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700827 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700828 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
829 * and can optionally have a {@link #EXTRA_TITLE} field containing the
830 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700831 * <p>
832 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700833 */
834 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
835 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
836
837 /**
838 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
839 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700840 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
841 * target intent, also optionally supplying a title. If the target
842 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
843 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
844 * set in the returned chooser intent, with its ClipData set appropriately:
845 * either a direct reflection of {@link #getClipData()} if that is non-null,
846 * or a new ClipData build from {@link #getData()}.
847 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700848 * @param target The Intent that the user will be selecting an activity
849 * to perform.
850 * @param title Optional title that will be displayed in the chooser.
851 * @return Return a new Intent object that you can hand to
852 * {@link Context#startActivity(Intent) Context.startActivity()} and
853 * related methods.
854 */
855 public static Intent createChooser(Intent target, CharSequence title) {
856 Intent intent = new Intent(ACTION_CHOOSER);
857 intent.putExtra(EXTRA_INTENT, target);
858 if (title != null) {
859 intent.putExtra(EXTRA_TITLE, title);
860 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700861
862 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700863 int permFlags = target.getFlags()
864 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
865 if (permFlags != 0) {
866 ClipData targetClipData = target.getClipData();
867 if (targetClipData == null && target.getData() != null) {
868 ClipData.Item item = new ClipData.Item(target.getData());
869 String[] mimeTypes;
870 if (target.getType() != null) {
871 mimeTypes = new String[] { target.getType() };
872 } else {
873 mimeTypes = new String[] { };
874 }
875 targetClipData = new ClipData(null, mimeTypes, item);
876 }
877 if (targetClipData != null) {
878 intent.setClipData(targetClipData);
879 intent.addFlags(permFlags);
880 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700881 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700882
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700883 return intent;
884 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700885
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700886 /**
887 * Activity Action: Allow the user to select a particular kind of data and
888 * return it. This is different than {@link #ACTION_PICK} in that here we
889 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800890 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700891 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900892 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700893 * etc.
894 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900895 * 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 -0700896 * of data, such as a person contact, you set the MIME type to the kind of
897 * data you want and launch it with {@link Context#startActivity(Intent)}.
898 * The system will then launch the best application to select that kind
899 * of data for you.
900 * <p>
901 * You may also be interested in any of a set of types of content the user
902 * can pick. For example, an e-mail application that wants to allow the
903 * user to add an attachment to an e-mail message can use this action to
904 * bring up a list of all of the types of content the user can attach.
905 * <p>
906 * In this case, you should wrap the GET_CONTENT intent with a chooser
907 * (through {@link #createChooser}), which will give the proper interface
908 * for the user to pick how to send your data and allow you to specify
909 * a prompt indicating what they are doing. You will usually specify a
910 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
911 * broad range of content types the user can select from.
912 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900913 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700914 * only pick from data that can be represented as a stream. This is
915 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
916 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800917 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900918 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800919 * is locally available on the device. For example, if this extra is set
920 * to true then an image picker should not show any pictures that are available
921 * from a remote server but not already on the local device (thus requiring
922 * they be downloaded when opened).
923 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800924 * If the caller can handle multiple returned items (the user performing
925 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
926 * to indicate this.
927 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700928 * Input: {@link #getType} is the desired MIME type to retrieve. Note
929 * that no URI is supplied in the intent, as there are no constraints on
930 * where the returned data originally comes from. You may also include the
931 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800932 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800933 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
934 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700935 * <p>
936 * Output: The URI of the item that was picked. This must be a content:
937 * URI so that any receiver can access it.
938 */
939 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
940 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
941 /**
942 * Activity Action: Dial a number as specified by the data. This shows a
943 * UI with the number being dialed, allowing the user to explicitly
944 * initiate the call.
945 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
946 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
947 * number.
948 * <p>Output: nothing.
949 */
950 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
951 public static final String ACTION_DIAL = "android.intent.action.DIAL";
952 /**
953 * Activity Action: Perform a call to someone specified by the data.
954 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
955 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
956 * number.
957 * <p>Output: nothing.
958 *
959 * <p>Note: there will be restrictions on which applications can initiate a
960 * call; most applications should use the {@link #ACTION_DIAL}.
961 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
962 * numbers. Applications can <strong>dial</strong> emergency numbers using
963 * {@link #ACTION_DIAL}, however.
964 */
965 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
966 public static final String ACTION_CALL = "android.intent.action.CALL";
967 /**
968 * Activity Action: Perform a call to an emergency number specified by the
969 * data.
970 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
971 * tel: URI of an explicit phone number.
972 * <p>Output: nothing.
973 * @hide
974 */
975 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
976 /**
977 * Activity action: Perform a call to any number (emergency or not)
978 * specified by the data.
979 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
980 * tel: URI of an explicit phone number.
981 * <p>Output: nothing.
982 * @hide
983 */
984 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
985 /**
986 * Activity Action: Send a message to someone specified by the data.
987 * <p>Input: {@link #getData} is URI describing the target.
988 * <p>Output: nothing.
989 */
990 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
991 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
992 /**
993 * Activity Action: Deliver some data to someone else. Who the data is
994 * being delivered to is not specified; it is up to the receiver of this
995 * action to ask the user where the data should be sent.
996 * <p>
997 * When launching a SEND intent, you should usually wrap it in a chooser
998 * (through {@link #createChooser}), which will give the proper interface
999 * for the user to pick how to send your data and allow you to specify
1000 * a prompt indicating what they are doing.
1001 * <p>
1002 * Input: {@link #getType} is the MIME type of the data being sent.
1003 * get*Extra can have either a {@link #EXTRA_TEXT}
1004 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1005 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1006 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1007 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001008 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1009 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1010 * your text with HTML formatting.
1011 * <p>
1012 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1013 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1014 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1015 * content: URIs and other advanced features of {@link ClipData}. If
1016 * using this approach, you still must supply the same data through the
1017 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1018 * for compatibility with old applications. If you don't set a ClipData,
1019 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001020 * <p>
1021 * Optional standard extras, which may be interpreted by some recipients as
1022 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1023 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1024 * <p>
1025 * Output: nothing.
1026 */
1027 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1028 public static final String ACTION_SEND = "android.intent.action.SEND";
1029 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001030 * Activity Action: Deliver multiple data to someone else.
1031 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001032 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001033 * <p>
1034 * Input: {@link #getType} is the MIME type of the data being sent.
1035 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001036 * #EXTRA_STREAM} field, containing the data to be sent. If using
1037 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1038 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001039 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001040 * Multiple types are supported, and receivers should handle mixed types
1041 * whenever possible. The right way for the receiver to check them is to
1042 * use the content resolver on each URI. The intent sender should try to
1043 * put the most concrete mime type in the intent type, but it can fall
1044 * back to {@literal <type>/*} or {@literal *}/* as needed.
1045 * <p>
1046 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1047 * be image/jpg, but if you are sending image/jpg and image/png, then the
1048 * intent's type should be image/*.
1049 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001050 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1051 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1052 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1053 * content: URIs and other advanced features of {@link ClipData}. If
1054 * using this approach, you still must supply the same data through the
1055 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1056 * for compatibility with old applications. If you don't set a ClipData,
1057 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1058 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001059 * Optional standard extras, which may be interpreted by some recipients as
1060 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1061 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1062 * <p>
1063 * Output: nothing.
1064 */
1065 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1066 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1067 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001068 * Activity Action: Handle an incoming phone call.
1069 * <p>Input: nothing.
1070 * <p>Output: nothing.
1071 */
1072 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1073 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1074 /**
1075 * Activity Action: Insert an empty item into the given container.
1076 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1077 * in which to place the data.
1078 * <p>Output: URI of the new data that was created.
1079 */
1080 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1081 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1082 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001083 * Activity Action: Create a new item in the given container, initializing it
1084 * from the current contents of the clipboard.
1085 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1086 * in which to place the data.
1087 * <p>Output: URI of the new data that was created.
1088 */
1089 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1090 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1091 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001092 * Activity Action: Delete the given data from its container.
1093 * <p>Input: {@link #getData} is URI of data to be deleted.
1094 * <p>Output: nothing.
1095 */
1096 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1097 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1098 /**
1099 * Activity Action: Run the data, whatever that means.
1100 * <p>Input: ? (Note: this is currently specific to the test harness.)
1101 * <p>Output: nothing.
1102 */
1103 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1104 public static final String ACTION_RUN = "android.intent.action.RUN";
1105 /**
1106 * Activity Action: Perform a data synchronization.
1107 * <p>Input: ?
1108 * <p>Output: ?
1109 */
1110 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1111 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1112 /**
1113 * Activity Action: Pick an activity given an intent, returning the class
1114 * selected.
1115 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1116 * used with {@link PackageManager#queryIntentActivities} to determine the
1117 * set of activities from which to pick.
1118 * <p>Output: Class name of the activity that was selected.
1119 */
1120 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1121 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1122 /**
1123 * Activity Action: Perform a search.
1124 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1125 * is the text to search for. If empty, simply
1126 * enter your search results Activity with the search UI activated.
1127 * <p>Output: nothing.
1128 */
1129 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1130 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1131 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001132 * Activity Action: Start the platform-defined tutorial
1133 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1134 * is the text to search for. If empty, simply
1135 * enter your search results Activity with the search UI activated.
1136 * <p>Output: nothing.
1137 */
1138 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1139 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1140 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001141 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001142 * <p>
1143 * Input: {@link android.app.SearchManager#QUERY
1144 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1145 * a url starts with http or https, the site will be opened. If it is plain
1146 * text, Google search will be applied.
1147 * <p>
1148 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001149 */
1150 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1151 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001152
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001153 /**
Jim Miller07994402012-05-02 14:22:27 -07001154 * Activity Action: Perform assist action.
1155 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001156 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1157 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001158 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001159 * Output: nothing.
1160 */
1161 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1162 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001163
1164 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001165 * Activity Action: Perform voice assist action.
1166 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001167 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1168 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001169 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001170 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001171 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001172 */
1173 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1174 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1175
1176 /**
Adam Skory7140a252013-09-11 12:04:58 +01001177 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1178 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001179 */
1180 public static final String EXTRA_ASSIST_PACKAGE
1181 = "android.intent.extra.ASSIST_PACKAGE";
1182
1183 /**
Adam Skory7140a252013-09-11 12:04:58 +01001184 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1185 * information supplied by the current foreground app at the time of the assist request.
1186 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001187 */
1188 public static final String EXTRA_ASSIST_CONTEXT
1189 = "android.intent.extra.ASSIST_CONTEXT";
1190
Jim Miller07994402012-05-02 14:22:27 -07001191 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001192 * Activity Action: List all available applications
1193 * <p>Input: Nothing.
1194 * <p>Output: nothing.
1195 */
1196 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1197 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1198 /**
1199 * Activity Action: Show settings for choosing wallpaper
1200 * <p>Input: Nothing.
1201 * <p>Output: Nothing.
1202 */
1203 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1204 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1205
1206 /**
1207 * Activity Action: Show activity for reporting a bug.
1208 * <p>Input: Nothing.
1209 * <p>Output: Nothing.
1210 */
1211 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1212 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1213
1214 /**
1215 * Activity Action: Main entry point for factory tests. Only used when
1216 * the device is booting in factory test node. The implementing package
1217 * must be installed in the system image.
1218 * <p>Input: nothing
1219 * <p>Output: nothing
1220 */
1221 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1222
1223 /**
1224 * Activity Action: The user pressed the "call" button to go to the dialer
1225 * or other appropriate UI for placing a call.
1226 * <p>Input: Nothing.
1227 * <p>Output: Nothing.
1228 */
1229 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1230 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1231
1232 /**
1233 * Activity Action: Start Voice Command.
1234 * <p>Input: Nothing.
1235 * <p>Output: Nothing.
1236 */
1237 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1238 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001239
1240 /**
1241 * Activity Action: Start action associated with long pressing on the
1242 * search key.
1243 * <p>Input: Nothing.
1244 * <p>Output: Nothing.
1245 */
1246 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1247 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001248
Jacek Surazski86b6c532009-05-13 14:38:28 +02001249 /**
1250 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1251 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001252 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001253 * <p>Input: No data is specified. The bug report is passed in using
1254 * an {@link #EXTRA_BUG_REPORT} field.
1255 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001256 *
1257 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001258 */
1259 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1260 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001261
1262 /**
1263 * Activity Action: Show power usage information to the user.
1264 * <p>Input: Nothing.
1265 * <p>Output: Nothing.
1266 */
1267 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1268 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001269
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001270 /**
1271 * Activity Action: Setup wizard to launch after a platform update. This
1272 * activity should have a string meta-data field associated with it,
1273 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1274 * the platform for setup. The activity will be launched only if
1275 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1276 * same value.
1277 * <p>Input: Nothing.
1278 * <p>Output: Nothing.
1279 * @hide
1280 */
1281 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1282 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001283
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001284 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001285 * Activity Action: Show settings for managing network data usage of a
1286 * specific application. Applications should define an activity that offers
1287 * options to control data usage.
1288 */
1289 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1290 public static final String ACTION_MANAGE_NETWORK_USAGE =
1291 "android.intent.action.MANAGE_NETWORK_USAGE";
1292
1293 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001294 * Activity Action: Launch application installer.
1295 * <p>
1296 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001297 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1298 * you can also use "package:<package-name>" to install an application for the
1299 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001300 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1301 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1302 * <p>
1303 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1304 * succeeded.
1305 *
1306 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1307 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1308 * @see #EXTRA_RETURN_RESULT
1309 */
1310 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1311 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1312
1313 /**
1314 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1315 * package. Specifies the installer package name; this package will receive the
1316 * {@link #ACTION_APP_ERROR} intent.
1317 */
1318 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1319 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1320
1321 /**
1322 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1323 * package. Specifies that the application being installed should not be
1324 * treated as coming from an unknown source, but as coming from the app
1325 * invoking the Intent. For this to work you must start the installer with
1326 * startActivityForResult().
1327 */
1328 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1329 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1330
1331 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001332 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1333 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001334 * data field originated from.
1335 */
rich cannings706e8ba2012-08-20 13:20:14 -07001336 public static final String EXTRA_ORIGINATING_URI
1337 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001338
1339 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001340 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1341 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1342 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001343 */
1344 public static final String EXTRA_REFERRER
1345 = "android.intent.extra.REFERRER";
1346
1347 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001348 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1349 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1350 * @hide
1351 */
1352 public static final String EXTRA_ORIGINATING_UID
1353 = "android.intent.extra.ORIGINATING_UID";
1354
1355 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001356 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1357 * package. Tells the installer UI to skip the confirmation with the user
1358 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001359 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1360 * will no longer show an interstitial message about updating existing
1361 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001362 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001363 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001364 public static final String EXTRA_ALLOW_REPLACE
1365 = "android.intent.extra.ALLOW_REPLACE";
1366
1367 /**
1368 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1369 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1370 * return to the application the result code of the install/uninstall. The returned result
1371 * code will be {@link android.app.Activity#RESULT_OK} on success or
1372 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1373 */
1374 public static final String EXTRA_RETURN_RESULT
1375 = "android.intent.extra.RETURN_RESULT";
1376
1377 /**
1378 * Package manager install result code. @hide because result codes are not
1379 * yet ready to be exposed.
1380 */
1381 public static final String EXTRA_INSTALL_RESULT
1382 = "android.intent.extra.INSTALL_RESULT";
1383
1384 /**
1385 * Activity Action: Launch application uninstaller.
1386 * <p>
1387 * Input: The data must be a package: URI whose scheme specific part is
1388 * the package name of the current installed package to be uninstalled.
1389 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1390 * <p>
1391 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1392 * succeeded.
1393 */
1394 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1395 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1396
1397 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001398 * Specify whether the package should be uninstalled for all users.
1399 * @hide because these should not be part of normal application flow.
1400 */
1401 public static final String EXTRA_UNINSTALL_ALL_USERS
1402 = "android.intent.extra.UNINSTALL_ALL_USERS";
1403
1404 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001405 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1406 * describing the last run version of the platform that was setup.
1407 * @hide
1408 */
1409 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1410
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001411 // ---------------------------------------------------------------------
1412 // ---------------------------------------------------------------------
1413 // Standard intent broadcast actions (see action variable).
1414
1415 /**
1416 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001417 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001418 * <p class="note">This is a protected intent that can only be sent
1419 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001420 */
1421 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1422 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1423 /**
1424 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001425 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001426 * <p class="note">This is a protected intent that can only be sent
1427 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001428 */
1429 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1430 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001431
1432 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001433 * Broadcast Action: Sent after the system stops dreaming.
1434 *
1435 * <p class="note">This is a protected intent that can only be sent by the system.
1436 * It is only sent to registered receivers.</p>
1437 */
1438 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1439 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1440
1441 /**
1442 * Broadcast Action: Sent after the system starts dreaming.
1443 *
1444 * <p class="note">This is a protected intent that can only be sent by the system.
1445 * It is only sent to registered receivers.</p>
1446 */
1447 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1448 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1449
1450 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001451 * 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 -07001452 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001453 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001454 * <p class="note">This is a protected intent that can only be sent
1455 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001456 */
1457 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001458 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001459
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001460 /**
1461 * Broadcast Action: The current time has changed. Sent every
1462 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001463 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001464 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1465 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001466 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001467 * <p class="note">This is a protected intent that can only be sent
1468 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001469 */
1470 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1471 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1472 /**
1473 * Broadcast Action: The time was set.
1474 */
1475 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1476 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1477 /**
1478 * Broadcast Action: The date has changed.
1479 */
1480 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1481 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1482 /**
1483 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1484 * <ul>
1485 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1486 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001487 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001488 * <p class="note">This is a protected intent that can only be sent
1489 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001490 */
1491 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1492 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1493 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001494 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1495 * DNS entries should be tossed.
1496 * @hide
1497 */
1498 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1499 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1500 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001501 * Alarm Changed Action: This is broadcast when the AlarmClock
1502 * application's alarm is set or unset. It is used by the
1503 * AlarmClock application and the StatusBar service.
1504 * @hide
1505 */
1506 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1507 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1508 /**
1509 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1510 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1511 * @hide
1512 */
1513 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1514 public static final String ACTION_SYNC_STATE_CHANGED
1515 = "android.intent.action.SYNC_STATE_CHANGED";
1516 /**
1517 * Broadcast Action: This is broadcast once, after the system has finished
1518 * booting. It can be used to perform application-specific initialization,
1519 * such as installing alarms. You must hold the
1520 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1521 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001522 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001523 * <p class="note">This is a protected intent that can only be sent
1524 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001525 */
1526 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1527 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1528 /**
1529 * Broadcast Action: This is broadcast when a user action should request a
1530 * temporary system dialog to dismiss. Some examples of temporary system
1531 * dialogs are the notification window-shade and the recent tasks dialog.
1532 */
1533 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1534 /**
1535 * Broadcast Action: Trigger the download and eventual installation
1536 * of a package.
1537 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001538 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001539 * <p class="note">This is a protected intent that can only be sent
1540 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001541 *
1542 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001543 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001544 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1546 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1547 /**
1548 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001549 * device. The data contains the name of the package. Note that the
1550 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001551 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001552 * <ul>
1553 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1554 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1555 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1556 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001557 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001558 * <p class="note">This is a protected intent that can only be sent
1559 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001560 */
1561 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1562 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1563 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001564 * Broadcast Action: A new version of an application package has been
1565 * installed, replacing an existing version that was previously installed.
1566 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001567 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001568 * <ul>
1569 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1570 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001571 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001572 * <p class="note">This is a protected intent that can only be sent
1573 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001574 */
1575 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1576 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1577 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001578 * Broadcast Action: A new version of your application has been installed
1579 * over an existing one. This is only sent to the application that was
1580 * replaced. It does not contain any additional data; to receive it, just
1581 * use an intent filter for this action.
1582 *
1583 * <p class="note">This is a protected intent that can only be sent
1584 * by the system.
1585 */
1586 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1587 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1588 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001589 * Broadcast Action: An existing application package has been removed from
1590 * the device. The data contains the name of the package. The package
1591 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001592 * <ul>
1593 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1594 * to the package.
1595 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1596 * application -- data and code -- is being removed.
1597 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1598 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1599 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001600 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001601 * <p class="note">This is a protected intent that can only be sent
1602 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001603 */
1604 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1605 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1606 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001607 * Broadcast Action: An existing application package has been completely
1608 * removed from the device. The data contains the name of the package.
1609 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1610 * {@link #EXTRA_DATA_REMOVED} is true and
1611 * {@link #EXTRA_REPLACING} is false of that broadcast.
1612 *
1613 * <ul>
1614 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1615 * to the package.
1616 * </ul>
1617 *
1618 * <p class="note">This is a protected intent that can only be sent
1619 * by the system.
1620 */
1621 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1622 public static final String ACTION_PACKAGE_FULLY_REMOVED
1623 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1624 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001625 * Broadcast Action: An existing application package has been changed (e.g.
1626 * a component has been enabled or disabled). The data contains the name of
1627 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001628 * <ul>
1629 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001630 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001631 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001632 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1633 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001634 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001635 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001636 * <p class="note">This is a protected intent that can only be sent
1637 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001638 */
1639 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1640 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1641 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001642 * @hide
1643 * Broadcast Action: Ask system services if there is any reason to
1644 * restart the given package. The data contains the name of the
1645 * package.
1646 * <ul>
1647 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1648 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1649 * </ul>
1650 *
1651 * <p class="note">This is a protected intent that can only be sent
1652 * by the system.
1653 */
1654 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1655 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1656 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001657 * Broadcast Action: The user has restarted a package, and all of its
1658 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001659 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001660 * be removed. Note that the restarted package does <em>not</em>
1661 * receive this broadcast.
1662 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001663 * <ul>
1664 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1665 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001666 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001667 * <p class="note">This is a protected intent that can only be sent
1668 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001669 */
1670 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1671 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1672 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001673 * Broadcast Action: The user has cleared the data of a package. This should
1674 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001675 * its persistent data is erased and this broadcast sent.
1676 * Note that the cleared package does <em>not</em>
1677 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001678 * <ul>
1679 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1680 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001681 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001682 * <p class="note">This is a protected intent that can only be sent
1683 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001684 */
1685 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1686 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1687 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001688 * Broadcast Action: A user ID has been removed from the system. The user
1689 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001690 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001691 * <p class="note">This is a protected intent that can only be sent
1692 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001693 */
1694 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1695 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001696
1697 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001698 * Broadcast Action: Sent to the installer package of an application
1699 * when that application is first launched (that is the first time it
1700 * is moved out of the stopped state). The data contains the name of the package.
1701 *
1702 * <p class="note">This is a protected intent that can only be sent
1703 * by the system.
1704 */
1705 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1706 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1707
1708 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001709 * Broadcast Action: Sent to the system package verifier when a package
1710 * needs to be verified. The data contains the package URI.
1711 * <p class="note">
1712 * This is a protected intent that can only be sent by the system.
1713 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001714 */
1715 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1716 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1717
1718 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001719 * Broadcast Action: Sent to the system package verifier when a package is
1720 * verified. The data contains the package URI.
1721 * <p class="note">
1722 * This is a protected intent that can only be sent by the system.
1723 */
1724 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1725 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1726
1727 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001728 * Broadcast Action: Resources for a set of packages (which were
1729 * previously unavailable) are currently
1730 * available since the media on which they exist is available.
1731 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1732 * list of packages whose availability changed.
1733 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1734 * list of uids of packages whose availability changed.
1735 * Note that the
1736 * packages in this list do <em>not</em> receive this broadcast.
1737 * The specified set of packages are now available on the system.
1738 * <p>Includes the following extras:
1739 * <ul>
1740 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1741 * whose resources(were previously unavailable) are currently available.
1742 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1743 * packages whose resources(were previously unavailable)
1744 * are currently available.
1745 * </ul>
1746 *
1747 * <p class="note">This is a protected intent that can only be sent
1748 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001749 */
1750 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001751 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1752 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001753
1754 /**
1755 * Broadcast Action: Resources for a set of packages are currently
1756 * unavailable since the media on which they exist is unavailable.
1757 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1758 * list of packages whose availability changed.
1759 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1760 * list of uids of packages whose availability changed.
1761 * The specified set of packages can no longer be
1762 * launched and are practically unavailable on the system.
1763 * <p>Inclues the following extras:
1764 * <ul>
1765 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1766 * whose resources are no longer available.
1767 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1768 * whose resources are no longer available.
1769 * </ul>
1770 *
1771 * <p class="note">This is a protected intent that can only be sent
1772 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001773 */
1774 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001775 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001776 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001777
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001778 /**
1779 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001780 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001781 * This should <em>only</em> be used to determine when the wallpaper
1782 * has changed to show the new wallpaper to the user. You should certainly
1783 * never, in response to this, change the wallpaper or other attributes of
1784 * it such as the suggested size. That would be crazy, right? You'd cause
1785 * all kinds of loops, especially if other apps are doing similar things,
1786 * right? Of course. So please don't do this.
1787 *
1788 * @deprecated Modern applications should use
1789 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1790 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1791 * shown behind their UI, rather than watching for this broadcast and
1792 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001793 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001794 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001795 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1796 /**
1797 * Broadcast Action: The current device {@link android.content.res.Configuration}
1798 * (orientation, locale, etc) has changed. When such a change happens, the
1799 * UIs (view hierarchy) will need to be rebuilt based on this new
1800 * information; for the most part, applications don't need to worry about
1801 * this, because the system will take care of stopping and restarting the
1802 * application to make sure it sees the new changes. Some system code that
1803 * can not be restarted will need to watch for this action and handle it
1804 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001805 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001806 * <p class="note">
1807 * You can <em>not</em> receive this through components declared
1808 * in manifests, only by explicitly registering for it with
1809 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1810 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001811 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001812 * <p class="note">This is a protected intent that can only be sent
1813 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001814 *
1815 * @see android.content.res.Configuration
1816 */
1817 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1818 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1819 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001820 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001821 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001822 * <p class="note">This is a protected intent that can only be sent
1823 * by the system.
1824 */
1825 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1826 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1827 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001828 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1829 * charging state, level, and other information about the battery.
1830 * See {@link android.os.BatteryManager} for documentation on the
1831 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001832 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001833 * <p class="note">
1834 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001835 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001836 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001837 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1838 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1839 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1840 * broadcasts that are sent and can be received through manifest
1841 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001842 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001843 * <p class="note">This is a protected intent that can only be sent
1844 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1848 /**
1849 * Broadcast Action: Indicates low battery condition on the device.
1850 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001851 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001852 * <p class="note">This is a protected intent that can only be sent
1853 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001854 */
1855 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1856 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1857 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001858 * Broadcast Action: Indicates the battery is now okay after being low.
1859 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1860 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001861 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001862 * <p class="note">This is a protected intent that can only be sent
1863 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001864 */
1865 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1866 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1867 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001868 * Broadcast Action: External power has been connected to the device.
1869 * This is intended for applications that wish to register specifically to this notification.
1870 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1871 * stay active to receive this notification. This action can be used to implement actions
1872 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001873 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001874 * <p class="note">This is a protected intent that can only be sent
1875 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001876 */
1877 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001878 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001879 /**
1880 * Broadcast Action: External power has been removed from the device.
1881 * This is intended for applications that wish to register specifically to this notification.
1882 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1883 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001884 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001885 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001886 * <p class="note">This is a protected intent that can only be sent
1887 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001888 */
1889 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001890 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001891 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001892 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001893 * Broadcast Action: Device is shutting down.
1894 * This is broadcast when the device is being shut down (completely turned
1895 * off, not sleeping). Once the broadcast is complete, the final shutdown
1896 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001897 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001898 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001899 * <p class="note">This is a protected intent that can only be sent
1900 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001901 * <p>May include the following extras:
1902 * <ul>
1903 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1904 * shutdown is only for userspace processes. If not set, assumed to be false.
1905 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001906 */
1907 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001908 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001909 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001910 * Activity Action: Start this activity to request system shutdown.
1911 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1912 * to request confirmation from the user before shutting down.
1913 *
1914 * <p class="note">This is a protected intent that can only be sent
1915 * by the system.
1916 *
1917 * {@hide}
1918 */
1919 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1920 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001921 * Broadcast Action: A sticky broadcast that indicates low memory
1922 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001923 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001924 * <p class="note">This is a protected intent that can only be sent
1925 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1929 /**
1930 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001931 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001932 * <p class="note">This is a protected intent that can only be sent
1933 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001934 */
1935 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1936 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1937 /**
Jake Hambybb371632010-08-23 18:16:48 -07001938 * Broadcast Action: A sticky broadcast that indicates a memory full
1939 * condition on the device. This is intended for activities that want
1940 * to be able to fill the data partition completely, leaving only
1941 * enough free space to prevent system-wide SQLite failures.
1942 *
1943 * <p class="note">This is a protected intent that can only be sent
1944 * by the system.
1945 *
1946 * {@hide}
1947 */
1948 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1949 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1950 /**
1951 * Broadcast Action: Indicates memory full condition on the device
1952 * no longer exists.
1953 *
1954 * <p class="note">This is a protected intent that can only be sent
1955 * by the system.
1956 *
1957 * {@hide}
1958 */
1959 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1960 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1961 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001962 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1963 * and package management should be started.
1964 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1965 * notification.
1966 */
1967 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1968 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1969 /**
1970 * Broadcast Action: The device has entered USB Mass Storage mode.
1971 * This is used mainly for the USB Settings panel.
1972 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1973 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001974 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001975 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001976 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001977 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1978
1979 /**
1980 * Broadcast Action: The device has exited USB Mass Storage mode.
1981 * This is used mainly for the USB Settings panel.
1982 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1983 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001984 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001985 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001986 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001987 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1988
1989 /**
1990 * Broadcast Action: External media has been removed.
1991 * The path to the mount point for the removed media is contained in the Intent.mData field.
1992 */
1993 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1994 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1995
1996 /**
1997 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001998 * The path to the mount point for the unmounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2002
2003 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002004 * Broadcast Action: External media is present, and being disk-checked
2005 * 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 -08002006 */
2007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2008 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2009
2010 /**
2011 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2012 * 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 -08002013 */
2014 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2015 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2016
2017 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002018 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002019 * The path to the mount point for the mounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002020 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2021 * media was mounted read only.
2022 */
2023 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2024 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2025
2026 /**
2027 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002028 * 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 -07002029 */
2030 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2031 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2032
2033 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002034 * Broadcast Action: External media is no longer being shared via USB mass storage.
2035 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2036 *
2037 * @hide
2038 */
2039 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2040
2041 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002042 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2043 * The path to the mount point for the removed media is contained in the Intent.mData field.
2044 */
2045 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2046 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2047
2048 /**
2049 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002050 * The path to the mount point for the unmountable media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002051 */
2052 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2053 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2054
2055 /**
2056 * Broadcast Action: User has expressed the desire to remove the external storage media.
2057 * Applications should close all files they have open within the mount point when they receive this intent.
2058 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2059 */
2060 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2061 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2062
2063 /**
2064 * Broadcast Action: The media scanner has started scanning a directory.
2065 * The path to the directory being scanned is contained in the Intent.mData field.
2066 */
2067 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2068 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2069
2070 /**
2071 * Broadcast Action: The media scanner has finished scanning a directory.
2072 * The path to the scanned directory is contained in the Intent.mData field.
2073 */
2074 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2075 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2076
2077 /**
2078 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2079 * The path to the file is contained in the Intent.mData field.
2080 */
2081 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2082 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2083
2084 /**
2085 * Broadcast Action: The "Media Button" was pressed. Includes a single
2086 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2087 * caused the broadcast.
2088 */
2089 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2090 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2091
2092 /**
2093 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2094 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2095 * caused the broadcast.
2096 */
2097 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2098 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2099
2100 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2101 // location; they are not general-purpose actions.
2102
2103 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002104 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002105 */
2106 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2107 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2108 "android.intent.action.GTALK_CONNECTED";
2109
2110 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002111 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002112 */
2113 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2114 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2115 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002116
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002117 /**
2118 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002119 */
2120 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2121 public static final String ACTION_INPUT_METHOD_CHANGED =
2122 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002123
2124 /**
2125 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2126 * more radios have been turned off or on. The intent will have the following extra value:</p>
2127 * <ul>
2128 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2129 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2130 * turned off</li>
2131 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002132 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002133 * <p class="note">This is a protected intent that can only be sent
2134 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002135 */
2136 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2137 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2138
2139 /**
2140 * Broadcast Action: Some content providers have parts of their namespace
2141 * where they publish new events or items that the user may be especially
2142 * interested in. For these things, they may broadcast this action when the
2143 * set of interesting items change.
2144 *
2145 * For example, GmailProvider sends this notification when the set of unread
2146 * mail in the inbox changes.
2147 *
2148 * <p>The data of the intent identifies which part of which provider
2149 * changed. When queried through the content resolver, the data URI will
2150 * return the data set in question.
2151 *
2152 * <p>The intent will have the following extra values:
2153 * <ul>
2154 * <li><em>count</em> - The number of items in the data set. This is the
2155 * same as the number of items in the cursor returned by querying the
2156 * data URI. </li>
2157 * </ul>
2158 *
2159 * This intent will be sent at boot (if the count is non-zero) and when the
2160 * data set changes. It is possible for the data set to change without the
2161 * count changing (for example, if a new unread message arrives in the same
2162 * sync operation in which a message is archived). The phone should still
2163 * ring/vibrate/etc as normal in this case.
2164 */
2165 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2166 public static final String ACTION_PROVIDER_CHANGED =
2167 "android.intent.action.PROVIDER_CHANGED";
2168
2169 /**
2170 * Broadcast Action: Wired Headset plugged in or unplugged.
2171 *
2172 * <p>The intent will have the following extra values:
2173 * <ul>
2174 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2175 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002176 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002177 * </ul>
2178 * </ul>
2179 */
2180 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2181 public static final String ACTION_HEADSET_PLUG =
2182 "android.intent.action.HEADSET_PLUG";
2183
2184 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002185 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2186 *
2187 * <p>The intent will have the following extra values:
2188 * <ul>
2189 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2190 * <li><em>name</em> - Headset type, human readable string </li>
2191 * </ul>
2192 * </ul>
2193 * @hide
2194 */
2195 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002196 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2197 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002198
2199 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002200 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002201 *
2202 * <p>The intent will have the following extra values:
2203 * <ul>
2204 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2205 * <li><em>name</em> - Headset type, human readable string </li>
2206 * </ul>
2207 * </ul>
2208 * @hide
2209 */
2210 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002211 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2212 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002213
2214 /**
2215 * Broadcast Action: A HMDI cable was plugged or unplugged
2216 *
2217 * <p>The intent will have the following extra values:
2218 * <ul>
2219 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2220 * <li><em>name</em> - HDMI cable, human readable string </li>
2221 * </ul>
2222 * </ul>
2223 * @hide
2224 */
2225 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2226 public static final String ACTION_HDMI_AUDIO_PLUG =
2227 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002228
2229 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002230 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2231 *
2232 * <p>The intent will have the following extra values:
2233 * <ul>
2234 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2235 * <li><em>card</em> - ALSA card number (integer) </li>
2236 * <li><em>device</em> - ALSA device number (integer) </li>
2237 * </ul>
2238 * </ul>
2239 * @hide
2240 */
2241 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2242 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2243 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2244
2245 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002246 * Broadcast Action: A USB audio device was plugged in or unplugged.
2247 *
2248 * <p>The intent will have the following extra values:
2249 * <ul>
2250 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2251 * <li><em>card</em> - ALSA card number (integer) </li>
2252 * <li><em>device</em> - ALSA device number (integer) </li>
2253 * </ul>
2254 * </ul>
2255 * @hide
2256 */
2257 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2258 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2259 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2260
2261 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002262 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2263 * <ul>
2264 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2265 * </ul>
2266 *
2267 * <p class="note">This is a protected intent that can only be sent
2268 * by the system.
2269 *
2270 * @hide
2271 */
2272 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2273 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2274 = "android.intent.action.ADVANCED_SETTINGS";
2275
2276 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002277 * Broadcast Action: An outgoing call is about to be placed.
2278 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002279 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002280 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002281 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002282 * the phone number originally intended to be dialed.</li>
2283 * </ul>
2284 * <p>Once the broadcast is finished, the resultData is used as the actual
2285 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002286 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002287 * outgoing call in turn: for example, a parental control application
2288 * might verify that the user is authorized to place the call at that
2289 * time, then a number-rewriting application might add an area code if
2290 * one was not specified.</p>
2291 * <p>For consistency, any receiver whose purpose is to prohibit phone
2292 * calls should have a priority of 0, to ensure it will see the final
2293 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002294 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002295 * should have a positive priority.
2296 * Negative priorities are reserved for the system for this broadcast;
2297 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002298 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2299 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002300 * <p>Emergency calls cannot be intercepted using this mechanism, and
2301 * other calls cannot be modified to call emergency numbers using this
2302 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002303 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2304 * call to use their own service instead. Those apps should first prevent
2305 * the call from being placed by setting resultData to <code>null</code>
2306 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002307 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002308 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2309 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002310 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002311 * <p class="note">This is a protected intent that can only be sent
2312 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002313 */
2314 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2315 public static final String ACTION_NEW_OUTGOING_CALL =
2316 "android.intent.action.NEW_OUTGOING_CALL";
2317
2318 /**
2319 * Broadcast Action: Have the device reboot. This is only for use by
2320 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002321 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002322 * <p class="note">This is a protected intent that can only be sent
2323 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002324 */
2325 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2326 public static final String ACTION_REBOOT =
2327 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002328
Wei Huang97ecc9c2009-05-11 17:44:20 -07002329 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002330 * Broadcast Action: A sticky broadcast for changes in the physical
2331 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002332 *
2333 * <p>The intent will have the following extra values:
2334 * <ul>
2335 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002336 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002337 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002338 * <p>This is intended for monitoring the current physical dock state.
2339 * See {@link android.app.UiModeManager} for the normal API dealing with
2340 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002341 */
2342 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2343 public static final String ACTION_DOCK_EVENT =
2344 "android.intent.action.DOCK_EVENT";
2345
2346 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002347 * Broadcast Action: A broadcast when idle maintenance can be started.
2348 * This means that the user is not interacting with the device and is
2349 * not expected to do so soon. Typical use of the idle maintenance is
2350 * to perform somehow expensive tasks that can be postponed at a moment
2351 * when they will not degrade user experience.
2352 * <p>
2353 * <p class="note">In order to keep the device responsive in case of an
2354 * unexpected user interaction, implementations of a maintenance task
2355 * should be interruptible. In such a scenario a broadcast with action
2356 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2357 * should not do the maintenance work in
2358 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2359 * maintenance service by {@link Context#startService(Intent)}. Also
2360 * you should hold a wake lock while your maintenance service is running
2361 * to prevent the device going to sleep.
2362 * </p>
2363 * <p>
2364 * <p class="note">This is a protected intent that can only be sent by
2365 * the system.
2366 * </p>
2367 *
2368 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002369 *
2370 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002371 */
2372 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2373 public static final String ACTION_IDLE_MAINTENANCE_START =
2374 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2375
2376 /**
2377 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2378 * This means that the user was not interacting with the device as a result
2379 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2380 * was sent and now the user started interacting with the device. Typical
2381 * use of the idle maintenance is to perform somehow expensive tasks that
2382 * can be postponed at a moment when they will not degrade user experience.
2383 * <p>
2384 * <p class="note">In order to keep the device responsive in case of an
2385 * unexpected user interaction, implementations of a maintenance task
2386 * should be interruptible. Hence, on receiving a broadcast with this
2387 * action, the maintenance task should be interrupted as soon as possible.
2388 * In other words, you should not do the maintenance work in
2389 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2390 * maintenance service that was started on receiving of
2391 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2392 * lock you acquired when your maintenance service started.
2393 * </p>
2394 * <p class="note">This is a protected intent that can only be sent
2395 * by the system.
2396 *
2397 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002398 *
2399 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002400 */
2401 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2402 public static final String ACTION_IDLE_MAINTENANCE_END =
2403 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2404
2405 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002406 * Broadcast Action: a remote intent is to be broadcasted.
2407 *
2408 * A remote intent is used for remote RPC between devices. The remote intent
2409 * is serialized and sent from one device to another device. The receiving
2410 * device parses the remote intent and broadcasts it. Note that anyone can
2411 * broadcast a remote intent. However, if the intent receiver of the remote intent
2412 * does not trust intent broadcasts from arbitrary intent senders, it should require
2413 * the sender to hold certain permissions so only trusted sender's broadcast will be
2414 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002415 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002416 */
2417 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002418 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002419
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002420 /**
2421 * Broadcast Action: hook for permforming cleanup after a system update.
2422 *
2423 * The broadcast is sent when the system is booting, before the
2424 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2425 * image. A receiver for this should do its work and then disable itself
2426 * so that it does not get run again at the next boot.
2427 * @hide
2428 */
2429 public static final String ACTION_PRE_BOOT_COMPLETED =
2430 "android.intent.action.PRE_BOOT_COMPLETED";
2431
Amith Yamasani13593602012-03-22 16:16:17 -07002432 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002433 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002434 * on restricted users. The broadcast intent contains an extra
2435 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2436 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2437 * String[] depending on the restriction type.<p/>
2438 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002439 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2440 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2441 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002442 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2443 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002444 * @see RestrictionEntry
2445 */
2446 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2447 "android.intent.action.GET_RESTRICTION_ENTRIES";
2448
2449 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002450 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002451 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002452 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2453 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2454 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002455 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2456 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2457 * challenge.<p/>
2458 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002459 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002460 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002461 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2462 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002463
2464 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002465 * Sent the first time a user is starting, to allow system apps to
2466 * perform one time initialization. (This will not be seen by third
2467 * party applications because a newly initialized user does not have any
2468 * third party applications installed for it.) This is sent early in
2469 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002470 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2471 * broadcast, since it is part of a visible user interaction; be as quick
2472 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002473 */
2474 public static final String ACTION_USER_INITIALIZE =
2475 "android.intent.action.USER_INITIALIZE";
2476
2477 /**
2478 * Sent when a user switch is happening, causing the process's user to be
2479 * brought to the foreground. This is only sent to receivers registered
2480 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2481 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002482 * foreground. This is sent as a foreground
2483 * broadcast, since it is part of a visible user interaction; be as quick
2484 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002485 */
2486 public static final String ACTION_USER_FOREGROUND =
2487 "android.intent.action.USER_FOREGROUND";
2488
2489 /**
2490 * Sent when a user switch is happening, causing the process's user to be
2491 * sent to the background. This is only sent to receivers registered
2492 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2493 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002494 * background. This is sent as a foreground
2495 * broadcast, since it is part of a visible user interaction; be as quick
2496 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002497 */
2498 public static final String ACTION_USER_BACKGROUND =
2499 "android.intent.action.USER_BACKGROUND";
2500
2501 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002502 * Broadcast sent to the system when a user is added. Carries an extra
2503 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2504 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002505 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002506 * @hide
2507 */
2508 public static final String ACTION_USER_ADDED =
2509 "android.intent.action.USER_ADDED";
2510
2511 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002512 * Broadcast sent by the system when a user is started. Carries an extra
2513 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002514 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002515 * that has been started. This is sent as a foreground
2516 * broadcast, since it is part of a visible user interaction; be as quick
2517 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002518 * @hide
2519 */
2520 public static final String ACTION_USER_STARTED =
2521 "android.intent.action.USER_STARTED";
2522
2523 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002524 * Broadcast sent when a user is in the process of starting. Carries an extra
2525 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2526 * sent to registered receivers, not manifest receivers. It is sent to all
2527 * users (including the one that is being started). You must hold
2528 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2529 * this broadcast. This is sent as a background broadcast, since
2530 * its result is not part of the primary UX flow; to safely keep track of
2531 * started/stopped state of a user you can use this in conjunction with
2532 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2533 * other user state broadcasts since those are foreground broadcasts so can
2534 * execute in a different order.
2535 * @hide
2536 */
2537 public static final String ACTION_USER_STARTING =
2538 "android.intent.action.USER_STARTING";
2539
2540 /**
2541 * Broadcast sent when a user is going to be stopped. Carries an extra
2542 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2543 * sent to registered receivers, not manifest receivers. It is sent to all
2544 * users (including the one that is being stopped). You must hold
2545 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2546 * this broadcast. The user will not stop until all receivers have
2547 * handled the broadcast. This is sent as a background broadcast, since
2548 * its result is not part of the primary UX flow; to safely keep track of
2549 * started/stopped state of a user you can use this in conjunction with
2550 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2551 * other user state broadcasts since those are foreground broadcasts so can
2552 * execute in a different order.
2553 * @hide
2554 */
2555 public static final String ACTION_USER_STOPPING =
2556 "android.intent.action.USER_STOPPING";
2557
2558 /**
2559 * Broadcast sent to the system when a user is stopped. Carries an extra
2560 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2561 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2562 * specific package. This is only sent to registered receivers, not manifest
2563 * receivers. It is sent to all running users <em>except</em> the one that
2564 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002565 * @hide
2566 */
2567 public static final String ACTION_USER_STOPPED =
2568 "android.intent.action.USER_STOPPED";
2569
2570 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002571 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002572 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002573 * one that has been removed. The user will not be completely removed until all receivers have
2574 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002575 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002576 * @hide
2577 */
2578 public static final String ACTION_USER_REMOVED =
2579 "android.intent.action.USER_REMOVED";
2580
2581 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002582 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002583 * the userHandle of the user to become the current one. This is only sent to
2584 * registered receivers, not manifest receivers. It is sent to all running users.
2585 * You must hold
2586 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002587 * @hide
2588 */
2589 public static final String ACTION_USER_SWITCHED =
2590 "android.intent.action.USER_SWITCHED";
2591
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002592 /**
2593 * Broadcast sent to the system when a user's information changes. Carries an extra
2594 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002595 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002596 * @hide
2597 */
2598 public static final String ACTION_USER_INFO_CHANGED =
2599 "android.intent.action.USER_INFO_CHANGED";
2600
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002601 /**
2602 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2603 */
2604 public static final String ACTION_QUICK_CLOCK =
2605 "android.intent.action.QUICK_CLOCK";
2606
Michael Wright0087a142013-02-05 16:29:39 -08002607 /**
2608 * Broadcast Action: This is broadcast when a user action should request the
2609 * brightness setting dialog.
2610 * @hide
2611 */
2612 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2613 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2614
Justin Kohd378ad72013-04-01 12:18:26 -07002615 /**
2616 * Broadcast Action: A global button was pressed. Includes a single
2617 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2618 * caused the broadcast.
2619 * @hide
2620 */
2621 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2622
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002623 /**
2624 * Activity Action: Allow the user to select and open one or more existing
2625 * documents. Both read and write access to the documents will be granted
2626 * until explicitly revoked by the user.
2627 * <p>
2628 * Callers can restrict selection to a specific kind of data, such as
2629 * photos, by setting one or more MIME types in {@link #EXTRA_MIME_TYPES}.
2630 * <p>
2631 * If the caller can handle multiple returned items (the user performing
2632 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE} to
2633 * indicate this.
2634 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002635 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2636 * returned URIs can be opened with
2637 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002638 * <p>
2639 * Output: The URI of the item that was picked. This must be a content: URI
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002640 * so that any receiver can access it. If multiple documents were selected,
2641 * they are returned in {@link #getClipData()}.
2642 *
2643 * @see DocumentsContract
2644 * @see DocumentsContract#getOpenDocuments(Context)
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002645 */
2646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2647 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2648
2649 /**
2650 * Activity Action: Allow the user to create a new document. Both read and
2651 * write access to the document will be granted until explicitly revoked by
2652 * the user.
2653 * <p>
2654 * Callers can provide a hint document name by setting {@link #EXTRA_TITLE},
2655 * but the user may change this value before creating the file. Callers can
2656 * optionally hint at the MIME type being created by setting
2657 * {@link #setType(String)}.
2658 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002659 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2660 * returned URIs can be opened with
2661 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002662 * <p>
2663 * Output: The URI of the item that was created. This must be a content: URI
2664 * so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002665 *
2666 * @see DocumentsContract
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002667 */
2668 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2669 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2670
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002671 // ---------------------------------------------------------------------
2672 // ---------------------------------------------------------------------
2673 // Standard intent categories (see addCategory()).
2674
2675 /**
2676 * Set if the activity should be an option for the default action
2677 * (center press) to perform on a piece of data. Setting this will
2678 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002679 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002680 * Intent when initiating an action -- it is for use in intent filters
2681 * specified in packages.
2682 */
2683 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2684 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2685 /**
2686 * Activities that can be safely invoked from a browser must support this
2687 * category. For example, if the user is viewing a web page or an e-mail
2688 * and clicks on a link in the text, the Intent generated execute that
2689 * link will require the BROWSABLE category, so that only activities
2690 * supporting this category will be considered as possible actions. By
2691 * supporting this category, you are promising that there is nothing
2692 * damaging (without user intervention) that can happen by invoking any
2693 * matching Intent.
2694 */
2695 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2696 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2697 /**
2698 * Set if the activity should be considered as an alternative action to
2699 * the data the user is currently viewing. See also
2700 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2701 * applies to the selection in a list of items.
2702 *
2703 * <p>Supporting this category means that you would like your activity to be
2704 * displayed in the set of alternative things the user can do, usually as
2705 * part of the current activity's options menu. You will usually want to
2706 * include a specific label in the &lt;intent-filter&gt; of this action
2707 * describing to the user what it does.
2708 *
2709 * <p>The action of IntentFilter with this category is important in that it
2710 * describes the specific action the target will perform. This generally
2711 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2712 * a specific name such as "com.android.camera.action.CROP. Only one
2713 * alternative of any particular action will be shown to the user, so using
2714 * a specific action like this makes sure that your alternative will be
2715 * displayed while also allowing other applications to provide their own
2716 * overrides of that particular action.
2717 */
2718 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2719 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2720 /**
2721 * Set if the activity should be considered as an alternative selection
2722 * action to the data the user has currently selected. This is like
2723 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2724 * of items from which the user can select, giving them alternatives to the
2725 * default action that will be performed on it.
2726 */
2727 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2728 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2729 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002730 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002731 */
2732 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2733 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2734 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002735 * Should be displayed in the top-level launcher.
2736 */
2737 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2738 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2739 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002740 * Provides information about the package it is in; typically used if
2741 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2742 * a front-door to the user without having to be shown in the all apps list.
2743 */
2744 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2745 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2746 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002747 * This is the home activity, that is the first activity that is displayed
2748 * when the device boots.
2749 */
2750 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2751 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2752 /**
2753 * This activity is a preference panel.
2754 */
2755 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2756 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2757 /**
2758 * This activity is a development preference panel.
2759 */
2760 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2761 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2762 /**
2763 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002764 */
2765 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2766 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2767 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002768 * This activity allows the user to browse and download new applications.
2769 */
2770 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2771 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2772 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002773 * This activity may be exercised by the monkey or other automated test tools.
2774 */
2775 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2776 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2777 /**
2778 * To be used as a test (not part of the normal user experience).
2779 */
2780 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2781 /**
2782 * To be used as a unit test (run through the Test Harness).
2783 */
2784 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2785 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002786 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002787 * experience).
2788 */
2789 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2790 /**
2791 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
Dianne Hackborna53ee352013-02-20 12:47:02 -08002792 * ContentResolver.openInputStream. Openable URIs must support the columns in
2793 * {@link android.provider.OpenableColumns}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002794 * when queried, though it is allowable for those columns to be blank.
2795 */
2796 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2797 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2798
2799 /**
2800 * To be used as code under test for framework instrumentation tests.
2801 */
2802 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2803 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002804 /**
2805 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002806 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2807 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002808 */
2809 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2810 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2811 /**
2812 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002813 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2814 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002815 */
2816 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2817 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002818 /**
2819 * An activity to run when device is inserted into a analog (low end) dock.
2820 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2821 * information, see {@link android.app.UiModeManager}.
2822 */
2823 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2824 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2825
2826 /**
2827 * An activity to run when device is inserted into a digital (high end) dock.
2828 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2829 * information, see {@link android.app.UiModeManager}.
2830 */
2831 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2832 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002833
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002834 /**
2835 * Used to indicate that the activity can be used in a car environment.
2836 */
2837 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2838 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2839
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002840 // ---------------------------------------------------------------------
2841 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002842 // Application launch intent categories (see addCategory()).
2843
2844 /**
2845 * Used with {@link #ACTION_MAIN} to launch the browser application.
2846 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002847 * <p>NOTE: This should not be used as the primary key of an Intent,
2848 * since it will not result in the app launching with the correct
2849 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002850 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002851 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002852 */
2853 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2854 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2855
2856 /**
2857 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2858 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002859 * <p>NOTE: This should not be used as the primary key of an Intent,
2860 * since it will not result in the app launching with the correct
2861 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002862 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002863 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002864 */
2865 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2866 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2867
2868 /**
2869 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2870 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002871 * <p>NOTE: This should not be used as the primary key of an Intent,
2872 * since it will not result in the app launching with the correct
2873 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002874 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002875 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002876 */
2877 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2878 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2879
2880 /**
2881 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2882 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002883 * <p>NOTE: This should not be used as the primary key of an Intent,
2884 * since it will not result in the app launching with the correct
2885 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002886 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002887 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002888 */
2889 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2890 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2891
2892 /**
2893 * Used with {@link #ACTION_MAIN} to launch the email application.
2894 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002895 * <p>NOTE: This should not be used as the primary key of an Intent,
2896 * since it will not result in the app launching with the correct
2897 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002898 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002899 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002900 */
2901 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2902 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2903
2904 /**
2905 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2906 * The activity should be able to view and manipulate image and video files
2907 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002908 * <p>NOTE: This should not be used as the primary key of an Intent,
2909 * since it will not result in the app launching with the correct
2910 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002911 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002912 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002913 */
2914 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2915 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2916
2917 /**
2918 * Used with {@link #ACTION_MAIN} to launch the maps application.
2919 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002920 * <p>NOTE: This should not be used as the primary key of an Intent,
2921 * since it will not result in the app launching with the correct
2922 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002923 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002924 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002925 */
2926 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2927 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2928
2929 /**
2930 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2931 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002932 * <p>NOTE: This should not be used as the primary key of an Intent,
2933 * since it will not result in the app launching with the correct
2934 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002935 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002936 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002937 */
2938 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2939 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2940
2941 /**
2942 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002943 * The activity should be able to play, browse, or manipulate music files
2944 * stored on the device.
2945 * <p>NOTE: This should not be used as the primary key of an Intent,
2946 * since it will not result in the app launching with the correct
2947 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002948 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002949 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002950 */
2951 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2952 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2953
2954 // ---------------------------------------------------------------------
2955 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002956 // Standard extra data keys.
2957
2958 /**
2959 * The initial data to place in a newly created record. Use with
2960 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2961 * fields as would be given to the underlying ContentProvider.insert()
2962 * call.
2963 */
2964 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2965
2966 /**
2967 * A constant CharSequence that is associated with the Intent, used with
2968 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2969 * this may be a styled CharSequence, so you must use
2970 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2971 * retrieve it.
2972 */
2973 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2974
2975 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002976 * A constant String that is associated with the Intent, used with
2977 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2978 * as HTML formatted text. Note that you <em>must</em> also supply
2979 * {@link #EXTRA_TEXT}.
2980 */
2981 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2982
2983 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002984 * A content: URI holding a stream of data associated with the Intent,
2985 * used with {@link #ACTION_SEND} to supply the data being sent.
2986 */
2987 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2988
2989 /**
2990 * A String[] holding e-mail addresses that should be delivered to.
2991 */
2992 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2993
2994 /**
2995 * A String[] holding e-mail addresses that should be carbon copied.
2996 */
2997 public static final String EXTRA_CC = "android.intent.extra.CC";
2998
2999 /**
3000 * A String[] holding e-mail addresses that should be blind carbon copied.
3001 */
3002 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3003
3004 /**
3005 * A constant string holding the desired subject line of a message.
3006 */
3007 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3008
3009 /**
3010 * An Intent describing the choices you would like shown with
3011 * {@link #ACTION_PICK_ACTIVITY}.
3012 */
3013 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3014
3015 /**
3016 * A CharSequence dialog title to provide to the user when used with a
3017 * {@link #ACTION_CHOOSER}.
3018 */
3019 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3020
3021 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003022 * A Parcelable[] of {@link Intent} or
3023 * {@link android.content.pm.LabeledIntent} objects as set with
3024 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3025 * a the front of the list of choices, when shown to the user with a
3026 * {@link #ACTION_CHOOSER}.
3027 */
3028 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3029
3030 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003031 * A {@link android.view.KeyEvent} object containing the event that
3032 * triggered the creation of the Intent it is in.
3033 */
3034 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3035
3036 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003037 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3038 * before shutting down.
3039 *
3040 * {@hide}
3041 */
3042 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3043
3044 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003045 * 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 -07003046 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3047 * of restarting the application.
3048 */
3049 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3050
3051 /**
3052 * A String holding the phone number originally entered in
3053 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3054 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3055 */
3056 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003057
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003058 /**
3059 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3060 * intents to supply the uid the package had been assigned. Also an optional
3061 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3062 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3063 * purpose.
3064 */
3065 public static final String EXTRA_UID = "android.intent.extra.UID";
3066
3067 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003068 * @hide String array of package names.
3069 */
3070 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3071
3072 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003073 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3074 * intents to indicate whether this represents a full uninstall (removing
3075 * both the code and its data) or a partial uninstall (leaving its data,
3076 * implying that this is an update).
3077 */
3078 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003079
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003080 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003081 * @hide
3082 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3083 * intents to indicate that at this point the package has been removed for
3084 * all users on the device.
3085 */
3086 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3087 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3088
3089 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003090 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3091 * intents to indicate that this is a replacement of the package, so this
3092 * broadcast will immediately be followed by an add broadcast for a
3093 * different version of the same package.
3094 */
3095 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003096
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003097 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003098 * Used as an int extra field in {@link android.app.AlarmManager} intents
3099 * to tell the application being invoked how many pending alarms are being
3100 * delievered with the intent. For one-shot alarms this will always be 1.
3101 * For recurring alarms, this might be greater than 1 if the device was
3102 * asleep or powered off at the time an earlier alarm would have been
3103 * delivered.
3104 */
3105 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003106
Jacek Surazski86b6c532009-05-13 14:38:28 +02003107 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003108 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3109 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003110 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3111 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003112 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3113 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3114 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003115 */
3116 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3117
3118 /**
3119 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3120 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003121 */
3122 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3123
3124 /**
3125 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3126 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003127 */
3128 public static final int EXTRA_DOCK_STATE_DESK = 1;
3129
3130 /**
3131 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3132 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003133 */
3134 public static final int EXTRA_DOCK_STATE_CAR = 2;
3135
3136 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003137 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3138 * to represent that the phone is in a analog (low end) dock.
3139 */
3140 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3141
3142 /**
3143 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3144 * to represent that the phone is in a digital (high end) dock.
3145 */
3146 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3147
3148 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003149 * Boolean that can be supplied as meta-data with a dock activity, to
3150 * indicate that the dock should take over the home key when it is active.
3151 */
3152 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003153
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003154 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003155 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3156 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003157 */
3158 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3159
3160 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003161 * Used in the extra field in the remote intent. It's astring token passed with the
3162 * remote intent.
3163 */
3164 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3165 "android.intent.extra.remote_intent_token";
3166
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003167 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003168 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003169 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003170 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003171 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003172 "android.intent.extra.changed_component_name";
3173
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003174 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003175 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003176 * and contains a string array of all of the components that have changed. If
3177 * the state of the overall package has changed, then it will contain an entry
3178 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003179 */
3180 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3181 "android.intent.extra.changed_component_name_list";
3182
3183 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003184 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003185 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3186 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003187 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003188 */
3189 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3190 "android.intent.extra.changed_package_list";
3191
3192 /**
3193 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003194 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3195 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003196 * and contains an integer array of uids of all of the components
3197 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003198 */
3199 public static final String EXTRA_CHANGED_UID_LIST =
3200 "android.intent.extra.changed_uid_list";
3201
3202 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003203 * @hide
3204 * Magic extra system code can use when binding, to give a label for
3205 * who it is that has bound to a service. This is an integer giving
3206 * a framework string resource that can be displayed to the user.
3207 */
3208 public static final String EXTRA_CLIENT_LABEL =
3209 "android.intent.extra.client_label";
3210
3211 /**
3212 * @hide
3213 * Magic extra system code can use when binding, to give a PendingIntent object
3214 * that can be launched for the user to disable the system's use of this
3215 * service.
3216 */
3217 public static final String EXTRA_CLIENT_INTENT =
3218 "android.intent.extra.client_intent";
3219
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003220 /**
3221 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3222 * data that is on the local device. This is a boolean extra; the default
3223 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3224 * the user to select media that is already on the device, not requiring it
3225 * be downloaded from a remote service when opened. Another way to look
3226 * at it is that such content should generally have a "_data" column to the
3227 * path of the content on local external storage.
3228 */
3229 public static final String EXTRA_LOCAL_ONLY =
3230 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003231
Amith Yamasani13593602012-03-22 16:16:17 -07003232 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003233 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3234 * user to select and return multiple items. This is a boolean extra; the default
3235 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3236 * present the user with a UI where they can pick multiple items that are all
3237 * returned to the caller. When this happens, they should be returned as
3238 * the {@link #getClipData()} part of the result Intent.
3239 */
3240 public static final String EXTRA_ALLOW_MULTIPLE =
3241 "android.intent.extra.ALLOW_MULTIPLE";
3242
3243 /**
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003244 * The userHandle carried with broadcast intents related to addition, removal and switching of
3245 * users
Amith Yamasani13593602012-03-22 16:16:17 -07003246 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3247 * @hide
3248 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003249 public static final String EXTRA_USER_HANDLE =
3250 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003251
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003252 /**
3253 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003254 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3255 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003256 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003257 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3258
3259 /**
3260 * Extra sent in the intent to the BroadcastReceiver that handles
3261 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3262 * the restrictions as key/value pairs.
3263 */
3264 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3265 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003266
Amith Yamasani86118ba2013-03-28 14:33:16 -07003267 /**
3268 * Extra used in the response from a BroadcastReceiver that handles
3269 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3270 */
3271 public static final String EXTRA_RESTRICTIONS_INTENT =
3272 "android.intent.extra.restrictions_intent";
3273
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003274 /**
3275 * Extra used to communicate set of acceptable MIME types for
Jeff Sharkey9ab3fd42013-05-01 18:12:12 -07003276 * {@link #ACTION_GET_CONTENT} or {@link #ACTION_OPEN_DOCUMENT}. The type of the
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003277 * extra is <code>ArrayList&lt;String&gt;</code>.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003278 */
3279 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3280
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003281 /**
3282 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3283 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003284 * When this is true, hardware devices can use this information to determine that
3285 * they shouldn't do a complete shutdown of their device since this is not a
3286 * complete shutdown down to the kernel, but only user space restarting.
3287 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003288 */
3289 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3290 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3291
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003292 // ---------------------------------------------------------------------
3293 // ---------------------------------------------------------------------
3294 // Intent flags (see mFlags variable).
3295
3296 /**
3297 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003298 * perform read operations on the Uri in the Intent's data and any URIs
3299 * specified in its ClipData. When applying to an Intent's ClipData,
3300 * all URIs as well as recursive traversals through data or other ClipData
3301 * in Intent items will be granted; only the grant flags of the top-level
3302 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003303 */
3304 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3305 /**
3306 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003307 * perform write operations on the Uri in the Intent's data and any URIs
3308 * specified in its ClipData. When applying to an Intent's ClipData,
3309 * all URIs as well as recursive traversals through data or other ClipData
3310 * in Intent items will be granted; only the grant flags of the top-level
3311 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003312 */
3313 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3314 /**
3315 * Can be set by the caller to indicate that this Intent is coming from
3316 * a background operation, not from direct user interaction.
3317 */
3318 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3319 /**
3320 * A flag you can enable for debugging: when set, log messages will be
3321 * printed during the resolution of this intent to show you what has
3322 * been found to create the final resolved list.
3323 */
3324 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003325 /**
3326 * If set, this intent will not match any components in packages that
3327 * are currently stopped. If this is not set, then the default behavior
3328 * is to include such applications in the result.
3329 */
3330 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3331 /**
3332 * If set, this intent will always match any components in packages that
3333 * are currently stopped. This is the default behavior when
3334 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3335 * flags are set, this one wins (it allows overriding of exclude for
3336 * places where the framework may automatically set the exclude flag).
3337 */
3338 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003339
3340 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003341 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3342 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the grant will be remembered
3343 * until explicitly revoked with
3344 * {@link Context#revokeUriPermission(Uri, int)}. These grants persist
3345 * across device reboots.
3346 */
3347 public static final int FLAG_PERSIST_GRANT_URI_PERMISSION = 0x00000040;
3348
3349 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003350 * If set, the new activity is not kept in the history stack. As soon as
3351 * the user navigates away from it, the activity is finished. This may also
3352 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3353 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003354 */
3355 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3356 /**
3357 * If set, the activity will not be launched if it is already running
3358 * at the top of the history stack.
3359 */
3360 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3361 /**
3362 * If set, this activity will become the start of a new task on this
3363 * history stack. A task (from the activity that started it to the
3364 * next task activity) defines an atomic group of activities that the
3365 * user can move to. Tasks can be moved to the foreground and background;
3366 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003367 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003368 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3369 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003370 *
3371 * <p>This flag is generally used by activities that want
3372 * to present a "launcher" style behavior: they give the user a list of
3373 * separate things that can be done, which otherwise run completely
3374 * independently of the activity launching them.
3375 *
3376 * <p>When using this flag, if a task is already running for the activity
3377 * you are now starting, then a new activity will not be started; instead,
3378 * the current task will simply be brought to the front of the screen with
3379 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3380 * to disable this behavior.
3381 *
3382 * <p>This flag can not be used when the caller is requesting a result from
3383 * the activity being launched.
3384 */
3385 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3386 /**
3387 * <strong>Do not use this flag unless you are implementing your own
3388 * top-level application launcher.</strong> Used in conjunction with
3389 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3390 * behavior of bringing an existing task to the foreground. When set,
3391 * a new task is <em>always</em> started to host the Activity for the
3392 * Intent, regardless of whether there is already an existing task running
3393 * the same thing.
3394 *
3395 * <p><strong>Because the default system does not include graphical task management,
3396 * you should not use this flag unless you provide some way for a user to
3397 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003398 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003399 * <p>This flag is ignored if
3400 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3401 *
Scott Main7aee61f2011-02-08 11:25:01 -08003402 * <p>See
3403 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3404 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003405 */
3406 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3407 /**
3408 * If set, and the activity being launched is already running in the
3409 * current task, then instead of launching a new instance of that activity,
3410 * all of the other activities on top of it will be closed and this Intent
3411 * will be delivered to the (now on top) old activity as a new Intent.
3412 *
3413 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3414 * If D calls startActivity() with an Intent that resolves to the component
3415 * of activity B, then C and D will be finished and B receive the given
3416 * Intent, resulting in the stack now being: A, B.
3417 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003418 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003419 * either receive the new intent you are starting here in its
3420 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003421 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003422 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3423 * the same intent, then it will be finished and re-created; for all other
3424 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3425 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003426 *
3427 * <p>This launch mode can also be used to good effect in conjunction with
3428 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3429 * of a task, it will bring any currently running instance of that task
3430 * to the foreground, and then clear it to its root state. This is
3431 * especially useful, for example, when launching an activity from the
3432 * notification manager.
3433 *
Scott Main7aee61f2011-02-08 11:25:01 -08003434 * <p>See
3435 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3436 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003437 */
3438 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3439 /**
3440 * If set and this intent is being used to launch a new activity from an
3441 * existing one, then the reply target of the existing activity will be
3442 * transfered to the new activity. This way the new activity can call
3443 * {@link android.app.Activity#setResult} and have that result sent back to
3444 * the reply target of the original activity.
3445 */
3446 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3447 /**
3448 * If set and this intent is being used to launch a new activity from an
3449 * existing one, the current activity will not be counted as the top
3450 * activity for deciding whether the new intent should be delivered to
3451 * the top instead of starting a new one. The previous activity will
3452 * be used as the top, with the assumption being that the current activity
3453 * will finish itself immediately.
3454 */
3455 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3456 /**
3457 * If set, the new activity is not kept in the list of recently launched
3458 * activities.
3459 */
3460 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3461 /**
3462 * This flag is not normally set by application code, but set for you by
3463 * the system as described in the
3464 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3465 * launchMode} documentation for the singleTask mode.
3466 */
3467 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3468 /**
3469 * If set, and this activity is either being started in a new task or
3470 * bringing to the top an existing task, then it will be launched as
3471 * the front door of the task. This will result in the application of
3472 * any affinities needed to have that task in the proper state (either
3473 * moving activities to or from it), or simply resetting that task to
3474 * its initial state if needed.
3475 */
3476 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3477 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003478 * This flag is not normally set by application code, but set for you by
3479 * the system if this activity is being launched from history
3480 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003481 */
3482 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003483 /**
3484 * If set, this marks a point in the task's activity stack that should
3485 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003486 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003487 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3488 * the user re-launching it from home), this activity and all on top of
3489 * it will be finished so that the user does not return to them, but
3490 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003491 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003492 * <p>This is useful for cases where you have a logical break in your
3493 * application. For example, an e-mail application may have a command
3494 * to view an attachment, which launches an image view activity to
3495 * display it. This activity should be part of the e-mail application's
3496 * task, since it is a part of the task the user is involved in. However,
3497 * if the user leaves that task, and later selects the e-mail app from
3498 * home, we may like them to return to the conversation they were
3499 * viewing, not the picture attachment, since that is confusing. By
3500 * setting this flag when launching the image viewer, that viewer and
3501 * any activities it starts will be removed the next time the user returns
3502 * to mail.
3503 */
3504 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003505 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003506 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003507 * callback from occurring on the current frontmost activity before it is
3508 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003509 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003510 * <p>Typically, an activity can rely on that callback to indicate that an
3511 * explicit user action has caused their activity to be moved out of the
3512 * foreground. The callback marks an appropriate point in the activity's
3513 * lifecycle for it to dismiss any notifications that it intends to display
3514 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003515 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003516 * <p>If an activity is ever started via any non-user-driven events such as
3517 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3518 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003519 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003520 */
3521 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003522 /**
3523 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3524 * this flag will cause the launched activity to be brought to the front of its
3525 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003526 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003527 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3528 * If D calls startActivity() with an Intent that resolves to the component
3529 * of activity B, then B will be brought to the front of the history stack,
3530 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003531 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003532 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003533 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003534 */
3535 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003536 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003537 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3538 * this flag will prevent the system from applying an activity transition
3539 * animation to go to the next activity state. This doesn't mean an
3540 * animation will never run -- if another activity change happens that doesn't
3541 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003542 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003543 * when you are going to do a series of activity operations but the
3544 * animation seen by the user shouldn't be driven by the first activity
3545 * change but rather a later one.
3546 */
3547 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3548 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003549 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3550 * this flag will cause any existing task that would be associated with the
3551 * activity to be cleared before the activity is started. That is, the activity
3552 * becomes the new root of an otherwise empty task, and any old activities
3553 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3554 */
3555 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3556 /**
3557 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3558 * this flag will cause a newly launching task to be placed on top of the current
3559 * home activity task (if there is one). That is, pressing back from the task
3560 * will always return the user to home even if that was not the last activity they
3561 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3562 */
3563 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3564 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003565 * If set, when sending a broadcast only registered receivers will be
3566 * called -- no BroadcastReceiver components will be launched.
3567 */
3568 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003569 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003570 * If set, when sending a broadcast the new broadcast will replace
3571 * any existing pending broadcast that matches it. Matching is defined
3572 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3573 * true for the intents of the two broadcasts. When a match is found,
3574 * the new broadcast (and receivers associated with it) will replace the
3575 * existing one in the pending broadcast list, remaining at the same
3576 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003577 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003578 * <p>This flag is most typically used with sticky broadcasts, which
3579 * only care about delivering the most recent values of the broadcast
3580 * to their receivers.
3581 */
3582 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3583 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003584 * If set, when sending a broadcast the recipient is allowed to run at
3585 * foreground priority, with a shorter timeout interval. During normal
3586 * broadcasts the receivers are not automatically hoisted out of the
3587 * background priority class.
3588 */
3589 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3590 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003591 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3592 * They can still propagate results through to later receivers, but they can not prevent
3593 * later receivers from seeing the broadcast.
3594 */
3595 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3596 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003597 * If set, when sending a broadcast <i>before boot has completed</i> only
3598 * registered receivers will be called -- no BroadcastReceiver components
3599 * will be launched. Sticky intent state will be recorded properly even
3600 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3601 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003602 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003603 * <p>This flag is only for use by system sevices as a convenience to
3604 * avoid having to implement a more complex mechanism around detection
3605 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003606 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003607 * @hide
3608 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003609 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003610 /**
3611 * Set when this broadcast is for a boot upgrade, a special mode that
3612 * allows the broadcast to be sent before the system is ready and launches
3613 * the app process with no providers running in it.
3614 * @hide
3615 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003616 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003617
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003618 /**
3619 * @hide Flags that can't be changed with PendingIntent.
3620 */
3621 public static final int IMMUTABLE_FLAGS =
3622 FLAG_GRANT_READ_URI_PERMISSION
3623 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003624
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003625 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003626 // ---------------------------------------------------------------------
3627 // toUri() and parseUri() options.
3628
3629 /**
3630 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3631 * always has the "intent:" scheme. This syntax can be used when you want
3632 * to later disambiguate between URIs that are intended to describe an
3633 * Intent vs. all others that should be treated as raw URIs. When used
3634 * with {@link #parseUri}, any other scheme will result in a generic
3635 * VIEW action for that raw URI.
3636 */
3637 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003638
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003639 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003640
3641 private String mAction;
3642 private Uri mData;
3643 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003644 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003645 private ComponentName mComponent;
3646 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003647 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003648 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003649 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003650 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003651 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003652
3653 // ---------------------------------------------------------------------
3654
3655 /**
3656 * Create an empty intent.
3657 */
3658 public Intent() {
3659 }
3660
3661 /**
3662 * Copy constructor.
3663 */
3664 public Intent(Intent o) {
3665 this.mAction = o.mAction;
3666 this.mData = o.mData;
3667 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003668 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003669 this.mComponent = o.mComponent;
3670 this.mFlags = o.mFlags;
3671 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003672 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003673 }
3674 if (o.mExtras != null) {
3675 this.mExtras = new Bundle(o.mExtras);
3676 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003677 if (o.mSourceBounds != null) {
3678 this.mSourceBounds = new Rect(o.mSourceBounds);
3679 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003680 if (o.mSelector != null) {
3681 this.mSelector = new Intent(o.mSelector);
3682 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003683 if (o.mClipData != null) {
3684 this.mClipData = new ClipData(o.mClipData);
3685 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003686 }
3687
3688 @Override
3689 public Object clone() {
3690 return new Intent(this);
3691 }
3692
3693 private Intent(Intent o, boolean all) {
3694 this.mAction = o.mAction;
3695 this.mData = o.mData;
3696 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003697 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003698 this.mComponent = o.mComponent;
3699 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003700 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003701 }
3702 }
3703
3704 /**
3705 * Make a clone of only the parts of the Intent that are relevant for
3706 * filter matching: the action, data, type, component, and categories.
3707 */
3708 public Intent cloneFilter() {
3709 return new Intent(this, false);
3710 }
3711
3712 /**
3713 * Create an intent with a given action. All other fields (data, type,
3714 * class) are null. Note that the action <em>must</em> be in a
3715 * namespace because Intents are used globally in the system -- for
3716 * example the system VIEW action is android.intent.action.VIEW; an
3717 * application's custom action would be something like
3718 * com.google.app.myapp.CUSTOM_ACTION.
3719 *
3720 * @param action The Intent action, such as ACTION_VIEW.
3721 */
3722 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003723 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003724 }
3725
3726 /**
3727 * Create an intent with a given action and for a given data url. Note
3728 * that the action <em>must</em> be in a namespace because Intents are
3729 * used globally in the system -- for example the system VIEW action is
3730 * android.intent.action.VIEW; an application's custom action would be
3731 * something like com.google.app.myapp.CUSTOM_ACTION.
3732 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003733 * <p><em>Note: scheme and host name matching in the Android framework is
3734 * case-sensitive, unlike the formal RFC. As a result,
3735 * you should always ensure that you write your Uri with these elements
3736 * using lower case letters, and normalize any Uris you receive from
3737 * outside of Android to ensure the scheme and host is lower case.</em></p>
3738 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003739 * @param action The Intent action, such as ACTION_VIEW.
3740 * @param uri The Intent data URI.
3741 */
3742 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003743 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003744 mData = uri;
3745 }
3746
3747 /**
3748 * Create an intent for a specific component. All other fields (action, data,
3749 * type, class) are null, though they can be modified later with explicit
3750 * calls. This provides a convenient way to create an intent that is
3751 * intended to execute a hard-coded class name, rather than relying on the
3752 * system to find an appropriate class for you; see {@link #setComponent}
3753 * for more information on the repercussions of this.
3754 *
3755 * @param packageContext A Context of the application package implementing
3756 * this class.
3757 * @param cls The component class that is to be used for the intent.
3758 *
3759 * @see #setClass
3760 * @see #setComponent
3761 * @see #Intent(String, android.net.Uri , Context, Class)
3762 */
3763 public Intent(Context packageContext, Class<?> cls) {
3764 mComponent = new ComponentName(packageContext, cls);
3765 }
3766
3767 /**
3768 * Create an intent for a specific component with a specified action and data.
3769 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3770 * construct the Intent and then calling {@link #setClass} to set its
3771 * class.
3772 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003773 * <p><em>Note: scheme and host name matching in the Android framework is
3774 * case-sensitive, unlike the formal RFC. As a result,
3775 * you should always ensure that you write your Uri with these elements
3776 * using lower case letters, and normalize any Uris you receive from
3777 * outside of Android to ensure the scheme and host is lower case.</em></p>
3778 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003779 * @param action The Intent action, such as ACTION_VIEW.
3780 * @param uri The Intent data URI.
3781 * @param packageContext A Context of the application package implementing
3782 * this class.
3783 * @param cls The component class that is to be used for the intent.
3784 *
3785 * @see #Intent(String, android.net.Uri)
3786 * @see #Intent(Context, Class)
3787 * @see #setClass
3788 * @see #setComponent
3789 */
3790 public Intent(String action, Uri uri,
3791 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003792 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003793 mData = uri;
3794 mComponent = new ComponentName(packageContext, cls);
3795 }
3796
3797 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003798 * Create an intent to launch the main (root) activity of a task. This
3799 * is the Intent that is started when the application's is launched from
3800 * Home. For anything else that wants to launch an application in the
3801 * same way, it is important that they use an Intent structured the same
3802 * way, and can use this function to ensure this is the case.
3803 *
3804 * <p>The returned Intent has the given Activity component as its explicit
3805 * component, {@link #ACTION_MAIN} as its action, and includes the
3806 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3807 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3808 * to do that through {@link #addFlags(int)} on the returned Intent.
3809 *
3810 * @param mainActivity The main activity component that this Intent will
3811 * launch.
3812 * @return Returns a newly created Intent that can be used to launch the
3813 * activity as a main application entry.
3814 *
3815 * @see #setClass
3816 * @see #setComponent
3817 */
3818 public static Intent makeMainActivity(ComponentName mainActivity) {
3819 Intent intent = new Intent(ACTION_MAIN);
3820 intent.setComponent(mainActivity);
3821 intent.addCategory(CATEGORY_LAUNCHER);
3822 return intent;
3823 }
3824
3825 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003826 * Make an Intent for the main activity of an application, without
3827 * specifying a specific activity to run but giving a selector to find
3828 * the activity. This results in a final Intent that is structured
3829 * the same as when the application is launched from
3830 * Home. For anything else that wants to launch an application in the
3831 * same way, it is important that they use an Intent structured the same
3832 * way, and can use this function to ensure this is the case.
3833 *
3834 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3835 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3836 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3837 * to do that through {@link #addFlags(int)} on the returned Intent.
3838 *
3839 * @param selectorAction The action name of the Intent's selector.
3840 * @param selectorCategory The name of a category to add to the Intent's
3841 * selector.
3842 * @return Returns a newly created Intent that can be used to launch the
3843 * activity as a main application entry.
3844 *
3845 * @see #setSelector(Intent)
3846 */
3847 public static Intent makeMainSelectorActivity(String selectorAction,
3848 String selectorCategory) {
3849 Intent intent = new Intent(ACTION_MAIN);
3850 intent.addCategory(CATEGORY_LAUNCHER);
3851 Intent selector = new Intent();
3852 selector.setAction(selectorAction);
3853 selector.addCategory(selectorCategory);
3854 intent.setSelector(selector);
3855 return intent;
3856 }
3857
3858 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003859 * Make an Intent that can be used to re-launch an application's task
3860 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3861 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3862 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3863 *
3864 * @param mainActivity The activity component that is the root of the
3865 * task; this is the activity that has been published in the application's
3866 * manifest as the main launcher icon.
3867 *
3868 * @return Returns a newly created Intent that can be used to relaunch the
3869 * activity's task in its root state.
3870 */
3871 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3872 Intent intent = makeMainActivity(mainActivity);
3873 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3874 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3875 return intent;
3876 }
3877
3878 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003879 * Call {@link #parseUri} with 0 flags.
3880 * @deprecated Use {@link #parseUri} instead.
3881 */
3882 @Deprecated
3883 public static Intent getIntent(String uri) throws URISyntaxException {
3884 return parseUri(uri, 0);
3885 }
Tom Taylord4a47292009-12-21 13:59:18 -08003886
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003887 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003888 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003889 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003890 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003891 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003892 *
3893 * <p>The URI given here must not be relative -- that is, it must include
3894 * the scheme and full path.
3895 *
3896 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003897 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003898 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003899 *
3900 * @return Intent The newly created Intent object.
3901 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003902 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3903 * it bad (as parsed by the Uri class) or the Intent data within the
3904 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003905 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003906 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003907 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003908 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003909 int i = 0;
3910 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003911 // Validate intent scheme for if requested.
3912 if ((flags&URI_INTENT_SCHEME) != 0) {
3913 if (!uri.startsWith("intent:")) {
3914 Intent intent = new Intent(ACTION_VIEW);
3915 try {
3916 intent.setData(Uri.parse(uri));
3917 } catch (IllegalArgumentException e) {
3918 throw new URISyntaxException(uri, e.getMessage());
3919 }
3920 return intent;
3921 }
3922 }
Tom Taylord4a47292009-12-21 13:59:18 -08003923
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003924 // simple case
3925 i = uri.lastIndexOf("#");
3926 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3927
3928 // old format Intent URI
3929 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003930
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003931 // new format
3932 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003933 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003934
3935 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003936 String data = i >= 0 ? uri.substring(0, i) : null;
3937 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003938 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003939
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003940 // loop over contents of Intent, all name=value;
3941 while (!uri.startsWith("end", i)) {
3942 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003943 if (eq < 0) eq = i-1;
3944 int semi = uri.indexOf(';', i);
3945 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003946
3947 // action
3948 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003949 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003950 }
3951
3952 // categories
3953 else if (uri.startsWith("category=", i)) {
3954 intent.addCategory(value);
3955 }
3956
3957 // type
3958 else if (uri.startsWith("type=", i)) {
3959 intent.mType = value;
3960 }
3961
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003962 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003963 else if (uri.startsWith("launchFlags=", i)) {
3964 intent.mFlags = Integer.decode(value).intValue();
3965 }
3966
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003967 // package
3968 else if (uri.startsWith("package=", i)) {
3969 intent.mPackage = value;
3970 }
3971
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003972 // component
3973 else if (uri.startsWith("component=", i)) {
3974 intent.mComponent = ComponentName.unflattenFromString(value);
3975 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003976
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003977 // scheme
3978 else if (uri.startsWith("scheme=", i)) {
3979 scheme = value;
3980 }
3981
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003982 // source bounds
3983 else if (uri.startsWith("sourceBounds=", i)) {
3984 intent.mSourceBounds = Rect.unflattenFromString(value);
3985 }
3986
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003987 // selector
3988 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3989 intent = new Intent();
3990 }
3991
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003992 // extra
3993 else {
3994 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003995 // create Bundle if it doesn't already exist
3996 if (intent.mExtras == null) intent.mExtras = new Bundle();
3997 Bundle b = intent.mExtras;
3998 // add EXTRA
3999 if (uri.startsWith("S.", i)) b.putString(key, value);
4000 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4001 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4002 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4003 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4004 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4005 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4006 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4007 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4008 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4009 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004010
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004011 // move to the next item
4012 i = semi + 1;
4013 }
4014
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004015 if (intent != baseIntent) {
4016 // The Intent had a selector; fix it up.
4017 baseIntent.setSelector(intent);
4018 intent = baseIntent;
4019 }
4020
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004021 if (data != null) {
4022 if (data.startsWith("intent:")) {
4023 data = data.substring(7);
4024 if (scheme != null) {
4025 data = scheme + ':' + data;
4026 }
4027 }
Tom Taylord4a47292009-12-21 13:59:18 -08004028
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004029 if (data.length() > 0) {
4030 try {
4031 intent.mData = Uri.parse(data);
4032 } catch (IllegalArgumentException e) {
4033 throw new URISyntaxException(uri, e.getMessage());
4034 }
4035 }
4036 }
Tom Taylord4a47292009-12-21 13:59:18 -08004037
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004038 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004039
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004040 } catch (IndexOutOfBoundsException e) {
4041 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4042 }
4043 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004044
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004045 public static Intent getIntentOld(String uri) throws URISyntaxException {
4046 Intent intent;
4047
4048 int i = uri.lastIndexOf('#');
4049 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004050 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004051 final int intentFragmentStart = i;
4052 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004053
4054 i++;
4055
4056 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004057 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004058 i += 7;
4059 int j = uri.indexOf(')', i);
4060 action = uri.substring(i, j);
4061 i = j + 1;
4062 }
4063
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004064 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004065
4066 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004067 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004068 i += 11;
4069 int j = uri.indexOf(')', i);
4070 while (i < j) {
4071 int sep = uri.indexOf('!', i);
4072 if (sep < 0) sep = j;
4073 if (i < sep) {
4074 intent.addCategory(uri.substring(i, sep));
4075 }
4076 i = sep + 1;
4077 }
4078 i = j + 1;
4079 }
4080
4081 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004082 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004083 i += 5;
4084 int j = uri.indexOf(')', i);
4085 intent.mType = uri.substring(i, j);
4086 i = j + 1;
4087 }
4088
4089 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004090 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004091 i += 12;
4092 int j = uri.indexOf(')', i);
4093 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4094 i = j + 1;
4095 }
4096
4097 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004098 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004099 i += 10;
4100 int j = uri.indexOf(')', i);
4101 int sep = uri.indexOf('!', i);
4102 if (sep >= 0 && sep < j) {
4103 String pkg = uri.substring(i, sep);
4104 String cls = uri.substring(sep + 1, j);
4105 intent.mComponent = new ComponentName(pkg, cls);
4106 }
4107 i = j + 1;
4108 }
4109
4110 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004111 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004112 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004113
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004114 final int closeParen = uri.indexOf(')', i);
4115 if (closeParen == -1) throw new URISyntaxException(uri,
4116 "EXTRA missing trailing ')'", i);
4117
4118 while (i < closeParen) {
4119 // fetch the key value
4120 int j = uri.indexOf('=', i);
4121 if (j <= i + 1 || i >= closeParen) {
4122 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4123 }
4124 char type = uri.charAt(i);
4125 i++;
4126 String key = uri.substring(i, j);
4127 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004128
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004129 // get type-value
4130 j = uri.indexOf('!', i);
4131 if (j == -1 || j >= closeParen) j = closeParen;
4132 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4133 String value = uri.substring(i, j);
4134 i = j;
4135
4136 // create Bundle if it doesn't already exist
4137 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004138
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004139 // add item to bundle
4140 try {
4141 switch (type) {
4142 case 'S':
4143 intent.mExtras.putString(key, Uri.decode(value));
4144 break;
4145 case 'B':
4146 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4147 break;
4148 case 'b':
4149 intent.mExtras.putByte(key, Byte.parseByte(value));
4150 break;
4151 case 'c':
4152 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4153 break;
4154 case 'd':
4155 intent.mExtras.putDouble(key, Double.parseDouble(value));
4156 break;
4157 case 'f':
4158 intent.mExtras.putFloat(key, Float.parseFloat(value));
4159 break;
4160 case 'i':
4161 intent.mExtras.putInt(key, Integer.parseInt(value));
4162 break;
4163 case 'l':
4164 intent.mExtras.putLong(key, Long.parseLong(value));
4165 break;
4166 case 's':
4167 intent.mExtras.putShort(key, Short.parseShort(value));
4168 break;
4169 default:
4170 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4171 }
4172 } catch (NumberFormatException e) {
4173 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4174 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004175
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004176 char ch = uri.charAt(i);
4177 if (ch == ')') break;
4178 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4179 i++;
4180 }
4181 }
4182
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004183 if (isIntentFragment) {
4184 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4185 } else {
4186 intent.mData = Uri.parse(uri);
4187 }
Tom Taylord4a47292009-12-21 13:59:18 -08004188
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004189 if (intent.mAction == null) {
4190 // By default, if no action is specified, then use VIEW.
4191 intent.mAction = ACTION_VIEW;
4192 }
4193
4194 } else {
4195 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4196 }
4197
4198 return intent;
4199 }
4200
4201 /**
4202 * Retrieve the general action to be performed, such as
4203 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4204 * the information in the intent should be interpreted -- most importantly,
4205 * what to do with the data returned by {@link #getData}.
4206 *
4207 * @return The action of this intent or null if none is specified.
4208 *
4209 * @see #setAction
4210 */
4211 public String getAction() {
4212 return mAction;
4213 }
4214
4215 /**
4216 * Retrieve data this intent is operating on. This URI specifies the name
4217 * of the data; often it uses the content: scheme, specifying data in a
4218 * content provider. Other schemes may be handled by specific activities,
4219 * such as http: by the web browser.
4220 *
4221 * @return The URI of the data this intent is targeting or null.
4222 *
4223 * @see #getScheme
4224 * @see #setData
4225 */
4226 public Uri getData() {
4227 return mData;
4228 }
4229
4230 /**
4231 * The same as {@link #getData()}, but returns the URI as an encoded
4232 * String.
4233 */
4234 public String getDataString() {
4235 return mData != null ? mData.toString() : null;
4236 }
4237
4238 /**
4239 * Return the scheme portion of the intent's data. If the data is null or
4240 * does not include a scheme, null is returned. Otherwise, the scheme
4241 * prefix without the final ':' is returned, i.e. "http".
4242 *
4243 * <p>This is the same as calling getData().getScheme() (and checking for
4244 * null data).
4245 *
4246 * @return The scheme of this intent.
4247 *
4248 * @see #getData
4249 */
4250 public String getScheme() {
4251 return mData != null ? mData.getScheme() : null;
4252 }
4253
4254 /**
4255 * Retrieve any explicit MIME type included in the intent. This is usually
4256 * null, as the type is determined by the intent data.
4257 *
4258 * @return If a type was manually set, it is returned; else null is
4259 * returned.
4260 *
4261 * @see #resolveType(ContentResolver)
4262 * @see #setType
4263 */
4264 public String getType() {
4265 return mType;
4266 }
4267
4268 /**
4269 * Return the MIME data type of this intent. If the type field is
4270 * explicitly set, that is simply returned. Otherwise, if the data is set,
4271 * the type of that data is returned. If neither fields are set, a null is
4272 * returned.
4273 *
4274 * @return The MIME type of this intent.
4275 *
4276 * @see #getType
4277 * @see #resolveType(ContentResolver)
4278 */
4279 public String resolveType(Context context) {
4280 return resolveType(context.getContentResolver());
4281 }
4282
4283 /**
4284 * Return the MIME data type of this intent. If the type field is
4285 * explicitly set, that is simply returned. Otherwise, if the data is set,
4286 * the type of that data is returned. If neither fields are set, a null is
4287 * returned.
4288 *
4289 * @param resolver A ContentResolver that can be used to determine the MIME
4290 * type of the intent's data.
4291 *
4292 * @return The MIME type of this intent.
4293 *
4294 * @see #getType
4295 * @see #resolveType(Context)
4296 */
4297 public String resolveType(ContentResolver resolver) {
4298 if (mType != null) {
4299 return mType;
4300 }
4301 if (mData != null) {
4302 if ("content".equals(mData.getScheme())) {
4303 return resolver.getType(mData);
4304 }
4305 }
4306 return null;
4307 }
4308
4309 /**
4310 * Return the MIME data type of this intent, only if it will be needed for
4311 * intent resolution. This is not generally useful for application code;
4312 * it is used by the frameworks for communicating with back-end system
4313 * services.
4314 *
4315 * @param resolver A ContentResolver that can be used to determine the MIME
4316 * type of the intent's data.
4317 *
4318 * @return The MIME type of this intent, or null if it is unknown or not
4319 * needed.
4320 */
4321 public String resolveTypeIfNeeded(ContentResolver resolver) {
4322 if (mComponent != null) {
4323 return mType;
4324 }
4325 return resolveType(resolver);
4326 }
4327
4328 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004329 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004330 *
4331 * @param category The category to check.
4332 *
4333 * @return boolean True if the intent contains the category, else false.
4334 *
4335 * @see #getCategories
4336 * @see #addCategory
4337 */
4338 public boolean hasCategory(String category) {
4339 return mCategories != null && mCategories.contains(category);
4340 }
4341
4342 /**
4343 * Return the set of all categories in the intent. If there are no categories,
4344 * returns NULL.
4345 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004346 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004347 *
4348 * @see #hasCategory
4349 * @see #addCategory
4350 */
4351 public Set<String> getCategories() {
4352 return mCategories;
4353 }
4354
4355 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004356 * Return the specific selector associated with this Intent. If there is
4357 * none, returns null. See {@link #setSelector} for more information.
4358 *
4359 * @see #setSelector
4360 */
4361 public Intent getSelector() {
4362 return mSelector;
4363 }
4364
4365 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004366 * Return the {@link ClipData} associated with this Intent. If there is
4367 * none, returns null. See {@link #setClipData} for more information.
4368 *
4369 * @see #setClipData;
4370 */
4371 public ClipData getClipData() {
4372 return mClipData;
4373 }
4374
4375 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004376 * Sets the ClassLoader that will be used when unmarshalling
4377 * any Parcelable values from the extras of this Intent.
4378 *
4379 * @param loader a ClassLoader, or null to use the default loader
4380 * at the time of unmarshalling.
4381 */
4382 public void setExtrasClassLoader(ClassLoader loader) {
4383 if (mExtras != null) {
4384 mExtras.setClassLoader(loader);
4385 }
4386 }
4387
4388 /**
4389 * Returns true if an extra value is associated with the given name.
4390 * @param name the extra's name
4391 * @return true if the given extra is present.
4392 */
4393 public boolean hasExtra(String name) {
4394 return mExtras != null && mExtras.containsKey(name);
4395 }
4396
4397 /**
4398 * Returns true if the Intent's extras contain a parcelled file descriptor.
4399 * @return true if the Intent contains a parcelled file descriptor.
4400 */
4401 public boolean hasFileDescriptors() {
4402 return mExtras != null && mExtras.hasFileDescriptors();
4403 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004404
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004405 /** @hide */
4406 public void setAllowFds(boolean allowFds) {
4407 if (mExtras != null) {
4408 mExtras.setAllowFds(allowFds);
4409 }
4410 }
4411
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004412 /**
4413 * Retrieve extended data from the intent.
4414 *
4415 * @param name The name of the desired item.
4416 *
4417 * @return the value of an item that previously added with putExtra()
4418 * or null if none was found.
4419 *
4420 * @deprecated
4421 * @hide
4422 */
4423 @Deprecated
4424 public Object getExtra(String name) {
4425 return getExtra(name, null);
4426 }
4427
4428 /**
4429 * Retrieve extended data from the intent.
4430 *
4431 * @param name The name of the desired item.
4432 * @param defaultValue the value to be returned if no value of the desired
4433 * type is stored with the given name.
4434 *
4435 * @return the value of an item that previously added with putExtra()
4436 * or the default value if none was found.
4437 *
4438 * @see #putExtra(String, boolean)
4439 */
4440 public boolean getBooleanExtra(String name, boolean defaultValue) {
4441 return mExtras == null ? defaultValue :
4442 mExtras.getBoolean(name, defaultValue);
4443 }
4444
4445 /**
4446 * Retrieve extended data from the intent.
4447 *
4448 * @param name The name of the desired item.
4449 * @param defaultValue the value to be returned if no value of the desired
4450 * type is stored with the given name.
4451 *
4452 * @return the value of an item that previously added with putExtra()
4453 * or the default value if none was found.
4454 *
4455 * @see #putExtra(String, byte)
4456 */
4457 public byte getByteExtra(String name, byte defaultValue) {
4458 return mExtras == null ? defaultValue :
4459 mExtras.getByte(name, defaultValue);
4460 }
4461
4462 /**
4463 * Retrieve extended data from the intent.
4464 *
4465 * @param name The name of the desired item.
4466 * @param defaultValue the value to be returned if no value of the desired
4467 * type is stored with the given name.
4468 *
4469 * @return the value of an item that previously added with putExtra()
4470 * or the default value if none was found.
4471 *
4472 * @see #putExtra(String, short)
4473 */
4474 public short getShortExtra(String name, short defaultValue) {
4475 return mExtras == null ? defaultValue :
4476 mExtras.getShort(name, defaultValue);
4477 }
4478
4479 /**
4480 * Retrieve extended data from the intent.
4481 *
4482 * @param name The name of the desired item.
4483 * @param defaultValue the value to be returned if no value of the desired
4484 * type is stored with the given name.
4485 *
4486 * @return the value of an item that previously added with putExtra()
4487 * or the default value if none was found.
4488 *
4489 * @see #putExtra(String, char)
4490 */
4491 public char getCharExtra(String name, char defaultValue) {
4492 return mExtras == null ? defaultValue :
4493 mExtras.getChar(name, defaultValue);
4494 }
4495
4496 /**
4497 * Retrieve extended data from the intent.
4498 *
4499 * @param name The name of the desired item.
4500 * @param defaultValue the value to be returned if no value of the desired
4501 * type is stored with the given name.
4502 *
4503 * @return the value of an item that previously added with putExtra()
4504 * or the default value if none was found.
4505 *
4506 * @see #putExtra(String, int)
4507 */
4508 public int getIntExtra(String name, int defaultValue) {
4509 return mExtras == null ? defaultValue :
4510 mExtras.getInt(name, defaultValue);
4511 }
4512
4513 /**
4514 * Retrieve extended data from the intent.
4515 *
4516 * @param name The name of the desired item.
4517 * @param defaultValue the value to be returned if no value of the desired
4518 * type is stored with the given name.
4519 *
4520 * @return the value of an item that previously added with putExtra()
4521 * or the default value if none was found.
4522 *
4523 * @see #putExtra(String, long)
4524 */
4525 public long getLongExtra(String name, long defaultValue) {
4526 return mExtras == null ? defaultValue :
4527 mExtras.getLong(name, defaultValue);
4528 }
4529
4530 /**
4531 * Retrieve extended data from the intent.
4532 *
4533 * @param name The name of the desired item.
4534 * @param defaultValue the value to be returned if no value of the desired
4535 * type is stored with the given name.
4536 *
4537 * @return the value of an item that previously added with putExtra(),
4538 * or the default value if no such item is present
4539 *
4540 * @see #putExtra(String, float)
4541 */
4542 public float getFloatExtra(String name, float defaultValue) {
4543 return mExtras == null ? defaultValue :
4544 mExtras.getFloat(name, defaultValue);
4545 }
4546
4547 /**
4548 * Retrieve extended data from the intent.
4549 *
4550 * @param name The name of the desired item.
4551 * @param defaultValue the value to be returned if no value of the desired
4552 * type is stored with the given name.
4553 *
4554 * @return the value of an item that previously added with putExtra()
4555 * or the default value if none was found.
4556 *
4557 * @see #putExtra(String, double)
4558 */
4559 public double getDoubleExtra(String name, double defaultValue) {
4560 return mExtras == null ? defaultValue :
4561 mExtras.getDouble(name, defaultValue);
4562 }
4563
4564 /**
4565 * Retrieve extended data from the intent.
4566 *
4567 * @param name The name of the desired item.
4568 *
4569 * @return the value of an item that previously added with putExtra()
4570 * or null if no String value was found.
4571 *
4572 * @see #putExtra(String, String)
4573 */
4574 public String getStringExtra(String name) {
4575 return mExtras == null ? null : mExtras.getString(name);
4576 }
4577
4578 /**
4579 * Retrieve extended data from the intent.
4580 *
4581 * @param name The name of the desired item.
4582 *
4583 * @return the value of an item that previously added with putExtra()
4584 * or null if no CharSequence value was found.
4585 *
4586 * @see #putExtra(String, CharSequence)
4587 */
4588 public CharSequence getCharSequenceExtra(String name) {
4589 return mExtras == null ? null : mExtras.getCharSequence(name);
4590 }
4591
4592 /**
4593 * Retrieve extended data from the intent.
4594 *
4595 * @param name The name of the desired item.
4596 *
4597 * @return the value of an item that previously added with putExtra()
4598 * or null if no Parcelable value was found.
4599 *
4600 * @see #putExtra(String, Parcelable)
4601 */
4602 public <T extends Parcelable> T getParcelableExtra(String name) {
4603 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4604 }
4605
4606 /**
4607 * Retrieve extended data from the intent.
4608 *
4609 * @param name The name of the desired item.
4610 *
4611 * @return the value of an item that previously added with putExtra()
4612 * or null if no Parcelable[] value was found.
4613 *
4614 * @see #putExtra(String, Parcelable[])
4615 */
4616 public Parcelable[] getParcelableArrayExtra(String name) {
4617 return mExtras == null ? null : mExtras.getParcelableArray(name);
4618 }
4619
4620 /**
4621 * Retrieve extended data from the intent.
4622 *
4623 * @param name The name of the desired item.
4624 *
4625 * @return the value of an item that previously added with putExtra()
4626 * or null if no ArrayList<Parcelable> value was found.
4627 *
4628 * @see #putParcelableArrayListExtra(String, ArrayList)
4629 */
4630 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4631 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4632 }
4633
4634 /**
4635 * Retrieve extended data from the intent.
4636 *
4637 * @param name The name of the desired item.
4638 *
4639 * @return the value of an item that previously added with putExtra()
4640 * or null if no Serializable value was found.
4641 *
4642 * @see #putExtra(String, Serializable)
4643 */
4644 public Serializable getSerializableExtra(String name) {
4645 return mExtras == null ? null : mExtras.getSerializable(name);
4646 }
4647
4648 /**
4649 * Retrieve extended data from the intent.
4650 *
4651 * @param name The name of the desired item.
4652 *
4653 * @return the value of an item that previously added with putExtra()
4654 * or null if no ArrayList<Integer> value was found.
4655 *
4656 * @see #putIntegerArrayListExtra(String, ArrayList)
4657 */
4658 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4659 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4660 }
4661
4662 /**
4663 * Retrieve extended data from the intent.
4664 *
4665 * @param name The name of the desired item.
4666 *
4667 * @return the value of an item that previously added with putExtra()
4668 * or null if no ArrayList<String> value was found.
4669 *
4670 * @see #putStringArrayListExtra(String, ArrayList)
4671 */
4672 public ArrayList<String> getStringArrayListExtra(String name) {
4673 return mExtras == null ? null : mExtras.getStringArrayList(name);
4674 }
4675
4676 /**
4677 * Retrieve extended data from the intent.
4678 *
4679 * @param name The name of the desired item.
4680 *
4681 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004682 * or null if no ArrayList<CharSequence> value was found.
4683 *
4684 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4685 */
4686 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4687 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4688 }
4689
4690 /**
4691 * Retrieve extended data from the intent.
4692 *
4693 * @param name The name of the desired item.
4694 *
4695 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004696 * or null if no boolean array value was found.
4697 *
4698 * @see #putExtra(String, boolean[])
4699 */
4700 public boolean[] getBooleanArrayExtra(String name) {
4701 return mExtras == null ? null : mExtras.getBooleanArray(name);
4702 }
4703
4704 /**
4705 * Retrieve extended data from the intent.
4706 *
4707 * @param name The name of the desired item.
4708 *
4709 * @return the value of an item that previously added with putExtra()
4710 * or null if no byte array value was found.
4711 *
4712 * @see #putExtra(String, byte[])
4713 */
4714 public byte[] getByteArrayExtra(String name) {
4715 return mExtras == null ? null : mExtras.getByteArray(name);
4716 }
4717
4718 /**
4719 * Retrieve extended data from the intent.
4720 *
4721 * @param name The name of the desired item.
4722 *
4723 * @return the value of an item that previously added with putExtra()
4724 * or null if no short array value was found.
4725 *
4726 * @see #putExtra(String, short[])
4727 */
4728 public short[] getShortArrayExtra(String name) {
4729 return mExtras == null ? null : mExtras.getShortArray(name);
4730 }
4731
4732 /**
4733 * Retrieve extended data from the intent.
4734 *
4735 * @param name The name of the desired item.
4736 *
4737 * @return the value of an item that previously added with putExtra()
4738 * or null if no char array value was found.
4739 *
4740 * @see #putExtra(String, char[])
4741 */
4742 public char[] getCharArrayExtra(String name) {
4743 return mExtras == null ? null : mExtras.getCharArray(name);
4744 }
4745
4746 /**
4747 * Retrieve extended data from the intent.
4748 *
4749 * @param name The name of the desired item.
4750 *
4751 * @return the value of an item that previously added with putExtra()
4752 * or null if no int array value was found.
4753 *
4754 * @see #putExtra(String, int[])
4755 */
4756 public int[] getIntArrayExtra(String name) {
4757 return mExtras == null ? null : mExtras.getIntArray(name);
4758 }
4759
4760 /**
4761 * Retrieve extended data from the intent.
4762 *
4763 * @param name The name of the desired item.
4764 *
4765 * @return the value of an item that previously added with putExtra()
4766 * or null if no long array value was found.
4767 *
4768 * @see #putExtra(String, long[])
4769 */
4770 public long[] getLongArrayExtra(String name) {
4771 return mExtras == null ? null : mExtras.getLongArray(name);
4772 }
4773
4774 /**
4775 * Retrieve extended data from the intent.
4776 *
4777 * @param name The name of the desired item.
4778 *
4779 * @return the value of an item that previously added with putExtra()
4780 * or null if no float array value was found.
4781 *
4782 * @see #putExtra(String, float[])
4783 */
4784 public float[] getFloatArrayExtra(String name) {
4785 return mExtras == null ? null : mExtras.getFloatArray(name);
4786 }
4787
4788 /**
4789 * Retrieve extended data from the intent.
4790 *
4791 * @param name The name of the desired item.
4792 *
4793 * @return the value of an item that previously added with putExtra()
4794 * or null if no double array value was found.
4795 *
4796 * @see #putExtra(String, double[])
4797 */
4798 public double[] getDoubleArrayExtra(String name) {
4799 return mExtras == null ? null : mExtras.getDoubleArray(name);
4800 }
4801
4802 /**
4803 * Retrieve extended data from the intent.
4804 *
4805 * @param name The name of the desired item.
4806 *
4807 * @return the value of an item that previously added with putExtra()
4808 * or null if no String array value was found.
4809 *
4810 * @see #putExtra(String, String[])
4811 */
4812 public String[] getStringArrayExtra(String name) {
4813 return mExtras == null ? null : mExtras.getStringArray(name);
4814 }
4815
4816 /**
4817 * Retrieve extended data from the intent.
4818 *
4819 * @param name The name of the desired item.
4820 *
4821 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004822 * or null if no CharSequence array value was found.
4823 *
4824 * @see #putExtra(String, CharSequence[])
4825 */
4826 public CharSequence[] getCharSequenceArrayExtra(String name) {
4827 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4828 }
4829
4830 /**
4831 * Retrieve extended data from the intent.
4832 *
4833 * @param name The name of the desired item.
4834 *
4835 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004836 * or null if no Bundle value was found.
4837 *
4838 * @see #putExtra(String, Bundle)
4839 */
4840 public Bundle getBundleExtra(String name) {
4841 return mExtras == null ? null : mExtras.getBundle(name);
4842 }
4843
4844 /**
4845 * Retrieve extended data from the intent.
4846 *
4847 * @param name The name of the desired item.
4848 *
4849 * @return the value of an item that previously added with putExtra()
4850 * or null if no IBinder value was found.
4851 *
4852 * @see #putExtra(String, IBinder)
4853 *
4854 * @deprecated
4855 * @hide
4856 */
4857 @Deprecated
4858 public IBinder getIBinderExtra(String name) {
4859 return mExtras == null ? null : mExtras.getIBinder(name);
4860 }
4861
4862 /**
4863 * Retrieve extended data from the intent.
4864 *
4865 * @param name The name of the desired item.
4866 * @param defaultValue The default value to return in case no item is
4867 * associated with the key 'name'
4868 *
4869 * @return the value of an item that previously added with putExtra()
4870 * or defaultValue if none was found.
4871 *
4872 * @see #putExtra
4873 *
4874 * @deprecated
4875 * @hide
4876 */
4877 @Deprecated
4878 public Object getExtra(String name, Object defaultValue) {
4879 Object result = defaultValue;
4880 if (mExtras != null) {
4881 Object result2 = mExtras.get(name);
4882 if (result2 != null) {
4883 result = result2;
4884 }
4885 }
4886
4887 return result;
4888 }
4889
4890 /**
4891 * Retrieves a map of extended data from the intent.
4892 *
4893 * @return the map of all extras previously added with putExtra(),
4894 * or null if none have been added.
4895 */
4896 public Bundle getExtras() {
4897 return (mExtras != null)
4898 ? new Bundle(mExtras)
4899 : null;
4900 }
4901
4902 /**
4903 * Retrieve any special flags associated with this intent. You will
4904 * normally just set them with {@link #setFlags} and let the system
4905 * take the appropriate action with them.
4906 *
4907 * @return int The currently set flags.
4908 *
4909 * @see #setFlags
4910 */
4911 public int getFlags() {
4912 return mFlags;
4913 }
4914
Dianne Hackborne7f97212011-02-24 14:40:20 -08004915 /** @hide */
4916 public boolean isExcludingStopped() {
4917 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4918 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4919 }
4920
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004921 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004922 * Retrieve the application package name this Intent is limited to. When
4923 * resolving an Intent, if non-null this limits the resolution to only
4924 * components in the given application package.
4925 *
4926 * @return The name of the application package for the Intent.
4927 *
4928 * @see #resolveActivity
4929 * @see #setPackage
4930 */
4931 public String getPackage() {
4932 return mPackage;
4933 }
4934
4935 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004936 * Retrieve the concrete component associated with the intent. When receiving
4937 * an intent, this is the component that was found to best handle it (that is,
4938 * yourself) and will always be non-null; in all other cases it will be
4939 * null unless explicitly set.
4940 *
4941 * @return The name of the application component to handle the intent.
4942 *
4943 * @see #resolveActivity
4944 * @see #setComponent
4945 */
4946 public ComponentName getComponent() {
4947 return mComponent;
4948 }
4949
4950 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004951 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4952 * used as a hint to the receiver for animations and the like. Null means that there
4953 * is no source bounds.
4954 */
4955 public Rect getSourceBounds() {
4956 return mSourceBounds;
4957 }
4958
4959 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004960 * Return the Activity component that should be used to handle this intent.
4961 * The appropriate component is determined based on the information in the
4962 * intent, evaluated as follows:
4963 *
4964 * <p>If {@link #getComponent} returns an explicit class, that is returned
4965 * without any further consideration.
4966 *
4967 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4968 * category to be considered.
4969 *
4970 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4971 * action.
4972 *
4973 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4974 * this type.
4975 *
4976 * <p>If {@link #addCategory} has added any categories, the activity must
4977 * handle ALL of the categories specified.
4978 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004979 * <p>If {@link #getPackage} is non-NULL, only activity components in
4980 * that application package will be considered.
4981 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004982 * <p>If there are no activities that satisfy all of these conditions, a
4983 * null string is returned.
4984 *
4985 * <p>If multiple activities are found to satisfy the intent, the one with
4986 * the highest priority will be used. If there are multiple activities
4987 * with the same priority, the system will either pick the best activity
4988 * based on user preference, or resolve to a system class that will allow
4989 * the user to pick an activity and forward from there.
4990 *
4991 * <p>This method is implemented simply by calling
4992 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4993 * true.</p>
4994 * <p> This API is called for you as part of starting an activity from an
4995 * intent. You do not normally need to call it yourself.</p>
4996 *
4997 * @param pm The package manager with which to resolve the Intent.
4998 *
4999 * @return Name of the component implementing an activity that can
5000 * display the intent.
5001 *
5002 * @see #setComponent
5003 * @see #getComponent
5004 * @see #resolveActivityInfo
5005 */
5006 public ComponentName resolveActivity(PackageManager pm) {
5007 if (mComponent != null) {
5008 return mComponent;
5009 }
5010
5011 ResolveInfo info = pm.resolveActivity(
5012 this, PackageManager.MATCH_DEFAULT_ONLY);
5013 if (info != null) {
5014 return new ComponentName(
5015 info.activityInfo.applicationInfo.packageName,
5016 info.activityInfo.name);
5017 }
5018
5019 return null;
5020 }
5021
5022 /**
5023 * Resolve the Intent into an {@link ActivityInfo}
5024 * describing the activity that should execute the intent. Resolution
5025 * follows the same rules as described for {@link #resolveActivity}, but
5026 * you get back the completely information about the resolved activity
5027 * instead of just its class name.
5028 *
5029 * @param pm The package manager with which to resolve the Intent.
5030 * @param flags Addition information to retrieve as per
5031 * {@link PackageManager#getActivityInfo(ComponentName, int)
5032 * PackageManager.getActivityInfo()}.
5033 *
5034 * @return PackageManager.ActivityInfo
5035 *
5036 * @see #resolveActivity
5037 */
5038 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5039 ActivityInfo ai = null;
5040 if (mComponent != null) {
5041 try {
5042 ai = pm.getActivityInfo(mComponent, flags);
5043 } catch (PackageManager.NameNotFoundException e) {
5044 // ignore
5045 }
5046 } else {
5047 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005048 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005049 if (info != null) {
5050 ai = info.activityInfo;
5051 }
5052 }
5053
5054 return ai;
5055 }
5056
5057 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005058 * Special function for use by the system to resolve service
5059 * intents to system apps. Throws an exception if there are
5060 * multiple potential matches to the Intent. Returns null if
5061 * there are no matches.
5062 * @hide
5063 */
5064 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5065 if (mComponent != null) {
5066 return mComponent;
5067 }
5068
5069 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5070 if (results == null) {
5071 return null;
5072 }
5073 ComponentName comp = null;
5074 for (int i=0; i<results.size(); i++) {
5075 ResolveInfo ri = results.get(i);
5076 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5077 continue;
5078 }
5079 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5080 ri.serviceInfo.name);
5081 if (comp != null) {
5082 throw new IllegalStateException("Multiple system services handle " + this
5083 + ": " + comp + ", " + foundComp);
5084 }
5085 comp = foundComp;
5086 }
5087 return comp;
5088 }
5089
5090 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005091 * Set the general action to be performed.
5092 *
5093 * @param action An action name, such as ACTION_VIEW. Application-specific
5094 * actions should be prefixed with the vendor's package name.
5095 *
5096 * @return Returns the same Intent object, for chaining multiple calls
5097 * into a single statement.
5098 *
5099 * @see #getAction
5100 */
5101 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005102 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005103 return this;
5104 }
5105
5106 /**
5107 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005108 * clears any type that was previously set by {@link #setType} or
5109 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005110 *
Nick Pellyccae4122012-01-09 14:12:58 -08005111 * <p><em>Note: scheme matching in the Android framework is
5112 * case-sensitive, unlike the formal RFC. As a result,
5113 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005114 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005115 * {@link #setDataAndNormalize}
5116 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005117 *
Nick Pellyccae4122012-01-09 14:12:58 -08005118 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005119 *
5120 * @return Returns the same Intent object, for chaining multiple calls
5121 * into a single statement.
5122 *
5123 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005124 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005125 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005126 */
5127 public Intent setData(Uri data) {
5128 mData = data;
5129 mType = null;
5130 return this;
5131 }
5132
5133 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005134 * Normalize and set the data this intent is operating on.
5135 *
5136 * <p>This method automatically clears any type that was
5137 * previously set (for example, by {@link #setType}).
5138 *
5139 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005140 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005141 * so really this is just a convenience method for
5142 * <pre>
5143 * setData(data.normalize())
5144 * </pre>
5145 *
5146 * @param data The Uri of the data this intent is now targeting.
5147 *
5148 * @return Returns the same Intent object, for chaining multiple calls
5149 * into a single statement.
5150 *
5151 * @see #getData
5152 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005153 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005154 */
5155 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005156 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005157 }
5158
5159 /**
5160 * Set an explicit MIME data type.
5161 *
5162 * <p>This is used to create intents that only specify a type and not data,
5163 * for example to indicate the type of data to return.
5164 *
5165 * <p>This method automatically clears any data that was
5166 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005167 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005168 * <p><em>Note: MIME type matching in the Android framework is
5169 * case-sensitive, unlike formal RFC MIME types. As a result,
5170 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005171 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5172 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005173 *
5174 * @param type The MIME type of the data being handled by this intent.
5175 *
5176 * @return Returns the same Intent object, for chaining multiple calls
5177 * into a single statement.
5178 *
5179 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005180 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005181 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005182 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005183 */
5184 public Intent setType(String type) {
5185 mData = null;
5186 mType = type;
5187 return this;
5188 }
5189
5190 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005191 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005192 *
Nick Pellyccae4122012-01-09 14:12:58 -08005193 * <p>This is used to create intents that only specify a type and not data,
5194 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005195 *
Nick Pellyccae4122012-01-09 14:12:58 -08005196 * <p>This method automatically clears any data that was
5197 * previously set (for example by {@link #setData}).
5198 *
5199 * <p>The MIME type is normalized using
5200 * {@link #normalizeMimeType} before it is set,
5201 * so really this is just a convenience method for
5202 * <pre>
5203 * setType(Intent.normalizeMimeType(type))
5204 * </pre>
5205 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005206 * @param type The MIME type of the data being handled by this intent.
5207 *
5208 * @return Returns the same Intent object, for chaining multiple calls
5209 * into a single statement.
5210 *
Nick Pellyccae4122012-01-09 14:12:58 -08005211 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005212 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005213 * @see #normalizeMimeType
5214 */
5215 public Intent setTypeAndNormalize(String type) {
5216 return setType(normalizeMimeType(type));
5217 }
5218
5219 /**
5220 * (Usually optional) Set the data for the intent along with an explicit
5221 * MIME data type. This method should very rarely be used -- it allows you
5222 * to override the MIME type that would ordinarily be inferred from the
5223 * data with your own type given here.
5224 *
5225 * <p><em>Note: MIME type and Uri scheme matching in the
5226 * Android framework is case-sensitive, unlike the formal RFC definitions.
5227 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005228 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005229 * {@link #setDataAndTypeAndNormalize}
5230 * to ensure that they are converted to lower case.</em>
5231 *
5232 * @param data The Uri of the data this intent is now targeting.
5233 * @param type The MIME type of the data being handled by this intent.
5234 *
5235 * @return Returns the same Intent object, for chaining multiple calls
5236 * into a single statement.
5237 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005238 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005239 * @see #setData
5240 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005241 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005242 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005243 */
5244 public Intent setDataAndType(Uri data, String type) {
5245 mData = data;
5246 mType = type;
5247 return this;
5248 }
5249
5250 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005251 * (Usually optional) Normalize and set both the data Uri and an explicit
5252 * MIME data type. This method should very rarely be used -- it allows you
5253 * to override the MIME type that would ordinarily be inferred from the
5254 * data with your own type given here.
5255 *
5256 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005257 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005258 * before they are set, so really this is just a convenience method for
5259 * <pre>
5260 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5261 * </pre>
5262 *
5263 * @param data The Uri of the data this intent is now targeting.
5264 * @param type The MIME type of the data being handled by this intent.
5265 *
5266 * @return Returns the same Intent object, for chaining multiple calls
5267 * into a single statement.
5268 *
5269 * @see #setType
5270 * @see #setData
5271 * @see #setDataAndType
5272 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005273 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005274 */
5275 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005276 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005277 }
5278
5279 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005280 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005281 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005282 * activities that provide <em>all</em> of the requested categories will be
5283 * used.
5284 *
5285 * @param category The desired category. This can be either one of the
5286 * predefined Intent categories, or a custom category in your own
5287 * namespace.
5288 *
5289 * @return Returns the same Intent object, for chaining multiple calls
5290 * into a single statement.
5291 *
5292 * @see #hasCategory
5293 * @see #removeCategory
5294 */
5295 public Intent addCategory(String category) {
5296 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005297 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005298 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005299 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005300 return this;
5301 }
5302
5303 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005304 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005305 *
5306 * @param category The category to remove.
5307 *
5308 * @see #addCategory
5309 */
5310 public void removeCategory(String category) {
5311 if (mCategories != null) {
5312 mCategories.remove(category);
5313 if (mCategories.size() == 0) {
5314 mCategories = null;
5315 }
5316 }
5317 }
5318
5319 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005320 * Set a selector for this Intent. This is a modification to the kinds of
5321 * things the Intent will match. If the selector is set, it will be used
5322 * when trying to find entities that can handle the Intent, instead of the
5323 * main contents of the Intent. This allows you build an Intent containing
5324 * a generic protocol while targeting it more specifically.
5325 *
5326 * <p>An example of where this may be used is with things like
5327 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5328 * Intent that will launch the Browser application. However, the correct
5329 * main entry point of an application is actually {@link #ACTION_MAIN}
5330 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5331 * used to specify the actual Activity to launch. If you launch the browser
5332 * with something different, undesired behavior may happen if the user has
5333 * previously or later launches it the normal way, since they do not match.
5334 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5335 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5336 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5337 *
5338 * <p>Setting a selector does not impact the behavior of
5339 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5340 * desired behavior of a selector -- it does not impact the base meaning
5341 * of the Intent, just what kinds of things will be matched against it
5342 * when determining who can handle it.</p>
5343 *
5344 * <p>You can not use both a selector and {@link #setPackage(String)} on
5345 * the same base Intent.</p>
5346 *
5347 * @param selector The desired selector Intent; set to null to not use
5348 * a special selector.
5349 */
5350 public void setSelector(Intent selector) {
5351 if (selector == this) {
5352 throw new IllegalArgumentException(
5353 "Intent being set as a selector of itself");
5354 }
5355 if (selector != null && mPackage != null) {
5356 throw new IllegalArgumentException(
5357 "Can't set selector when package name is already set");
5358 }
5359 mSelector = selector;
5360 }
5361
5362 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005363 * Set a {@link ClipData} associated with this Intent. This replaces any
5364 * previously set ClipData.
5365 *
5366 * <p>The ClipData in an intent is not used for Intent matching or other
5367 * such operations. Semantically it is like extras, used to transmit
5368 * additional data with the Intent. The main feature of using this over
5369 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5370 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5371 * items included in the clip data. This is useful, in particular, if
5372 * you want to transmit an Intent containing multiple <code>content:</code>
5373 * URIs for which the recipient may not have global permission to access the
5374 * content provider.
5375 *
5376 * <p>If the ClipData contains items that are themselves Intents, any
5377 * grant flags in those Intents will be ignored. Only the top-level flags
5378 * of the main Intent are respected, and will be applied to all Uri or
5379 * Intent items in the clip (or sub-items of the clip).
5380 *
5381 * <p>The MIME type, label, and icon in the ClipData object are not
5382 * directly used by Intent. Applications should generally rely on the
5383 * MIME type of the Intent itself, not what it may find in the ClipData.
5384 * A common practice is to construct a ClipData for use with an Intent
5385 * with a MIME type of "*\/*".
5386 *
5387 * @param clip The new clip to set. May be null to clear the current clip.
5388 */
5389 public void setClipData(ClipData clip) {
5390 mClipData = clip;
5391 }
5392
5393 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005394 * Add extended data to the intent. The name must include a package
5395 * prefix, for example the app com.android.contacts would use names
5396 * like "com.android.contacts.ShowAll".
5397 *
5398 * @param name The name of the extra data, with package prefix.
5399 * @param value The boolean data value.
5400 *
5401 * @return Returns the same Intent object, for chaining multiple calls
5402 * into a single statement.
5403 *
5404 * @see #putExtras
5405 * @see #removeExtra
5406 * @see #getBooleanExtra(String, boolean)
5407 */
5408 public Intent putExtra(String name, boolean value) {
5409 if (mExtras == null) {
5410 mExtras = new Bundle();
5411 }
5412 mExtras.putBoolean(name, value);
5413 return this;
5414 }
5415
5416 /**
5417 * Add extended data to the intent. The name must include a package
5418 * prefix, for example the app com.android.contacts would use names
5419 * like "com.android.contacts.ShowAll".
5420 *
5421 * @param name The name of the extra data, with package prefix.
5422 * @param value The byte data value.
5423 *
5424 * @return Returns the same Intent object, for chaining multiple calls
5425 * into a single statement.
5426 *
5427 * @see #putExtras
5428 * @see #removeExtra
5429 * @see #getByteExtra(String, byte)
5430 */
5431 public Intent putExtra(String name, byte value) {
5432 if (mExtras == null) {
5433 mExtras = new Bundle();
5434 }
5435 mExtras.putByte(name, value);
5436 return this;
5437 }
5438
5439 /**
5440 * Add extended data to the intent. The name must include a package
5441 * prefix, for example the app com.android.contacts would use names
5442 * like "com.android.contacts.ShowAll".
5443 *
5444 * @param name The name of the extra data, with package prefix.
5445 * @param value The char data value.
5446 *
5447 * @return Returns the same Intent object, for chaining multiple calls
5448 * into a single statement.
5449 *
5450 * @see #putExtras
5451 * @see #removeExtra
5452 * @see #getCharExtra(String, char)
5453 */
5454 public Intent putExtra(String name, char value) {
5455 if (mExtras == null) {
5456 mExtras = new Bundle();
5457 }
5458 mExtras.putChar(name, value);
5459 return this;
5460 }
5461
5462 /**
5463 * Add extended data to the intent. The name must include a package
5464 * prefix, for example the app com.android.contacts would use names
5465 * like "com.android.contacts.ShowAll".
5466 *
5467 * @param name The name of the extra data, with package prefix.
5468 * @param value The short data value.
5469 *
5470 * @return Returns the same Intent object, for chaining multiple calls
5471 * into a single statement.
5472 *
5473 * @see #putExtras
5474 * @see #removeExtra
5475 * @see #getShortExtra(String, short)
5476 */
5477 public Intent putExtra(String name, short value) {
5478 if (mExtras == null) {
5479 mExtras = new Bundle();
5480 }
5481 mExtras.putShort(name, value);
5482 return this;
5483 }
5484
5485 /**
5486 * Add extended data to the intent. The name must include a package
5487 * prefix, for example the app com.android.contacts would use names
5488 * like "com.android.contacts.ShowAll".
5489 *
5490 * @param name The name of the extra data, with package prefix.
5491 * @param value The integer data value.
5492 *
5493 * @return Returns the same Intent object, for chaining multiple calls
5494 * into a single statement.
5495 *
5496 * @see #putExtras
5497 * @see #removeExtra
5498 * @see #getIntExtra(String, int)
5499 */
5500 public Intent putExtra(String name, int value) {
5501 if (mExtras == null) {
5502 mExtras = new Bundle();
5503 }
5504 mExtras.putInt(name, value);
5505 return this;
5506 }
5507
5508 /**
5509 * Add extended data to the intent. The name must include a package
5510 * prefix, for example the app com.android.contacts would use names
5511 * like "com.android.contacts.ShowAll".
5512 *
5513 * @param name The name of the extra data, with package prefix.
5514 * @param value The long data value.
5515 *
5516 * @return Returns the same Intent object, for chaining multiple calls
5517 * into a single statement.
5518 *
5519 * @see #putExtras
5520 * @see #removeExtra
5521 * @see #getLongExtra(String, long)
5522 */
5523 public Intent putExtra(String name, long value) {
5524 if (mExtras == null) {
5525 mExtras = new Bundle();
5526 }
5527 mExtras.putLong(name, value);
5528 return this;
5529 }
5530
5531 /**
5532 * Add extended data to the intent. The name must include a package
5533 * prefix, for example the app com.android.contacts would use names
5534 * like "com.android.contacts.ShowAll".
5535 *
5536 * @param name The name of the extra data, with package prefix.
5537 * @param value The float data value.
5538 *
5539 * @return Returns the same Intent object, for chaining multiple calls
5540 * into a single statement.
5541 *
5542 * @see #putExtras
5543 * @see #removeExtra
5544 * @see #getFloatExtra(String, float)
5545 */
5546 public Intent putExtra(String name, float value) {
5547 if (mExtras == null) {
5548 mExtras = new Bundle();
5549 }
5550 mExtras.putFloat(name, value);
5551 return this;
5552 }
5553
5554 /**
5555 * Add extended data to the intent. The name must include a package
5556 * prefix, for example the app com.android.contacts would use names
5557 * like "com.android.contacts.ShowAll".
5558 *
5559 * @param name The name of the extra data, with package prefix.
5560 * @param value The double data value.
5561 *
5562 * @return Returns the same Intent object, for chaining multiple calls
5563 * into a single statement.
5564 *
5565 * @see #putExtras
5566 * @see #removeExtra
5567 * @see #getDoubleExtra(String, double)
5568 */
5569 public Intent putExtra(String name, double value) {
5570 if (mExtras == null) {
5571 mExtras = new Bundle();
5572 }
5573 mExtras.putDouble(name, value);
5574 return this;
5575 }
5576
5577 /**
5578 * Add extended data to the intent. The name must include a package
5579 * prefix, for example the app com.android.contacts would use names
5580 * like "com.android.contacts.ShowAll".
5581 *
5582 * @param name The name of the extra data, with package prefix.
5583 * @param value The String data value.
5584 *
5585 * @return Returns the same Intent object, for chaining multiple calls
5586 * into a single statement.
5587 *
5588 * @see #putExtras
5589 * @see #removeExtra
5590 * @see #getStringExtra(String)
5591 */
5592 public Intent putExtra(String name, String value) {
5593 if (mExtras == null) {
5594 mExtras = new Bundle();
5595 }
5596 mExtras.putString(name, value);
5597 return this;
5598 }
5599
5600 /**
5601 * Add extended data to the intent. The name must include a package
5602 * prefix, for example the app com.android.contacts would use names
5603 * like "com.android.contacts.ShowAll".
5604 *
5605 * @param name The name of the extra data, with package prefix.
5606 * @param value The CharSequence data value.
5607 *
5608 * @return Returns the same Intent object, for chaining multiple calls
5609 * into a single statement.
5610 *
5611 * @see #putExtras
5612 * @see #removeExtra
5613 * @see #getCharSequenceExtra(String)
5614 */
5615 public Intent putExtra(String name, CharSequence value) {
5616 if (mExtras == null) {
5617 mExtras = new Bundle();
5618 }
5619 mExtras.putCharSequence(name, value);
5620 return this;
5621 }
5622
5623 /**
5624 * Add extended data to the intent. The name must include a package
5625 * prefix, for example the app com.android.contacts would use names
5626 * like "com.android.contacts.ShowAll".
5627 *
5628 * @param name The name of the extra data, with package prefix.
5629 * @param value The Parcelable data value.
5630 *
5631 * @return Returns the same Intent object, for chaining multiple calls
5632 * into a single statement.
5633 *
5634 * @see #putExtras
5635 * @see #removeExtra
5636 * @see #getParcelableExtra(String)
5637 */
5638 public Intent putExtra(String name, Parcelable value) {
5639 if (mExtras == null) {
5640 mExtras = new Bundle();
5641 }
5642 mExtras.putParcelable(name, value);
5643 return this;
5644 }
5645
5646 /**
5647 * Add extended data to the intent. The name must include a package
5648 * prefix, for example the app com.android.contacts would use names
5649 * like "com.android.contacts.ShowAll".
5650 *
5651 * @param name The name of the extra data, with package prefix.
5652 * @param value The Parcelable[] data value.
5653 *
5654 * @return Returns the same Intent object, for chaining multiple calls
5655 * into a single statement.
5656 *
5657 * @see #putExtras
5658 * @see #removeExtra
5659 * @see #getParcelableArrayExtra(String)
5660 */
5661 public Intent putExtra(String name, Parcelable[] value) {
5662 if (mExtras == null) {
5663 mExtras = new Bundle();
5664 }
5665 mExtras.putParcelableArray(name, value);
5666 return this;
5667 }
5668
5669 /**
5670 * Add extended data to the intent. The name must include a package
5671 * prefix, for example the app com.android.contacts would use names
5672 * like "com.android.contacts.ShowAll".
5673 *
5674 * @param name The name of the extra data, with package prefix.
5675 * @param value The ArrayList<Parcelable> data value.
5676 *
5677 * @return Returns the same Intent object, for chaining multiple calls
5678 * into a single statement.
5679 *
5680 * @see #putExtras
5681 * @see #removeExtra
5682 * @see #getParcelableArrayListExtra(String)
5683 */
5684 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5685 if (mExtras == null) {
5686 mExtras = new Bundle();
5687 }
5688 mExtras.putParcelableArrayList(name, value);
5689 return this;
5690 }
5691
5692 /**
5693 * Add extended data to the intent. The name must include a package
5694 * prefix, for example the app com.android.contacts would use names
5695 * like "com.android.contacts.ShowAll".
5696 *
5697 * @param name The name of the extra data, with package prefix.
5698 * @param value The ArrayList<Integer> data value.
5699 *
5700 * @return Returns the same Intent object, for chaining multiple calls
5701 * into a single statement.
5702 *
5703 * @see #putExtras
5704 * @see #removeExtra
5705 * @see #getIntegerArrayListExtra(String)
5706 */
5707 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5708 if (mExtras == null) {
5709 mExtras = new Bundle();
5710 }
5711 mExtras.putIntegerArrayList(name, value);
5712 return this;
5713 }
5714
5715 /**
5716 * Add extended data to the intent. The name must include a package
5717 * prefix, for example the app com.android.contacts would use names
5718 * like "com.android.contacts.ShowAll".
5719 *
5720 * @param name The name of the extra data, with package prefix.
5721 * @param value The ArrayList<String> data value.
5722 *
5723 * @return Returns the same Intent object, for chaining multiple calls
5724 * into a single statement.
5725 *
5726 * @see #putExtras
5727 * @see #removeExtra
5728 * @see #getStringArrayListExtra(String)
5729 */
5730 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5731 if (mExtras == null) {
5732 mExtras = new Bundle();
5733 }
5734 mExtras.putStringArrayList(name, value);
5735 return this;
5736 }
5737
5738 /**
5739 * Add extended data to the intent. The name must include a package
5740 * prefix, for example the app com.android.contacts would use names
5741 * like "com.android.contacts.ShowAll".
5742 *
5743 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005744 * @param value The ArrayList<CharSequence> data value.
5745 *
5746 * @return Returns the same Intent object, for chaining multiple calls
5747 * into a single statement.
5748 *
5749 * @see #putExtras
5750 * @see #removeExtra
5751 * @see #getCharSequenceArrayListExtra(String)
5752 */
5753 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5754 if (mExtras == null) {
5755 mExtras = new Bundle();
5756 }
5757 mExtras.putCharSequenceArrayList(name, value);
5758 return this;
5759 }
5760
5761 /**
5762 * Add extended data to the intent. The name must include a package
5763 * prefix, for example the app com.android.contacts would use names
5764 * like "com.android.contacts.ShowAll".
5765 *
5766 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005767 * @param value The Serializable data value.
5768 *
5769 * @return Returns the same Intent object, for chaining multiple calls
5770 * into a single statement.
5771 *
5772 * @see #putExtras
5773 * @see #removeExtra
5774 * @see #getSerializableExtra(String)
5775 */
5776 public Intent putExtra(String name, Serializable value) {
5777 if (mExtras == null) {
5778 mExtras = new Bundle();
5779 }
5780 mExtras.putSerializable(name, value);
5781 return this;
5782 }
5783
5784 /**
5785 * Add extended data to the intent. The name must include a package
5786 * prefix, for example the app com.android.contacts would use names
5787 * like "com.android.contacts.ShowAll".
5788 *
5789 * @param name The name of the extra data, with package prefix.
5790 * @param value The boolean array data value.
5791 *
5792 * @return Returns the same Intent object, for chaining multiple calls
5793 * into a single statement.
5794 *
5795 * @see #putExtras
5796 * @see #removeExtra
5797 * @see #getBooleanArrayExtra(String)
5798 */
5799 public Intent putExtra(String name, boolean[] value) {
5800 if (mExtras == null) {
5801 mExtras = new Bundle();
5802 }
5803 mExtras.putBooleanArray(name, value);
5804 return this;
5805 }
5806
5807 /**
5808 * Add extended data to the intent. The name must include a package
5809 * prefix, for example the app com.android.contacts would use names
5810 * like "com.android.contacts.ShowAll".
5811 *
5812 * @param name The name of the extra data, with package prefix.
5813 * @param value The byte array data value.
5814 *
5815 * @return Returns the same Intent object, for chaining multiple calls
5816 * into a single statement.
5817 *
5818 * @see #putExtras
5819 * @see #removeExtra
5820 * @see #getByteArrayExtra(String)
5821 */
5822 public Intent putExtra(String name, byte[] value) {
5823 if (mExtras == null) {
5824 mExtras = new Bundle();
5825 }
5826 mExtras.putByteArray(name, value);
5827 return this;
5828 }
5829
5830 /**
5831 * Add extended data to the intent. The name must include a package
5832 * prefix, for example the app com.android.contacts would use names
5833 * like "com.android.contacts.ShowAll".
5834 *
5835 * @param name The name of the extra data, with package prefix.
5836 * @param value The short array data value.
5837 *
5838 * @return Returns the same Intent object, for chaining multiple calls
5839 * into a single statement.
5840 *
5841 * @see #putExtras
5842 * @see #removeExtra
5843 * @see #getShortArrayExtra(String)
5844 */
5845 public Intent putExtra(String name, short[] value) {
5846 if (mExtras == null) {
5847 mExtras = new Bundle();
5848 }
5849 mExtras.putShortArray(name, value);
5850 return this;
5851 }
5852
5853 /**
5854 * Add extended data to the intent. The name must include a package
5855 * prefix, for example the app com.android.contacts would use names
5856 * like "com.android.contacts.ShowAll".
5857 *
5858 * @param name The name of the extra data, with package prefix.
5859 * @param value The char array data value.
5860 *
5861 * @return Returns the same Intent object, for chaining multiple calls
5862 * into a single statement.
5863 *
5864 * @see #putExtras
5865 * @see #removeExtra
5866 * @see #getCharArrayExtra(String)
5867 */
5868 public Intent putExtra(String name, char[] value) {
5869 if (mExtras == null) {
5870 mExtras = new Bundle();
5871 }
5872 mExtras.putCharArray(name, value);
5873 return this;
5874 }
5875
5876 /**
5877 * Add extended data to the intent. The name must include a package
5878 * prefix, for example the app com.android.contacts would use names
5879 * like "com.android.contacts.ShowAll".
5880 *
5881 * @param name The name of the extra data, with package prefix.
5882 * @param value The int array data value.
5883 *
5884 * @return Returns the same Intent object, for chaining multiple calls
5885 * into a single statement.
5886 *
5887 * @see #putExtras
5888 * @see #removeExtra
5889 * @see #getIntArrayExtra(String)
5890 */
5891 public Intent putExtra(String name, int[] value) {
5892 if (mExtras == null) {
5893 mExtras = new Bundle();
5894 }
5895 mExtras.putIntArray(name, value);
5896 return this;
5897 }
5898
5899 /**
5900 * Add extended data to the intent. The name must include a package
5901 * prefix, for example the app com.android.contacts would use names
5902 * like "com.android.contacts.ShowAll".
5903 *
5904 * @param name The name of the extra data, with package prefix.
5905 * @param value The byte array data value.
5906 *
5907 * @return Returns the same Intent object, for chaining multiple calls
5908 * into a single statement.
5909 *
5910 * @see #putExtras
5911 * @see #removeExtra
5912 * @see #getLongArrayExtra(String)
5913 */
5914 public Intent putExtra(String name, long[] value) {
5915 if (mExtras == null) {
5916 mExtras = new Bundle();
5917 }
5918 mExtras.putLongArray(name, value);
5919 return this;
5920 }
5921
5922 /**
5923 * Add extended data to the intent. The name must include a package
5924 * prefix, for example the app com.android.contacts would use names
5925 * like "com.android.contacts.ShowAll".
5926 *
5927 * @param name The name of the extra data, with package prefix.
5928 * @param value The float array data value.
5929 *
5930 * @return Returns the same Intent object, for chaining multiple calls
5931 * into a single statement.
5932 *
5933 * @see #putExtras
5934 * @see #removeExtra
5935 * @see #getFloatArrayExtra(String)
5936 */
5937 public Intent putExtra(String name, float[] value) {
5938 if (mExtras == null) {
5939 mExtras = new Bundle();
5940 }
5941 mExtras.putFloatArray(name, value);
5942 return this;
5943 }
5944
5945 /**
5946 * Add extended data to the intent. The name must include a package
5947 * prefix, for example the app com.android.contacts would use names
5948 * like "com.android.contacts.ShowAll".
5949 *
5950 * @param name The name of the extra data, with package prefix.
5951 * @param value The double array data value.
5952 *
5953 * @return Returns the same Intent object, for chaining multiple calls
5954 * into a single statement.
5955 *
5956 * @see #putExtras
5957 * @see #removeExtra
5958 * @see #getDoubleArrayExtra(String)
5959 */
5960 public Intent putExtra(String name, double[] value) {
5961 if (mExtras == null) {
5962 mExtras = new Bundle();
5963 }
5964 mExtras.putDoubleArray(name, value);
5965 return this;
5966 }
5967
5968 /**
5969 * Add extended data to the intent. The name must include a package
5970 * prefix, for example the app com.android.contacts would use names
5971 * like "com.android.contacts.ShowAll".
5972 *
5973 * @param name The name of the extra data, with package prefix.
5974 * @param value The String array data value.
5975 *
5976 * @return Returns the same Intent object, for chaining multiple calls
5977 * into a single statement.
5978 *
5979 * @see #putExtras
5980 * @see #removeExtra
5981 * @see #getStringArrayExtra(String)
5982 */
5983 public Intent putExtra(String name, String[] value) {
5984 if (mExtras == null) {
5985 mExtras = new Bundle();
5986 }
5987 mExtras.putStringArray(name, value);
5988 return this;
5989 }
5990
5991 /**
5992 * Add extended data to the intent. The name must include a package
5993 * prefix, for example the app com.android.contacts would use names
5994 * like "com.android.contacts.ShowAll".
5995 *
5996 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005997 * @param value The CharSequence array data value.
5998 *
5999 * @return Returns the same Intent object, for chaining multiple calls
6000 * into a single statement.
6001 *
6002 * @see #putExtras
6003 * @see #removeExtra
6004 * @see #getCharSequenceArrayExtra(String)
6005 */
6006 public Intent putExtra(String name, CharSequence[] value) {
6007 if (mExtras == null) {
6008 mExtras = new Bundle();
6009 }
6010 mExtras.putCharSequenceArray(name, value);
6011 return this;
6012 }
6013
6014 /**
6015 * Add extended data to the intent. The name must include a package
6016 * prefix, for example the app com.android.contacts would use names
6017 * like "com.android.contacts.ShowAll".
6018 *
6019 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006020 * @param value The Bundle data value.
6021 *
6022 * @return Returns the same Intent object, for chaining multiple calls
6023 * into a single statement.
6024 *
6025 * @see #putExtras
6026 * @see #removeExtra
6027 * @see #getBundleExtra(String)
6028 */
6029 public Intent putExtra(String name, Bundle value) {
6030 if (mExtras == null) {
6031 mExtras = new Bundle();
6032 }
6033 mExtras.putBundle(name, value);
6034 return this;
6035 }
6036
6037 /**
6038 * Add extended data to the intent. The name must include a package
6039 * prefix, for example the app com.android.contacts would use names
6040 * like "com.android.contacts.ShowAll".
6041 *
6042 * @param name The name of the extra data, with package prefix.
6043 * @param value The IBinder data value.
6044 *
6045 * @return Returns the same Intent object, for chaining multiple calls
6046 * into a single statement.
6047 *
6048 * @see #putExtras
6049 * @see #removeExtra
6050 * @see #getIBinderExtra(String)
6051 *
6052 * @deprecated
6053 * @hide
6054 */
6055 @Deprecated
6056 public Intent putExtra(String name, IBinder value) {
6057 if (mExtras == null) {
6058 mExtras = new Bundle();
6059 }
6060 mExtras.putIBinder(name, value);
6061 return this;
6062 }
6063
6064 /**
6065 * Copy all extras in 'src' in to this intent.
6066 *
6067 * @param src Contains the extras to copy.
6068 *
6069 * @see #putExtra
6070 */
6071 public Intent putExtras(Intent src) {
6072 if (src.mExtras != null) {
6073 if (mExtras == null) {
6074 mExtras = new Bundle(src.mExtras);
6075 } else {
6076 mExtras.putAll(src.mExtras);
6077 }
6078 }
6079 return this;
6080 }
6081
6082 /**
6083 * Add a set of extended data to the intent. The keys must include a package
6084 * prefix, for example the app com.android.contacts would use names
6085 * like "com.android.contacts.ShowAll".
6086 *
6087 * @param extras The Bundle of extras to add to this intent.
6088 *
6089 * @see #putExtra
6090 * @see #removeExtra
6091 */
6092 public Intent putExtras(Bundle extras) {
6093 if (mExtras == null) {
6094 mExtras = new Bundle();
6095 }
6096 mExtras.putAll(extras);
6097 return this;
6098 }
6099
6100 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006101 * Completely replace the extras in the Intent with the extras in the
6102 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006103 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006104 * @param src The exact extras contained in this Intent are copied
6105 * into the target intent, replacing any that were previously there.
6106 */
6107 public Intent replaceExtras(Intent src) {
6108 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6109 return this;
6110 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006111
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006112 /**
6113 * Completely replace the extras in the Intent with the given Bundle of
6114 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006115 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006116 * @param extras The new set of extras in the Intent, or null to erase
6117 * all extras.
6118 */
6119 public Intent replaceExtras(Bundle extras) {
6120 mExtras = extras != null ? new Bundle(extras) : null;
6121 return this;
6122 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006123
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006124 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006125 * Remove extended data from the intent.
6126 *
6127 * @see #putExtra
6128 */
6129 public void removeExtra(String name) {
6130 if (mExtras != null) {
6131 mExtras.remove(name);
6132 if (mExtras.size() == 0) {
6133 mExtras = null;
6134 }
6135 }
6136 }
6137
6138 /**
6139 * Set special flags controlling how this intent is handled. Most values
6140 * here depend on the type of component being executed by the Intent,
6141 * specifically the FLAG_ACTIVITY_* flags are all for use with
6142 * {@link Context#startActivity Context.startActivity()} and the
6143 * FLAG_RECEIVER_* flags are all for use with
6144 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6145 *
Scott Main7aee61f2011-02-08 11:25:01 -08006146 * <p>See the
6147 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6148 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006149 * the behavior of your application.
6150 *
6151 * @param flags The desired flags.
6152 *
6153 * @return Returns the same Intent object, for chaining multiple calls
6154 * into a single statement.
6155 *
6156 * @see #getFlags
6157 * @see #addFlags
6158 *
6159 * @see #FLAG_GRANT_READ_URI_PERMISSION
6160 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6161 * @see #FLAG_DEBUG_LOG_RESOLUTION
6162 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006163 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006164 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006165 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006166 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006167 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6168 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006169 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006170 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
6171 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006172 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006173 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006174 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006175 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6176 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006177 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006178 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006179 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006180 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6181 */
6182 public Intent setFlags(int flags) {
6183 mFlags = flags;
6184 return this;
6185 }
6186
6187 /**
6188 * Add additional flags to the intent (or with existing flags
6189 * value).
6190 *
6191 * @param flags The new flags to set.
6192 *
6193 * @return Returns the same Intent object, for chaining multiple calls
6194 * into a single statement.
6195 *
6196 * @see #setFlags
6197 */
6198 public Intent addFlags(int flags) {
6199 mFlags |= flags;
6200 return this;
6201 }
6202
6203 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006204 * (Usually optional) Set an explicit application package name that limits
6205 * the components this Intent will resolve to. If left to the default
6206 * value of null, all components in all applications will considered.
6207 * If non-null, the Intent can only match the components in the given
6208 * application package.
6209 *
6210 * @param packageName The name of the application package to handle the
6211 * intent, or null to allow any application package.
6212 *
6213 * @return Returns the same Intent object, for chaining multiple calls
6214 * into a single statement.
6215 *
6216 * @see #getPackage
6217 * @see #resolveActivity
6218 */
6219 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006220 if (packageName != null && mSelector != null) {
6221 throw new IllegalArgumentException(
6222 "Can't set package name when selector is already set");
6223 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006224 mPackage = packageName;
6225 return this;
6226 }
6227
6228 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006229 * (Usually optional) Explicitly set the component to handle the intent.
6230 * If left with the default value of null, the system will determine the
6231 * appropriate class to use based on the other fields (action, data,
6232 * type, categories) in the Intent. If this class is defined, the
6233 * specified class will always be used regardless of the other fields. You
6234 * should only set this value when you know you absolutely want a specific
6235 * class to be used; otherwise it is better to let the system find the
6236 * appropriate class so that you will respect the installed applications
6237 * and user preferences.
6238 *
6239 * @param component The name of the application component to handle the
6240 * intent, or null to let the system find one for you.
6241 *
6242 * @return Returns the same Intent object, for chaining multiple calls
6243 * into a single statement.
6244 *
6245 * @see #setClass
6246 * @see #setClassName(Context, String)
6247 * @see #setClassName(String, String)
6248 * @see #getComponent
6249 * @see #resolveActivity
6250 */
6251 public Intent setComponent(ComponentName component) {
6252 mComponent = component;
6253 return this;
6254 }
6255
6256 /**
6257 * Convenience for calling {@link #setComponent} with an
6258 * explicit class name.
6259 *
6260 * @param packageContext A Context of the application package implementing
6261 * this class.
6262 * @param className The name of a class inside of the application package
6263 * that will be used as the component for this Intent.
6264 *
6265 * @return Returns the same Intent object, for chaining multiple calls
6266 * into a single statement.
6267 *
6268 * @see #setComponent
6269 * @see #setClass
6270 */
6271 public Intent setClassName(Context packageContext, String className) {
6272 mComponent = new ComponentName(packageContext, className);
6273 return this;
6274 }
6275
6276 /**
6277 * Convenience for calling {@link #setComponent} with an
6278 * explicit application package name and class name.
6279 *
6280 * @param packageName The name of the package implementing the desired
6281 * component.
6282 * @param className The name of a class inside of the application package
6283 * that will be used as the component for this Intent.
6284 *
6285 * @return Returns the same Intent object, for chaining multiple calls
6286 * into a single statement.
6287 *
6288 * @see #setComponent
6289 * @see #setClass
6290 */
6291 public Intent setClassName(String packageName, String className) {
6292 mComponent = new ComponentName(packageName, className);
6293 return this;
6294 }
6295
6296 /**
6297 * Convenience for calling {@link #setComponent(ComponentName)} with the
6298 * name returned by a {@link Class} object.
6299 *
6300 * @param packageContext A Context of the application package implementing
6301 * this class.
6302 * @param cls The class name to set, equivalent to
6303 * <code>setClassName(context, cls.getName())</code>.
6304 *
6305 * @return Returns the same Intent object, for chaining multiple calls
6306 * into a single statement.
6307 *
6308 * @see #setComponent
6309 */
6310 public Intent setClass(Context packageContext, Class<?> cls) {
6311 mComponent = new ComponentName(packageContext, cls);
6312 return this;
6313 }
6314
6315 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006316 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6317 * used as a hint to the receiver for animations and the like. Null means that there
6318 * is no source bounds.
6319 */
6320 public void setSourceBounds(Rect r) {
6321 if (r != null) {
6322 mSourceBounds = new Rect(r);
6323 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006324 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006325 }
6326 }
6327
6328 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006329 * Use with {@link #fillIn} to allow the current action value to be
6330 * overwritten, even if it is already set.
6331 */
6332 public static final int FILL_IN_ACTION = 1<<0;
6333
6334 /**
6335 * Use with {@link #fillIn} to allow the current data or type value
6336 * overwritten, even if it is already set.
6337 */
6338 public static final int FILL_IN_DATA = 1<<1;
6339
6340 /**
6341 * Use with {@link #fillIn} to allow the current categories to be
6342 * overwritten, even if they are already set.
6343 */
6344 public static final int FILL_IN_CATEGORIES = 1<<2;
6345
6346 /**
6347 * Use with {@link #fillIn} to allow the current component value to be
6348 * overwritten, even if it is already set.
6349 */
6350 public static final int FILL_IN_COMPONENT = 1<<3;
6351
6352 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006353 * Use with {@link #fillIn} to allow the current package value to be
6354 * overwritten, even if it is already set.
6355 */
6356 public static final int FILL_IN_PACKAGE = 1<<4;
6357
6358 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006359 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006360 * overwritten, even if it is already set.
6361 */
6362 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6363
6364 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006365 * Use with {@link #fillIn} to allow the current selector to be
6366 * overwritten, even if it is already set.
6367 */
6368 public static final int FILL_IN_SELECTOR = 1<<6;
6369
6370 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006371 * Use with {@link #fillIn} to allow the current ClipData to be
6372 * overwritten, even if it is already set.
6373 */
6374 public static final int FILL_IN_CLIP_DATA = 1<<7;
6375
6376 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006377 * Copy the contents of <var>other</var> in to this object, but only
6378 * where fields are not defined by this object. For purposes of a field
6379 * being defined, the following pieces of data in the Intent are
6380 * considered to be separate fields:
6381 *
6382 * <ul>
6383 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006384 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006385 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6386 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006387 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006388 * <li> component, as set by {@link #setComponent(ComponentName)} or
6389 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006390 * <li> source bounds, as set by {@link #setSourceBounds}.
6391 * <li> selector, as set by {@link #setSelector(Intent)}.
6392 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006393 * <li> each top-level name in the associated extras.
6394 * </ul>
6395 *
6396 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006397 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006398 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6399 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6400 * the restriction where the corresponding field will not be replaced if
6401 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006402 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006403 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6404 * is explicitly specified. The selector will only be copied if
6405 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006406 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006407 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6408 * and Intent B with {action="gotit", data-type="some/thing",
6409 * categories="one","two"}.
6410 *
6411 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6412 * containing: {action="gotit", data-type="some/thing",
6413 * categories="bar"}.
6414 *
6415 * @param other Another Intent whose values are to be used to fill in
6416 * the current one.
6417 * @param flags Options to control which fields can be filled in.
6418 *
6419 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006420 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006421 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6422 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006423 */
6424 public int fillIn(Intent other, int flags) {
6425 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006426 if (other.mAction != null
6427 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006428 mAction = other.mAction;
6429 changes |= FILL_IN_ACTION;
6430 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006431 if ((other.mData != null || other.mType != null)
6432 && ((mData == null && mType == null)
6433 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006434 mData = other.mData;
6435 mType = other.mType;
6436 changes |= FILL_IN_DATA;
6437 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006438 if (other.mCategories != null
6439 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006440 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006441 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006442 }
6443 changes |= FILL_IN_CATEGORIES;
6444 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006445 if (other.mPackage != null
6446 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006447 // Only do this if mSelector is not set.
6448 if (mSelector == null) {
6449 mPackage = other.mPackage;
6450 changes |= FILL_IN_PACKAGE;
6451 }
6452 }
6453 // Selector is special: it can only be set if explicitly allowed,
6454 // for the same reason as the component name.
6455 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6456 if (mPackage == null) {
6457 mSelector = new Intent(other.mSelector);
6458 mPackage = null;
6459 changes |= FILL_IN_SELECTOR;
6460 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006461 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006462 if (other.mClipData != null
6463 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6464 mClipData = other.mClipData;
6465 changes |= FILL_IN_CLIP_DATA;
6466 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006467 // Component is special: it can -only- be set if explicitly allowed,
6468 // since otherwise the sender could force the intent somewhere the
6469 // originator didn't intend.
6470 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006471 mComponent = other.mComponent;
6472 changes |= FILL_IN_COMPONENT;
6473 }
6474 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006475 if (other.mSourceBounds != null
6476 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6477 mSourceBounds = new Rect(other.mSourceBounds);
6478 changes |= FILL_IN_SOURCE_BOUNDS;
6479 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006480 if (mExtras == null) {
6481 if (other.mExtras != null) {
6482 mExtras = new Bundle(other.mExtras);
6483 }
6484 } else if (other.mExtras != null) {
6485 try {
6486 Bundle newb = new Bundle(other.mExtras);
6487 newb.putAll(mExtras);
6488 mExtras = newb;
6489 } catch (RuntimeException e) {
6490 // Modifying the extras can cause us to unparcel the contents
6491 // of the bundle, and if we do this in the system process that
6492 // may fail. We really should handle this (i.e., the Bundle
6493 // impl shouldn't be on top of a plain map), but for now just
6494 // ignore it and keep the original contents. :(
6495 Log.w("Intent", "Failure filling in extras", e);
6496 }
6497 }
6498 return changes;
6499 }
6500
6501 /**
6502 * Wrapper class holding an Intent and implementing comparisons on it for
6503 * the purpose of filtering. The class implements its
6504 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6505 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6506 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6507 * on the wrapped Intent.
6508 */
6509 public static final class FilterComparison {
6510 private final Intent mIntent;
6511 private final int mHashCode;
6512
6513 public FilterComparison(Intent intent) {
6514 mIntent = intent;
6515 mHashCode = intent.filterHashCode();
6516 }
6517
6518 /**
6519 * Return the Intent that this FilterComparison represents.
6520 * @return Returns the Intent held by the FilterComparison. Do
6521 * not modify!
6522 */
6523 public Intent getIntent() {
6524 return mIntent;
6525 }
6526
6527 @Override
6528 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006529 if (obj instanceof FilterComparison) {
6530 Intent other = ((FilterComparison)obj).mIntent;
6531 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006532 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006533 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006534 }
6535
6536 @Override
6537 public int hashCode() {
6538 return mHashCode;
6539 }
6540 }
6541
6542 /**
6543 * Determine if two intents are the same for the purposes of intent
6544 * resolution (filtering). That is, if their action, data, type,
6545 * class, and categories are the same. This does <em>not</em> compare
6546 * any extra data included in the intents.
6547 *
6548 * @param other The other Intent to compare against.
6549 *
6550 * @return Returns true if action, data, type, class, and categories
6551 * are the same.
6552 */
6553 public boolean filterEquals(Intent other) {
6554 if (other == null) {
6555 return false;
6556 }
6557 if (mAction != other.mAction) {
6558 if (mAction != null) {
6559 if (!mAction.equals(other.mAction)) {
6560 return false;
6561 }
6562 } else {
6563 if (!other.mAction.equals(mAction)) {
6564 return false;
6565 }
6566 }
6567 }
6568 if (mData != other.mData) {
6569 if (mData != null) {
6570 if (!mData.equals(other.mData)) {
6571 return false;
6572 }
6573 } else {
6574 if (!other.mData.equals(mData)) {
6575 return false;
6576 }
6577 }
6578 }
6579 if (mType != other.mType) {
6580 if (mType != null) {
6581 if (!mType.equals(other.mType)) {
6582 return false;
6583 }
6584 } else {
6585 if (!other.mType.equals(mType)) {
6586 return false;
6587 }
6588 }
6589 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006590 if (mPackage != other.mPackage) {
6591 if (mPackage != null) {
6592 if (!mPackage.equals(other.mPackage)) {
6593 return false;
6594 }
6595 } else {
6596 if (!other.mPackage.equals(mPackage)) {
6597 return false;
6598 }
6599 }
6600 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006601 if (mComponent != other.mComponent) {
6602 if (mComponent != null) {
6603 if (!mComponent.equals(other.mComponent)) {
6604 return false;
6605 }
6606 } else {
6607 if (!other.mComponent.equals(mComponent)) {
6608 return false;
6609 }
6610 }
6611 }
6612 if (mCategories != other.mCategories) {
6613 if (mCategories != null) {
6614 if (!mCategories.equals(other.mCategories)) {
6615 return false;
6616 }
6617 } else {
6618 if (!other.mCategories.equals(mCategories)) {
6619 return false;
6620 }
6621 }
6622 }
6623
6624 return true;
6625 }
6626
6627 /**
6628 * Generate hash code that matches semantics of filterEquals().
6629 *
6630 * @return Returns the hash value of the action, data, type, class, and
6631 * categories.
6632 *
6633 * @see #filterEquals
6634 */
6635 public int filterHashCode() {
6636 int code = 0;
6637 if (mAction != null) {
6638 code += mAction.hashCode();
6639 }
6640 if (mData != null) {
6641 code += mData.hashCode();
6642 }
6643 if (mType != null) {
6644 code += mType.hashCode();
6645 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006646 if (mPackage != null) {
6647 code += mPackage.hashCode();
6648 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006649 if (mComponent != null) {
6650 code += mComponent.hashCode();
6651 }
6652 if (mCategories != null) {
6653 code += mCategories.hashCode();
6654 }
6655 return code;
6656 }
6657
6658 @Override
6659 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006660 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006661
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006662 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006663 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006664 b.append(" }");
6665
6666 return b.toString();
6667 }
6668
6669 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006670 public String toInsecureString() {
6671 StringBuilder b = new StringBuilder(128);
6672
6673 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006674 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006675 b.append(" }");
6676
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006677 return b.toString();
6678 }
Romain Guy4969af72009-06-17 10:53:19 -07006679
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006680 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006681 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006682 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006683
6684 b.append("Intent { ");
6685 toShortString(b, false, true, true, true);
6686 b.append(" }");
6687
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006688 return b.toString();
6689 }
6690
6691 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006692 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6693 StringBuilder b = new StringBuilder(128);
6694 toShortString(b, secure, comp, extras, clip);
6695 return b.toString();
6696 }
6697
6698 /** @hide */
6699 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6700 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006701 boolean first = true;
6702 if (mAction != null) {
6703 b.append("act=").append(mAction);
6704 first = false;
6705 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006706 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006707 if (!first) {
6708 b.append(' ');
6709 }
6710 first = false;
6711 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006712 for (int i=0; i<mCategories.size(); i++) {
6713 if (i > 0) b.append(',');
6714 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006715 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006716 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006717 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006718 if (mData != null) {
6719 if (!first) {
6720 b.append(' ');
6721 }
6722 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006723 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006724 if (secure) {
6725 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006726 } else {
6727 b.append(mData);
6728 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006729 }
6730 if (mType != null) {
6731 if (!first) {
6732 b.append(' ');
6733 }
6734 first = false;
6735 b.append("typ=").append(mType);
6736 }
6737 if (mFlags != 0) {
6738 if (!first) {
6739 b.append(' ');
6740 }
6741 first = false;
6742 b.append("flg=0x").append(Integer.toHexString(mFlags));
6743 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006744 if (mPackage != null) {
6745 if (!first) {
6746 b.append(' ');
6747 }
6748 first = false;
6749 b.append("pkg=").append(mPackage);
6750 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006751 if (comp && mComponent != null) {
6752 if (!first) {
6753 b.append(' ');
6754 }
6755 first = false;
6756 b.append("cmp=").append(mComponent.flattenToShortString());
6757 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006758 if (mSourceBounds != null) {
6759 if (!first) {
6760 b.append(' ');
6761 }
6762 first = false;
6763 b.append("bnds=").append(mSourceBounds.toShortString());
6764 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006765 if (mClipData != null) {
6766 if (!first) {
6767 b.append(' ');
6768 }
6769 first = false;
6770 if (clip) {
6771 b.append("clip={");
6772 mClipData.toShortString(b);
6773 b.append('}');
6774 } else {
6775 b.append("(has clip)");
6776 }
6777 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006778 if (extras && mExtras != null) {
6779 if (!first) {
6780 b.append(' ');
6781 }
6782 first = false;
6783 b.append("(has extras)");
6784 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006785 if (mSelector != null) {
6786 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006787 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006788 b.append("}");
6789 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006790 }
6791
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006792 /**
6793 * Call {@link #toUri} with 0 flags.
6794 * @deprecated Use {@link #toUri} instead.
6795 */
6796 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006797 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006798 return toUri(0);
6799 }
6800
6801 /**
6802 * Convert this Intent into a String holding a URI representation of it.
6803 * The returned URI string has been properly URI encoded, so it can be
6804 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6805 * Intent's data as the base URI, with an additional fragment describing
6806 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006807 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006808 * <p>You can convert the returned string back to an Intent with
6809 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006810 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006811 * @param flags Additional operating flags. Either 0 or
6812 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006813 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006814 * @return Returns a URI encoding URI string describing the entire contents
6815 * of the Intent.
6816 */
6817 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006818 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006819 String scheme = null;
6820 if (mData != null) {
6821 String data = mData.toString();
6822 if ((flags&URI_INTENT_SCHEME) != 0) {
6823 final int N = data.length();
6824 for (int i=0; i<N; i++) {
6825 char c = data.charAt(i);
6826 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6827 || c == '.' || c == '-') {
6828 continue;
6829 }
6830 if (c == ':' && i > 0) {
6831 // Valid scheme.
6832 scheme = data.substring(0, i);
6833 uri.append("intent:");
6834 data = data.substring(i+1);
6835 break;
6836 }
Tom Taylord4a47292009-12-21 13:59:18 -08006837
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006838 // No scheme.
6839 break;
6840 }
6841 }
6842 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006843
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006844 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6845 uri.append("intent:");
6846 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006847
6848 uri.append("#Intent;");
6849
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006850 toUriInner(uri, scheme, flags);
6851 if (mSelector != null) {
6852 uri.append("SEL;");
6853 // Note that for now we are not going to try to handle the
6854 // data part; not clear how to represent this as a URI, and
6855 // not much utility in it.
6856 mSelector.toUriInner(uri, null, flags);
6857 }
6858
6859 uri.append("end");
6860
6861 return uri.toString();
6862 }
6863
6864 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006865 if (scheme != null) {
6866 uri.append("scheme=").append(scheme).append(';');
6867 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006868 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006869 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006870 }
6871 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006872 for (int i=0; i<mCategories.size(); i++) {
6873 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006874 }
6875 }
6876 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006877 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006878 }
6879 if (mFlags != 0) {
6880 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6881 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006882 if (mPackage != null) {
6883 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6884 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006885 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006886 uri.append("component=").append(Uri.encode(
6887 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006888 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006889 if (mSourceBounds != null) {
6890 uri.append("sourceBounds=")
6891 .append(Uri.encode(mSourceBounds.flattenToString()))
6892 .append(';');
6893 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006894 if (mExtras != null) {
6895 for (String key : mExtras.keySet()) {
6896 final Object value = mExtras.get(key);
6897 char entryType =
6898 value instanceof String ? 'S' :
6899 value instanceof Boolean ? 'B' :
6900 value instanceof Byte ? 'b' :
6901 value instanceof Character ? 'c' :
6902 value instanceof Double ? 'd' :
6903 value instanceof Float ? 'f' :
6904 value instanceof Integer ? 'i' :
6905 value instanceof Long ? 'l' :
6906 value instanceof Short ? 's' :
6907 '\0';
6908
6909 if (entryType != '\0') {
6910 uri.append(entryType);
6911 uri.append('.');
6912 uri.append(Uri.encode(key));
6913 uri.append('=');
6914 uri.append(Uri.encode(value.toString()));
6915 uri.append(';');
6916 }
6917 }
6918 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006919 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006920
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006921 public int describeContents() {
6922 return (mExtras != null) ? mExtras.describeContents() : 0;
6923 }
6924
6925 public void writeToParcel(Parcel out, int flags) {
6926 out.writeString(mAction);
6927 Uri.writeToParcel(out, mData);
6928 out.writeString(mType);
6929 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006930 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006931 ComponentName.writeToParcel(mComponent, out);
6932
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006933 if (mSourceBounds != null) {
6934 out.writeInt(1);
6935 mSourceBounds.writeToParcel(out, flags);
6936 } else {
6937 out.writeInt(0);
6938 }
6939
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006940 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006941 final int N = mCategories.size();
6942 out.writeInt(N);
6943 for (int i=0; i<N; i++) {
6944 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006945 }
6946 } else {
6947 out.writeInt(0);
6948 }
6949
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006950 if (mSelector != null) {
6951 out.writeInt(1);
6952 mSelector.writeToParcel(out, flags);
6953 } else {
6954 out.writeInt(0);
6955 }
6956
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006957 if (mClipData != null) {
6958 out.writeInt(1);
6959 mClipData.writeToParcel(out, flags);
6960 } else {
6961 out.writeInt(0);
6962 }
6963
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006964 out.writeBundle(mExtras);
6965 }
6966
6967 public static final Parcelable.Creator<Intent> CREATOR
6968 = new Parcelable.Creator<Intent>() {
6969 public Intent createFromParcel(Parcel in) {
6970 return new Intent(in);
6971 }
6972 public Intent[] newArray(int size) {
6973 return new Intent[size];
6974 }
6975 };
6976
Dianne Hackborneb034652009-09-07 00:49:58 -07006977 /** @hide */
6978 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006979 readFromParcel(in);
6980 }
6981
6982 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006983 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006984 mData = Uri.CREATOR.createFromParcel(in);
6985 mType = in.readString();
6986 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006987 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006988 mComponent = ComponentName.readFromParcel(in);
6989
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006990 if (in.readInt() != 0) {
6991 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6992 }
6993
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006994 int N = in.readInt();
6995 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006996 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006997 int i;
6998 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006999 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007000 }
7001 } else {
7002 mCategories = null;
7003 }
7004
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007005 if (in.readInt() != 0) {
7006 mSelector = new Intent(in);
7007 }
7008
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007009 if (in.readInt() != 0) {
7010 mClipData = new ClipData(in);
7011 }
7012
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007013 mExtras = in.readBundle();
7014 }
7015
7016 /**
7017 * Parses the "intent" element (and its children) from XML and instantiates
7018 * an Intent object. The given XML parser should be located at the tag
7019 * where parsing should start (often named "intent"), from which the
7020 * basic action, data, type, and package and class name will be
7021 * retrieved. The function will then parse in to any child elements,
7022 * looking for <category android:name="xxx"> tags to add categories and
7023 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7024 * to the intent.
7025 *
7026 * @param resources The Resources to use when inflating resources.
7027 * @param parser The XML parser pointing at an "intent" tag.
7028 * @param attrs The AttributeSet interface for retrieving extended
7029 * attribute data at the current <var>parser</var> location.
7030 * @return An Intent object matching the XML data.
7031 * @throws XmlPullParserException If there was an XML parsing error.
7032 * @throws IOException If there was an I/O error.
7033 */
7034 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7035 throws XmlPullParserException, IOException {
7036 Intent intent = new Intent();
7037
7038 TypedArray sa = resources.obtainAttributes(attrs,
7039 com.android.internal.R.styleable.Intent);
7040
7041 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7042
7043 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7044 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7045 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7046
7047 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7048 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7049 if (packageName != null && className != null) {
7050 intent.setComponent(new ComponentName(packageName, className));
7051 }
7052
7053 sa.recycle();
7054
7055 int outerDepth = parser.getDepth();
7056 int type;
7057 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7058 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7059 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7060 continue;
7061 }
7062
7063 String nodeName = parser.getName();
7064 if (nodeName.equals("category")) {
7065 sa = resources.obtainAttributes(attrs,
7066 com.android.internal.R.styleable.IntentCategory);
7067 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7068 sa.recycle();
7069
7070 if (cat != null) {
7071 intent.addCategory(cat);
7072 }
7073 XmlUtils.skipCurrentTag(parser);
7074
7075 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007076 if (intent.mExtras == null) {
7077 intent.mExtras = new Bundle();
7078 }
7079 resources.parseBundleExtra("extra", attrs, intent.mExtras);
7080 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007081
7082 } else {
7083 XmlUtils.skipCurrentTag(parser);
7084 }
7085 }
7086
7087 return intent;
7088 }
Nick Pellyccae4122012-01-09 14:12:58 -08007089
7090 /**
7091 * Normalize a MIME data type.
7092 *
7093 * <p>A normalized MIME type has white-space trimmed,
7094 * content-type parameters removed, and is lower-case.
7095 * This aligns the type with Android best practices for
7096 * intent filtering.
7097 *
7098 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7099 * "text/x-vCard" becomes "text/x-vcard".
7100 *
7101 * <p>All MIME types received from outside Android (such as user input,
7102 * or external sources like Bluetooth, NFC, or the Internet) should
7103 * be normalized before they are used to create an Intent.
7104 *
7105 * @param type MIME data type to normalize
7106 * @return normalized MIME data type, or null if the input was null
7107 * @see {@link #setType}
7108 * @see {@link #setTypeAndNormalize}
7109 */
7110 public static String normalizeMimeType(String type) {
7111 if (type == null) {
7112 return null;
7113 }
7114
Elliott Hughescb64d432013-08-02 10:00:44 -07007115 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007116
7117 final int semicolonIndex = type.indexOf(';');
7118 if (semicolonIndex != -1) {
7119 type = type.substring(0, semicolonIndex);
7120 }
7121 return type;
7122 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007123
7124 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007125 * Prepare this {@link Intent} to leave an app process.
7126 *
7127 * @hide
7128 */
7129 public void prepareToLeaveProcess() {
7130 setAllowFds(false);
7131
7132 if (mSelector != null) {
7133 mSelector.prepareToLeaveProcess();
7134 }
7135 if (mClipData != null) {
7136 mClipData.prepareToLeaveProcess();
7137 }
7138
7139 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7140 // There are several ACTION_MEDIA_* broadcasts that send file://
7141 // Uris, so only check common actions.
7142 if (ACTION_VIEW.equals(mAction) ||
7143 ACTION_EDIT.equals(mAction) ||
7144 ACTION_ATTACH_DATA.equals(mAction)) {
7145 mData.checkFileUriExposed("Intent.getData()");
7146 }
7147 }
7148 }
7149
7150 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007151 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007152 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7153 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007154 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007155 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007156 * @hide
7157 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007158 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007159 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007160 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007161
7162 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007163 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007164
7165 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007166 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007167 try {
7168 // Inspect target intent to see if we need to migrate
7169 final Intent target = getParcelableExtra(EXTRA_INTENT);
7170 if (target != null && target.migrateExtraStreamToClipData()) {
7171 // Since we migrated in child, we need to promote ClipData
7172 // and flags to ourselves to grant.
7173 setClipData(target.getClipData());
7174 addFlags(target.getFlags()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07007175 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION
7176 | FLAG_PERSIST_GRANT_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007177 return true;
7178 } else {
7179 return false;
7180 }
7181 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007182 }
7183
7184 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007185 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007186 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7187 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7188 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7189 if (stream != null || text != null || htmlText != null) {
7190 final ClipData clipData = new ClipData(
7191 null, new String[] { getType() },
7192 new ClipData.Item(text, htmlText, null, stream));
7193 setClipData(clipData);
7194 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007195 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007196 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007197 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007198 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007199
7200 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007201 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007202 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7203 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7204 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7205 int num = -1;
7206 if (streams != null) {
7207 num = streams.size();
7208 }
7209 if (texts != null) {
7210 if (num >= 0 && num != texts.size()) {
7211 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007212 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007213 }
7214 num = texts.size();
7215 }
7216 if (htmlTexts != null) {
7217 if (num >= 0 && num != htmlTexts.size()) {
7218 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007219 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007220 }
7221 num = htmlTexts.size();
7222 }
7223 if (num > 0) {
7224 final ClipData clipData = new ClipData(
7225 null, new String[] { getType() },
7226 makeClipItem(streams, texts, htmlTexts, 0));
7227
7228 for (int i = 1; i < num; i++) {
7229 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7230 }
7231
7232 setClipData(clipData);
7233 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007234 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007235 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007236 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007237 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007238 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007239
7240 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007241 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007242
7243 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7244 ArrayList<String> htmlTexts, int which) {
7245 Uri uri = streams != null ? streams.get(which) : null;
7246 CharSequence text = texts != null ? texts.get(which) : null;
7247 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7248 return new ClipData.Item(text, htmlText, null, uri);
7249 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007250}