blob: be136205949418e4cbf571491715d62102cf4ea6 [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 Skorydfc7fd72013-08-05 19:23:41 -07001156 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT},
1157 * {@link #EXTRA_ASSIST_SERVICES_PACKAGES}, and {@link #EXTRA_ASSIST_SERVICES_CONTEXTS} can
1158 * provide additional optional contextual information about where the user was when they
1159 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001160 * Output: nothing.
1161 */
1162 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1163 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001164
1165 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001166 * Activity Action: Perform voice assist action.
1167 * <p>
Adam Skorydfc7fd72013-08-05 19:23:41 -07001168 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT},
1169 * {@link #EXTRA_ASSIST_SERVICES_PACKAGES}, and {@link #EXTRA_ASSIST_SERVICES_CONTEXTS} can
1170 * provide additional optional contextual information about where the user was when they
1171 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001172 * Output: nothing.
1173 */
1174 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1175 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1176
1177 /**
1178 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1179 * containing the name of the current foreground application package at the time
1180 * the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001181 */
1182 public static final String EXTRA_ASSIST_PACKAGE
1183 = "android.intent.extra.ASSIST_PACKAGE";
1184
1185 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001186 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1187 * containing additional contextual information supplied by the current
1188 * foreground app at the time of the assist request. This is a {@link Bundle} of
1189 * additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001190 */
1191 public static final String EXTRA_ASSIST_CONTEXT
1192 = "android.intent.extra.ASSIST_CONTEXT";
1193
Jim Miller07994402012-05-02 14:22:27 -07001194 /**
Adam Skorydfc7fd72013-08-05 19:23:41 -07001195 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1196 * containing an the names of the application package of foreground services at the time
1197 * of the assist request. This is an array of {@link String}s, with one entry
1198 * per service.
1199 */
1200 public static final String EXTRA_ASSIST_SERVICES_PACKAGES
1201 = "android.intent.extra.ASSIST_SERVICES_PACKAGES";
1202
1203 /**
1204 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1205 * containing additional contextual information supplied by the current
1206 * foreground services at the time of the assist request. This is an array
1207 * of {@link Bundle}s of additional data, with one {@link Bundle} per service.
1208 */
1209 public static final String EXTRA_ASSIST_SERVICES_CONTEXTS
1210 = "android.intent.extra.ASSIST_SERVICES_CONTEXTS";
1211
1212
1213 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001214 * Activity Action: List all available applications
1215 * <p>Input: Nothing.
1216 * <p>Output: nothing.
1217 */
1218 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1219 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1220 /**
1221 * Activity Action: Show settings for choosing wallpaper
1222 * <p>Input: Nothing.
1223 * <p>Output: Nothing.
1224 */
1225 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1226 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1227
1228 /**
1229 * Activity Action: Show activity for reporting a bug.
1230 * <p>Input: Nothing.
1231 * <p>Output: Nothing.
1232 */
1233 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1234 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1235
1236 /**
1237 * Activity Action: Main entry point for factory tests. Only used when
1238 * the device is booting in factory test node. The implementing package
1239 * must be installed in the system image.
1240 * <p>Input: nothing
1241 * <p>Output: nothing
1242 */
1243 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1244
1245 /**
1246 * Activity Action: The user pressed the "call" button to go to the dialer
1247 * or other appropriate UI for placing a call.
1248 * <p>Input: Nothing.
1249 * <p>Output: Nothing.
1250 */
1251 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1252 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1253
1254 /**
1255 * Activity Action: Start Voice Command.
1256 * <p>Input: Nothing.
1257 * <p>Output: Nothing.
1258 */
1259 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1260 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001261
1262 /**
1263 * Activity Action: Start action associated with long pressing on the
1264 * search key.
1265 * <p>Input: Nothing.
1266 * <p>Output: Nothing.
1267 */
1268 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1269 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001270
Jacek Surazski86b6c532009-05-13 14:38:28 +02001271 /**
1272 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1273 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001274 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001275 * <p>Input: No data is specified. The bug report is passed in using
1276 * an {@link #EXTRA_BUG_REPORT} field.
1277 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001278 *
1279 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001280 */
1281 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1282 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001283
1284 /**
1285 * Activity Action: Show power usage information to the user.
1286 * <p>Input: Nothing.
1287 * <p>Output: Nothing.
1288 */
1289 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1290 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001291
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001292 /**
1293 * Activity Action: Setup wizard to launch after a platform update. This
1294 * activity should have a string meta-data field associated with it,
1295 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1296 * the platform for setup. The activity will be launched only if
1297 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1298 * same value.
1299 * <p>Input: Nothing.
1300 * <p>Output: Nothing.
1301 * @hide
1302 */
1303 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1304 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001305
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001306 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001307 * Activity Action: Show settings for managing network data usage of a
1308 * specific application. Applications should define an activity that offers
1309 * options to control data usage.
1310 */
1311 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1312 public static final String ACTION_MANAGE_NETWORK_USAGE =
1313 "android.intent.action.MANAGE_NETWORK_USAGE";
1314
1315 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001316 * Activity Action: Launch application installer.
1317 * <p>
1318 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001319 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1320 * you can also use "package:<package-name>" to install an application for the
1321 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001322 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1323 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1324 * <p>
1325 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1326 * succeeded.
1327 *
1328 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1329 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1330 * @see #EXTRA_RETURN_RESULT
1331 */
1332 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1333 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1334
1335 /**
1336 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1337 * package. Specifies the installer package name; this package will receive the
1338 * {@link #ACTION_APP_ERROR} intent.
1339 */
1340 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1341 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1342
1343 /**
1344 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1345 * package. Specifies that the application being installed should not be
1346 * treated as coming from an unknown source, but as coming from the app
1347 * invoking the Intent. For this to work you must start the installer with
1348 * startActivityForResult().
1349 */
1350 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1351 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1352
1353 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001354 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1355 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001356 * data field originated from.
1357 */
rich cannings706e8ba2012-08-20 13:20:14 -07001358 public static final String EXTRA_ORIGINATING_URI
1359 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001360
1361 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001362 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1363 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1364 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001365 */
1366 public static final String EXTRA_REFERRER
1367 = "android.intent.extra.REFERRER";
1368
1369 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001370 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1371 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1372 * @hide
1373 */
1374 public static final String EXTRA_ORIGINATING_UID
1375 = "android.intent.extra.ORIGINATING_UID";
1376
1377 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001378 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1379 * package. Tells the installer UI to skip the confirmation with the user
1380 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001381 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1382 * will no longer show an interstitial message about updating existing
1383 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001384 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001385 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001386 public static final String EXTRA_ALLOW_REPLACE
1387 = "android.intent.extra.ALLOW_REPLACE";
1388
1389 /**
1390 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1391 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1392 * return to the application the result code of the install/uninstall. The returned result
1393 * code will be {@link android.app.Activity#RESULT_OK} on success or
1394 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1395 */
1396 public static final String EXTRA_RETURN_RESULT
1397 = "android.intent.extra.RETURN_RESULT";
1398
1399 /**
1400 * Package manager install result code. @hide because result codes are not
1401 * yet ready to be exposed.
1402 */
1403 public static final String EXTRA_INSTALL_RESULT
1404 = "android.intent.extra.INSTALL_RESULT";
1405
1406 /**
1407 * Activity Action: Launch application uninstaller.
1408 * <p>
1409 * Input: The data must be a package: URI whose scheme specific part is
1410 * the package name of the current installed package to be uninstalled.
1411 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1412 * <p>
1413 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1414 * succeeded.
1415 */
1416 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1417 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1418
1419 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001420 * Specify whether the package should be uninstalled for all users.
1421 * @hide because these should not be part of normal application flow.
1422 */
1423 public static final String EXTRA_UNINSTALL_ALL_USERS
1424 = "android.intent.extra.UNINSTALL_ALL_USERS";
1425
1426 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001427 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1428 * describing the last run version of the platform that was setup.
1429 * @hide
1430 */
1431 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1432
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001433 // ---------------------------------------------------------------------
1434 // ---------------------------------------------------------------------
1435 // Standard intent broadcast actions (see action variable).
1436
1437 /**
1438 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001439 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001440 * <p class="note">This is a protected intent that can only be sent
1441 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001442 */
1443 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1444 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1445 /**
1446 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001447 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001448 * <p class="note">This is a protected intent that can only be sent
1449 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001450 */
1451 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1452 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001453
1454 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001455 * Broadcast Action: Sent after the system stops dreaming.
1456 *
1457 * <p class="note">This is a protected intent that can only be sent by the system.
1458 * It is only sent to registered receivers.</p>
1459 */
1460 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1461 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1462
1463 /**
1464 * Broadcast Action: Sent after the system starts dreaming.
1465 *
1466 * <p class="note">This is a protected intent that can only be sent by the system.
1467 * It is only sent to registered receivers.</p>
1468 */
1469 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1470 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1471
1472 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001473 * 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 -07001474 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001475 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001476 * <p class="note">This is a protected intent that can only be sent
1477 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001478 */
1479 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001480 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001481
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001482 /**
1483 * Broadcast Action: The current time has changed. Sent every
1484 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001485 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001486 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1487 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001488 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001489 * <p class="note">This is a protected intent that can only be sent
1490 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001491 */
1492 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1493 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1494 /**
1495 * Broadcast Action: The time was set.
1496 */
1497 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1498 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1499 /**
1500 * Broadcast Action: The date has changed.
1501 */
1502 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1503 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1504 /**
1505 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1506 * <ul>
1507 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1508 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001509 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001510 * <p class="note">This is a protected intent that can only be sent
1511 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001512 */
1513 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1514 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1515 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001516 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1517 * DNS entries should be tossed.
1518 * @hide
1519 */
1520 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1521 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1522 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001523 * Alarm Changed Action: This is broadcast when the AlarmClock
1524 * application's alarm is set or unset. It is used by the
1525 * AlarmClock application and the StatusBar service.
1526 * @hide
1527 */
1528 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1529 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1530 /**
1531 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1532 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1533 * @hide
1534 */
1535 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1536 public static final String ACTION_SYNC_STATE_CHANGED
1537 = "android.intent.action.SYNC_STATE_CHANGED";
1538 /**
1539 * Broadcast Action: This is broadcast once, after the system has finished
1540 * booting. It can be used to perform application-specific initialization,
1541 * such as installing alarms. You must hold the
1542 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1543 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001544 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001545 * <p class="note">This is a protected intent that can only be sent
1546 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001547 */
1548 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1549 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1550 /**
1551 * Broadcast Action: This is broadcast when a user action should request a
1552 * temporary system dialog to dismiss. Some examples of temporary system
1553 * dialogs are the notification window-shade and the recent tasks dialog.
1554 */
1555 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1556 /**
1557 * Broadcast Action: Trigger the download and eventual installation
1558 * of a package.
1559 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001560 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001561 * <p class="note">This is a protected intent that can only be sent
1562 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001563 *
1564 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001565 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001566 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1568 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1569 /**
1570 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001571 * device. The data contains the name of the package. Note that the
1572 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001573 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001574 * <ul>
1575 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1576 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1577 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1578 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001579 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001580 * <p class="note">This is a protected intent that can only be sent
1581 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001582 */
1583 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1584 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1585 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001586 * Broadcast Action: A new version of an application package has been
1587 * installed, replacing an existing version that was previously installed.
1588 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001589 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001590 * <ul>
1591 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1592 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001593 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001594 * <p class="note">This is a protected intent that can only be sent
1595 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001596 */
1597 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1598 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1599 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001600 * Broadcast Action: A new version of your application has been installed
1601 * over an existing one. This is only sent to the application that was
1602 * replaced. It does not contain any additional data; to receive it, just
1603 * use an intent filter for this action.
1604 *
1605 * <p class="note">This is a protected intent that can only be sent
1606 * by the system.
1607 */
1608 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1609 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1610 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001611 * Broadcast Action: An existing application package has been removed from
1612 * the device. The data contains the name of the package. The package
1613 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001614 * <ul>
1615 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1616 * to the package.
1617 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1618 * application -- data and code -- is being removed.
1619 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1620 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1621 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001622 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001623 * <p class="note">This is a protected intent that can only be sent
1624 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001625 */
1626 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1627 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1628 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001629 * Broadcast Action: An existing application package has been completely
1630 * removed from the device. The data contains the name of the package.
1631 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1632 * {@link #EXTRA_DATA_REMOVED} is true and
1633 * {@link #EXTRA_REPLACING} is false of that broadcast.
1634 *
1635 * <ul>
1636 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1637 * to the package.
1638 * </ul>
1639 *
1640 * <p class="note">This is a protected intent that can only be sent
1641 * by the system.
1642 */
1643 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1644 public static final String ACTION_PACKAGE_FULLY_REMOVED
1645 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1646 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001647 * Broadcast Action: An existing application package has been changed (e.g.
1648 * a component has been enabled or disabled). The data contains the name of
1649 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001650 * <ul>
1651 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001652 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001653 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001654 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1655 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001656 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001657 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001658 * <p class="note">This is a protected intent that can only be sent
1659 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001660 */
1661 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1662 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1663 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001664 * @hide
1665 * Broadcast Action: Ask system services if there is any reason to
1666 * restart the given package. The data contains the name of the
1667 * package.
1668 * <ul>
1669 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1670 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1671 * </ul>
1672 *
1673 * <p class="note">This is a protected intent that can only be sent
1674 * by the system.
1675 */
1676 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1677 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1678 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001679 * Broadcast Action: The user has restarted a package, and all of its
1680 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001681 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001682 * be removed. Note that the restarted package does <em>not</em>
1683 * receive this broadcast.
1684 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001685 * <ul>
1686 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1687 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001688 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001689 * <p class="note">This is a protected intent that can only be sent
1690 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001691 */
1692 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1693 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1694 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001695 * Broadcast Action: The user has cleared the data of a package. This should
1696 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001697 * its persistent data is erased and this broadcast sent.
1698 * Note that the cleared package does <em>not</em>
1699 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001700 * <ul>
1701 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1702 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001703 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001704 * <p class="note">This is a protected intent that can only be sent
1705 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001706 */
1707 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1708 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1709 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001710 * Broadcast Action: A user ID has been removed from the system. The user
1711 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001712 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001713 * <p class="note">This is a protected intent that can only be sent
1714 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001715 */
1716 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1717 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001718
1719 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001720 * Broadcast Action: Sent to the installer package of an application
1721 * when that application is first launched (that is the first time it
1722 * is moved out of the stopped state). The data contains the name of the package.
1723 *
1724 * <p class="note">This is a protected intent that can only be sent
1725 * by the system.
1726 */
1727 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1728 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1729
1730 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001731 * Broadcast Action: Sent to the system package verifier when a package
1732 * needs to be verified. The data contains the package URI.
1733 * <p class="note">
1734 * This is a protected intent that can only be sent by the system.
1735 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001736 */
1737 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1738 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1739
1740 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001741 * Broadcast Action: Sent to the system package verifier when a package is
1742 * verified. The data contains the package URI.
1743 * <p class="note">
1744 * This is a protected intent that can only be sent by the system.
1745 */
1746 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1747 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1748
1749 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001750 * Broadcast Action: Resources for a set of packages (which were
1751 * previously unavailable) are currently
1752 * available since the media on which they exist is available.
1753 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1754 * list of packages whose availability changed.
1755 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1756 * list of uids of packages whose availability changed.
1757 * Note that the
1758 * packages in this list do <em>not</em> receive this broadcast.
1759 * The specified set of packages are now available on the system.
1760 * <p>Includes the following extras:
1761 * <ul>
1762 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1763 * whose resources(were previously unavailable) are currently available.
1764 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1765 * packages whose resources(were previously unavailable)
1766 * are currently available.
1767 * </ul>
1768 *
1769 * <p class="note">This is a protected intent that can only be sent
1770 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001771 */
1772 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001773 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1774 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001775
1776 /**
1777 * Broadcast Action: Resources for a set of packages are currently
1778 * unavailable since the media on which they exist is unavailable.
1779 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1780 * list of packages whose availability changed.
1781 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1782 * list of uids of packages whose availability changed.
1783 * The specified set of packages can no longer be
1784 * launched and are practically unavailable on the system.
1785 * <p>Inclues the following extras:
1786 * <ul>
1787 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1788 * whose resources are no longer available.
1789 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1790 * whose resources are no longer available.
1791 * </ul>
1792 *
1793 * <p class="note">This is a protected intent that can only be sent
1794 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001795 */
1796 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001797 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001798 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001799
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001800 /**
1801 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001802 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001803 * This should <em>only</em> be used to determine when the wallpaper
1804 * has changed to show the new wallpaper to the user. You should certainly
1805 * never, in response to this, change the wallpaper or other attributes of
1806 * it such as the suggested size. That would be crazy, right? You'd cause
1807 * all kinds of loops, especially if other apps are doing similar things,
1808 * right? Of course. So please don't do this.
1809 *
1810 * @deprecated Modern applications should use
1811 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1812 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1813 * shown behind their UI, rather than watching for this broadcast and
1814 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001815 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001816 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001817 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1818 /**
1819 * Broadcast Action: The current device {@link android.content.res.Configuration}
1820 * (orientation, locale, etc) has changed. When such a change happens, the
1821 * UIs (view hierarchy) will need to be rebuilt based on this new
1822 * information; for the most part, applications don't need to worry about
1823 * this, because the system will take care of stopping and restarting the
1824 * application to make sure it sees the new changes. Some system code that
1825 * can not be restarted will need to watch for this action and handle it
1826 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001827 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001828 * <p class="note">
1829 * You can <em>not</em> receive this through components declared
1830 * in manifests, only by explicitly registering for it with
1831 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1832 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001833 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001834 * <p class="note">This is a protected intent that can only be sent
1835 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001836 *
1837 * @see android.content.res.Configuration
1838 */
1839 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1840 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1841 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001842 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001843 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001844 * <p class="note">This is a protected intent that can only be sent
1845 * by the system.
1846 */
1847 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1848 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1849 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001850 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1851 * charging state, level, and other information about the battery.
1852 * See {@link android.os.BatteryManager} for documentation on the
1853 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001854 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001855 * <p class="note">
1856 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001857 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001858 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001859 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1860 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1861 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1862 * broadcasts that are sent and can be received through manifest
1863 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001864 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001865 * <p class="note">This is a protected intent that can only be sent
1866 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001867 */
1868 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1869 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1870 /**
1871 * Broadcast Action: Indicates low battery condition on the device.
1872 * This broadcast corresponds to the "Low battery warning" system dialog.
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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001876 */
1877 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1878 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1879 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001880 * Broadcast Action: Indicates the battery is now okay after being low.
1881 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1882 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001883 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001884 * <p class="note">This is a protected intent that can only be sent
1885 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001886 */
1887 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1888 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1889 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001890 * Broadcast Action: External power has been connected to the device.
1891 * This is intended for applications that wish to register specifically to this notification.
1892 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1893 * stay active to receive this notification. This action can be used to implement actions
1894 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001895 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001896 * <p class="note">This is a protected intent that can only be sent
1897 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001898 */
1899 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001900 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001901 /**
1902 * Broadcast Action: External power has been removed from the device.
1903 * This is intended for applications that wish to register specifically to this notification.
1904 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1905 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001906 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001907 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001908 * <p class="note">This is a protected intent that can only be sent
1909 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001910 */
1911 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001912 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001913 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001914 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001915 * Broadcast Action: Device is shutting down.
1916 * This is broadcast when the device is being shut down (completely turned
1917 * off, not sleeping). Once the broadcast is complete, the final shutdown
1918 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001919 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001920 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001921 * <p class="note">This is a protected intent that can only be sent
1922 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001923 * <p>May include the following extras:
1924 * <ul>
1925 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1926 * shutdown is only for userspace processes. If not set, assumed to be false.
1927 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001928 */
1929 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001930 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001931 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001932 * Activity Action: Start this activity to request system shutdown.
1933 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1934 * to request confirmation from the user before shutting down.
1935 *
1936 * <p class="note">This is a protected intent that can only be sent
1937 * by the system.
1938 *
1939 * {@hide}
1940 */
1941 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1942 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001943 * Broadcast Action: A sticky broadcast that indicates low memory
1944 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001945 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001946 * <p class="note">This is a protected intent that can only be sent
1947 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001948 */
1949 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1950 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1951 /**
1952 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001953 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001954 * <p class="note">This is a protected intent that can only be sent
1955 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001956 */
1957 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1958 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1959 /**
Jake Hambybb371632010-08-23 18:16:48 -07001960 * Broadcast Action: A sticky broadcast that indicates a memory full
1961 * condition on the device. This is intended for activities that want
1962 * to be able to fill the data partition completely, leaving only
1963 * enough free space to prevent system-wide SQLite failures.
1964 *
1965 * <p class="note">This is a protected intent that can only be sent
1966 * by the system.
1967 *
1968 * {@hide}
1969 */
1970 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1971 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1972 /**
1973 * Broadcast Action: Indicates memory full condition on the device
1974 * no longer exists.
1975 *
1976 * <p class="note">This is a protected intent that can only be sent
1977 * by the system.
1978 *
1979 * {@hide}
1980 */
1981 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1982 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1983 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001984 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1985 * and package management should be started.
1986 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1987 * notification.
1988 */
1989 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1990 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1991 /**
1992 * Broadcast Action: The device has entered USB Mass Storage mode.
1993 * This is used mainly for the USB Settings panel.
1994 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1995 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001996 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001997 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001998 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001999 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2000
2001 /**
2002 * Broadcast Action: The device has exited USB Mass Storage mode.
2003 * This is used mainly for the USB Settings panel.
2004 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2005 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002006 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002007 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002008 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002009 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2010
2011 /**
2012 * Broadcast Action: External media has been removed.
2013 * The path to the mount point for the removed media is contained in the Intent.mData field.
2014 */
2015 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2016 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2017
2018 /**
2019 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002020 * 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 -07002021 */
2022 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2023 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2024
2025 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002026 * Broadcast Action: External media is present, and being disk-checked
2027 * 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 -08002028 */
2029 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2030 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2031
2032 /**
2033 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2034 * 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 -08002035 */
2036 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2037 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2038
2039 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002040 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002041 * 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 -07002042 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2043 * media was mounted read only.
2044 */
2045 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2046 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2047
2048 /**
2049 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002050 * 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 -07002051 */
2052 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2053 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2054
2055 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002056 * Broadcast Action: External media is no longer being shared via USB mass storage.
2057 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2058 *
2059 * @hide
2060 */
2061 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2062
2063 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002064 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2065 * The path to the mount point for the removed media is contained in the Intent.mData field.
2066 */
2067 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2068 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2069
2070 /**
2071 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002072 * 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 -07002073 */
2074 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2075 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2076
2077 /**
2078 * Broadcast Action: User has expressed the desire to remove the external storage media.
2079 * Applications should close all files they have open within the mount point when they receive this intent.
2080 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2081 */
2082 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2083 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2084
2085 /**
2086 * Broadcast Action: The media scanner has started scanning a directory.
2087 * The path to the directory being scanned is contained in the Intent.mData field.
2088 */
2089 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2090 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2091
2092 /**
2093 * Broadcast Action: The media scanner has finished scanning a directory.
2094 * The path to the scanned directory is contained in the Intent.mData field.
2095 */
2096 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2097 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2098
2099 /**
2100 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2101 * The path to the file is contained in the Intent.mData field.
2102 */
2103 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2104 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2105
2106 /**
2107 * Broadcast Action: The "Media Button" was pressed. Includes a single
2108 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2109 * caused the broadcast.
2110 */
2111 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2112 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2113
2114 /**
2115 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2116 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2117 * caused the broadcast.
2118 */
2119 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2120 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2121
2122 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2123 // location; they are not general-purpose actions.
2124
2125 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002126 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002127 */
2128 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2129 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2130 "android.intent.action.GTALK_CONNECTED";
2131
2132 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002133 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002134 */
2135 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2136 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2137 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002138
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002139 /**
2140 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002141 */
2142 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2143 public static final String ACTION_INPUT_METHOD_CHANGED =
2144 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002145
2146 /**
2147 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2148 * more radios have been turned off or on. The intent will have the following extra value:</p>
2149 * <ul>
2150 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2151 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2152 * turned off</li>
2153 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002154 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002155 * <p class="note">This is a protected intent that can only be sent
2156 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002157 */
2158 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2159 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2160
2161 /**
2162 * Broadcast Action: Some content providers have parts of their namespace
2163 * where they publish new events or items that the user may be especially
2164 * interested in. For these things, they may broadcast this action when the
2165 * set of interesting items change.
2166 *
2167 * For example, GmailProvider sends this notification when the set of unread
2168 * mail in the inbox changes.
2169 *
2170 * <p>The data of the intent identifies which part of which provider
2171 * changed. When queried through the content resolver, the data URI will
2172 * return the data set in question.
2173 *
2174 * <p>The intent will have the following extra values:
2175 * <ul>
2176 * <li><em>count</em> - The number of items in the data set. This is the
2177 * same as the number of items in the cursor returned by querying the
2178 * data URI. </li>
2179 * </ul>
2180 *
2181 * This intent will be sent at boot (if the count is non-zero) and when the
2182 * data set changes. It is possible for the data set to change without the
2183 * count changing (for example, if a new unread message arrives in the same
2184 * sync operation in which a message is archived). The phone should still
2185 * ring/vibrate/etc as normal in this case.
2186 */
2187 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2188 public static final String ACTION_PROVIDER_CHANGED =
2189 "android.intent.action.PROVIDER_CHANGED";
2190
2191 /**
2192 * Broadcast Action: Wired Headset plugged in or unplugged.
2193 *
2194 * <p>The intent will have the following extra values:
2195 * <ul>
2196 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2197 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002198 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002199 * </ul>
2200 * </ul>
2201 */
2202 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2203 public static final String ACTION_HEADSET_PLUG =
2204 "android.intent.action.HEADSET_PLUG";
2205
2206 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002207 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2208 *
2209 * <p>The intent will have the following extra values:
2210 * <ul>
2211 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2212 * <li><em>name</em> - Headset type, human readable string </li>
2213 * </ul>
2214 * </ul>
2215 * @hide
2216 */
2217 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002218 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2219 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002220
2221 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002222 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002223 *
2224 * <p>The intent will have the following extra values:
2225 * <ul>
2226 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2227 * <li><em>name</em> - Headset type, human readable string </li>
2228 * </ul>
2229 * </ul>
2230 * @hide
2231 */
2232 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002233 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2234 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002235
2236 /**
2237 * Broadcast Action: A HMDI cable was plugged or unplugged
2238 *
2239 * <p>The intent will have the following extra values:
2240 * <ul>
2241 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2242 * <li><em>name</em> - HDMI cable, human readable string </li>
2243 * </ul>
2244 * </ul>
2245 * @hide
2246 */
2247 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2248 public static final String ACTION_HDMI_AUDIO_PLUG =
2249 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002250
2251 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002252 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2253 *
2254 * <p>The intent will have the following extra values:
2255 * <ul>
2256 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2257 * <li><em>card</em> - ALSA card number (integer) </li>
2258 * <li><em>device</em> - ALSA device number (integer) </li>
2259 * </ul>
2260 * </ul>
2261 * @hide
2262 */
2263 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2264 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2265 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2266
2267 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002268 * Broadcast Action: A USB audio device was plugged in or unplugged.
2269 *
2270 * <p>The intent will have the following extra values:
2271 * <ul>
2272 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2273 * <li><em>card</em> - ALSA card number (integer) </li>
2274 * <li><em>device</em> - ALSA device number (integer) </li>
2275 * </ul>
2276 * </ul>
2277 * @hide
2278 */
2279 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2280 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2281 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2282
2283 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002284 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2285 * <ul>
2286 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2287 * </ul>
2288 *
2289 * <p class="note">This is a protected intent that can only be sent
2290 * by the system.
2291 *
2292 * @hide
2293 */
2294 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2295 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2296 = "android.intent.action.ADVANCED_SETTINGS";
2297
2298 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002299 * Broadcast Action: An outgoing call is about to be placed.
2300 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002301 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002302 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002303 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002304 * the phone number originally intended to be dialed.</li>
2305 * </ul>
2306 * <p>Once the broadcast is finished, the resultData is used as the actual
2307 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002308 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002309 * outgoing call in turn: for example, a parental control application
2310 * might verify that the user is authorized to place the call at that
2311 * time, then a number-rewriting application might add an area code if
2312 * one was not specified.</p>
2313 * <p>For consistency, any receiver whose purpose is to prohibit phone
2314 * calls should have a priority of 0, to ensure it will see the final
2315 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002316 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002317 * should have a positive priority.
2318 * Negative priorities are reserved for the system for this broadcast;
2319 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002320 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2321 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002322 * <p>Emergency calls cannot be intercepted using this mechanism, and
2323 * other calls cannot be modified to call emergency numbers using this
2324 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002325 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2326 * call to use their own service instead. Those apps should first prevent
2327 * the call from being placed by setting resultData to <code>null</code>
2328 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002329 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002330 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2331 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002332 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002333 * <p class="note">This is a protected intent that can only be sent
2334 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002335 */
2336 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2337 public static final String ACTION_NEW_OUTGOING_CALL =
2338 "android.intent.action.NEW_OUTGOING_CALL";
2339
2340 /**
2341 * Broadcast Action: Have the device reboot. This is only for use by
2342 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002343 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002344 * <p class="note">This is a protected intent that can only be sent
2345 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002346 */
2347 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2348 public static final String ACTION_REBOOT =
2349 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002350
Wei Huang97ecc9c2009-05-11 17:44:20 -07002351 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002352 * Broadcast Action: A sticky broadcast for changes in the physical
2353 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002354 *
2355 * <p>The intent will have the following extra values:
2356 * <ul>
2357 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002358 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002359 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002360 * <p>This is intended for monitoring the current physical dock state.
2361 * See {@link android.app.UiModeManager} for the normal API dealing with
2362 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002363 */
2364 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2365 public static final String ACTION_DOCK_EVENT =
2366 "android.intent.action.DOCK_EVENT";
2367
2368 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002369 * Broadcast Action: A broadcast when idle maintenance can be started.
2370 * This means that the user is not interacting with the device and is
2371 * not expected to do so soon. Typical use of the idle maintenance is
2372 * to perform somehow expensive tasks that can be postponed at a moment
2373 * when they will not degrade user experience.
2374 * <p>
2375 * <p class="note">In order to keep the device responsive in case of an
2376 * unexpected user interaction, implementations of a maintenance task
2377 * should be interruptible. In such a scenario a broadcast with action
2378 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2379 * should not do the maintenance work in
2380 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2381 * maintenance service by {@link Context#startService(Intent)}. Also
2382 * you should hold a wake lock while your maintenance service is running
2383 * to prevent the device going to sleep.
2384 * </p>
2385 * <p>
2386 * <p class="note">This is a protected intent that can only be sent by
2387 * the system.
2388 * </p>
2389 *
2390 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002391 *
2392 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002393 */
2394 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2395 public static final String ACTION_IDLE_MAINTENANCE_START =
2396 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2397
2398 /**
2399 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2400 * This means that the user was not interacting with the device as a result
2401 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2402 * was sent and now the user started interacting with the device. Typical
2403 * use of the idle maintenance is to perform somehow expensive tasks that
2404 * can be postponed at a moment when they will not degrade user experience.
2405 * <p>
2406 * <p class="note">In order to keep the device responsive in case of an
2407 * unexpected user interaction, implementations of a maintenance task
2408 * should be interruptible. Hence, on receiving a broadcast with this
2409 * action, the maintenance task should be interrupted as soon as possible.
2410 * In other words, you should not do the maintenance work in
2411 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2412 * maintenance service that was started on receiving of
2413 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2414 * lock you acquired when your maintenance service started.
2415 * </p>
2416 * <p class="note">This is a protected intent that can only be sent
2417 * by the system.
2418 *
2419 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002420 *
2421 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002422 */
2423 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2424 public static final String ACTION_IDLE_MAINTENANCE_END =
2425 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2426
2427 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002428 * Broadcast Action: a remote intent is to be broadcasted.
2429 *
2430 * A remote intent is used for remote RPC between devices. The remote intent
2431 * is serialized and sent from one device to another device. The receiving
2432 * device parses the remote intent and broadcasts it. Note that anyone can
2433 * broadcast a remote intent. However, if the intent receiver of the remote intent
2434 * does not trust intent broadcasts from arbitrary intent senders, it should require
2435 * the sender to hold certain permissions so only trusted sender's broadcast will be
2436 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002437 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002438 */
2439 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002440 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002441
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002442 /**
2443 * Broadcast Action: hook for permforming cleanup after a system update.
2444 *
2445 * The broadcast is sent when the system is booting, before the
2446 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2447 * image. A receiver for this should do its work and then disable itself
2448 * so that it does not get run again at the next boot.
2449 * @hide
2450 */
2451 public static final String ACTION_PRE_BOOT_COMPLETED =
2452 "android.intent.action.PRE_BOOT_COMPLETED";
2453
Amith Yamasani13593602012-03-22 16:16:17 -07002454 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002455 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002456 * on restricted users. The broadcast intent contains an extra
2457 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2458 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2459 * String[] depending on the restriction type.<p/>
2460 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002461 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2462 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2463 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002464 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2465 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002466 * @see RestrictionEntry
2467 */
2468 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2469 "android.intent.action.GET_RESTRICTION_ENTRIES";
2470
2471 /**
Amith Yamasani655d0e22013-06-12 14:19:10 -07002472 * Activity to challenge the user for a PIN that was configured when setting up
2473 * restrictions. Launch the activity using
2474 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2475 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2476 * challenge.<p/>
2477 * Before launching this activity, make sure that there is a PIN in effect, by calling
2478 * {@link android.os.UserManager#hasRestrictionsPin()}.
2479 */
2480 public static final String ACTION_RESTRICTIONS_PIN_CHALLENGE =
2481 "android.intent.action.RESTRICTIONS_PIN_CHALLENGE";
2482
2483 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002484 * Sent the first time a user is starting, to allow system apps to
2485 * perform one time initialization. (This will not be seen by third
2486 * party applications because a newly initialized user does not have any
2487 * third party applications installed for it.) This is sent early in
2488 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002489 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2490 * broadcast, since it is part of a visible user interaction; be as quick
2491 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002492 */
2493 public static final String ACTION_USER_INITIALIZE =
2494 "android.intent.action.USER_INITIALIZE";
2495
2496 /**
2497 * Sent when a user switch is happening, causing the process's user to be
2498 * brought to the foreground. This is only sent to receivers registered
2499 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2500 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002501 * foreground. This is sent as a foreground
2502 * broadcast, since it is part of a visible user interaction; be as quick
2503 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002504 */
2505 public static final String ACTION_USER_FOREGROUND =
2506 "android.intent.action.USER_FOREGROUND";
2507
2508 /**
2509 * Sent when a user switch is happening, causing the process's user to be
2510 * sent to the background. This is only sent to receivers registered
2511 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2512 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002513 * background. This is sent as a foreground
2514 * broadcast, since it is part of a visible user interaction; be as quick
2515 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002516 */
2517 public static final String ACTION_USER_BACKGROUND =
2518 "android.intent.action.USER_BACKGROUND";
2519
2520 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002521 * Broadcast sent to the system when a user is added. Carries an extra
2522 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2523 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002524 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002525 * @hide
2526 */
2527 public static final String ACTION_USER_ADDED =
2528 "android.intent.action.USER_ADDED";
2529
2530 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002531 * Broadcast sent by the system when a user is started. Carries an extra
2532 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002533 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002534 * that has been started. This is sent as a foreground
2535 * broadcast, since it is part of a visible user interaction; be as quick
2536 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002537 * @hide
2538 */
2539 public static final String ACTION_USER_STARTED =
2540 "android.intent.action.USER_STARTED";
2541
2542 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002543 * Broadcast sent when a user is in the process of starting. Carries an extra
2544 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2545 * sent to registered receivers, not manifest receivers. It is sent to all
2546 * users (including the one that is being started). You must hold
2547 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2548 * this broadcast. This is sent as a background broadcast, since
2549 * its result is not part of the primary UX flow; to safely keep track of
2550 * started/stopped state of a user you can use this in conjunction with
2551 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2552 * other user state broadcasts since those are foreground broadcasts so can
2553 * execute in a different order.
2554 * @hide
2555 */
2556 public static final String ACTION_USER_STARTING =
2557 "android.intent.action.USER_STARTING";
2558
2559 /**
2560 * Broadcast sent when a user is going to be stopped. Carries an extra
2561 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2562 * sent to registered receivers, not manifest receivers. It is sent to all
2563 * users (including the one that is being stopped). You must hold
2564 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2565 * this broadcast. The user will not stop until all receivers have
2566 * handled the broadcast. This is sent as a background broadcast, since
2567 * its result is not part of the primary UX flow; to safely keep track of
2568 * started/stopped state of a user you can use this in conjunction with
2569 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2570 * other user state broadcasts since those are foreground broadcasts so can
2571 * execute in a different order.
2572 * @hide
2573 */
2574 public static final String ACTION_USER_STOPPING =
2575 "android.intent.action.USER_STOPPING";
2576
2577 /**
2578 * Broadcast sent to the system when a user is stopped. Carries an extra
2579 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2580 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2581 * specific package. This is only sent to registered receivers, not manifest
2582 * receivers. It is sent to all running users <em>except</em> the one that
2583 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002584 * @hide
2585 */
2586 public static final String ACTION_USER_STOPPED =
2587 "android.intent.action.USER_STOPPED";
2588
2589 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002590 * 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 -07002591 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002592 * one that has been removed. The user will not be completely removed until all receivers have
2593 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002594 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002595 * @hide
2596 */
2597 public static final String ACTION_USER_REMOVED =
2598 "android.intent.action.USER_REMOVED";
2599
2600 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002601 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002602 * the userHandle of the user to become the current one. This is only sent to
2603 * registered receivers, not manifest receivers. It is sent to all running users.
2604 * You must hold
2605 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002606 * @hide
2607 */
2608 public static final String ACTION_USER_SWITCHED =
2609 "android.intent.action.USER_SWITCHED";
2610
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002611 /**
2612 * Broadcast sent to the system when a user's information changes. Carries an extra
2613 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002614 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002615 * @hide
2616 */
2617 public static final String ACTION_USER_INFO_CHANGED =
2618 "android.intent.action.USER_INFO_CHANGED";
2619
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002620 /**
2621 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2622 */
2623 public static final String ACTION_QUICK_CLOCK =
2624 "android.intent.action.QUICK_CLOCK";
2625
Michael Wright0087a142013-02-05 16:29:39 -08002626 /**
2627 * Broadcast Action: This is broadcast when a user action should request the
2628 * brightness setting dialog.
2629 * @hide
2630 */
2631 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2632 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2633
Justin Kohd378ad72013-04-01 12:18:26 -07002634 /**
2635 * Broadcast Action: A global button was pressed. Includes a single
2636 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2637 * caused the broadcast.
2638 * @hide
2639 */
2640 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2641
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002642 /**
2643 * Activity Action: Allow the user to select and open one or more existing
2644 * documents. Both read and write access to the documents will be granted
2645 * until explicitly revoked by the user.
2646 * <p>
2647 * Callers can restrict selection to a specific kind of data, such as
2648 * photos, by setting one or more MIME types in {@link #EXTRA_MIME_TYPES}.
2649 * <p>
2650 * If the caller can handle multiple returned items (the user performing
2651 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE} to
2652 * indicate this.
2653 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002654 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2655 * returned URIs can be opened with
2656 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002657 * <p>
2658 * Output: The URI of the item that was picked. This must be a content: URI
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002659 * so that any receiver can access it. If multiple documents were selected,
2660 * they are returned in {@link #getClipData()}.
2661 *
2662 * @see DocumentsContract
2663 * @see DocumentsContract#getOpenDocuments(Context)
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002664 */
2665 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2666 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2667
2668 /**
2669 * Activity Action: Allow the user to create a new document. Both read and
2670 * write access to the document will be granted until explicitly revoked by
2671 * the user.
2672 * <p>
2673 * Callers can provide a hint document name by setting {@link #EXTRA_TITLE},
2674 * but the user may change this value before creating the file. Callers can
2675 * optionally hint at the MIME type being created by setting
2676 * {@link #setType(String)}.
2677 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002678 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2679 * returned URIs can be opened with
2680 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002681 * <p>
2682 * Output: The URI of the item that was created. This must be a content: URI
2683 * so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002684 *
2685 * @see DocumentsContract
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002686 */
2687 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2688 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2689
Jeff Sharkeya5599ef2013-08-15 16:17:41 -07002690 /** {@hide} */
2691 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2692 public static final String ACTION_MANAGE_DOCUMENT = "android.intent.action.MANAGE_DOCUMENT";
2693
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002694 // ---------------------------------------------------------------------
2695 // ---------------------------------------------------------------------
2696 // Standard intent categories (see addCategory()).
2697
2698 /**
2699 * Set if the activity should be an option for the default action
2700 * (center press) to perform on a piece of data. Setting this will
2701 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002702 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002703 * Intent when initiating an action -- it is for use in intent filters
2704 * specified in packages.
2705 */
2706 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2707 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2708 /**
2709 * Activities that can be safely invoked from a browser must support this
2710 * category. For example, if the user is viewing a web page or an e-mail
2711 * and clicks on a link in the text, the Intent generated execute that
2712 * link will require the BROWSABLE category, so that only activities
2713 * supporting this category will be considered as possible actions. By
2714 * supporting this category, you are promising that there is nothing
2715 * damaging (without user intervention) that can happen by invoking any
2716 * matching Intent.
2717 */
2718 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2719 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2720 /**
2721 * Set if the activity should be considered as an alternative action to
2722 * the data the user is currently viewing. See also
2723 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2724 * applies to the selection in a list of items.
2725 *
2726 * <p>Supporting this category means that you would like your activity to be
2727 * displayed in the set of alternative things the user can do, usually as
2728 * part of the current activity's options menu. You will usually want to
2729 * include a specific label in the &lt;intent-filter&gt; of this action
2730 * describing to the user what it does.
2731 *
2732 * <p>The action of IntentFilter with this category is important in that it
2733 * describes the specific action the target will perform. This generally
2734 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2735 * a specific name such as "com.android.camera.action.CROP. Only one
2736 * alternative of any particular action will be shown to the user, so using
2737 * a specific action like this makes sure that your alternative will be
2738 * displayed while also allowing other applications to provide their own
2739 * overrides of that particular action.
2740 */
2741 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2742 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2743 /**
2744 * Set if the activity should be considered as an alternative selection
2745 * action to the data the user has currently selected. This is like
2746 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2747 * of items from which the user can select, giving them alternatives to the
2748 * default action that will be performed on it.
2749 */
2750 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2751 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2752 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002753 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002754 */
2755 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2756 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2757 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002758 * Should be displayed in the top-level launcher.
2759 */
2760 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2761 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2762 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002763 * Provides information about the package it is in; typically used if
2764 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2765 * a front-door to the user without having to be shown in the all apps list.
2766 */
2767 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2768 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2769 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002770 * This is the home activity, that is the first activity that is displayed
2771 * when the device boots.
2772 */
2773 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2774 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2775 /**
2776 * This activity is a preference panel.
2777 */
2778 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2779 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2780 /**
2781 * This activity is a development preference panel.
2782 */
2783 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2784 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2785 /**
2786 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002787 */
2788 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2789 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2790 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002791 * This activity allows the user to browse and download new applications.
2792 */
2793 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2794 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2795 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002796 * This activity may be exercised by the monkey or other automated test tools.
2797 */
2798 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2799 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2800 /**
2801 * To be used as a test (not part of the normal user experience).
2802 */
2803 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2804 /**
2805 * To be used as a unit test (run through the Test Harness).
2806 */
2807 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2808 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002809 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002810 * experience).
2811 */
2812 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2813 /**
2814 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
Dianne Hackborna53ee352013-02-20 12:47:02 -08002815 * ContentResolver.openInputStream. Openable URIs must support the columns in
2816 * {@link android.provider.OpenableColumns}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002817 * when queried, though it is allowable for those columns to be blank.
2818 */
2819 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2820 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2821
2822 /**
2823 * To be used as code under test for framework instrumentation tests.
2824 */
2825 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2826 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002827 /**
2828 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002829 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2830 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002831 */
2832 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2833 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2834 /**
2835 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002836 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2837 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002838 */
2839 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2840 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002841 /**
2842 * An activity to run when device is inserted into a analog (low end) dock.
2843 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2844 * information, see {@link android.app.UiModeManager}.
2845 */
2846 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2847 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2848
2849 /**
2850 * An activity to run when device is inserted into a digital (high end) dock.
2851 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2852 * information, see {@link android.app.UiModeManager}.
2853 */
2854 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2855 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002856
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002857 /**
2858 * Used to indicate that the activity can be used in a car environment.
2859 */
2860 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2861 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2862
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002863 // ---------------------------------------------------------------------
2864 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002865 // Application launch intent categories (see addCategory()).
2866
2867 /**
2868 * Used with {@link #ACTION_MAIN} to launch the browser application.
2869 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002870 * <p>NOTE: This should not be used as the primary key of an Intent,
2871 * since it will not result in the app launching with the correct
2872 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002873 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002874 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002875 */
2876 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2877 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2878
2879 /**
2880 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2881 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002882 * <p>NOTE: This should not be used as the primary key of an Intent,
2883 * since it will not result in the app launching with the correct
2884 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002885 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002886 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002887 */
2888 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2889 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2890
2891 /**
2892 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2893 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002894 * <p>NOTE: This should not be used as the primary key of an Intent,
2895 * since it will not result in the app launching with the correct
2896 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002897 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002898 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002899 */
2900 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2901 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2902
2903 /**
2904 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2905 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002906 * <p>NOTE: This should not be used as the primary key of an Intent,
2907 * since it will not result in the app launching with the correct
2908 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002909 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002910 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002911 */
2912 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2913 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2914
2915 /**
2916 * Used with {@link #ACTION_MAIN} to launch the email application.
2917 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002918 * <p>NOTE: This should not be used as the primary key of an Intent,
2919 * since it will not result in the app launching with the correct
2920 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002921 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002922 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002923 */
2924 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2925 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2926
2927 /**
2928 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2929 * The activity should be able to view and manipulate image and video files
2930 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002931 * <p>NOTE: This should not be used as the primary key of an Intent,
2932 * since it will not result in the app launching with the correct
2933 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002934 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002935 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002936 */
2937 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2938 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2939
2940 /**
2941 * Used with {@link #ACTION_MAIN} to launch the maps application.
2942 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002943 * <p>NOTE: This should not be used as the primary key of an Intent,
2944 * since it will not result in the app launching with the correct
2945 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002946 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002947 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002948 */
2949 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2950 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2951
2952 /**
2953 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2954 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002955 * <p>NOTE: This should not be used as the primary key of an Intent,
2956 * since it will not result in the app launching with the correct
2957 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002958 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002959 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002960 */
2961 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2962 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2963
2964 /**
2965 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002966 * The activity should be able to play, browse, or manipulate music files
2967 * stored on the device.
2968 * <p>NOTE: This should not be used as the primary key of an Intent,
2969 * since it will not result in the app launching with the correct
2970 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002971 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002972 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002973 */
2974 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2975 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2976
2977 // ---------------------------------------------------------------------
2978 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002979 // Standard extra data keys.
2980
2981 /**
2982 * The initial data to place in a newly created record. Use with
2983 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2984 * fields as would be given to the underlying ContentProvider.insert()
2985 * call.
2986 */
2987 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2988
2989 /**
2990 * A constant CharSequence that is associated with the Intent, used with
2991 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2992 * this may be a styled CharSequence, so you must use
2993 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2994 * retrieve it.
2995 */
2996 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2997
2998 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002999 * A constant String that is associated with the Intent, used with
3000 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3001 * as HTML formatted text. Note that you <em>must</em> also supply
3002 * {@link #EXTRA_TEXT}.
3003 */
3004 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3005
3006 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003007 * A content: URI holding a stream of data associated with the Intent,
3008 * used with {@link #ACTION_SEND} to supply the data being sent.
3009 */
3010 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3011
3012 /**
3013 * A String[] holding e-mail addresses that should be delivered to.
3014 */
3015 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3016
3017 /**
3018 * A String[] holding e-mail addresses that should be carbon copied.
3019 */
3020 public static final String EXTRA_CC = "android.intent.extra.CC";
3021
3022 /**
3023 * A String[] holding e-mail addresses that should be blind carbon copied.
3024 */
3025 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3026
3027 /**
3028 * A constant string holding the desired subject line of a message.
3029 */
3030 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3031
3032 /**
3033 * An Intent describing the choices you would like shown with
3034 * {@link #ACTION_PICK_ACTIVITY}.
3035 */
3036 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3037
3038 /**
3039 * A CharSequence dialog title to provide to the user when used with a
3040 * {@link #ACTION_CHOOSER}.
3041 */
3042 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3043
3044 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003045 * A Parcelable[] of {@link Intent} or
3046 * {@link android.content.pm.LabeledIntent} objects as set with
3047 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3048 * a the front of the list of choices, when shown to the user with a
3049 * {@link #ACTION_CHOOSER}.
3050 */
3051 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3052
3053 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003054 * A {@link android.view.KeyEvent} object containing the event that
3055 * triggered the creation of the Intent it is in.
3056 */
3057 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3058
3059 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003060 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3061 * before shutting down.
3062 *
3063 * {@hide}
3064 */
3065 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3066
3067 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003068 * 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 -07003069 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3070 * of restarting the application.
3071 */
3072 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3073
3074 /**
3075 * A String holding the phone number originally entered in
3076 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3077 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3078 */
3079 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003080
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003081 /**
3082 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3083 * intents to supply the uid the package had been assigned. Also an optional
3084 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3085 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3086 * purpose.
3087 */
3088 public static final String EXTRA_UID = "android.intent.extra.UID";
3089
3090 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003091 * @hide String array of package names.
3092 */
3093 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3094
3095 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003096 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3097 * intents to indicate whether this represents a full uninstall (removing
3098 * both the code and its data) or a partial uninstall (leaving its data,
3099 * implying that this is an update).
3100 */
3101 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003102
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003103 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003104 * @hide
3105 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3106 * intents to indicate that at this point the package has been removed for
3107 * all users on the device.
3108 */
3109 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3110 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3111
3112 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003113 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3114 * intents to indicate that this is a replacement of the package, so this
3115 * broadcast will immediately be followed by an add broadcast for a
3116 * different version of the same package.
3117 */
3118 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003119
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003120 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003121 * Used as an int extra field in {@link android.app.AlarmManager} intents
3122 * to tell the application being invoked how many pending alarms are being
3123 * delievered with the intent. For one-shot alarms this will always be 1.
3124 * For recurring alarms, this might be greater than 1 if the device was
3125 * asleep or powered off at the time an earlier alarm would have been
3126 * delivered.
3127 */
3128 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003129
Jacek Surazski86b6c532009-05-13 14:38:28 +02003130 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003131 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3132 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003133 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3134 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003135 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3136 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3137 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003138 */
3139 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3140
3141 /**
3142 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3143 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003144 */
3145 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3146
3147 /**
3148 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3149 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003150 */
3151 public static final int EXTRA_DOCK_STATE_DESK = 1;
3152
3153 /**
3154 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3155 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003156 */
3157 public static final int EXTRA_DOCK_STATE_CAR = 2;
3158
3159 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003160 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3161 * to represent that the phone is in a analog (low end) dock.
3162 */
3163 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3164
3165 /**
3166 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3167 * to represent that the phone is in a digital (high end) dock.
3168 */
3169 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3170
3171 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003172 * Boolean that can be supplied as meta-data with a dock activity, to
3173 * indicate that the dock should take over the home key when it is active.
3174 */
3175 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003176
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003177 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003178 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3179 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003180 */
3181 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3182
3183 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003184 * Used in the extra field in the remote intent. It's astring token passed with the
3185 * remote intent.
3186 */
3187 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3188 "android.intent.extra.remote_intent_token";
3189
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003190 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003191 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003192 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003193 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003194 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003195 "android.intent.extra.changed_component_name";
3196
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003197 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003198 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003199 * and contains a string array of all of the components that have changed. If
3200 * the state of the overall package has changed, then it will contain an entry
3201 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003202 */
3203 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3204 "android.intent.extra.changed_component_name_list";
3205
3206 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003207 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003208 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3209 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003210 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003211 */
3212 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3213 "android.intent.extra.changed_package_list";
3214
3215 /**
3216 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003217 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3218 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003219 * and contains an integer array of uids of all of the components
3220 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003221 */
3222 public static final String EXTRA_CHANGED_UID_LIST =
3223 "android.intent.extra.changed_uid_list";
3224
3225 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003226 * @hide
3227 * Magic extra system code can use when binding, to give a label for
3228 * who it is that has bound to a service. This is an integer giving
3229 * a framework string resource that can be displayed to the user.
3230 */
3231 public static final String EXTRA_CLIENT_LABEL =
3232 "android.intent.extra.client_label";
3233
3234 /**
3235 * @hide
3236 * Magic extra system code can use when binding, to give a PendingIntent object
3237 * that can be launched for the user to disable the system's use of this
3238 * service.
3239 */
3240 public static final String EXTRA_CLIENT_INTENT =
3241 "android.intent.extra.client_intent";
3242
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003243 /**
3244 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3245 * data that is on the local device. This is a boolean extra; the default
3246 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3247 * the user to select media that is already on the device, not requiring it
3248 * be downloaded from a remote service when opened. Another way to look
3249 * at it is that such content should generally have a "_data" column to the
3250 * path of the content on local external storage.
3251 */
3252 public static final String EXTRA_LOCAL_ONLY =
3253 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003254
Amith Yamasani13593602012-03-22 16:16:17 -07003255 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003256 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3257 * user to select and return multiple items. This is a boolean extra; the default
3258 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3259 * present the user with a UI where they can pick multiple items that are all
3260 * returned to the caller. When this happens, they should be returned as
3261 * the {@link #getClipData()} part of the result Intent.
3262 */
3263 public static final String EXTRA_ALLOW_MULTIPLE =
3264 "android.intent.extra.ALLOW_MULTIPLE";
3265
3266 /**
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003267 * The userHandle carried with broadcast intents related to addition, removal and switching of
3268 * users
Amith Yamasani13593602012-03-22 16:16:17 -07003269 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3270 * @hide
3271 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003272 public static final String EXTRA_USER_HANDLE =
3273 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003274
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003275 /**
3276 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003277 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3278 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003279 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003280 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3281
3282 /**
3283 * Extra sent in the intent to the BroadcastReceiver that handles
3284 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3285 * the restrictions as key/value pairs.
3286 */
3287 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3288 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003289
Amith Yamasani86118ba2013-03-28 14:33:16 -07003290 /**
3291 * Extra used in the response from a BroadcastReceiver that handles
3292 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3293 */
3294 public static final String EXTRA_RESTRICTIONS_INTENT =
3295 "android.intent.extra.restrictions_intent";
3296
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003297 /**
3298 * Extra used to communicate set of acceptable MIME types for
Jeff Sharkey9ab3fd42013-05-01 18:12:12 -07003299 * {@link #ACTION_GET_CONTENT} or {@link #ACTION_OPEN_DOCUMENT}. The type of the
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003300 * extra is <code>ArrayList&lt;String&gt;</code>.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003301 */
3302 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3303
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003304 /**
3305 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3306 * this shutdown is only for the user space of the system, not a complete shutdown.
3307 * Hardware should not be shut down when this is true. The default if not supplied
3308 * is false.
3309 */
3310 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3311 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3312
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003313 // ---------------------------------------------------------------------
3314 // ---------------------------------------------------------------------
3315 // Intent flags (see mFlags variable).
3316
3317 /**
3318 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003319 * perform read operations on the Uri in the Intent's data and any URIs
3320 * specified in its ClipData. When applying to an Intent's ClipData,
3321 * all URIs as well as recursive traversals through data or other ClipData
3322 * in Intent items will be granted; only the grant flags of the top-level
3323 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003324 */
3325 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3326 /**
3327 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003328 * perform write operations on the Uri in the Intent's data and any URIs
3329 * specified in its ClipData. When applying to an Intent's ClipData,
3330 * all URIs as well as recursive traversals through data or other ClipData
3331 * in Intent items will be granted; only the grant flags of the top-level
3332 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003333 */
3334 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3335 /**
3336 * Can be set by the caller to indicate that this Intent is coming from
3337 * a background operation, not from direct user interaction.
3338 */
3339 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3340 /**
3341 * A flag you can enable for debugging: when set, log messages will be
3342 * printed during the resolution of this intent to show you what has
3343 * been found to create the final resolved list.
3344 */
3345 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003346 /**
3347 * If set, this intent will not match any components in packages that
3348 * are currently stopped. If this is not set, then the default behavior
3349 * is to include such applications in the result.
3350 */
3351 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3352 /**
3353 * If set, this intent will always match any components in packages that
3354 * are currently stopped. This is the default behavior when
3355 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3356 * flags are set, this one wins (it allows overriding of exclude for
3357 * places where the framework may automatically set the exclude flag).
3358 */
3359 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003360
3361 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003362 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3363 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the grant will be remembered
3364 * until explicitly revoked with
3365 * {@link Context#revokeUriPermission(Uri, int)}. These grants persist
3366 * across device reboots.
3367 */
3368 public static final int FLAG_PERSIST_GRANT_URI_PERMISSION = 0x00000040;
3369
3370 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003371 * If set, the new activity is not kept in the history stack. As soon as
3372 * the user navigates away from it, the activity is finished. This may also
3373 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3374 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003375 */
3376 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3377 /**
3378 * If set, the activity will not be launched if it is already running
3379 * at the top of the history stack.
3380 */
3381 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3382 /**
3383 * If set, this activity will become the start of a new task on this
3384 * history stack. A task (from the activity that started it to the
3385 * next task activity) defines an atomic group of activities that the
3386 * user can move to. Tasks can be moved to the foreground and background;
3387 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003388 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003389 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3390 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003391 *
3392 * <p>This flag is generally used by activities that want
3393 * to present a "launcher" style behavior: they give the user a list of
3394 * separate things that can be done, which otherwise run completely
3395 * independently of the activity launching them.
3396 *
3397 * <p>When using this flag, if a task is already running for the activity
3398 * you are now starting, then a new activity will not be started; instead,
3399 * the current task will simply be brought to the front of the screen with
3400 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3401 * to disable this behavior.
3402 *
3403 * <p>This flag can not be used when the caller is requesting a result from
3404 * the activity being launched.
3405 */
3406 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3407 /**
3408 * <strong>Do not use this flag unless you are implementing your own
3409 * top-level application launcher.</strong> Used in conjunction with
3410 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3411 * behavior of bringing an existing task to the foreground. When set,
3412 * a new task is <em>always</em> started to host the Activity for the
3413 * Intent, regardless of whether there is already an existing task running
3414 * the same thing.
3415 *
3416 * <p><strong>Because the default system does not include graphical task management,
3417 * you should not use this flag unless you provide some way for a user to
3418 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003419 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003420 * <p>This flag is ignored if
3421 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3422 *
Scott Main7aee61f2011-02-08 11:25:01 -08003423 * <p>See
3424 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3425 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003426 */
3427 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3428 /**
3429 * If set, and the activity being launched is already running in the
3430 * current task, then instead of launching a new instance of that activity,
3431 * all of the other activities on top of it will be closed and this Intent
3432 * will be delivered to the (now on top) old activity as a new Intent.
3433 *
3434 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3435 * If D calls startActivity() with an Intent that resolves to the component
3436 * of activity B, then C and D will be finished and B receive the given
3437 * Intent, resulting in the stack now being: A, B.
3438 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003439 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003440 * either receive the new intent you are starting here in its
3441 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003442 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003443 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3444 * the same intent, then it will be finished and re-created; for all other
3445 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3446 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003447 *
3448 * <p>This launch mode can also be used to good effect in conjunction with
3449 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3450 * of a task, it will bring any currently running instance of that task
3451 * to the foreground, and then clear it to its root state. This is
3452 * especially useful, for example, when launching an activity from the
3453 * notification manager.
3454 *
Scott Main7aee61f2011-02-08 11:25:01 -08003455 * <p>See
3456 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3457 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003458 */
3459 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3460 /**
3461 * If set and this intent is being used to launch a new activity from an
3462 * existing one, then the reply target of the existing activity will be
3463 * transfered to the new activity. This way the new activity can call
3464 * {@link android.app.Activity#setResult} and have that result sent back to
3465 * the reply target of the original activity.
3466 */
3467 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3468 /**
3469 * If set and this intent is being used to launch a new activity from an
3470 * existing one, the current activity will not be counted as the top
3471 * activity for deciding whether the new intent should be delivered to
3472 * the top instead of starting a new one. The previous activity will
3473 * be used as the top, with the assumption being that the current activity
3474 * will finish itself immediately.
3475 */
3476 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3477 /**
3478 * If set, the new activity is not kept in the list of recently launched
3479 * activities.
3480 */
3481 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3482 /**
3483 * This flag is not normally set by application code, but set for you by
3484 * the system as described in the
3485 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3486 * launchMode} documentation for the singleTask mode.
3487 */
3488 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3489 /**
3490 * If set, and this activity is either being started in a new task or
3491 * bringing to the top an existing task, then it will be launched as
3492 * the front door of the task. This will result in the application of
3493 * any affinities needed to have that task in the proper state (either
3494 * moving activities to or from it), or simply resetting that task to
3495 * its initial state if needed.
3496 */
3497 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3498 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003499 * This flag is not normally set by application code, but set for you by
3500 * the system if this activity is being launched from history
3501 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003502 */
3503 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003504 /**
3505 * If set, this marks a point in the task's activity stack that should
3506 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003507 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003508 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3509 * the user re-launching it from home), this activity and all on top of
3510 * it will be finished so that the user does not return to them, but
3511 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003512 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003513 * <p>This is useful for cases where you have a logical break in your
3514 * application. For example, an e-mail application may have a command
3515 * to view an attachment, which launches an image view activity to
3516 * display it. This activity should be part of the e-mail application's
3517 * task, since it is a part of the task the user is involved in. However,
3518 * if the user leaves that task, and later selects the e-mail app from
3519 * home, we may like them to return to the conversation they were
3520 * viewing, not the picture attachment, since that is confusing. By
3521 * setting this flag when launching the image viewer, that viewer and
3522 * any activities it starts will be removed the next time the user returns
3523 * to mail.
3524 */
3525 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003526 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003527 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003528 * callback from occurring on the current frontmost activity before it is
3529 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003530 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003531 * <p>Typically, an activity can rely on that callback to indicate that an
3532 * explicit user action has caused their activity to be moved out of the
3533 * foreground. The callback marks an appropriate point in the activity's
3534 * lifecycle for it to dismiss any notifications that it intends to display
3535 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003536 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003537 * <p>If an activity is ever started via any non-user-driven events such as
3538 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3539 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003540 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003541 */
3542 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003543 /**
3544 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3545 * this flag will cause the launched activity to be brought to the front of its
3546 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003547 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003548 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3549 * If D calls startActivity() with an Intent that resolves to the component
3550 * of activity B, then B will be brought to the front of the history stack,
3551 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003552 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003553 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003554 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003555 */
3556 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003557 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003558 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3559 * this flag will prevent the system from applying an activity transition
3560 * animation to go to the next activity state. This doesn't mean an
3561 * animation will never run -- if another activity change happens that doesn't
3562 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003563 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003564 * when you are going to do a series of activity operations but the
3565 * animation seen by the user shouldn't be driven by the first activity
3566 * change but rather a later one.
3567 */
3568 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3569 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003570 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3571 * this flag will cause any existing task that would be associated with the
3572 * activity to be cleared before the activity is started. That is, the activity
3573 * becomes the new root of an otherwise empty task, and any old activities
3574 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3575 */
3576 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3577 /**
3578 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3579 * this flag will cause a newly launching task to be placed on top of the current
3580 * home activity task (if there is one). That is, pressing back from the task
3581 * will always return the user to home even if that was not the last activity they
3582 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3583 */
3584 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3585 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003586 * If set, when sending a broadcast only registered receivers will be
3587 * called -- no BroadcastReceiver components will be launched.
3588 */
3589 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003590 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003591 * If set, when sending a broadcast the new broadcast will replace
3592 * any existing pending broadcast that matches it. Matching is defined
3593 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3594 * true for the intents of the two broadcasts. When a match is found,
3595 * the new broadcast (and receivers associated with it) will replace the
3596 * existing one in the pending broadcast list, remaining at the same
3597 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003598 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003599 * <p>This flag is most typically used with sticky broadcasts, which
3600 * only care about delivering the most recent values of the broadcast
3601 * to their receivers.
3602 */
3603 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3604 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003605 * If set, when sending a broadcast the recipient is allowed to run at
3606 * foreground priority, with a shorter timeout interval. During normal
3607 * broadcasts the receivers are not automatically hoisted out of the
3608 * background priority class.
3609 */
3610 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3611 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003612 * If set, when sending a broadcast <i>before boot has completed</i> only
3613 * registered receivers will be called -- no BroadcastReceiver components
3614 * will be launched. Sticky intent state will be recorded properly even
3615 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3616 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003617 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003618 * <p>This flag is only for use by system sevices as a convenience to
3619 * avoid having to implement a more complex mechanism around detection
3620 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003621 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003622 * @hide
3623 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003624 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003625 /**
3626 * Set when this broadcast is for a boot upgrade, a special mode that
3627 * allows the broadcast to be sent before the system is ready and launches
3628 * the app process with no providers running in it.
3629 * @hide
3630 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003631 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003632
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003633 /**
3634 * @hide Flags that can't be changed with PendingIntent.
3635 */
3636 public static final int IMMUTABLE_FLAGS =
3637 FLAG_GRANT_READ_URI_PERMISSION
3638 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003639
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003640 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003641 // ---------------------------------------------------------------------
3642 // toUri() and parseUri() options.
3643
3644 /**
3645 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3646 * always has the "intent:" scheme. This syntax can be used when you want
3647 * to later disambiguate between URIs that are intended to describe an
3648 * Intent vs. all others that should be treated as raw URIs. When used
3649 * with {@link #parseUri}, any other scheme will result in a generic
3650 * VIEW action for that raw URI.
3651 */
3652 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003653
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003654 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003655
3656 private String mAction;
3657 private Uri mData;
3658 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003659 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003660 private ComponentName mComponent;
3661 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003662 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003663 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003664 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003665 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003666 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003667
3668 // ---------------------------------------------------------------------
3669
3670 /**
3671 * Create an empty intent.
3672 */
3673 public Intent() {
3674 }
3675
3676 /**
3677 * Copy constructor.
3678 */
3679 public Intent(Intent o) {
3680 this.mAction = o.mAction;
3681 this.mData = o.mData;
3682 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003683 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003684 this.mComponent = o.mComponent;
3685 this.mFlags = o.mFlags;
3686 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003687 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003688 }
3689 if (o.mExtras != null) {
3690 this.mExtras = new Bundle(o.mExtras);
3691 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003692 if (o.mSourceBounds != null) {
3693 this.mSourceBounds = new Rect(o.mSourceBounds);
3694 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003695 if (o.mSelector != null) {
3696 this.mSelector = new Intent(o.mSelector);
3697 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003698 if (o.mClipData != null) {
3699 this.mClipData = new ClipData(o.mClipData);
3700 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003701 }
3702
3703 @Override
3704 public Object clone() {
3705 return new Intent(this);
3706 }
3707
3708 private Intent(Intent o, boolean all) {
3709 this.mAction = o.mAction;
3710 this.mData = o.mData;
3711 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003712 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003713 this.mComponent = o.mComponent;
3714 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003715 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003716 }
3717 }
3718
3719 /**
3720 * Make a clone of only the parts of the Intent that are relevant for
3721 * filter matching: the action, data, type, component, and categories.
3722 */
3723 public Intent cloneFilter() {
3724 return new Intent(this, false);
3725 }
3726
3727 /**
3728 * Create an intent with a given action. All other fields (data, type,
3729 * class) are null. Note that the action <em>must</em> be in a
3730 * namespace because Intents are used globally in the system -- for
3731 * example the system VIEW action is android.intent.action.VIEW; an
3732 * application's custom action would be something like
3733 * com.google.app.myapp.CUSTOM_ACTION.
3734 *
3735 * @param action The Intent action, such as ACTION_VIEW.
3736 */
3737 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003738 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003739 }
3740
3741 /**
3742 * Create an intent with a given action and for a given data url. Note
3743 * that the action <em>must</em> be in a namespace because Intents are
3744 * used globally in the system -- for example the system VIEW action is
3745 * android.intent.action.VIEW; an application's custom action would be
3746 * something like com.google.app.myapp.CUSTOM_ACTION.
3747 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003748 * <p><em>Note: scheme and host name matching in the Android framework is
3749 * case-sensitive, unlike the formal RFC. As a result,
3750 * you should always ensure that you write your Uri with these elements
3751 * using lower case letters, and normalize any Uris you receive from
3752 * outside of Android to ensure the scheme and host is lower case.</em></p>
3753 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003754 * @param action The Intent action, such as ACTION_VIEW.
3755 * @param uri The Intent data URI.
3756 */
3757 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003758 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003759 mData = uri;
3760 }
3761
3762 /**
3763 * Create an intent for a specific component. All other fields (action, data,
3764 * type, class) are null, though they can be modified later with explicit
3765 * calls. This provides a convenient way to create an intent that is
3766 * intended to execute a hard-coded class name, rather than relying on the
3767 * system to find an appropriate class for you; see {@link #setComponent}
3768 * for more information on the repercussions of this.
3769 *
3770 * @param packageContext A Context of the application package implementing
3771 * this class.
3772 * @param cls The component class that is to be used for the intent.
3773 *
3774 * @see #setClass
3775 * @see #setComponent
3776 * @see #Intent(String, android.net.Uri , Context, Class)
3777 */
3778 public Intent(Context packageContext, Class<?> cls) {
3779 mComponent = new ComponentName(packageContext, cls);
3780 }
3781
3782 /**
3783 * Create an intent for a specific component with a specified action and data.
3784 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3785 * construct the Intent and then calling {@link #setClass} to set its
3786 * class.
3787 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003788 * <p><em>Note: scheme and host name matching in the Android framework is
3789 * case-sensitive, unlike the formal RFC. As a result,
3790 * you should always ensure that you write your Uri with these elements
3791 * using lower case letters, and normalize any Uris you receive from
3792 * outside of Android to ensure the scheme and host is lower case.</em></p>
3793 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003794 * @param action The Intent action, such as ACTION_VIEW.
3795 * @param uri The Intent data URI.
3796 * @param packageContext A Context of the application package implementing
3797 * this class.
3798 * @param cls The component class that is to be used for the intent.
3799 *
3800 * @see #Intent(String, android.net.Uri)
3801 * @see #Intent(Context, Class)
3802 * @see #setClass
3803 * @see #setComponent
3804 */
3805 public Intent(String action, Uri uri,
3806 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003807 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003808 mData = uri;
3809 mComponent = new ComponentName(packageContext, cls);
3810 }
3811
3812 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003813 * Create an intent to launch the main (root) activity of a task. This
3814 * is the Intent that is started when the application's is launched from
3815 * Home. For anything else that wants to launch an application in the
3816 * same way, it is important that they use an Intent structured the same
3817 * way, and can use this function to ensure this is the case.
3818 *
3819 * <p>The returned Intent has the given Activity component as its explicit
3820 * component, {@link #ACTION_MAIN} as its action, and includes the
3821 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3822 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3823 * to do that through {@link #addFlags(int)} on the returned Intent.
3824 *
3825 * @param mainActivity The main activity component that this Intent will
3826 * launch.
3827 * @return Returns a newly created Intent that can be used to launch the
3828 * activity as a main application entry.
3829 *
3830 * @see #setClass
3831 * @see #setComponent
3832 */
3833 public static Intent makeMainActivity(ComponentName mainActivity) {
3834 Intent intent = new Intent(ACTION_MAIN);
3835 intent.setComponent(mainActivity);
3836 intent.addCategory(CATEGORY_LAUNCHER);
3837 return intent;
3838 }
3839
3840 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003841 * Make an Intent for the main activity of an application, without
3842 * specifying a specific activity to run but giving a selector to find
3843 * the activity. This results in a final Intent that is structured
3844 * the same as when the application is launched from
3845 * Home. For anything else that wants to launch an application in the
3846 * same way, it is important that they use an Intent structured the same
3847 * way, and can use this function to ensure this is the case.
3848 *
3849 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3850 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3851 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3852 * to do that through {@link #addFlags(int)} on the returned Intent.
3853 *
3854 * @param selectorAction The action name of the Intent's selector.
3855 * @param selectorCategory The name of a category to add to the Intent's
3856 * selector.
3857 * @return Returns a newly created Intent that can be used to launch the
3858 * activity as a main application entry.
3859 *
3860 * @see #setSelector(Intent)
3861 */
3862 public static Intent makeMainSelectorActivity(String selectorAction,
3863 String selectorCategory) {
3864 Intent intent = new Intent(ACTION_MAIN);
3865 intent.addCategory(CATEGORY_LAUNCHER);
3866 Intent selector = new Intent();
3867 selector.setAction(selectorAction);
3868 selector.addCategory(selectorCategory);
3869 intent.setSelector(selector);
3870 return intent;
3871 }
3872
3873 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003874 * Make an Intent that can be used to re-launch an application's task
3875 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3876 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3877 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3878 *
3879 * @param mainActivity The activity component that is the root of the
3880 * task; this is the activity that has been published in the application's
3881 * manifest as the main launcher icon.
3882 *
3883 * @return Returns a newly created Intent that can be used to relaunch the
3884 * activity's task in its root state.
3885 */
3886 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3887 Intent intent = makeMainActivity(mainActivity);
3888 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3889 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3890 return intent;
3891 }
3892
3893 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003894 * Call {@link #parseUri} with 0 flags.
3895 * @deprecated Use {@link #parseUri} instead.
3896 */
3897 @Deprecated
3898 public static Intent getIntent(String uri) throws URISyntaxException {
3899 return parseUri(uri, 0);
3900 }
Tom Taylord4a47292009-12-21 13:59:18 -08003901
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003902 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003903 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003904 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003905 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003906 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003907 *
3908 * <p>The URI given here must not be relative -- that is, it must include
3909 * the scheme and full path.
3910 *
3911 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003912 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003913 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003914 *
3915 * @return Intent The newly created Intent object.
3916 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003917 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3918 * it bad (as parsed by the Uri class) or the Intent data within the
3919 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003920 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003921 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003922 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003923 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003924 int i = 0;
3925 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003926 // Validate intent scheme for if requested.
3927 if ((flags&URI_INTENT_SCHEME) != 0) {
3928 if (!uri.startsWith("intent:")) {
3929 Intent intent = new Intent(ACTION_VIEW);
3930 try {
3931 intent.setData(Uri.parse(uri));
3932 } catch (IllegalArgumentException e) {
3933 throw new URISyntaxException(uri, e.getMessage());
3934 }
3935 return intent;
3936 }
3937 }
Tom Taylord4a47292009-12-21 13:59:18 -08003938
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003939 // simple case
3940 i = uri.lastIndexOf("#");
3941 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3942
3943 // old format Intent URI
3944 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003945
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003946 // new format
3947 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003948 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003949
3950 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003951 String data = i >= 0 ? uri.substring(0, i) : null;
3952 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003953 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003954
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003955 // loop over contents of Intent, all name=value;
3956 while (!uri.startsWith("end", i)) {
3957 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003958 if (eq < 0) eq = i-1;
3959 int semi = uri.indexOf(';', i);
3960 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003961
3962 // action
3963 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003964 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003965 }
3966
3967 // categories
3968 else if (uri.startsWith("category=", i)) {
3969 intent.addCategory(value);
3970 }
3971
3972 // type
3973 else if (uri.startsWith("type=", i)) {
3974 intent.mType = value;
3975 }
3976
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003977 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003978 else if (uri.startsWith("launchFlags=", i)) {
3979 intent.mFlags = Integer.decode(value).intValue();
3980 }
3981
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003982 // package
3983 else if (uri.startsWith("package=", i)) {
3984 intent.mPackage = value;
3985 }
3986
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003987 // component
3988 else if (uri.startsWith("component=", i)) {
3989 intent.mComponent = ComponentName.unflattenFromString(value);
3990 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003991
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003992 // scheme
3993 else if (uri.startsWith("scheme=", i)) {
3994 scheme = value;
3995 }
3996
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003997 // source bounds
3998 else if (uri.startsWith("sourceBounds=", i)) {
3999 intent.mSourceBounds = Rect.unflattenFromString(value);
4000 }
4001
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004002 // selector
4003 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4004 intent = new Intent();
4005 }
4006
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004007 // extra
4008 else {
4009 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004010 // create Bundle if it doesn't already exist
4011 if (intent.mExtras == null) intent.mExtras = new Bundle();
4012 Bundle b = intent.mExtras;
4013 // add EXTRA
4014 if (uri.startsWith("S.", i)) b.putString(key, value);
4015 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4016 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4017 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4018 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4019 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4020 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4021 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4022 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4023 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4024 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004025
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004026 // move to the next item
4027 i = semi + 1;
4028 }
4029
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004030 if (intent != baseIntent) {
4031 // The Intent had a selector; fix it up.
4032 baseIntent.setSelector(intent);
4033 intent = baseIntent;
4034 }
4035
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004036 if (data != null) {
4037 if (data.startsWith("intent:")) {
4038 data = data.substring(7);
4039 if (scheme != null) {
4040 data = scheme + ':' + data;
4041 }
4042 }
Tom Taylord4a47292009-12-21 13:59:18 -08004043
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004044 if (data.length() > 0) {
4045 try {
4046 intent.mData = Uri.parse(data);
4047 } catch (IllegalArgumentException e) {
4048 throw new URISyntaxException(uri, e.getMessage());
4049 }
4050 }
4051 }
Tom Taylord4a47292009-12-21 13:59:18 -08004052
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004053 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004054
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004055 } catch (IndexOutOfBoundsException e) {
4056 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4057 }
4058 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004059
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004060 public static Intent getIntentOld(String uri) throws URISyntaxException {
4061 Intent intent;
4062
4063 int i = uri.lastIndexOf('#');
4064 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004065 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004066 final int intentFragmentStart = i;
4067 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004068
4069 i++;
4070
4071 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004072 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004073 i += 7;
4074 int j = uri.indexOf(')', i);
4075 action = uri.substring(i, j);
4076 i = j + 1;
4077 }
4078
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004079 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004080
4081 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004082 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004083 i += 11;
4084 int j = uri.indexOf(')', i);
4085 while (i < j) {
4086 int sep = uri.indexOf('!', i);
4087 if (sep < 0) sep = j;
4088 if (i < sep) {
4089 intent.addCategory(uri.substring(i, sep));
4090 }
4091 i = sep + 1;
4092 }
4093 i = j + 1;
4094 }
4095
4096 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004097 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004098 i += 5;
4099 int j = uri.indexOf(')', i);
4100 intent.mType = uri.substring(i, j);
4101 i = j + 1;
4102 }
4103
4104 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004105 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004106 i += 12;
4107 int j = uri.indexOf(')', i);
4108 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4109 i = j + 1;
4110 }
4111
4112 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004113 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004114 i += 10;
4115 int j = uri.indexOf(')', i);
4116 int sep = uri.indexOf('!', i);
4117 if (sep >= 0 && sep < j) {
4118 String pkg = uri.substring(i, sep);
4119 String cls = uri.substring(sep + 1, j);
4120 intent.mComponent = new ComponentName(pkg, cls);
4121 }
4122 i = j + 1;
4123 }
4124
4125 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004126 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004127 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004128
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004129 final int closeParen = uri.indexOf(')', i);
4130 if (closeParen == -1) throw new URISyntaxException(uri,
4131 "EXTRA missing trailing ')'", i);
4132
4133 while (i < closeParen) {
4134 // fetch the key value
4135 int j = uri.indexOf('=', i);
4136 if (j <= i + 1 || i >= closeParen) {
4137 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4138 }
4139 char type = uri.charAt(i);
4140 i++;
4141 String key = uri.substring(i, j);
4142 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004143
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004144 // get type-value
4145 j = uri.indexOf('!', i);
4146 if (j == -1 || j >= closeParen) j = closeParen;
4147 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4148 String value = uri.substring(i, j);
4149 i = j;
4150
4151 // create Bundle if it doesn't already exist
4152 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004153
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004154 // add item to bundle
4155 try {
4156 switch (type) {
4157 case 'S':
4158 intent.mExtras.putString(key, Uri.decode(value));
4159 break;
4160 case 'B':
4161 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4162 break;
4163 case 'b':
4164 intent.mExtras.putByte(key, Byte.parseByte(value));
4165 break;
4166 case 'c':
4167 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4168 break;
4169 case 'd':
4170 intent.mExtras.putDouble(key, Double.parseDouble(value));
4171 break;
4172 case 'f':
4173 intent.mExtras.putFloat(key, Float.parseFloat(value));
4174 break;
4175 case 'i':
4176 intent.mExtras.putInt(key, Integer.parseInt(value));
4177 break;
4178 case 'l':
4179 intent.mExtras.putLong(key, Long.parseLong(value));
4180 break;
4181 case 's':
4182 intent.mExtras.putShort(key, Short.parseShort(value));
4183 break;
4184 default:
4185 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4186 }
4187 } catch (NumberFormatException e) {
4188 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4189 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004190
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004191 char ch = uri.charAt(i);
4192 if (ch == ')') break;
4193 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4194 i++;
4195 }
4196 }
4197
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004198 if (isIntentFragment) {
4199 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4200 } else {
4201 intent.mData = Uri.parse(uri);
4202 }
Tom Taylord4a47292009-12-21 13:59:18 -08004203
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004204 if (intent.mAction == null) {
4205 // By default, if no action is specified, then use VIEW.
4206 intent.mAction = ACTION_VIEW;
4207 }
4208
4209 } else {
4210 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4211 }
4212
4213 return intent;
4214 }
4215
4216 /**
4217 * Retrieve the general action to be performed, such as
4218 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4219 * the information in the intent should be interpreted -- most importantly,
4220 * what to do with the data returned by {@link #getData}.
4221 *
4222 * @return The action of this intent or null if none is specified.
4223 *
4224 * @see #setAction
4225 */
4226 public String getAction() {
4227 return mAction;
4228 }
4229
4230 /**
4231 * Retrieve data this intent is operating on. This URI specifies the name
4232 * of the data; often it uses the content: scheme, specifying data in a
4233 * content provider. Other schemes may be handled by specific activities,
4234 * such as http: by the web browser.
4235 *
4236 * @return The URI of the data this intent is targeting or null.
4237 *
4238 * @see #getScheme
4239 * @see #setData
4240 */
4241 public Uri getData() {
4242 return mData;
4243 }
4244
4245 /**
4246 * The same as {@link #getData()}, but returns the URI as an encoded
4247 * String.
4248 */
4249 public String getDataString() {
4250 return mData != null ? mData.toString() : null;
4251 }
4252
4253 /**
4254 * Return the scheme portion of the intent's data. If the data is null or
4255 * does not include a scheme, null is returned. Otherwise, the scheme
4256 * prefix without the final ':' is returned, i.e. "http".
4257 *
4258 * <p>This is the same as calling getData().getScheme() (and checking for
4259 * null data).
4260 *
4261 * @return The scheme of this intent.
4262 *
4263 * @see #getData
4264 */
4265 public String getScheme() {
4266 return mData != null ? mData.getScheme() : null;
4267 }
4268
4269 /**
4270 * Retrieve any explicit MIME type included in the intent. This is usually
4271 * null, as the type is determined by the intent data.
4272 *
4273 * @return If a type was manually set, it is returned; else null is
4274 * returned.
4275 *
4276 * @see #resolveType(ContentResolver)
4277 * @see #setType
4278 */
4279 public String getType() {
4280 return mType;
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 * @return The MIME type of this intent.
4290 *
4291 * @see #getType
4292 * @see #resolveType(ContentResolver)
4293 */
4294 public String resolveType(Context context) {
4295 return resolveType(context.getContentResolver());
4296 }
4297
4298 /**
4299 * Return the MIME data type of this intent. If the type field is
4300 * explicitly set, that is simply returned. Otherwise, if the data is set,
4301 * the type of that data is returned. If neither fields are set, a null is
4302 * returned.
4303 *
4304 * @param resolver A ContentResolver that can be used to determine the MIME
4305 * type of the intent's data.
4306 *
4307 * @return The MIME type of this intent.
4308 *
4309 * @see #getType
4310 * @see #resolveType(Context)
4311 */
4312 public String resolveType(ContentResolver resolver) {
4313 if (mType != null) {
4314 return mType;
4315 }
4316 if (mData != null) {
4317 if ("content".equals(mData.getScheme())) {
4318 return resolver.getType(mData);
4319 }
4320 }
4321 return null;
4322 }
4323
4324 /**
4325 * Return the MIME data type of this intent, only if it will be needed for
4326 * intent resolution. This is not generally useful for application code;
4327 * it is used by the frameworks for communicating with back-end system
4328 * services.
4329 *
4330 * @param resolver A ContentResolver that can be used to determine the MIME
4331 * type of the intent's data.
4332 *
4333 * @return The MIME type of this intent, or null if it is unknown or not
4334 * needed.
4335 */
4336 public String resolveTypeIfNeeded(ContentResolver resolver) {
4337 if (mComponent != null) {
4338 return mType;
4339 }
4340 return resolveType(resolver);
4341 }
4342
4343 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004344 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004345 *
4346 * @param category The category to check.
4347 *
4348 * @return boolean True if the intent contains the category, else false.
4349 *
4350 * @see #getCategories
4351 * @see #addCategory
4352 */
4353 public boolean hasCategory(String category) {
4354 return mCategories != null && mCategories.contains(category);
4355 }
4356
4357 /**
4358 * Return the set of all categories in the intent. If there are no categories,
4359 * returns NULL.
4360 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004361 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004362 *
4363 * @see #hasCategory
4364 * @see #addCategory
4365 */
4366 public Set<String> getCategories() {
4367 return mCategories;
4368 }
4369
4370 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004371 * Return the specific selector associated with this Intent. If there is
4372 * none, returns null. See {@link #setSelector} for more information.
4373 *
4374 * @see #setSelector
4375 */
4376 public Intent getSelector() {
4377 return mSelector;
4378 }
4379
4380 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004381 * Return the {@link ClipData} associated with this Intent. If there is
4382 * none, returns null. See {@link #setClipData} for more information.
4383 *
4384 * @see #setClipData;
4385 */
4386 public ClipData getClipData() {
4387 return mClipData;
4388 }
4389
4390 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004391 * Sets the ClassLoader that will be used when unmarshalling
4392 * any Parcelable values from the extras of this Intent.
4393 *
4394 * @param loader a ClassLoader, or null to use the default loader
4395 * at the time of unmarshalling.
4396 */
4397 public void setExtrasClassLoader(ClassLoader loader) {
4398 if (mExtras != null) {
4399 mExtras.setClassLoader(loader);
4400 }
4401 }
4402
4403 /**
4404 * Returns true if an extra value is associated with the given name.
4405 * @param name the extra's name
4406 * @return true if the given extra is present.
4407 */
4408 public boolean hasExtra(String name) {
4409 return mExtras != null && mExtras.containsKey(name);
4410 }
4411
4412 /**
4413 * Returns true if the Intent's extras contain a parcelled file descriptor.
4414 * @return true if the Intent contains a parcelled file descriptor.
4415 */
4416 public boolean hasFileDescriptors() {
4417 return mExtras != null && mExtras.hasFileDescriptors();
4418 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004419
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004420 /** @hide */
4421 public void setAllowFds(boolean allowFds) {
4422 if (mExtras != null) {
4423 mExtras.setAllowFds(allowFds);
4424 }
4425 }
4426
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004427 /**
4428 * Retrieve extended data from the intent.
4429 *
4430 * @param name The name of the desired item.
4431 *
4432 * @return the value of an item that previously added with putExtra()
4433 * or null if none was found.
4434 *
4435 * @deprecated
4436 * @hide
4437 */
4438 @Deprecated
4439 public Object getExtra(String name) {
4440 return getExtra(name, null);
4441 }
4442
4443 /**
4444 * Retrieve extended data from the intent.
4445 *
4446 * @param name The name of the desired item.
4447 * @param defaultValue the value to be returned if no value of the desired
4448 * type is stored with the given name.
4449 *
4450 * @return the value of an item that previously added with putExtra()
4451 * or the default value if none was found.
4452 *
4453 * @see #putExtra(String, boolean)
4454 */
4455 public boolean getBooleanExtra(String name, boolean defaultValue) {
4456 return mExtras == null ? defaultValue :
4457 mExtras.getBoolean(name, defaultValue);
4458 }
4459
4460 /**
4461 * Retrieve extended data from the intent.
4462 *
4463 * @param name The name of the desired item.
4464 * @param defaultValue the value to be returned if no value of the desired
4465 * type is stored with the given name.
4466 *
4467 * @return the value of an item that previously added with putExtra()
4468 * or the default value if none was found.
4469 *
4470 * @see #putExtra(String, byte)
4471 */
4472 public byte getByteExtra(String name, byte defaultValue) {
4473 return mExtras == null ? defaultValue :
4474 mExtras.getByte(name, defaultValue);
4475 }
4476
4477 /**
4478 * Retrieve extended data from the intent.
4479 *
4480 * @param name The name of the desired item.
4481 * @param defaultValue the value to be returned if no value of the desired
4482 * type is stored with the given name.
4483 *
4484 * @return the value of an item that previously added with putExtra()
4485 * or the default value if none was found.
4486 *
4487 * @see #putExtra(String, short)
4488 */
4489 public short getShortExtra(String name, short defaultValue) {
4490 return mExtras == null ? defaultValue :
4491 mExtras.getShort(name, defaultValue);
4492 }
4493
4494 /**
4495 * Retrieve extended data from the intent.
4496 *
4497 * @param name The name of the desired item.
4498 * @param defaultValue the value to be returned if no value of the desired
4499 * type is stored with the given name.
4500 *
4501 * @return the value of an item that previously added with putExtra()
4502 * or the default value if none was found.
4503 *
4504 * @see #putExtra(String, char)
4505 */
4506 public char getCharExtra(String name, char defaultValue) {
4507 return mExtras == null ? defaultValue :
4508 mExtras.getChar(name, defaultValue);
4509 }
4510
4511 /**
4512 * Retrieve extended data from the intent.
4513 *
4514 * @param name The name of the desired item.
4515 * @param defaultValue the value to be returned if no value of the desired
4516 * type is stored with the given name.
4517 *
4518 * @return the value of an item that previously added with putExtra()
4519 * or the default value if none was found.
4520 *
4521 * @see #putExtra(String, int)
4522 */
4523 public int getIntExtra(String name, int defaultValue) {
4524 return mExtras == null ? defaultValue :
4525 mExtras.getInt(name, defaultValue);
4526 }
4527
4528 /**
4529 * Retrieve extended data from the intent.
4530 *
4531 * @param name The name of the desired item.
4532 * @param defaultValue the value to be returned if no value of the desired
4533 * type is stored with the given name.
4534 *
4535 * @return the value of an item that previously added with putExtra()
4536 * or the default value if none was found.
4537 *
4538 * @see #putExtra(String, long)
4539 */
4540 public long getLongExtra(String name, long defaultValue) {
4541 return mExtras == null ? defaultValue :
4542 mExtras.getLong(name, defaultValue);
4543 }
4544
4545 /**
4546 * Retrieve extended data from the intent.
4547 *
4548 * @param name The name of the desired item.
4549 * @param defaultValue the value to be returned if no value of the desired
4550 * type is stored with the given name.
4551 *
4552 * @return the value of an item that previously added with putExtra(),
4553 * or the default value if no such item is present
4554 *
4555 * @see #putExtra(String, float)
4556 */
4557 public float getFloatExtra(String name, float defaultValue) {
4558 return mExtras == null ? defaultValue :
4559 mExtras.getFloat(name, defaultValue);
4560 }
4561
4562 /**
4563 * Retrieve extended data from the intent.
4564 *
4565 * @param name The name of the desired item.
4566 * @param defaultValue the value to be returned if no value of the desired
4567 * type is stored with the given name.
4568 *
4569 * @return the value of an item that previously added with putExtra()
4570 * or the default value if none was found.
4571 *
4572 * @see #putExtra(String, double)
4573 */
4574 public double getDoubleExtra(String name, double defaultValue) {
4575 return mExtras == null ? defaultValue :
4576 mExtras.getDouble(name, defaultValue);
4577 }
4578
4579 /**
4580 * Retrieve extended data from the intent.
4581 *
4582 * @param name The name of the desired item.
4583 *
4584 * @return the value of an item that previously added with putExtra()
4585 * or null if no String value was found.
4586 *
4587 * @see #putExtra(String, String)
4588 */
4589 public String getStringExtra(String name) {
4590 return mExtras == null ? null : mExtras.getString(name);
4591 }
4592
4593 /**
4594 * Retrieve extended data from the intent.
4595 *
4596 * @param name The name of the desired item.
4597 *
4598 * @return the value of an item that previously added with putExtra()
4599 * or null if no CharSequence value was found.
4600 *
4601 * @see #putExtra(String, CharSequence)
4602 */
4603 public CharSequence getCharSequenceExtra(String name) {
4604 return mExtras == null ? null : mExtras.getCharSequence(name);
4605 }
4606
4607 /**
4608 * Retrieve extended data from the intent.
4609 *
4610 * @param name The name of the desired item.
4611 *
4612 * @return the value of an item that previously added with putExtra()
4613 * or null if no Parcelable value was found.
4614 *
4615 * @see #putExtra(String, Parcelable)
4616 */
4617 public <T extends Parcelable> T getParcelableExtra(String name) {
4618 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4619 }
4620
4621 /**
4622 * Retrieve extended data from the intent.
4623 *
4624 * @param name The name of the desired item.
4625 *
4626 * @return the value of an item that previously added with putExtra()
4627 * or null if no Parcelable[] value was found.
4628 *
4629 * @see #putExtra(String, Parcelable[])
4630 */
4631 public Parcelable[] getParcelableArrayExtra(String name) {
4632 return mExtras == null ? null : mExtras.getParcelableArray(name);
4633 }
4634
4635 /**
4636 * Retrieve extended data from the intent.
4637 *
4638 * @param name The name of the desired item.
4639 *
4640 * @return the value of an item that previously added with putExtra()
4641 * or null if no ArrayList<Parcelable> value was found.
4642 *
4643 * @see #putParcelableArrayListExtra(String, ArrayList)
4644 */
4645 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4646 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4647 }
4648
4649 /**
4650 * Retrieve extended data from the intent.
4651 *
4652 * @param name The name of the desired item.
4653 *
4654 * @return the value of an item that previously added with putExtra()
4655 * or null if no Serializable value was found.
4656 *
4657 * @see #putExtra(String, Serializable)
4658 */
4659 public Serializable getSerializableExtra(String name) {
4660 return mExtras == null ? null : mExtras.getSerializable(name);
4661 }
4662
4663 /**
4664 * Retrieve extended data from the intent.
4665 *
4666 * @param name The name of the desired item.
4667 *
4668 * @return the value of an item that previously added with putExtra()
4669 * or null if no ArrayList<Integer> value was found.
4670 *
4671 * @see #putIntegerArrayListExtra(String, ArrayList)
4672 */
4673 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4674 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4675 }
4676
4677 /**
4678 * Retrieve extended data from the intent.
4679 *
4680 * @param name The name of the desired item.
4681 *
4682 * @return the value of an item that previously added with putExtra()
4683 * or null if no ArrayList<String> value was found.
4684 *
4685 * @see #putStringArrayListExtra(String, ArrayList)
4686 */
4687 public ArrayList<String> getStringArrayListExtra(String name) {
4688 return mExtras == null ? null : mExtras.getStringArrayList(name);
4689 }
4690
4691 /**
4692 * Retrieve extended data from the intent.
4693 *
4694 * @param name The name of the desired item.
4695 *
4696 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004697 * or null if no ArrayList<CharSequence> value was found.
4698 *
4699 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4700 */
4701 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4702 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4703 }
4704
4705 /**
4706 * Retrieve extended data from the intent.
4707 *
4708 * @param name The name of the desired item.
4709 *
4710 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004711 * or null if no boolean array value was found.
4712 *
4713 * @see #putExtra(String, boolean[])
4714 */
4715 public boolean[] getBooleanArrayExtra(String name) {
4716 return mExtras == null ? null : mExtras.getBooleanArray(name);
4717 }
4718
4719 /**
4720 * Retrieve extended data from the intent.
4721 *
4722 * @param name The name of the desired item.
4723 *
4724 * @return the value of an item that previously added with putExtra()
4725 * or null if no byte array value was found.
4726 *
4727 * @see #putExtra(String, byte[])
4728 */
4729 public byte[] getByteArrayExtra(String name) {
4730 return mExtras == null ? null : mExtras.getByteArray(name);
4731 }
4732
4733 /**
4734 * Retrieve extended data from the intent.
4735 *
4736 * @param name The name of the desired item.
4737 *
4738 * @return the value of an item that previously added with putExtra()
4739 * or null if no short array value was found.
4740 *
4741 * @see #putExtra(String, short[])
4742 */
4743 public short[] getShortArrayExtra(String name) {
4744 return mExtras == null ? null : mExtras.getShortArray(name);
4745 }
4746
4747 /**
4748 * Retrieve extended data from the intent.
4749 *
4750 * @param name The name of the desired item.
4751 *
4752 * @return the value of an item that previously added with putExtra()
4753 * or null if no char array value was found.
4754 *
4755 * @see #putExtra(String, char[])
4756 */
4757 public char[] getCharArrayExtra(String name) {
4758 return mExtras == null ? null : mExtras.getCharArray(name);
4759 }
4760
4761 /**
4762 * Retrieve extended data from the intent.
4763 *
4764 * @param name The name of the desired item.
4765 *
4766 * @return the value of an item that previously added with putExtra()
4767 * or null if no int array value was found.
4768 *
4769 * @see #putExtra(String, int[])
4770 */
4771 public int[] getIntArrayExtra(String name) {
4772 return mExtras == null ? null : mExtras.getIntArray(name);
4773 }
4774
4775 /**
4776 * Retrieve extended data from the intent.
4777 *
4778 * @param name The name of the desired item.
4779 *
4780 * @return the value of an item that previously added with putExtra()
4781 * or null if no long array value was found.
4782 *
4783 * @see #putExtra(String, long[])
4784 */
4785 public long[] getLongArrayExtra(String name) {
4786 return mExtras == null ? null : mExtras.getLongArray(name);
4787 }
4788
4789 /**
4790 * Retrieve extended data from the intent.
4791 *
4792 * @param name The name of the desired item.
4793 *
4794 * @return the value of an item that previously added with putExtra()
4795 * or null if no float array value was found.
4796 *
4797 * @see #putExtra(String, float[])
4798 */
4799 public float[] getFloatArrayExtra(String name) {
4800 return mExtras == null ? null : mExtras.getFloatArray(name);
4801 }
4802
4803 /**
4804 * Retrieve extended data from the intent.
4805 *
4806 * @param name The name of the desired item.
4807 *
4808 * @return the value of an item that previously added with putExtra()
4809 * or null if no double array value was found.
4810 *
4811 * @see #putExtra(String, double[])
4812 */
4813 public double[] getDoubleArrayExtra(String name) {
4814 return mExtras == null ? null : mExtras.getDoubleArray(name);
4815 }
4816
4817 /**
4818 * Retrieve extended data from the intent.
4819 *
4820 * @param name The name of the desired item.
4821 *
4822 * @return the value of an item that previously added with putExtra()
4823 * or null if no String array value was found.
4824 *
4825 * @see #putExtra(String, String[])
4826 */
4827 public String[] getStringArrayExtra(String name) {
4828 return mExtras == null ? null : mExtras.getStringArray(name);
4829 }
4830
4831 /**
4832 * Retrieve extended data from the intent.
4833 *
4834 * @param name The name of the desired item.
4835 *
4836 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004837 * or null if no CharSequence array value was found.
4838 *
4839 * @see #putExtra(String, CharSequence[])
4840 */
4841 public CharSequence[] getCharSequenceArrayExtra(String name) {
4842 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4843 }
4844
4845 /**
4846 * Retrieve extended data from the intent.
4847 *
4848 * @param name The name of the desired item.
4849 *
4850 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004851 * or null if no Bundle value was found.
4852 *
4853 * @see #putExtra(String, Bundle)
4854 */
4855 public Bundle getBundleExtra(String name) {
4856 return mExtras == null ? null : mExtras.getBundle(name);
4857 }
4858
4859 /**
4860 * Retrieve extended data from the intent.
4861 *
4862 * @param name The name of the desired item.
4863 *
4864 * @return the value of an item that previously added with putExtra()
4865 * or null if no IBinder value was found.
4866 *
4867 * @see #putExtra(String, IBinder)
4868 *
4869 * @deprecated
4870 * @hide
4871 */
4872 @Deprecated
4873 public IBinder getIBinderExtra(String name) {
4874 return mExtras == null ? null : mExtras.getIBinder(name);
4875 }
4876
4877 /**
4878 * Retrieve extended data from the intent.
4879 *
4880 * @param name The name of the desired item.
4881 * @param defaultValue The default value to return in case no item is
4882 * associated with the key 'name'
4883 *
4884 * @return the value of an item that previously added with putExtra()
4885 * or defaultValue if none was found.
4886 *
4887 * @see #putExtra
4888 *
4889 * @deprecated
4890 * @hide
4891 */
4892 @Deprecated
4893 public Object getExtra(String name, Object defaultValue) {
4894 Object result = defaultValue;
4895 if (mExtras != null) {
4896 Object result2 = mExtras.get(name);
4897 if (result2 != null) {
4898 result = result2;
4899 }
4900 }
4901
4902 return result;
4903 }
4904
4905 /**
4906 * Retrieves a map of extended data from the intent.
4907 *
4908 * @return the map of all extras previously added with putExtra(),
4909 * or null if none have been added.
4910 */
4911 public Bundle getExtras() {
4912 return (mExtras != null)
4913 ? new Bundle(mExtras)
4914 : null;
4915 }
4916
4917 /**
4918 * Retrieve any special flags associated with this intent. You will
4919 * normally just set them with {@link #setFlags} and let the system
4920 * take the appropriate action with them.
4921 *
4922 * @return int The currently set flags.
4923 *
4924 * @see #setFlags
4925 */
4926 public int getFlags() {
4927 return mFlags;
4928 }
4929
Dianne Hackborne7f97212011-02-24 14:40:20 -08004930 /** @hide */
4931 public boolean isExcludingStopped() {
4932 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4933 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4934 }
4935
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004936 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004937 * Retrieve the application package name this Intent is limited to. When
4938 * resolving an Intent, if non-null this limits the resolution to only
4939 * components in the given application package.
4940 *
4941 * @return The name of the application package for the Intent.
4942 *
4943 * @see #resolveActivity
4944 * @see #setPackage
4945 */
4946 public String getPackage() {
4947 return mPackage;
4948 }
4949
4950 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004951 * Retrieve the concrete component associated with the intent. When receiving
4952 * an intent, this is the component that was found to best handle it (that is,
4953 * yourself) and will always be non-null; in all other cases it will be
4954 * null unless explicitly set.
4955 *
4956 * @return The name of the application component to handle the intent.
4957 *
4958 * @see #resolveActivity
4959 * @see #setComponent
4960 */
4961 public ComponentName getComponent() {
4962 return mComponent;
4963 }
4964
4965 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004966 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4967 * used as a hint to the receiver for animations and the like. Null means that there
4968 * is no source bounds.
4969 */
4970 public Rect getSourceBounds() {
4971 return mSourceBounds;
4972 }
4973
4974 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004975 * Return the Activity component that should be used to handle this intent.
4976 * The appropriate component is determined based on the information in the
4977 * intent, evaluated as follows:
4978 *
4979 * <p>If {@link #getComponent} returns an explicit class, that is returned
4980 * without any further consideration.
4981 *
4982 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4983 * category to be considered.
4984 *
4985 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4986 * action.
4987 *
4988 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4989 * this type.
4990 *
4991 * <p>If {@link #addCategory} has added any categories, the activity must
4992 * handle ALL of the categories specified.
4993 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004994 * <p>If {@link #getPackage} is non-NULL, only activity components in
4995 * that application package will be considered.
4996 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004997 * <p>If there are no activities that satisfy all of these conditions, a
4998 * null string is returned.
4999 *
5000 * <p>If multiple activities are found to satisfy the intent, the one with
5001 * the highest priority will be used. If there are multiple activities
5002 * with the same priority, the system will either pick the best activity
5003 * based on user preference, or resolve to a system class that will allow
5004 * the user to pick an activity and forward from there.
5005 *
5006 * <p>This method is implemented simply by calling
5007 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5008 * true.</p>
5009 * <p> This API is called for you as part of starting an activity from an
5010 * intent. You do not normally need to call it yourself.</p>
5011 *
5012 * @param pm The package manager with which to resolve the Intent.
5013 *
5014 * @return Name of the component implementing an activity that can
5015 * display the intent.
5016 *
5017 * @see #setComponent
5018 * @see #getComponent
5019 * @see #resolveActivityInfo
5020 */
5021 public ComponentName resolveActivity(PackageManager pm) {
5022 if (mComponent != null) {
5023 return mComponent;
5024 }
5025
5026 ResolveInfo info = pm.resolveActivity(
5027 this, PackageManager.MATCH_DEFAULT_ONLY);
5028 if (info != null) {
5029 return new ComponentName(
5030 info.activityInfo.applicationInfo.packageName,
5031 info.activityInfo.name);
5032 }
5033
5034 return null;
5035 }
5036
5037 /**
5038 * Resolve the Intent into an {@link ActivityInfo}
5039 * describing the activity that should execute the intent. Resolution
5040 * follows the same rules as described for {@link #resolveActivity}, but
5041 * you get back the completely information about the resolved activity
5042 * instead of just its class name.
5043 *
5044 * @param pm The package manager with which to resolve the Intent.
5045 * @param flags Addition information to retrieve as per
5046 * {@link PackageManager#getActivityInfo(ComponentName, int)
5047 * PackageManager.getActivityInfo()}.
5048 *
5049 * @return PackageManager.ActivityInfo
5050 *
5051 * @see #resolveActivity
5052 */
5053 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5054 ActivityInfo ai = null;
5055 if (mComponent != null) {
5056 try {
5057 ai = pm.getActivityInfo(mComponent, flags);
5058 } catch (PackageManager.NameNotFoundException e) {
5059 // ignore
5060 }
5061 } else {
5062 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005063 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005064 if (info != null) {
5065 ai = info.activityInfo;
5066 }
5067 }
5068
5069 return ai;
5070 }
5071
5072 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005073 * Special function for use by the system to resolve service
5074 * intents to system apps. Throws an exception if there are
5075 * multiple potential matches to the Intent. Returns null if
5076 * there are no matches.
5077 * @hide
5078 */
5079 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5080 if (mComponent != null) {
5081 return mComponent;
5082 }
5083
5084 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5085 if (results == null) {
5086 return null;
5087 }
5088 ComponentName comp = null;
5089 for (int i=0; i<results.size(); i++) {
5090 ResolveInfo ri = results.get(i);
5091 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5092 continue;
5093 }
5094 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5095 ri.serviceInfo.name);
5096 if (comp != null) {
5097 throw new IllegalStateException("Multiple system services handle " + this
5098 + ": " + comp + ", " + foundComp);
5099 }
5100 comp = foundComp;
5101 }
5102 return comp;
5103 }
5104
5105 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005106 * Set the general action to be performed.
5107 *
5108 * @param action An action name, such as ACTION_VIEW. Application-specific
5109 * actions should be prefixed with the vendor's package name.
5110 *
5111 * @return Returns the same Intent object, for chaining multiple calls
5112 * into a single statement.
5113 *
5114 * @see #getAction
5115 */
5116 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005117 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005118 return this;
5119 }
5120
5121 /**
5122 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005123 * clears any type that was previously set by {@link #setType} or
5124 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005125 *
Nick Pellyccae4122012-01-09 14:12:58 -08005126 * <p><em>Note: scheme matching in the Android framework is
5127 * case-sensitive, unlike the formal RFC. As a result,
5128 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005129 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005130 * {@link #setDataAndNormalize}
5131 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005132 *
Nick Pellyccae4122012-01-09 14:12:58 -08005133 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005134 *
5135 * @return Returns the same Intent object, for chaining multiple calls
5136 * into a single statement.
5137 *
5138 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005139 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005140 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005141 */
5142 public Intent setData(Uri data) {
5143 mData = data;
5144 mType = null;
5145 return this;
5146 }
5147
5148 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005149 * Normalize and set the data this intent is operating on.
5150 *
5151 * <p>This method automatically clears any type that was
5152 * previously set (for example, by {@link #setType}).
5153 *
5154 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005155 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005156 * so really this is just a convenience method for
5157 * <pre>
5158 * setData(data.normalize())
5159 * </pre>
5160 *
5161 * @param data The Uri of the data this intent is now targeting.
5162 *
5163 * @return Returns the same Intent object, for chaining multiple calls
5164 * into a single statement.
5165 *
5166 * @see #getData
5167 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005168 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005169 */
5170 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005171 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005172 }
5173
5174 /**
5175 * Set an explicit MIME data type.
5176 *
5177 * <p>This is used to create intents that only specify a type and not data,
5178 * for example to indicate the type of data to return.
5179 *
5180 * <p>This method automatically clears any data that was
5181 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005182 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005183 * <p><em>Note: MIME type matching in the Android framework is
5184 * case-sensitive, unlike formal RFC MIME types. As a result,
5185 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005186 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5187 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005188 *
5189 * @param type The MIME type of the data being handled by this intent.
5190 *
5191 * @return Returns the same Intent object, for chaining multiple calls
5192 * into a single statement.
5193 *
5194 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005195 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005196 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005197 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005198 */
5199 public Intent setType(String type) {
5200 mData = null;
5201 mType = type;
5202 return this;
5203 }
5204
5205 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005206 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005207 *
Nick Pellyccae4122012-01-09 14:12:58 -08005208 * <p>This is used to create intents that only specify a type and not data,
5209 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005210 *
Nick Pellyccae4122012-01-09 14:12:58 -08005211 * <p>This method automatically clears any data that was
5212 * previously set (for example by {@link #setData}).
5213 *
5214 * <p>The MIME type is normalized using
5215 * {@link #normalizeMimeType} before it is set,
5216 * so really this is just a convenience method for
5217 * <pre>
5218 * setType(Intent.normalizeMimeType(type))
5219 * </pre>
5220 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005221 * @param type The MIME type of the data being handled by this intent.
5222 *
5223 * @return Returns the same Intent object, for chaining multiple calls
5224 * into a single statement.
5225 *
Nick Pellyccae4122012-01-09 14:12:58 -08005226 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005227 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005228 * @see #normalizeMimeType
5229 */
5230 public Intent setTypeAndNormalize(String type) {
5231 return setType(normalizeMimeType(type));
5232 }
5233
5234 /**
5235 * (Usually optional) Set the data for the intent along with an explicit
5236 * MIME data type. This method should very rarely be used -- it allows you
5237 * to override the MIME type that would ordinarily be inferred from the
5238 * data with your own type given here.
5239 *
5240 * <p><em>Note: MIME type and Uri scheme matching in the
5241 * Android framework is case-sensitive, unlike the formal RFC definitions.
5242 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005243 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005244 * {@link #setDataAndTypeAndNormalize}
5245 * to ensure that they are converted to lower case.</em>
5246 *
5247 * @param data The Uri of the data this intent is now targeting.
5248 * @param type The MIME type of the data being handled by this intent.
5249 *
5250 * @return Returns the same Intent object, for chaining multiple calls
5251 * into a single statement.
5252 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005253 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005254 * @see #setData
5255 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005256 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005257 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005258 */
5259 public Intent setDataAndType(Uri data, String type) {
5260 mData = data;
5261 mType = type;
5262 return this;
5263 }
5264
5265 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005266 * (Usually optional) Normalize and set both the data Uri and an explicit
5267 * MIME data type. This method should very rarely be used -- it allows you
5268 * to override the MIME type that would ordinarily be inferred from the
5269 * data with your own type given here.
5270 *
5271 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005272 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005273 * before they are set, so really this is just a convenience method for
5274 * <pre>
5275 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5276 * </pre>
5277 *
5278 * @param data The Uri of the data this intent is now targeting.
5279 * @param type The MIME type of the data being handled by this intent.
5280 *
5281 * @return Returns the same Intent object, for chaining multiple calls
5282 * into a single statement.
5283 *
5284 * @see #setType
5285 * @see #setData
5286 * @see #setDataAndType
5287 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005288 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005289 */
5290 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005291 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005292 }
5293
5294 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005295 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005296 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005297 * activities that provide <em>all</em> of the requested categories will be
5298 * used.
5299 *
5300 * @param category The desired category. This can be either one of the
5301 * predefined Intent categories, or a custom category in your own
5302 * namespace.
5303 *
5304 * @return Returns the same Intent object, for chaining multiple calls
5305 * into a single statement.
5306 *
5307 * @see #hasCategory
5308 * @see #removeCategory
5309 */
5310 public Intent addCategory(String category) {
5311 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005312 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005313 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005314 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005315 return this;
5316 }
5317
5318 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005319 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005320 *
5321 * @param category The category to remove.
5322 *
5323 * @see #addCategory
5324 */
5325 public void removeCategory(String category) {
5326 if (mCategories != null) {
5327 mCategories.remove(category);
5328 if (mCategories.size() == 0) {
5329 mCategories = null;
5330 }
5331 }
5332 }
5333
5334 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005335 * Set a selector for this Intent. This is a modification to the kinds of
5336 * things the Intent will match. If the selector is set, it will be used
5337 * when trying to find entities that can handle the Intent, instead of the
5338 * main contents of the Intent. This allows you build an Intent containing
5339 * a generic protocol while targeting it more specifically.
5340 *
5341 * <p>An example of where this may be used is with things like
5342 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5343 * Intent that will launch the Browser application. However, the correct
5344 * main entry point of an application is actually {@link #ACTION_MAIN}
5345 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5346 * used to specify the actual Activity to launch. If you launch the browser
5347 * with something different, undesired behavior may happen if the user has
5348 * previously or later launches it the normal way, since they do not match.
5349 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5350 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5351 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5352 *
5353 * <p>Setting a selector does not impact the behavior of
5354 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5355 * desired behavior of a selector -- it does not impact the base meaning
5356 * of the Intent, just what kinds of things will be matched against it
5357 * when determining who can handle it.</p>
5358 *
5359 * <p>You can not use both a selector and {@link #setPackage(String)} on
5360 * the same base Intent.</p>
5361 *
5362 * @param selector The desired selector Intent; set to null to not use
5363 * a special selector.
5364 */
5365 public void setSelector(Intent selector) {
5366 if (selector == this) {
5367 throw new IllegalArgumentException(
5368 "Intent being set as a selector of itself");
5369 }
5370 if (selector != null && mPackage != null) {
5371 throw new IllegalArgumentException(
5372 "Can't set selector when package name is already set");
5373 }
5374 mSelector = selector;
5375 }
5376
5377 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005378 * Set a {@link ClipData} associated with this Intent. This replaces any
5379 * previously set ClipData.
5380 *
5381 * <p>The ClipData in an intent is not used for Intent matching or other
5382 * such operations. Semantically it is like extras, used to transmit
5383 * additional data with the Intent. The main feature of using this over
5384 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5385 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5386 * items included in the clip data. This is useful, in particular, if
5387 * you want to transmit an Intent containing multiple <code>content:</code>
5388 * URIs for which the recipient may not have global permission to access the
5389 * content provider.
5390 *
5391 * <p>If the ClipData contains items that are themselves Intents, any
5392 * grant flags in those Intents will be ignored. Only the top-level flags
5393 * of the main Intent are respected, and will be applied to all Uri or
5394 * Intent items in the clip (or sub-items of the clip).
5395 *
5396 * <p>The MIME type, label, and icon in the ClipData object are not
5397 * directly used by Intent. Applications should generally rely on the
5398 * MIME type of the Intent itself, not what it may find in the ClipData.
5399 * A common practice is to construct a ClipData for use with an Intent
5400 * with a MIME type of "*\/*".
5401 *
5402 * @param clip The new clip to set. May be null to clear the current clip.
5403 */
5404 public void setClipData(ClipData clip) {
5405 mClipData = clip;
5406 }
5407
5408 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005409 * Add extended data to the intent. The name must include a package
5410 * prefix, for example the app com.android.contacts would use names
5411 * like "com.android.contacts.ShowAll".
5412 *
5413 * @param name The name of the extra data, with package prefix.
5414 * @param value The boolean data value.
5415 *
5416 * @return Returns the same Intent object, for chaining multiple calls
5417 * into a single statement.
5418 *
5419 * @see #putExtras
5420 * @see #removeExtra
5421 * @see #getBooleanExtra(String, boolean)
5422 */
5423 public Intent putExtra(String name, boolean value) {
5424 if (mExtras == null) {
5425 mExtras = new Bundle();
5426 }
5427 mExtras.putBoolean(name, value);
5428 return this;
5429 }
5430
5431 /**
5432 * Add extended data to the intent. The name must include a package
5433 * prefix, for example the app com.android.contacts would use names
5434 * like "com.android.contacts.ShowAll".
5435 *
5436 * @param name The name of the extra data, with package prefix.
5437 * @param value The byte data value.
5438 *
5439 * @return Returns the same Intent object, for chaining multiple calls
5440 * into a single statement.
5441 *
5442 * @see #putExtras
5443 * @see #removeExtra
5444 * @see #getByteExtra(String, byte)
5445 */
5446 public Intent putExtra(String name, byte value) {
5447 if (mExtras == null) {
5448 mExtras = new Bundle();
5449 }
5450 mExtras.putByte(name, value);
5451 return this;
5452 }
5453
5454 /**
5455 * Add extended data to the intent. The name must include a package
5456 * prefix, for example the app com.android.contacts would use names
5457 * like "com.android.contacts.ShowAll".
5458 *
5459 * @param name The name of the extra data, with package prefix.
5460 * @param value The char data value.
5461 *
5462 * @return Returns the same Intent object, for chaining multiple calls
5463 * into a single statement.
5464 *
5465 * @see #putExtras
5466 * @see #removeExtra
5467 * @see #getCharExtra(String, char)
5468 */
5469 public Intent putExtra(String name, char value) {
5470 if (mExtras == null) {
5471 mExtras = new Bundle();
5472 }
5473 mExtras.putChar(name, value);
5474 return this;
5475 }
5476
5477 /**
5478 * Add extended data to the intent. The name must include a package
5479 * prefix, for example the app com.android.contacts would use names
5480 * like "com.android.contacts.ShowAll".
5481 *
5482 * @param name The name of the extra data, with package prefix.
5483 * @param value The short data value.
5484 *
5485 * @return Returns the same Intent object, for chaining multiple calls
5486 * into a single statement.
5487 *
5488 * @see #putExtras
5489 * @see #removeExtra
5490 * @see #getShortExtra(String, short)
5491 */
5492 public Intent putExtra(String name, short value) {
5493 if (mExtras == null) {
5494 mExtras = new Bundle();
5495 }
5496 mExtras.putShort(name, value);
5497 return this;
5498 }
5499
5500 /**
5501 * Add extended data to the intent. The name must include a package
5502 * prefix, for example the app com.android.contacts would use names
5503 * like "com.android.contacts.ShowAll".
5504 *
5505 * @param name The name of the extra data, with package prefix.
5506 * @param value The integer data value.
5507 *
5508 * @return Returns the same Intent object, for chaining multiple calls
5509 * into a single statement.
5510 *
5511 * @see #putExtras
5512 * @see #removeExtra
5513 * @see #getIntExtra(String, int)
5514 */
5515 public Intent putExtra(String name, int value) {
5516 if (mExtras == null) {
5517 mExtras = new Bundle();
5518 }
5519 mExtras.putInt(name, value);
5520 return this;
5521 }
5522
5523 /**
5524 * Add extended data to the intent. The name must include a package
5525 * prefix, for example the app com.android.contacts would use names
5526 * like "com.android.contacts.ShowAll".
5527 *
5528 * @param name The name of the extra data, with package prefix.
5529 * @param value The long data value.
5530 *
5531 * @return Returns the same Intent object, for chaining multiple calls
5532 * into a single statement.
5533 *
5534 * @see #putExtras
5535 * @see #removeExtra
5536 * @see #getLongExtra(String, long)
5537 */
5538 public Intent putExtra(String name, long value) {
5539 if (mExtras == null) {
5540 mExtras = new Bundle();
5541 }
5542 mExtras.putLong(name, value);
5543 return this;
5544 }
5545
5546 /**
5547 * Add extended data to the intent. The name must include a package
5548 * prefix, for example the app com.android.contacts would use names
5549 * like "com.android.contacts.ShowAll".
5550 *
5551 * @param name The name of the extra data, with package prefix.
5552 * @param value The float data value.
5553 *
5554 * @return Returns the same Intent object, for chaining multiple calls
5555 * into a single statement.
5556 *
5557 * @see #putExtras
5558 * @see #removeExtra
5559 * @see #getFloatExtra(String, float)
5560 */
5561 public Intent putExtra(String name, float value) {
5562 if (mExtras == null) {
5563 mExtras = new Bundle();
5564 }
5565 mExtras.putFloat(name, value);
5566 return this;
5567 }
5568
5569 /**
5570 * Add extended data to the intent. The name must include a package
5571 * prefix, for example the app com.android.contacts would use names
5572 * like "com.android.contacts.ShowAll".
5573 *
5574 * @param name The name of the extra data, with package prefix.
5575 * @param value The double data value.
5576 *
5577 * @return Returns the same Intent object, for chaining multiple calls
5578 * into a single statement.
5579 *
5580 * @see #putExtras
5581 * @see #removeExtra
5582 * @see #getDoubleExtra(String, double)
5583 */
5584 public Intent putExtra(String name, double value) {
5585 if (mExtras == null) {
5586 mExtras = new Bundle();
5587 }
5588 mExtras.putDouble(name, value);
5589 return this;
5590 }
5591
5592 /**
5593 * Add extended data to the intent. The name must include a package
5594 * prefix, for example the app com.android.contacts would use names
5595 * like "com.android.contacts.ShowAll".
5596 *
5597 * @param name The name of the extra data, with package prefix.
5598 * @param value The String data value.
5599 *
5600 * @return Returns the same Intent object, for chaining multiple calls
5601 * into a single statement.
5602 *
5603 * @see #putExtras
5604 * @see #removeExtra
5605 * @see #getStringExtra(String)
5606 */
5607 public Intent putExtra(String name, String value) {
5608 if (mExtras == null) {
5609 mExtras = new Bundle();
5610 }
5611 mExtras.putString(name, value);
5612 return this;
5613 }
5614
5615 /**
5616 * Add extended data to the intent. The name must include a package
5617 * prefix, for example the app com.android.contacts would use names
5618 * like "com.android.contacts.ShowAll".
5619 *
5620 * @param name The name of the extra data, with package prefix.
5621 * @param value The CharSequence data value.
5622 *
5623 * @return Returns the same Intent object, for chaining multiple calls
5624 * into a single statement.
5625 *
5626 * @see #putExtras
5627 * @see #removeExtra
5628 * @see #getCharSequenceExtra(String)
5629 */
5630 public Intent putExtra(String name, CharSequence value) {
5631 if (mExtras == null) {
5632 mExtras = new Bundle();
5633 }
5634 mExtras.putCharSequence(name, value);
5635 return this;
5636 }
5637
5638 /**
5639 * Add extended data to the intent. The name must include a package
5640 * prefix, for example the app com.android.contacts would use names
5641 * like "com.android.contacts.ShowAll".
5642 *
5643 * @param name The name of the extra data, with package prefix.
5644 * @param value The Parcelable data value.
5645 *
5646 * @return Returns the same Intent object, for chaining multiple calls
5647 * into a single statement.
5648 *
5649 * @see #putExtras
5650 * @see #removeExtra
5651 * @see #getParcelableExtra(String)
5652 */
5653 public Intent putExtra(String name, Parcelable value) {
5654 if (mExtras == null) {
5655 mExtras = new Bundle();
5656 }
5657 mExtras.putParcelable(name, value);
5658 return this;
5659 }
5660
5661 /**
5662 * Add extended data to the intent. The name must include a package
5663 * prefix, for example the app com.android.contacts would use names
5664 * like "com.android.contacts.ShowAll".
5665 *
5666 * @param name The name of the extra data, with package prefix.
5667 * @param value The Parcelable[] data value.
5668 *
5669 * @return Returns the same Intent object, for chaining multiple calls
5670 * into a single statement.
5671 *
5672 * @see #putExtras
5673 * @see #removeExtra
5674 * @see #getParcelableArrayExtra(String)
5675 */
5676 public Intent putExtra(String name, Parcelable[] value) {
5677 if (mExtras == null) {
5678 mExtras = new Bundle();
5679 }
5680 mExtras.putParcelableArray(name, value);
5681 return this;
5682 }
5683
5684 /**
5685 * Add extended data to the intent. The name must include a package
5686 * prefix, for example the app com.android.contacts would use names
5687 * like "com.android.contacts.ShowAll".
5688 *
5689 * @param name The name of the extra data, with package prefix.
5690 * @param value The ArrayList<Parcelable> data value.
5691 *
5692 * @return Returns the same Intent object, for chaining multiple calls
5693 * into a single statement.
5694 *
5695 * @see #putExtras
5696 * @see #removeExtra
5697 * @see #getParcelableArrayListExtra(String)
5698 */
5699 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5700 if (mExtras == null) {
5701 mExtras = new Bundle();
5702 }
5703 mExtras.putParcelableArrayList(name, value);
5704 return this;
5705 }
5706
5707 /**
5708 * Add extended data to the intent. The name must include a package
5709 * prefix, for example the app com.android.contacts would use names
5710 * like "com.android.contacts.ShowAll".
5711 *
5712 * @param name The name of the extra data, with package prefix.
5713 * @param value The ArrayList<Integer> data value.
5714 *
5715 * @return Returns the same Intent object, for chaining multiple calls
5716 * into a single statement.
5717 *
5718 * @see #putExtras
5719 * @see #removeExtra
5720 * @see #getIntegerArrayListExtra(String)
5721 */
5722 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5723 if (mExtras == null) {
5724 mExtras = new Bundle();
5725 }
5726 mExtras.putIntegerArrayList(name, value);
5727 return this;
5728 }
5729
5730 /**
5731 * Add extended data to the intent. The name must include a package
5732 * prefix, for example the app com.android.contacts would use names
5733 * like "com.android.contacts.ShowAll".
5734 *
5735 * @param name The name of the extra data, with package prefix.
5736 * @param value The ArrayList<String> data value.
5737 *
5738 * @return Returns the same Intent object, for chaining multiple calls
5739 * into a single statement.
5740 *
5741 * @see #putExtras
5742 * @see #removeExtra
5743 * @see #getStringArrayListExtra(String)
5744 */
5745 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5746 if (mExtras == null) {
5747 mExtras = new Bundle();
5748 }
5749 mExtras.putStringArrayList(name, value);
5750 return this;
5751 }
5752
5753 /**
5754 * Add extended data to the intent. The name must include a package
5755 * prefix, for example the app com.android.contacts would use names
5756 * like "com.android.contacts.ShowAll".
5757 *
5758 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005759 * @param value The ArrayList<CharSequence> data value.
5760 *
5761 * @return Returns the same Intent object, for chaining multiple calls
5762 * into a single statement.
5763 *
5764 * @see #putExtras
5765 * @see #removeExtra
5766 * @see #getCharSequenceArrayListExtra(String)
5767 */
5768 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5769 if (mExtras == null) {
5770 mExtras = new Bundle();
5771 }
5772 mExtras.putCharSequenceArrayList(name, value);
5773 return this;
5774 }
5775
5776 /**
5777 * Add extended data to the intent. The name must include a package
5778 * prefix, for example the app com.android.contacts would use names
5779 * like "com.android.contacts.ShowAll".
5780 *
5781 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005782 * @param value The Serializable data value.
5783 *
5784 * @return Returns the same Intent object, for chaining multiple calls
5785 * into a single statement.
5786 *
5787 * @see #putExtras
5788 * @see #removeExtra
5789 * @see #getSerializableExtra(String)
5790 */
5791 public Intent putExtra(String name, Serializable value) {
5792 if (mExtras == null) {
5793 mExtras = new Bundle();
5794 }
5795 mExtras.putSerializable(name, value);
5796 return this;
5797 }
5798
5799 /**
5800 * Add extended data to the intent. The name must include a package
5801 * prefix, for example the app com.android.contacts would use names
5802 * like "com.android.contacts.ShowAll".
5803 *
5804 * @param name The name of the extra data, with package prefix.
5805 * @param value The boolean array data value.
5806 *
5807 * @return Returns the same Intent object, for chaining multiple calls
5808 * into a single statement.
5809 *
5810 * @see #putExtras
5811 * @see #removeExtra
5812 * @see #getBooleanArrayExtra(String)
5813 */
5814 public Intent putExtra(String name, boolean[] value) {
5815 if (mExtras == null) {
5816 mExtras = new Bundle();
5817 }
5818 mExtras.putBooleanArray(name, value);
5819 return this;
5820 }
5821
5822 /**
5823 * Add extended data to the intent. The name must include a package
5824 * prefix, for example the app com.android.contacts would use names
5825 * like "com.android.contacts.ShowAll".
5826 *
5827 * @param name The name of the extra data, with package prefix.
5828 * @param value The byte array data value.
5829 *
5830 * @return Returns the same Intent object, for chaining multiple calls
5831 * into a single statement.
5832 *
5833 * @see #putExtras
5834 * @see #removeExtra
5835 * @see #getByteArrayExtra(String)
5836 */
5837 public Intent putExtra(String name, byte[] value) {
5838 if (mExtras == null) {
5839 mExtras = new Bundle();
5840 }
5841 mExtras.putByteArray(name, value);
5842 return this;
5843 }
5844
5845 /**
5846 * Add extended data to the intent. The name must include a package
5847 * prefix, for example the app com.android.contacts would use names
5848 * like "com.android.contacts.ShowAll".
5849 *
5850 * @param name The name of the extra data, with package prefix.
5851 * @param value The short array data value.
5852 *
5853 * @return Returns the same Intent object, for chaining multiple calls
5854 * into a single statement.
5855 *
5856 * @see #putExtras
5857 * @see #removeExtra
5858 * @see #getShortArrayExtra(String)
5859 */
5860 public Intent putExtra(String name, short[] value) {
5861 if (mExtras == null) {
5862 mExtras = new Bundle();
5863 }
5864 mExtras.putShortArray(name, value);
5865 return this;
5866 }
5867
5868 /**
5869 * Add extended data to the intent. The name must include a package
5870 * prefix, for example the app com.android.contacts would use names
5871 * like "com.android.contacts.ShowAll".
5872 *
5873 * @param name The name of the extra data, with package prefix.
5874 * @param value The char array data value.
5875 *
5876 * @return Returns the same Intent object, for chaining multiple calls
5877 * into a single statement.
5878 *
5879 * @see #putExtras
5880 * @see #removeExtra
5881 * @see #getCharArrayExtra(String)
5882 */
5883 public Intent putExtra(String name, char[] value) {
5884 if (mExtras == null) {
5885 mExtras = new Bundle();
5886 }
5887 mExtras.putCharArray(name, value);
5888 return this;
5889 }
5890
5891 /**
5892 * Add extended data to the intent. The name must include a package
5893 * prefix, for example the app com.android.contacts would use names
5894 * like "com.android.contacts.ShowAll".
5895 *
5896 * @param name The name of the extra data, with package prefix.
5897 * @param value The int array data value.
5898 *
5899 * @return Returns the same Intent object, for chaining multiple calls
5900 * into a single statement.
5901 *
5902 * @see #putExtras
5903 * @see #removeExtra
5904 * @see #getIntArrayExtra(String)
5905 */
5906 public Intent putExtra(String name, int[] value) {
5907 if (mExtras == null) {
5908 mExtras = new Bundle();
5909 }
5910 mExtras.putIntArray(name, value);
5911 return this;
5912 }
5913
5914 /**
5915 * Add extended data to the intent. The name must include a package
5916 * prefix, for example the app com.android.contacts would use names
5917 * like "com.android.contacts.ShowAll".
5918 *
5919 * @param name The name of the extra data, with package prefix.
5920 * @param value The byte array data value.
5921 *
5922 * @return Returns the same Intent object, for chaining multiple calls
5923 * into a single statement.
5924 *
5925 * @see #putExtras
5926 * @see #removeExtra
5927 * @see #getLongArrayExtra(String)
5928 */
5929 public Intent putExtra(String name, long[] value) {
5930 if (mExtras == null) {
5931 mExtras = new Bundle();
5932 }
5933 mExtras.putLongArray(name, value);
5934 return this;
5935 }
5936
5937 /**
5938 * Add extended data to the intent. The name must include a package
5939 * prefix, for example the app com.android.contacts would use names
5940 * like "com.android.contacts.ShowAll".
5941 *
5942 * @param name The name of the extra data, with package prefix.
5943 * @param value The float array data value.
5944 *
5945 * @return Returns the same Intent object, for chaining multiple calls
5946 * into a single statement.
5947 *
5948 * @see #putExtras
5949 * @see #removeExtra
5950 * @see #getFloatArrayExtra(String)
5951 */
5952 public Intent putExtra(String name, float[] value) {
5953 if (mExtras == null) {
5954 mExtras = new Bundle();
5955 }
5956 mExtras.putFloatArray(name, value);
5957 return this;
5958 }
5959
5960 /**
5961 * Add extended data to the intent. The name must include a package
5962 * prefix, for example the app com.android.contacts would use names
5963 * like "com.android.contacts.ShowAll".
5964 *
5965 * @param name The name of the extra data, with package prefix.
5966 * @param value The double array data value.
5967 *
5968 * @return Returns the same Intent object, for chaining multiple calls
5969 * into a single statement.
5970 *
5971 * @see #putExtras
5972 * @see #removeExtra
5973 * @see #getDoubleArrayExtra(String)
5974 */
5975 public Intent putExtra(String name, double[] value) {
5976 if (mExtras == null) {
5977 mExtras = new Bundle();
5978 }
5979 mExtras.putDoubleArray(name, value);
5980 return this;
5981 }
5982
5983 /**
5984 * Add extended data to the intent. The name must include a package
5985 * prefix, for example the app com.android.contacts would use names
5986 * like "com.android.contacts.ShowAll".
5987 *
5988 * @param name The name of the extra data, with package prefix.
5989 * @param value The String array data value.
5990 *
5991 * @return Returns the same Intent object, for chaining multiple calls
5992 * into a single statement.
5993 *
5994 * @see #putExtras
5995 * @see #removeExtra
5996 * @see #getStringArrayExtra(String)
5997 */
5998 public Intent putExtra(String name, String[] value) {
5999 if (mExtras == null) {
6000 mExtras = new Bundle();
6001 }
6002 mExtras.putStringArray(name, value);
6003 return this;
6004 }
6005
6006 /**
6007 * Add extended data to the intent. The name must include a package
6008 * prefix, for example the app com.android.contacts would use names
6009 * like "com.android.contacts.ShowAll".
6010 *
6011 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006012 * @param value The CharSequence array data value.
6013 *
6014 * @return Returns the same Intent object, for chaining multiple calls
6015 * into a single statement.
6016 *
6017 * @see #putExtras
6018 * @see #removeExtra
6019 * @see #getCharSequenceArrayExtra(String)
6020 */
6021 public Intent putExtra(String name, CharSequence[] value) {
6022 if (mExtras == null) {
6023 mExtras = new Bundle();
6024 }
6025 mExtras.putCharSequenceArray(name, value);
6026 return this;
6027 }
6028
6029 /**
6030 * Add extended data to the intent. The name must include a package
6031 * prefix, for example the app com.android.contacts would use names
6032 * like "com.android.contacts.ShowAll".
6033 *
6034 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006035 * @param value The Bundle data value.
6036 *
6037 * @return Returns the same Intent object, for chaining multiple calls
6038 * into a single statement.
6039 *
6040 * @see #putExtras
6041 * @see #removeExtra
6042 * @see #getBundleExtra(String)
6043 */
6044 public Intent putExtra(String name, Bundle value) {
6045 if (mExtras == null) {
6046 mExtras = new Bundle();
6047 }
6048 mExtras.putBundle(name, value);
6049 return this;
6050 }
6051
6052 /**
6053 * Add extended data to the intent. The name must include a package
6054 * prefix, for example the app com.android.contacts would use names
6055 * like "com.android.contacts.ShowAll".
6056 *
6057 * @param name The name of the extra data, with package prefix.
6058 * @param value The IBinder data value.
6059 *
6060 * @return Returns the same Intent object, for chaining multiple calls
6061 * into a single statement.
6062 *
6063 * @see #putExtras
6064 * @see #removeExtra
6065 * @see #getIBinderExtra(String)
6066 *
6067 * @deprecated
6068 * @hide
6069 */
6070 @Deprecated
6071 public Intent putExtra(String name, IBinder value) {
6072 if (mExtras == null) {
6073 mExtras = new Bundle();
6074 }
6075 mExtras.putIBinder(name, value);
6076 return this;
6077 }
6078
6079 /**
6080 * Copy all extras in 'src' in to this intent.
6081 *
6082 * @param src Contains the extras to copy.
6083 *
6084 * @see #putExtra
6085 */
6086 public Intent putExtras(Intent src) {
6087 if (src.mExtras != null) {
6088 if (mExtras == null) {
6089 mExtras = new Bundle(src.mExtras);
6090 } else {
6091 mExtras.putAll(src.mExtras);
6092 }
6093 }
6094 return this;
6095 }
6096
6097 /**
6098 * Add a set of extended data to the intent. The keys must include a package
6099 * prefix, for example the app com.android.contacts would use names
6100 * like "com.android.contacts.ShowAll".
6101 *
6102 * @param extras The Bundle of extras to add to this intent.
6103 *
6104 * @see #putExtra
6105 * @see #removeExtra
6106 */
6107 public Intent putExtras(Bundle extras) {
6108 if (mExtras == null) {
6109 mExtras = new Bundle();
6110 }
6111 mExtras.putAll(extras);
6112 return this;
6113 }
6114
6115 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006116 * Completely replace the extras in the Intent with the extras in the
6117 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006118 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006119 * @param src The exact extras contained in this Intent are copied
6120 * into the target intent, replacing any that were previously there.
6121 */
6122 public Intent replaceExtras(Intent src) {
6123 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6124 return this;
6125 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006126
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006127 /**
6128 * Completely replace the extras in the Intent with the given Bundle of
6129 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006130 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006131 * @param extras The new set of extras in the Intent, or null to erase
6132 * all extras.
6133 */
6134 public Intent replaceExtras(Bundle extras) {
6135 mExtras = extras != null ? new Bundle(extras) : null;
6136 return this;
6137 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006138
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006139 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006140 * Remove extended data from the intent.
6141 *
6142 * @see #putExtra
6143 */
6144 public void removeExtra(String name) {
6145 if (mExtras != null) {
6146 mExtras.remove(name);
6147 if (mExtras.size() == 0) {
6148 mExtras = null;
6149 }
6150 }
6151 }
6152
6153 /**
6154 * Set special flags controlling how this intent is handled. Most values
6155 * here depend on the type of component being executed by the Intent,
6156 * specifically the FLAG_ACTIVITY_* flags are all for use with
6157 * {@link Context#startActivity Context.startActivity()} and the
6158 * FLAG_RECEIVER_* flags are all for use with
6159 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6160 *
Scott Main7aee61f2011-02-08 11:25:01 -08006161 * <p>See the
6162 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6163 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006164 * the behavior of your application.
6165 *
6166 * @param flags The desired flags.
6167 *
6168 * @return Returns the same Intent object, for chaining multiple calls
6169 * into a single statement.
6170 *
6171 * @see #getFlags
6172 * @see #addFlags
6173 *
6174 * @see #FLAG_GRANT_READ_URI_PERMISSION
6175 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6176 * @see #FLAG_DEBUG_LOG_RESOLUTION
6177 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006178 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006179 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006180 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006181 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006182 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6183 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006184 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006185 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
6186 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006187 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006188 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006189 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006190 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6191 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006192 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006193 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006194 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006195 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6196 */
6197 public Intent setFlags(int flags) {
6198 mFlags = flags;
6199 return this;
6200 }
6201
6202 /**
6203 * Add additional flags to the intent (or with existing flags
6204 * value).
6205 *
6206 * @param flags The new flags to set.
6207 *
6208 * @return Returns the same Intent object, for chaining multiple calls
6209 * into a single statement.
6210 *
6211 * @see #setFlags
6212 */
6213 public Intent addFlags(int flags) {
6214 mFlags |= flags;
6215 return this;
6216 }
6217
6218 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006219 * (Usually optional) Set an explicit application package name that limits
6220 * the components this Intent will resolve to. If left to the default
6221 * value of null, all components in all applications will considered.
6222 * If non-null, the Intent can only match the components in the given
6223 * application package.
6224 *
6225 * @param packageName The name of the application package to handle the
6226 * intent, or null to allow any application package.
6227 *
6228 * @return Returns the same Intent object, for chaining multiple calls
6229 * into a single statement.
6230 *
6231 * @see #getPackage
6232 * @see #resolveActivity
6233 */
6234 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006235 if (packageName != null && mSelector != null) {
6236 throw new IllegalArgumentException(
6237 "Can't set package name when selector is already set");
6238 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006239 mPackage = packageName;
6240 return this;
6241 }
6242
6243 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006244 * (Usually optional) Explicitly set the component to handle the intent.
6245 * If left with the default value of null, the system will determine the
6246 * appropriate class to use based on the other fields (action, data,
6247 * type, categories) in the Intent. If this class is defined, the
6248 * specified class will always be used regardless of the other fields. You
6249 * should only set this value when you know you absolutely want a specific
6250 * class to be used; otherwise it is better to let the system find the
6251 * appropriate class so that you will respect the installed applications
6252 * and user preferences.
6253 *
6254 * @param component The name of the application component to handle the
6255 * intent, or null to let the system find one for you.
6256 *
6257 * @return Returns the same Intent object, for chaining multiple calls
6258 * into a single statement.
6259 *
6260 * @see #setClass
6261 * @see #setClassName(Context, String)
6262 * @see #setClassName(String, String)
6263 * @see #getComponent
6264 * @see #resolveActivity
6265 */
6266 public Intent setComponent(ComponentName component) {
6267 mComponent = component;
6268 return this;
6269 }
6270
6271 /**
6272 * Convenience for calling {@link #setComponent} with an
6273 * explicit class name.
6274 *
6275 * @param packageContext A Context of the application package implementing
6276 * this class.
6277 * @param className The name of a class inside of the application package
6278 * that will be used as the component for this Intent.
6279 *
6280 * @return Returns the same Intent object, for chaining multiple calls
6281 * into a single statement.
6282 *
6283 * @see #setComponent
6284 * @see #setClass
6285 */
6286 public Intent setClassName(Context packageContext, String className) {
6287 mComponent = new ComponentName(packageContext, className);
6288 return this;
6289 }
6290
6291 /**
6292 * Convenience for calling {@link #setComponent} with an
6293 * explicit application package name and class name.
6294 *
6295 * @param packageName The name of the package implementing the desired
6296 * component.
6297 * @param className The name of a class inside of the application package
6298 * that will be used as the component for this Intent.
6299 *
6300 * @return Returns the same Intent object, for chaining multiple calls
6301 * into a single statement.
6302 *
6303 * @see #setComponent
6304 * @see #setClass
6305 */
6306 public Intent setClassName(String packageName, String className) {
6307 mComponent = new ComponentName(packageName, className);
6308 return this;
6309 }
6310
6311 /**
6312 * Convenience for calling {@link #setComponent(ComponentName)} with the
6313 * name returned by a {@link Class} object.
6314 *
6315 * @param packageContext A Context of the application package implementing
6316 * this class.
6317 * @param cls The class name to set, equivalent to
6318 * <code>setClassName(context, cls.getName())</code>.
6319 *
6320 * @return Returns the same Intent object, for chaining multiple calls
6321 * into a single statement.
6322 *
6323 * @see #setComponent
6324 */
6325 public Intent setClass(Context packageContext, Class<?> cls) {
6326 mComponent = new ComponentName(packageContext, cls);
6327 return this;
6328 }
6329
6330 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006331 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6332 * used as a hint to the receiver for animations and the like. Null means that there
6333 * is no source bounds.
6334 */
6335 public void setSourceBounds(Rect r) {
6336 if (r != null) {
6337 mSourceBounds = new Rect(r);
6338 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006339 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006340 }
6341 }
6342
6343 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006344 * Use with {@link #fillIn} to allow the current action value to be
6345 * overwritten, even if it is already set.
6346 */
6347 public static final int FILL_IN_ACTION = 1<<0;
6348
6349 /**
6350 * Use with {@link #fillIn} to allow the current data or type value
6351 * overwritten, even if it is already set.
6352 */
6353 public static final int FILL_IN_DATA = 1<<1;
6354
6355 /**
6356 * Use with {@link #fillIn} to allow the current categories to be
6357 * overwritten, even if they are already set.
6358 */
6359 public static final int FILL_IN_CATEGORIES = 1<<2;
6360
6361 /**
6362 * Use with {@link #fillIn} to allow the current component value to be
6363 * overwritten, even if it is already set.
6364 */
6365 public static final int FILL_IN_COMPONENT = 1<<3;
6366
6367 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006368 * Use with {@link #fillIn} to allow the current package value to be
6369 * overwritten, even if it is already set.
6370 */
6371 public static final int FILL_IN_PACKAGE = 1<<4;
6372
6373 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006374 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006375 * overwritten, even if it is already set.
6376 */
6377 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6378
6379 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006380 * Use with {@link #fillIn} to allow the current selector to be
6381 * overwritten, even if it is already set.
6382 */
6383 public static final int FILL_IN_SELECTOR = 1<<6;
6384
6385 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006386 * Use with {@link #fillIn} to allow the current ClipData to be
6387 * overwritten, even if it is already set.
6388 */
6389 public static final int FILL_IN_CLIP_DATA = 1<<7;
6390
6391 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006392 * Copy the contents of <var>other</var> in to this object, but only
6393 * where fields are not defined by this object. For purposes of a field
6394 * being defined, the following pieces of data in the Intent are
6395 * considered to be separate fields:
6396 *
6397 * <ul>
6398 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006399 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006400 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6401 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006402 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006403 * <li> component, as set by {@link #setComponent(ComponentName)} or
6404 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006405 * <li> source bounds, as set by {@link #setSourceBounds}.
6406 * <li> selector, as set by {@link #setSelector(Intent)}.
6407 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006408 * <li> each top-level name in the associated extras.
6409 * </ul>
6410 *
6411 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006412 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006413 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6414 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6415 * the restriction where the corresponding field will not be replaced if
6416 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006417 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006418 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6419 * is explicitly specified. The selector will only be copied if
6420 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006421 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006422 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6423 * and Intent B with {action="gotit", data-type="some/thing",
6424 * categories="one","two"}.
6425 *
6426 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6427 * containing: {action="gotit", data-type="some/thing",
6428 * categories="bar"}.
6429 *
6430 * @param other Another Intent whose values are to be used to fill in
6431 * the current one.
6432 * @param flags Options to control which fields can be filled in.
6433 *
6434 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006435 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006436 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6437 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006438 */
6439 public int fillIn(Intent other, int flags) {
6440 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006441 if (other.mAction != null
6442 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006443 mAction = other.mAction;
6444 changes |= FILL_IN_ACTION;
6445 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006446 if ((other.mData != null || other.mType != null)
6447 && ((mData == null && mType == null)
6448 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006449 mData = other.mData;
6450 mType = other.mType;
6451 changes |= FILL_IN_DATA;
6452 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006453 if (other.mCategories != null
6454 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006455 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006456 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006457 }
6458 changes |= FILL_IN_CATEGORIES;
6459 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006460 if (other.mPackage != null
6461 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006462 // Only do this if mSelector is not set.
6463 if (mSelector == null) {
6464 mPackage = other.mPackage;
6465 changes |= FILL_IN_PACKAGE;
6466 }
6467 }
6468 // Selector is special: it can only be set if explicitly allowed,
6469 // for the same reason as the component name.
6470 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6471 if (mPackage == null) {
6472 mSelector = new Intent(other.mSelector);
6473 mPackage = null;
6474 changes |= FILL_IN_SELECTOR;
6475 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006476 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006477 if (other.mClipData != null
6478 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6479 mClipData = other.mClipData;
6480 changes |= FILL_IN_CLIP_DATA;
6481 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006482 // Component is special: it can -only- be set if explicitly allowed,
6483 // since otherwise the sender could force the intent somewhere the
6484 // originator didn't intend.
6485 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006486 mComponent = other.mComponent;
6487 changes |= FILL_IN_COMPONENT;
6488 }
6489 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006490 if (other.mSourceBounds != null
6491 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6492 mSourceBounds = new Rect(other.mSourceBounds);
6493 changes |= FILL_IN_SOURCE_BOUNDS;
6494 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006495 if (mExtras == null) {
6496 if (other.mExtras != null) {
6497 mExtras = new Bundle(other.mExtras);
6498 }
6499 } else if (other.mExtras != null) {
6500 try {
6501 Bundle newb = new Bundle(other.mExtras);
6502 newb.putAll(mExtras);
6503 mExtras = newb;
6504 } catch (RuntimeException e) {
6505 // Modifying the extras can cause us to unparcel the contents
6506 // of the bundle, and if we do this in the system process that
6507 // may fail. We really should handle this (i.e., the Bundle
6508 // impl shouldn't be on top of a plain map), but for now just
6509 // ignore it and keep the original contents. :(
6510 Log.w("Intent", "Failure filling in extras", e);
6511 }
6512 }
6513 return changes;
6514 }
6515
6516 /**
6517 * Wrapper class holding an Intent and implementing comparisons on it for
6518 * the purpose of filtering. The class implements its
6519 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6520 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6521 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6522 * on the wrapped Intent.
6523 */
6524 public static final class FilterComparison {
6525 private final Intent mIntent;
6526 private final int mHashCode;
6527
6528 public FilterComparison(Intent intent) {
6529 mIntent = intent;
6530 mHashCode = intent.filterHashCode();
6531 }
6532
6533 /**
6534 * Return the Intent that this FilterComparison represents.
6535 * @return Returns the Intent held by the FilterComparison. Do
6536 * not modify!
6537 */
6538 public Intent getIntent() {
6539 return mIntent;
6540 }
6541
6542 @Override
6543 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006544 if (obj instanceof FilterComparison) {
6545 Intent other = ((FilterComparison)obj).mIntent;
6546 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006547 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006548 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006549 }
6550
6551 @Override
6552 public int hashCode() {
6553 return mHashCode;
6554 }
6555 }
6556
6557 /**
6558 * Determine if two intents are the same for the purposes of intent
6559 * resolution (filtering). That is, if their action, data, type,
6560 * class, and categories are the same. This does <em>not</em> compare
6561 * any extra data included in the intents.
6562 *
6563 * @param other The other Intent to compare against.
6564 *
6565 * @return Returns true if action, data, type, class, and categories
6566 * are the same.
6567 */
6568 public boolean filterEquals(Intent other) {
6569 if (other == null) {
6570 return false;
6571 }
6572 if (mAction != other.mAction) {
6573 if (mAction != null) {
6574 if (!mAction.equals(other.mAction)) {
6575 return false;
6576 }
6577 } else {
6578 if (!other.mAction.equals(mAction)) {
6579 return false;
6580 }
6581 }
6582 }
6583 if (mData != other.mData) {
6584 if (mData != null) {
6585 if (!mData.equals(other.mData)) {
6586 return false;
6587 }
6588 } else {
6589 if (!other.mData.equals(mData)) {
6590 return false;
6591 }
6592 }
6593 }
6594 if (mType != other.mType) {
6595 if (mType != null) {
6596 if (!mType.equals(other.mType)) {
6597 return false;
6598 }
6599 } else {
6600 if (!other.mType.equals(mType)) {
6601 return false;
6602 }
6603 }
6604 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006605 if (mPackage != other.mPackage) {
6606 if (mPackage != null) {
6607 if (!mPackage.equals(other.mPackage)) {
6608 return false;
6609 }
6610 } else {
6611 if (!other.mPackage.equals(mPackage)) {
6612 return false;
6613 }
6614 }
6615 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006616 if (mComponent != other.mComponent) {
6617 if (mComponent != null) {
6618 if (!mComponent.equals(other.mComponent)) {
6619 return false;
6620 }
6621 } else {
6622 if (!other.mComponent.equals(mComponent)) {
6623 return false;
6624 }
6625 }
6626 }
6627 if (mCategories != other.mCategories) {
6628 if (mCategories != null) {
6629 if (!mCategories.equals(other.mCategories)) {
6630 return false;
6631 }
6632 } else {
6633 if (!other.mCategories.equals(mCategories)) {
6634 return false;
6635 }
6636 }
6637 }
6638
6639 return true;
6640 }
6641
6642 /**
6643 * Generate hash code that matches semantics of filterEquals().
6644 *
6645 * @return Returns the hash value of the action, data, type, class, and
6646 * categories.
6647 *
6648 * @see #filterEquals
6649 */
6650 public int filterHashCode() {
6651 int code = 0;
6652 if (mAction != null) {
6653 code += mAction.hashCode();
6654 }
6655 if (mData != null) {
6656 code += mData.hashCode();
6657 }
6658 if (mType != null) {
6659 code += mType.hashCode();
6660 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006661 if (mPackage != null) {
6662 code += mPackage.hashCode();
6663 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006664 if (mComponent != null) {
6665 code += mComponent.hashCode();
6666 }
6667 if (mCategories != null) {
6668 code += mCategories.hashCode();
6669 }
6670 return code;
6671 }
6672
6673 @Override
6674 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006675 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006676
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006677 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006678 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006679 b.append(" }");
6680
6681 return b.toString();
6682 }
6683
6684 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006685 public String toInsecureString() {
6686 StringBuilder b = new StringBuilder(128);
6687
6688 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006689 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006690 b.append(" }");
6691
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006692 return b.toString();
6693 }
Romain Guy4969af72009-06-17 10:53:19 -07006694
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006695 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006696 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006697 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006698
6699 b.append("Intent { ");
6700 toShortString(b, false, true, true, true);
6701 b.append(" }");
6702
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006703 return b.toString();
6704 }
6705
6706 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006707 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6708 StringBuilder b = new StringBuilder(128);
6709 toShortString(b, secure, comp, extras, clip);
6710 return b.toString();
6711 }
6712
6713 /** @hide */
6714 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6715 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006716 boolean first = true;
6717 if (mAction != null) {
6718 b.append("act=").append(mAction);
6719 first = false;
6720 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006721 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006722 if (!first) {
6723 b.append(' ');
6724 }
6725 first = false;
6726 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006727 for (int i=0; i<mCategories.size(); i++) {
6728 if (i > 0) b.append(',');
6729 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006730 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006731 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006732 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006733 if (mData != null) {
6734 if (!first) {
6735 b.append(' ');
6736 }
6737 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006738 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006739 if (secure) {
6740 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006741 } else {
6742 b.append(mData);
6743 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006744 }
6745 if (mType != null) {
6746 if (!first) {
6747 b.append(' ');
6748 }
6749 first = false;
6750 b.append("typ=").append(mType);
6751 }
6752 if (mFlags != 0) {
6753 if (!first) {
6754 b.append(' ');
6755 }
6756 first = false;
6757 b.append("flg=0x").append(Integer.toHexString(mFlags));
6758 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006759 if (mPackage != null) {
6760 if (!first) {
6761 b.append(' ');
6762 }
6763 first = false;
6764 b.append("pkg=").append(mPackage);
6765 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006766 if (comp && mComponent != null) {
6767 if (!first) {
6768 b.append(' ');
6769 }
6770 first = false;
6771 b.append("cmp=").append(mComponent.flattenToShortString());
6772 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006773 if (mSourceBounds != null) {
6774 if (!first) {
6775 b.append(' ');
6776 }
6777 first = false;
6778 b.append("bnds=").append(mSourceBounds.toShortString());
6779 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006780 if (mClipData != null) {
6781 if (!first) {
6782 b.append(' ');
6783 }
6784 first = false;
6785 if (clip) {
6786 b.append("clip={");
6787 mClipData.toShortString(b);
6788 b.append('}');
6789 } else {
6790 b.append("(has clip)");
6791 }
6792 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006793 if (extras && mExtras != null) {
6794 if (!first) {
6795 b.append(' ');
6796 }
6797 first = false;
6798 b.append("(has extras)");
6799 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006800 if (mSelector != null) {
6801 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006802 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006803 b.append("}");
6804 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006805 }
6806
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006807 /**
6808 * Call {@link #toUri} with 0 flags.
6809 * @deprecated Use {@link #toUri} instead.
6810 */
6811 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006812 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006813 return toUri(0);
6814 }
6815
6816 /**
6817 * Convert this Intent into a String holding a URI representation of it.
6818 * The returned URI string has been properly URI encoded, so it can be
6819 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6820 * Intent's data as the base URI, with an additional fragment describing
6821 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006822 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006823 * <p>You can convert the returned string back to an Intent with
6824 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006825 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006826 * @param flags Additional operating flags. Either 0 or
6827 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006828 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006829 * @return Returns a URI encoding URI string describing the entire contents
6830 * of the Intent.
6831 */
6832 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006833 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006834 String scheme = null;
6835 if (mData != null) {
6836 String data = mData.toString();
6837 if ((flags&URI_INTENT_SCHEME) != 0) {
6838 final int N = data.length();
6839 for (int i=0; i<N; i++) {
6840 char c = data.charAt(i);
6841 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6842 || c == '.' || c == '-') {
6843 continue;
6844 }
6845 if (c == ':' && i > 0) {
6846 // Valid scheme.
6847 scheme = data.substring(0, i);
6848 uri.append("intent:");
6849 data = data.substring(i+1);
6850 break;
6851 }
Tom Taylord4a47292009-12-21 13:59:18 -08006852
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006853 // No scheme.
6854 break;
6855 }
6856 }
6857 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006858
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006859 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6860 uri.append("intent:");
6861 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006862
6863 uri.append("#Intent;");
6864
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006865 toUriInner(uri, scheme, flags);
6866 if (mSelector != null) {
6867 uri.append("SEL;");
6868 // Note that for now we are not going to try to handle the
6869 // data part; not clear how to represent this as a URI, and
6870 // not much utility in it.
6871 mSelector.toUriInner(uri, null, flags);
6872 }
6873
6874 uri.append("end");
6875
6876 return uri.toString();
6877 }
6878
6879 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006880 if (scheme != null) {
6881 uri.append("scheme=").append(scheme).append(';');
6882 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006883 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006884 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006885 }
6886 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006887 for (int i=0; i<mCategories.size(); i++) {
6888 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006889 }
6890 }
6891 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006892 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006893 }
6894 if (mFlags != 0) {
6895 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6896 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006897 if (mPackage != null) {
6898 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6899 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006900 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006901 uri.append("component=").append(Uri.encode(
6902 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006903 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006904 if (mSourceBounds != null) {
6905 uri.append("sourceBounds=")
6906 .append(Uri.encode(mSourceBounds.flattenToString()))
6907 .append(';');
6908 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006909 if (mExtras != null) {
6910 for (String key : mExtras.keySet()) {
6911 final Object value = mExtras.get(key);
6912 char entryType =
6913 value instanceof String ? 'S' :
6914 value instanceof Boolean ? 'B' :
6915 value instanceof Byte ? 'b' :
6916 value instanceof Character ? 'c' :
6917 value instanceof Double ? 'd' :
6918 value instanceof Float ? 'f' :
6919 value instanceof Integer ? 'i' :
6920 value instanceof Long ? 'l' :
6921 value instanceof Short ? 's' :
6922 '\0';
6923
6924 if (entryType != '\0') {
6925 uri.append(entryType);
6926 uri.append('.');
6927 uri.append(Uri.encode(key));
6928 uri.append('=');
6929 uri.append(Uri.encode(value.toString()));
6930 uri.append(';');
6931 }
6932 }
6933 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006934 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006935
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006936 public int describeContents() {
6937 return (mExtras != null) ? mExtras.describeContents() : 0;
6938 }
6939
6940 public void writeToParcel(Parcel out, int flags) {
6941 out.writeString(mAction);
6942 Uri.writeToParcel(out, mData);
6943 out.writeString(mType);
6944 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006945 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006946 ComponentName.writeToParcel(mComponent, out);
6947
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006948 if (mSourceBounds != null) {
6949 out.writeInt(1);
6950 mSourceBounds.writeToParcel(out, flags);
6951 } else {
6952 out.writeInt(0);
6953 }
6954
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006955 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006956 final int N = mCategories.size();
6957 out.writeInt(N);
6958 for (int i=0; i<N; i++) {
6959 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006960 }
6961 } else {
6962 out.writeInt(0);
6963 }
6964
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006965 if (mSelector != null) {
6966 out.writeInt(1);
6967 mSelector.writeToParcel(out, flags);
6968 } else {
6969 out.writeInt(0);
6970 }
6971
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006972 if (mClipData != null) {
6973 out.writeInt(1);
6974 mClipData.writeToParcel(out, flags);
6975 } else {
6976 out.writeInt(0);
6977 }
6978
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006979 out.writeBundle(mExtras);
6980 }
6981
6982 public static final Parcelable.Creator<Intent> CREATOR
6983 = new Parcelable.Creator<Intent>() {
6984 public Intent createFromParcel(Parcel in) {
6985 return new Intent(in);
6986 }
6987 public Intent[] newArray(int size) {
6988 return new Intent[size];
6989 }
6990 };
6991
Dianne Hackborneb034652009-09-07 00:49:58 -07006992 /** @hide */
6993 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006994 readFromParcel(in);
6995 }
6996
6997 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006998 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006999 mData = Uri.CREATOR.createFromParcel(in);
7000 mType = in.readString();
7001 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007002 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007003 mComponent = ComponentName.readFromParcel(in);
7004
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007005 if (in.readInt() != 0) {
7006 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7007 }
7008
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007009 int N = in.readInt();
7010 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007011 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007012 int i;
7013 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007014 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007015 }
7016 } else {
7017 mCategories = null;
7018 }
7019
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007020 if (in.readInt() != 0) {
7021 mSelector = new Intent(in);
7022 }
7023
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007024 if (in.readInt() != 0) {
7025 mClipData = new ClipData(in);
7026 }
7027
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007028 mExtras = in.readBundle();
7029 }
7030
7031 /**
7032 * Parses the "intent" element (and its children) from XML and instantiates
7033 * an Intent object. The given XML parser should be located at the tag
7034 * where parsing should start (often named "intent"), from which the
7035 * basic action, data, type, and package and class name will be
7036 * retrieved. The function will then parse in to any child elements,
7037 * looking for <category android:name="xxx"> tags to add categories and
7038 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7039 * to the intent.
7040 *
7041 * @param resources The Resources to use when inflating resources.
7042 * @param parser The XML parser pointing at an "intent" tag.
7043 * @param attrs The AttributeSet interface for retrieving extended
7044 * attribute data at the current <var>parser</var> location.
7045 * @return An Intent object matching the XML data.
7046 * @throws XmlPullParserException If there was an XML parsing error.
7047 * @throws IOException If there was an I/O error.
7048 */
7049 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7050 throws XmlPullParserException, IOException {
7051 Intent intent = new Intent();
7052
7053 TypedArray sa = resources.obtainAttributes(attrs,
7054 com.android.internal.R.styleable.Intent);
7055
7056 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7057
7058 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7059 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7060 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7061
7062 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7063 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7064 if (packageName != null && className != null) {
7065 intent.setComponent(new ComponentName(packageName, className));
7066 }
7067
7068 sa.recycle();
7069
7070 int outerDepth = parser.getDepth();
7071 int type;
7072 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7073 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7074 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7075 continue;
7076 }
7077
7078 String nodeName = parser.getName();
7079 if (nodeName.equals("category")) {
7080 sa = resources.obtainAttributes(attrs,
7081 com.android.internal.R.styleable.IntentCategory);
7082 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7083 sa.recycle();
7084
7085 if (cat != null) {
7086 intent.addCategory(cat);
7087 }
7088 XmlUtils.skipCurrentTag(parser);
7089
7090 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007091 if (intent.mExtras == null) {
7092 intent.mExtras = new Bundle();
7093 }
7094 resources.parseBundleExtra("extra", attrs, intent.mExtras);
7095 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007096
7097 } else {
7098 XmlUtils.skipCurrentTag(parser);
7099 }
7100 }
7101
7102 return intent;
7103 }
Nick Pellyccae4122012-01-09 14:12:58 -08007104
7105 /**
7106 * Normalize a MIME data type.
7107 *
7108 * <p>A normalized MIME type has white-space trimmed,
7109 * content-type parameters removed, and is lower-case.
7110 * This aligns the type with Android best practices for
7111 * intent filtering.
7112 *
7113 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7114 * "text/x-vCard" becomes "text/x-vcard".
7115 *
7116 * <p>All MIME types received from outside Android (such as user input,
7117 * or external sources like Bluetooth, NFC, or the Internet) should
7118 * be normalized before they are used to create an Intent.
7119 *
7120 * @param type MIME data type to normalize
7121 * @return normalized MIME data type, or null if the input was null
7122 * @see {@link #setType}
7123 * @see {@link #setTypeAndNormalize}
7124 */
7125 public static String normalizeMimeType(String type) {
7126 if (type == null) {
7127 return null;
7128 }
7129
Elliott Hughescb64d432013-08-02 10:00:44 -07007130 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007131
7132 final int semicolonIndex = type.indexOf(';');
7133 if (semicolonIndex != -1) {
7134 type = type.substring(0, semicolonIndex);
7135 }
7136 return type;
7137 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007138
7139 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007140 * Prepare this {@link Intent} to leave an app process.
7141 *
7142 * @hide
7143 */
7144 public void prepareToLeaveProcess() {
7145 setAllowFds(false);
7146
7147 if (mSelector != null) {
7148 mSelector.prepareToLeaveProcess();
7149 }
7150 if (mClipData != null) {
7151 mClipData.prepareToLeaveProcess();
7152 }
7153
7154 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7155 // There are several ACTION_MEDIA_* broadcasts that send file://
7156 // Uris, so only check common actions.
7157 if (ACTION_VIEW.equals(mAction) ||
7158 ACTION_EDIT.equals(mAction) ||
7159 ACTION_ATTACH_DATA.equals(mAction)) {
7160 mData.checkFileUriExposed("Intent.getData()");
7161 }
7162 }
7163 }
7164
7165 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007166 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007167 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7168 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007169 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007170 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007171 * @hide
7172 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007173 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007174 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007175 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007176
7177 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007178 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007179
7180 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007181 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007182 try {
7183 // Inspect target intent to see if we need to migrate
7184 final Intent target = getParcelableExtra(EXTRA_INTENT);
7185 if (target != null && target.migrateExtraStreamToClipData()) {
7186 // Since we migrated in child, we need to promote ClipData
7187 // and flags to ourselves to grant.
7188 setClipData(target.getClipData());
7189 addFlags(target.getFlags()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07007190 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION
7191 | FLAG_PERSIST_GRANT_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007192 return true;
7193 } else {
7194 return false;
7195 }
7196 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007197 }
7198
7199 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007200 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007201 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7202 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7203 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7204 if (stream != null || text != null || htmlText != null) {
7205 final ClipData clipData = new ClipData(
7206 null, new String[] { getType() },
7207 new ClipData.Item(text, htmlText, null, stream));
7208 setClipData(clipData);
7209 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007210 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007211 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007212 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007213 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007214
7215 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007216 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007217 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7218 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7219 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7220 int num = -1;
7221 if (streams != null) {
7222 num = streams.size();
7223 }
7224 if (texts != null) {
7225 if (num >= 0 && num != texts.size()) {
7226 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007227 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007228 }
7229 num = texts.size();
7230 }
7231 if (htmlTexts != null) {
7232 if (num >= 0 && num != htmlTexts.size()) {
7233 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007234 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007235 }
7236 num = htmlTexts.size();
7237 }
7238 if (num > 0) {
7239 final ClipData clipData = new ClipData(
7240 null, new String[] { getType() },
7241 makeClipItem(streams, texts, htmlTexts, 0));
7242
7243 for (int i = 1; i < num; i++) {
7244 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7245 }
7246
7247 setClipData(clipData);
7248 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007249 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007250 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007251 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007252 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007253 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007254
7255 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007256 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007257
7258 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7259 ArrayList<String> htmlTexts, int which) {
7260 Uri uri = streams != null ? streams.get(which) : null;
7261 CharSequence text = texts != null ? texts.get(which) : null;
7262 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7263 return new ClipData.Item(text, htmlText, null, uri);
7264 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007265}