blob: ff350b92ab8a8a20325f8c1be551286eb40395f9 [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;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070038import android.util.AttributeSet;
39import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080040
41import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070042
43import java.io.IOException;
44import java.io.Serializable;
45import java.net.URISyntaxException;
46import java.util.ArrayList;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070047import java.util.Iterator;
Dianne Hackborn221ea892013-08-04 16:50:16 -070048import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080049import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070050import java.util.Set;
51
52/**
53 * An intent is an abstract description of an operation to be performed. It
54 * can be used with {@link Context#startActivity(Intent) startActivity} to
55 * launch an {@link android.app.Activity},
56 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
57 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
58 * and {@link android.content.Context#startService} or
59 * {@link android.content.Context#bindService} to communicate with a
60 * background {@link android.app.Service}.
61 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070062 * <p>An Intent provides a facility for performing late runtime binding between the code in
63 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070064 * can be thought of as the glue between activities. It is basically a passive data structure
65 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070066 *
67 * <div class="special reference">
68 * <h3>Developer Guides</h3>
69 * <p>For information about how to create and resolve intents, read the
70 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
71 * developer guide.</p>
72 * </div>
73 *
74 * <a name="IntentStructure"></a>
75 * <h3>Intent Structure</h3>
76 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070077 *
78 * <ul>
79 * <li> <p><b>action</b> -- The general action to be performed, such as
80 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
81 * etc.</p>
82 * </li>
83 * <li> <p><b>data</b> -- The data to operate on, such as a person record
84 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
85 * </li>
86 * </ul>
87 *
88 *
89 * <p>Some examples of action/data pairs are:</p>
90 *
91 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * information about the person whose identifier is "1".</p>
94 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070095 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070096 * the phone dialer with the person filled in.</p>
97 * </li>
98 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
99 * the phone dialer with the given number filled in. Note how the
100 * VIEW action does what what is considered the most reasonable thing for
101 * a particular URI.</p>
102 * </li>
103 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
104 * the phone dialer with the given number filled in.</p>
105 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700106 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700107 * information about the person whose identifier is "1".</p>
108 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700109 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700110 * a list of people, which the user can browse through. This example is a
111 * typical top-level entry into the Contacts application, showing you the
112 * list of people. Selecting a particular person to view would result in a
113 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
114 * being used to start an activity to display that person.</p>
115 * </li>
116 * </ul>
117 *
118 * <p>In addition to these primary attributes, there are a number of secondary
119 * attributes that you can also include with an intent:</p>
120 *
121 * <ul>
122 * <li> <p><b>category</b> -- Gives additional information about the action
123 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
124 * appear in the Launcher as a top-level application, while
125 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
126 * of alternative actions the user can perform on a piece of data.</p>
127 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
128 * intent data. Normally the type is inferred from the data itself.
129 * By setting this attribute, you disable that evaluation and force
130 * an explicit type.</p>
131 * <li> <p><b>component</b> -- Specifies an explicit name of a component
132 * class to use for the intent. Normally this is determined by looking
133 * at the other information in the intent (the action, data/type, and
134 * categories) and matching that with a component that can handle it.
135 * If this attribute is set then none of the evaluation is performed,
136 * and this component is used exactly as is. By specifying this attribute,
137 * all of the other Intent attributes become optional.</p>
138 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
139 * This can be used to provide extended information to the component.
140 * For example, if we have a action to send an e-mail message, we could
141 * also include extra pieces of data here to supply a subject, body,
142 * etc.</p>
143 * </ul>
144 *
145 * <p>Here are some examples of other operations you can specify as intents
146 * using these additional parameters:</p>
147 *
148 * <ul>
149 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
150 * Launch the home screen.</p>
151 * </li>
152 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
153 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
154 * vnd.android.cursor.item/phone}</i></b>
155 * -- Display the list of people's phone numbers, allowing the user to
156 * browse through them and pick one and return it to the parent activity.</p>
157 * </li>
158 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
159 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
160 * -- Display all pickers for data that can be opened with
161 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
162 * allowing the user to pick one of them and then some data inside of it
163 * and returning the resulting URI to the caller. This can be used,
164 * for example, in an e-mail application to allow the user to pick some
165 * data to include as an attachment.</p>
166 * </li>
167 * </ul>
168 *
169 * <p>There are a variety of standard Intent action and category constants
170 * defined in the Intent class, but applications can also define their own.
171 * These strings use java style scoping, to ensure they are unique -- for
172 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700173 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700174 *
175 * <p>Put together, the set of actions, data types, categories, and extra data
176 * defines a language for the system allowing for the expression of phrases
177 * such as "call john smith's cell". As applications are added to the system,
178 * they can extend this language by adding new actions, types, and categories, or
179 * they can modify the behavior of existing phrases by supplying their own
180 * activities that handle them.</p>
181 *
182 * <a name="IntentResolution"></a>
183 * <h3>Intent Resolution</h3>
184 *
185 * <p>There are two primary forms of intents you will use.
186 *
187 * <ul>
188 * <li> <p><b>Explicit Intents</b> have specified a component (via
189 * {@link #setComponent} or {@link #setClass}), which provides the exact
190 * class to be run. Often these will not include any other information,
191 * simply being a way for an application to launch various internal
192 * activities it has as the user interacts with the application.
193 *
194 * <li> <p><b>Implicit Intents</b> have not specified a component;
195 * instead, they must include enough information for the system to
196 * determine which of the available components is best to run for that
197 * intent.
198 * </ul>
199 *
200 * <p>When using implicit intents, given such an arbitrary intent we need to
201 * know what to do with it. This is handled by the process of <em>Intent
202 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
203 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
204 * more activities/receivers) that can handle it.</p>
205 *
206 * <p>The intent resolution mechanism basically revolves around matching an
207 * Intent against all of the &lt;intent-filter&gt; descriptions in the
208 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
209 * objects explicitly registered with {@link Context#registerReceiver}.) More
210 * details on this can be found in the documentation on the {@link
211 * IntentFilter} class.</p>
212 *
213 * <p>There are three pieces of information in the Intent that are used for
214 * resolution: the action, type, and category. Using this information, a query
215 * is done on the {@link PackageManager} for a component that can handle the
216 * intent. The appropriate component is determined based on the intent
217 * information supplied in the <code>AndroidManifest.xml</code> file as
218 * follows:</p>
219 *
220 * <ul>
221 * <li> <p>The <b>action</b>, if given, must be listed by the component as
222 * one it handles.</p>
223 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
224 * already supplied in the Intent. Like the action, if a type is
225 * included in the intent (either explicitly or implicitly in its
226 * data), then this must be listed by the component as one it handles.</p>
227 * <li> For data that is not a <code>content:</code> URI and where no explicit
228 * type is included in the Intent, instead the <b>scheme</b> of the
229 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
230 * considered. Again like the action, if we are matching a scheme it
231 * must be listed by the component as one it can handle.
232 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
233 * by the activity as categories it handles. That is, if you include
234 * the categories {@link #CATEGORY_LAUNCHER} and
235 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
236 * with an intent that lists <em>both</em> of those categories.
237 * Activities will very often need to support the
238 * {@link #CATEGORY_DEFAULT} so that they can be found by
239 * {@link Context#startActivity Context.startActivity()}.</p>
240 * </ul>
241 *
242 * <p>For example, consider the Note Pad sample application that
243 * allows user to browse through a list of notes data and view details about
244 * individual items. Text in italics indicate places were you would replace a
245 * name with one specific to your own package.</p>
246 *
247 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
248 * package="<i>com.android.notepad</i>"&gt;
249 * &lt;application android:icon="@drawable/app_notes"
250 * android:label="@string/app_name"&gt;
251 *
252 * &lt;provider class=".NotePadProvider"
253 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
254 *
255 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
256 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700257 * &lt;action android:name="android.intent.action.MAIN" /&gt;
258 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700259 * &lt;/intent-filter&gt;
260 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700261 * &lt;action android:name="android.intent.action.VIEW" /&gt;
262 * &lt;action android:name="android.intent.action.EDIT" /&gt;
263 * &lt;action android:name="android.intent.action.PICK" /&gt;
264 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
265 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700266 * &lt;/intent-filter&gt;
267 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700268 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
269 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
270 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700271 * &lt;/intent-filter&gt;
272 * &lt;/activity&gt;
273 *
274 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
275 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700276 * &lt;action android:name="android.intent.action.VIEW" /&gt;
277 * &lt;action android:name="android.intent.action.EDIT" /&gt;
278 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
279 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700280 * &lt;/intent-filter&gt;
281 *
282 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700283 * &lt;action android:name="android.intent.action.INSERT" /&gt;
284 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
285 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700286 * &lt;/intent-filter&gt;
287 *
288 * &lt;/activity&gt;
289 *
290 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
291 * android:theme="@android:style/Theme.Dialog"&gt;
292 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700293 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
294 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
295 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
296 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
297 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700298 * &lt;/intent-filter&gt;
299 * &lt;/activity&gt;
300 *
301 * &lt;/application&gt;
302 * &lt;/manifest&gt;</pre>
303 *
304 * <p>The first activity,
305 * <code>com.android.notepad.NotesList</code>, serves as our main
306 * entry into the app. It can do three things as described by its three intent
307 * templates:
308 * <ol>
309 * <li><pre>
310 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700311 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
312 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700313 * &lt;/intent-filter&gt;</pre>
314 * <p>This provides a top-level entry into the NotePad application: the standard
315 * MAIN action is a main entry point (not requiring any other information in
316 * the Intent), and the LAUNCHER category says that this entry point should be
317 * listed in the application launcher.</p>
318 * <li><pre>
319 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700320 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
321 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
322 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
323 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
324 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700325 * &lt;/intent-filter&gt;</pre>
326 * <p>This declares the things that the activity can do on a directory of
327 * notes. The type being supported is given with the &lt;type&gt; tag, where
328 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
329 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
330 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
331 * The activity allows the user to view or edit the directory of data (via
332 * the VIEW and EDIT actions), or to pick a particular note and return it
333 * to the caller (via the PICK action). Note also the DEFAULT category
334 * supplied here: this is <em>required</em> for the
335 * {@link Context#startActivity Context.startActivity} method to resolve your
336 * activity when its component name is not explicitly specified.</p>
337 * <li><pre>
338 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700339 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
340 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
341 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700342 * &lt;/intent-filter&gt;</pre>
343 * <p>This filter describes the ability return to the caller a note selected by
344 * the user without needing to know where it came from. The data type
345 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
346 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
347 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
348 * The GET_CONTENT action is similar to the PICK action, where the activity
349 * will return to its caller a piece of data selected by the user. Here,
350 * however, the caller specifies the type of data they desire instead of
351 * the type of data the user will be picking from.</p>
352 * </ol>
353 *
354 * <p>Given these capabilities, the following intents will resolve to the
355 * NotesList activity:</p>
356 *
357 * <ul>
358 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
359 * activities that can be used as top-level entry points into an
360 * application.</p>
361 * <li> <p><b>{ action=android.app.action.MAIN,
362 * category=android.app.category.LAUNCHER }</b> is the actual intent
363 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700364 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700365 * data=content://com.google.provider.NotePad/notes }</b>
366 * displays a list of all the notes under
367 * "content://com.google.provider.NotePad/notes", which
368 * the user can browse through and see the details on.</p>
369 * <li> <p><b>{ action=android.app.action.PICK
370 * data=content://com.google.provider.NotePad/notes }</b>
371 * provides a list of the notes under
372 * "content://com.google.provider.NotePad/notes", from which
373 * the user can pick a note whose data URL is returned back to the caller.</p>
374 * <li> <p><b>{ action=android.app.action.GET_CONTENT
375 * type=vnd.android.cursor.item/vnd.google.note }</b>
376 * is similar to the pick action, but allows the caller to specify the
377 * kind of data they want back so that the system can find the appropriate
378 * activity to pick something of that data type.</p>
379 * </ul>
380 *
381 * <p>The second activity,
382 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
383 * note entry and allows them to edit it. It can do two things as described
384 * by its two intent templates:
385 * <ol>
386 * <li><pre>
387 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700388 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
389 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
390 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
391 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700392 * &lt;/intent-filter&gt;</pre>
393 * <p>The first, primary, purpose of this activity is to let the user interact
394 * with a single note, as decribed by the MIME type
395 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
396 * either VIEW a note or allow the user to EDIT it. Again we support the
397 * DEFAULT category to allow the activity to be launched without explicitly
398 * specifying its component.</p>
399 * <li><pre>
400 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700401 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
402 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
403 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700404 * &lt;/intent-filter&gt;</pre>
405 * <p>The secondary use of this activity is to insert a new note entry into
406 * an existing directory of notes. This is used when the user creates a new
407 * note: the INSERT action is executed on the directory of notes, causing
408 * this activity to run and have the user create the new note data which
409 * it then adds to the content provider.</p>
410 * </ol>
411 *
412 * <p>Given these capabilities, the following intents will resolve to the
413 * NoteEditor activity:</p>
414 *
415 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700416 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700417 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
418 * shows the user the content of note <var>{ID}</var>.</p>
419 * <li> <p><b>{ action=android.app.action.EDIT
420 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
421 * allows the user to edit the content of note <var>{ID}</var>.</p>
422 * <li> <p><b>{ action=android.app.action.INSERT
423 * data=content://com.google.provider.NotePad/notes }</b>
424 * creates a new, empty note in the notes list at
425 * "content://com.google.provider.NotePad/notes"
426 * and allows the user to edit it. If they keep their changes, the URI
427 * of the newly created note is returned to the caller.</p>
428 * </ul>
429 *
430 * <p>The last activity,
431 * <code>com.android.notepad.TitleEditor</code>, allows the user to
432 * edit the title of a note. This could be implemented as a class that the
433 * application directly invokes (by explicitly setting its component in
434 * the Intent), but here we show a way you can publish alternative
435 * operations on existing data:</p>
436 *
437 * <pre>
438 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700439 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
440 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
441 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
442 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
443 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700444 * &lt;/intent-filter&gt;</pre>
445 *
446 * <p>In the single intent template here, we
447 * have created our own private action called
448 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
449 * edit the title of a note. It must be invoked on a specific note
450 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
451 * view and edit actions, but here displays and edits the title contained
452 * in the note data.
453 *
454 * <p>In addition to supporting the default category as usual, our title editor
455 * also supports two other standard categories: ALTERNATIVE and
456 * SELECTED_ALTERNATIVE. Implementing
457 * these categories allows others to find the special action it provides
458 * without directly knowing about it, through the
459 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
460 * more often to build dynamic menu items with
461 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
462 * template here was also supply an explicit name for the template
463 * (via <code>android:label="@string/resolve_title"</code>) to better control
464 * what the user sees when presented with this activity as an alternative
465 * action to the data they are viewing.
466 *
467 * <p>Given these capabilities, the following intent will resolve to the
468 * TitleEditor activity:</p>
469 *
470 * <ul>
471 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
472 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
473 * displays and allows the user to edit the title associated
474 * with note <var>{ID}</var>.</p>
475 * </ul>
476 *
477 * <h3>Standard Activity Actions</h3>
478 *
479 * <p>These are the current standard actions that Intent defines for launching
480 * activities (usually through {@link Context#startActivity}. The most
481 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
482 * {@link #ACTION_EDIT}.
483 *
484 * <ul>
485 * <li> {@link #ACTION_MAIN}
486 * <li> {@link #ACTION_VIEW}
487 * <li> {@link #ACTION_ATTACH_DATA}
488 * <li> {@link #ACTION_EDIT}
489 * <li> {@link #ACTION_PICK}
490 * <li> {@link #ACTION_CHOOSER}
491 * <li> {@link #ACTION_GET_CONTENT}
492 * <li> {@link #ACTION_DIAL}
493 * <li> {@link #ACTION_CALL}
494 * <li> {@link #ACTION_SEND}
495 * <li> {@link #ACTION_SENDTO}
496 * <li> {@link #ACTION_ANSWER}
497 * <li> {@link #ACTION_INSERT}
498 * <li> {@link #ACTION_DELETE}
499 * <li> {@link #ACTION_RUN}
500 * <li> {@link #ACTION_SYNC}
501 * <li> {@link #ACTION_PICK_ACTIVITY}
502 * <li> {@link #ACTION_SEARCH}
503 * <li> {@link #ACTION_WEB_SEARCH}
504 * <li> {@link #ACTION_FACTORY_TEST}
505 * </ul>
506 *
507 * <h3>Standard Broadcast Actions</h3>
508 *
509 * <p>These are the current standard actions that Intent defines for receiving
510 * broadcasts (usually through {@link Context#registerReceiver} or a
511 * &lt;receiver&gt; tag in a manifest).
512 *
513 * <ul>
514 * <li> {@link #ACTION_TIME_TICK}
515 * <li> {@link #ACTION_TIME_CHANGED}
516 * <li> {@link #ACTION_TIMEZONE_CHANGED}
517 * <li> {@link #ACTION_BOOT_COMPLETED}
518 * <li> {@link #ACTION_PACKAGE_ADDED}
519 * <li> {@link #ACTION_PACKAGE_CHANGED}
520 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800521 * <li> {@link #ACTION_PACKAGE_RESTARTED}
522 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700523 * <li> {@link #ACTION_UID_REMOVED}
524 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700525 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700526 * <li> {@link #ACTION_POWER_DISCONNECTED}
527 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700528 * </ul>
529 *
530 * <h3>Standard Categories</h3>
531 *
532 * <p>These are the current standard categories that can be used to further
533 * clarify an Intent via {@link #addCategory}.
534 *
535 * <ul>
536 * <li> {@link #CATEGORY_DEFAULT}
537 * <li> {@link #CATEGORY_BROWSABLE}
538 * <li> {@link #CATEGORY_TAB}
539 * <li> {@link #CATEGORY_ALTERNATIVE}
540 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
541 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800542 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * <li> {@link #CATEGORY_HOME}
544 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700545 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400546 * <li> {@link #CATEGORY_CAR_DOCK}
547 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500548 * <li> {@link #CATEGORY_LE_DESK_DOCK}
549 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200550 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700551 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700552 * </ul>
553 *
554 * <h3>Standard Extra Data</h3>
555 *
556 * <p>These are the current standard fields that can be used as extra data via
557 * {@link #putExtra}.
558 *
559 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800560 * <li> {@link #EXTRA_ALARM_COUNT}
561 * <li> {@link #EXTRA_BCC}
562 * <li> {@link #EXTRA_CC}
563 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
564 * <li> {@link #EXTRA_DATA_REMOVED}
565 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500566 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
567 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800568 * <li> {@link #EXTRA_DOCK_STATE_CAR}
569 * <li> {@link #EXTRA_DOCK_STATE_DESK}
570 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
571 * <li> {@link #EXTRA_DONT_KILL_APP}
572 * <li> {@link #EXTRA_EMAIL}
573 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700574 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800575 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700576 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800577 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700578 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800579 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
580 * <li> {@link #EXTRA_REPLACING}
581 * <li> {@link #EXTRA_SHORTCUT_ICON}
582 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
583 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700584 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800585 * <li> {@link #EXTRA_SHORTCUT_NAME}
586 * <li> {@link #EXTRA_SUBJECT}
587 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700588 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800589 * <li> {@link #EXTRA_TITLE}
590 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700591 * </ul>
592 *
593 * <h3>Flags</h3>
594 *
595 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800596 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
597 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700598 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800599public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700600 // ---------------------------------------------------------------------
601 // ---------------------------------------------------------------------
602 // Standard intent activity actions (see action variable).
603
604 /**
605 * Activity Action: Start as a main entry point, does not expect to
606 * receive data.
607 * <p>Input: nothing
608 * <p>Output: nothing
609 */
610 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
611 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800612
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700613 /**
614 * Activity Action: Display the data to the user. This is the most common
615 * action performed on data -- it is the generic action you can use on
616 * a piece of data to get the most reasonable thing to occur. For example,
617 * when used on a contacts entry it will view the entry; when used on a
618 * mailto: URI it will bring up a compose window filled with the information
619 * supplied by the URI; when used with a tel: URI it will invoke the
620 * dialer.
621 * <p>Input: {@link #getData} is URI from which to retrieve data.
622 * <p>Output: nothing.
623 */
624 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
625 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800626
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700627 /**
628 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
629 * performed on a piece of data.
630 */
631 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800632
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700633 /**
634 * Used to indicate that some piece of data should be attached to some other
635 * place. For example, image data could be attached to a contact. It is up
636 * to the recipient to decide where the data should be attached; the intent
637 * does not specify the ultimate destination.
638 * <p>Input: {@link #getData} is URI of data to be attached.
639 * <p>Output: nothing.
640 */
641 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
642 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800643
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700644 /**
645 * Activity Action: Provide explicit editable access to the given data.
646 * <p>Input: {@link #getData} is URI of data to be edited.
647 * <p>Output: nothing.
648 */
649 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
650 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800651
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700652 /**
653 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
654 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
655 * The extras can contain type specific data to pass through to the editing/creating
656 * activity.
657 * <p>Output: The URI of the item that was picked. This must be a content:
658 * URI so that any receiver can access it.
659 */
660 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
661 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800662
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700663 /**
664 * Activity Action: Pick an item from the data, returning what was selected.
665 * <p>Input: {@link #getData} is URI containing a directory of data
666 * (vnd.android.cursor.dir/*) from which to pick an item.
667 * <p>Output: The URI of the item that was picked.
668 */
669 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
670 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800671
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700672 /**
673 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800674 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700675 * <p>Output: An Intent representing the shortcut. The intent must contain three
676 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
677 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800678 * (value: ShortcutIconResource).</p>
679 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700680 * @see #EXTRA_SHORTCUT_INTENT
681 * @see #EXTRA_SHORTCUT_NAME
682 * @see #EXTRA_SHORTCUT_ICON
683 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
684 * @see android.content.Intent.ShortcutIconResource
685 */
686 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
687 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
688
689 /**
690 * The name of the extra used to define the Intent of a shortcut.
691 *
692 * @see #ACTION_CREATE_SHORTCUT
693 */
694 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
695 /**
696 * The name of the extra used to define the name of a shortcut.
697 *
698 * @see #ACTION_CREATE_SHORTCUT
699 */
700 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
701 /**
702 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
703 *
704 * @see #ACTION_CREATE_SHORTCUT
705 */
706 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
707 /**
708 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
709 *
710 * @see #ACTION_CREATE_SHORTCUT
711 * @see android.content.Intent.ShortcutIconResource
712 */
713 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
714 "android.intent.extra.shortcut.ICON_RESOURCE";
715
716 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800717 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700718 *
719 * @see Intent#ACTION_CREATE_SHORTCUT
720 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800721 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
722 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700723 */
724 public static class ShortcutIconResource implements Parcelable {
725 /**
726 * The package name of the application containing the icon.
727 */
728 public String packageName;
729
730 /**
731 * The resource name of the icon, including package, name and type.
732 */
733 public String resourceName;
734
735 /**
736 * Creates a new ShortcutIconResource for the specified context and resource
737 * identifier.
738 *
739 * @param context The context of the application.
740 * @param resourceId The resource idenfitier for the icon.
741 * @return A new ShortcutIconResource with the specified's context package name
742 * and icon resource idenfitier.
743 */
744 public static ShortcutIconResource fromContext(Context context, int resourceId) {
745 ShortcutIconResource icon = new ShortcutIconResource();
746 icon.packageName = context.getPackageName();
747 icon.resourceName = context.getResources().getResourceName(resourceId);
748 return icon;
749 }
750
751 /**
752 * Used to read a ShortcutIconResource from a Parcel.
753 */
754 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
755 new Parcelable.Creator<ShortcutIconResource>() {
756
757 public ShortcutIconResource createFromParcel(Parcel source) {
758 ShortcutIconResource icon = new ShortcutIconResource();
759 icon.packageName = source.readString();
760 icon.resourceName = source.readString();
761 return icon;
762 }
763
764 public ShortcutIconResource[] newArray(int size) {
765 return new ShortcutIconResource[size];
766 }
767 };
768
769 /**
770 * No special parcel contents.
771 */
772 public int describeContents() {
773 return 0;
774 }
775
776 public void writeToParcel(Parcel dest, int flags) {
777 dest.writeString(packageName);
778 dest.writeString(resourceName);
779 }
780
781 @Override
782 public String toString() {
783 return resourceName;
784 }
785 }
786
787 /**
788 * Activity Action: Display an activity chooser, allowing the user to pick
789 * what they want to before proceeding. This can be used as an alternative
790 * to the standard activity picker that is displayed by the system when
791 * you try to start an activity with multiple possible matches, with these
792 * differences in behavior:
793 * <ul>
794 * <li>You can specify the title that will appear in the activity chooser.
795 * <li>The user does not have the option to make one of the matching
796 * activities a preferred activity, and all possible activities will
797 * always be shown even if one of them is currently marked as the
798 * preferred activity.
799 * </ul>
800 * <p>
801 * This action should be used when the user will naturally expect to
802 * select an activity in order to proceed. An example if when not to use
803 * it is when the user clicks on a "mailto:" link. They would naturally
804 * expect to go directly to their mail app, so startActivity() should be
805 * called directly: it will
806 * either launch the current preferred app, or put up a dialog allowing the
807 * user to pick an app to use and optionally marking that as preferred.
808 * <p>
809 * In contrast, if the user is selecting a menu item to send a picture
810 * they are viewing to someone else, there are many different things they
811 * may want to do at this point: send it through e-mail, upload it to a
812 * web service, etc. In this case the CHOOSER action should be used, to
813 * always present to the user a list of the things they can do, with a
814 * nice title given by the caller such as "Send this photo with:".
815 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700816 * If you need to grant URI permissions through a chooser, you must specify
817 * the permissions to be granted on the ACTION_CHOOSER Intent
818 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
819 * {@link #setClipData} to specify the URIs to be granted as well as
820 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
821 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
822 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700823 * As a convenience, an Intent of this form can be created with the
824 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700825 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700826 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700827 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
828 * and can optionally have a {@link #EXTRA_TITLE} field containing the
829 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700830 * <p>
831 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700832 */
833 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
834 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
835
836 /**
837 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
838 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700839 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
840 * target intent, also optionally supplying a title. If the target
841 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
842 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
843 * set in the returned chooser intent, with its ClipData set appropriately:
844 * either a direct reflection of {@link #getClipData()} if that is non-null,
845 * or a new ClipData build from {@link #getData()}.
846 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700847 * @param target The Intent that the user will be selecting an activity
848 * to perform.
849 * @param title Optional title that will be displayed in the chooser.
850 * @return Return a new Intent object that you can hand to
851 * {@link Context#startActivity(Intent) Context.startActivity()} and
852 * related methods.
853 */
854 public static Intent createChooser(Intent target, CharSequence title) {
855 Intent intent = new Intent(ACTION_CHOOSER);
856 intent.putExtra(EXTRA_INTENT, target);
857 if (title != null) {
858 intent.putExtra(EXTRA_TITLE, title);
859 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700860
861 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700862 int permFlags = target.getFlags()
863 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
864 if (permFlags != 0) {
865 ClipData targetClipData = target.getClipData();
866 if (targetClipData == null && target.getData() != null) {
867 ClipData.Item item = new ClipData.Item(target.getData());
868 String[] mimeTypes;
869 if (target.getType() != null) {
870 mimeTypes = new String[] { target.getType() };
871 } else {
872 mimeTypes = new String[] { };
873 }
874 targetClipData = new ClipData(null, mimeTypes, item);
875 }
876 if (targetClipData != null) {
877 intent.setClipData(targetClipData);
878 intent.addFlags(permFlags);
879 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700880 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700881
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700882 return intent;
883 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700884
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700885 /**
886 * Activity Action: Allow the user to select a particular kind of data and
887 * return it. This is different than {@link #ACTION_PICK} in that here we
888 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800889 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700890 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900891 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700892 * etc.
893 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900894 * 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 -0700895 * of data, such as a person contact, you set the MIME type to the kind of
896 * data you want and launch it with {@link Context#startActivity(Intent)}.
897 * The system will then launch the best application to select that kind
898 * of data for you.
899 * <p>
900 * You may also be interested in any of a set of types of content the user
901 * can pick. For example, an e-mail application that wants to allow the
902 * user to add an attachment to an e-mail message can use this action to
903 * bring up a list of all of the types of content the user can attach.
904 * <p>
905 * In this case, you should wrap the GET_CONTENT intent with a chooser
906 * (through {@link #createChooser}), which will give the proper interface
907 * for the user to pick how to send your data and allow you to specify
908 * a prompt indicating what they are doing. You will usually specify a
909 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
910 * broad range of content types the user can select from.
911 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900912 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700913 * only pick from data that can be represented as a stream. This is
914 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
915 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800916 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900917 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800918 * is locally available on the device. For example, if this extra is set
919 * to true then an image picker should not show any pictures that are available
920 * from a remote server but not already on the local device (thus requiring
921 * they be downloaded when opened).
922 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800923 * If the caller can handle multiple returned items (the user performing
924 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
925 * to indicate this.
926 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700927 * Input: {@link #getType} is the desired MIME type to retrieve. Note
928 * that no URI is supplied in the intent, as there are no constraints on
929 * where the returned data originally comes from. You may also include the
930 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800931 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800932 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
933 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700934 * <p>
935 * Output: The URI of the item that was picked. This must be a content:
936 * URI so that any receiver can access it.
937 */
938 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
939 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
940 /**
941 * Activity Action: Dial a number as specified by the data. This shows a
942 * UI with the number being dialed, allowing the user to explicitly
943 * initiate the call.
944 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
945 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
946 * number.
947 * <p>Output: nothing.
948 */
949 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
950 public static final String ACTION_DIAL = "android.intent.action.DIAL";
951 /**
952 * Activity Action: Perform a call to someone specified by the data.
953 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
954 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
955 * number.
956 * <p>Output: nothing.
957 *
958 * <p>Note: there will be restrictions on which applications can initiate a
959 * call; most applications should use the {@link #ACTION_DIAL}.
960 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
961 * numbers. Applications can <strong>dial</strong> emergency numbers using
962 * {@link #ACTION_DIAL}, however.
963 */
964 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
965 public static final String ACTION_CALL = "android.intent.action.CALL";
966 /**
967 * Activity Action: Perform a call to an emergency number specified by the
968 * data.
969 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
970 * tel: URI of an explicit phone number.
971 * <p>Output: nothing.
972 * @hide
973 */
974 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
975 /**
976 * Activity action: Perform a call to any number (emergency or not)
977 * specified by the data.
978 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
979 * tel: URI of an explicit phone number.
980 * <p>Output: nothing.
981 * @hide
982 */
983 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
984 /**
985 * Activity Action: Send a message to someone specified by the data.
986 * <p>Input: {@link #getData} is URI describing the target.
987 * <p>Output: nothing.
988 */
989 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
990 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
991 /**
992 * Activity Action: Deliver some data to someone else. Who the data is
993 * being delivered to is not specified; it is up to the receiver of this
994 * action to ask the user where the data should be sent.
995 * <p>
996 * When launching a SEND intent, you should usually wrap it in a chooser
997 * (through {@link #createChooser}), which will give the proper interface
998 * for the user to pick how to send your data and allow you to specify
999 * a prompt indicating what they are doing.
1000 * <p>
1001 * Input: {@link #getType} is the MIME type of the data being sent.
1002 * get*Extra can have either a {@link #EXTRA_TEXT}
1003 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1004 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1005 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1006 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001007 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1008 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1009 * your text with HTML formatting.
1010 * <p>
1011 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1012 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1013 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1014 * content: URIs and other advanced features of {@link ClipData}. If
1015 * using this approach, you still must supply the same data through the
1016 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1017 * for compatibility with old applications. If you don't set a ClipData,
1018 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001019 * <p>
1020 * Optional standard extras, which may be interpreted by some recipients as
1021 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1022 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1023 * <p>
1024 * Output: nothing.
1025 */
1026 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1027 public static final String ACTION_SEND = "android.intent.action.SEND";
1028 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001029 * Activity Action: Deliver multiple data to someone else.
1030 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001031 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001032 * <p>
1033 * Input: {@link #getType} is the MIME type of the data being sent.
1034 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001035 * #EXTRA_STREAM} field, containing the data to be sent. If using
1036 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1037 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001038 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001039 * Multiple types are supported, and receivers should handle mixed types
1040 * whenever possible. The right way for the receiver to check them is to
1041 * use the content resolver on each URI. The intent sender should try to
1042 * put the most concrete mime type in the intent type, but it can fall
1043 * back to {@literal <type>/*} or {@literal *}/* as needed.
1044 * <p>
1045 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1046 * be image/jpg, but if you are sending image/jpg and image/png, then the
1047 * intent's type should be image/*.
1048 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001049 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1050 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1051 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1052 * content: URIs and other advanced features of {@link ClipData}. If
1053 * using this approach, you still must supply the same data through the
1054 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1055 * for compatibility with old applications. If you don't set a ClipData,
1056 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1057 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001058 * Optional standard extras, which may be interpreted by some recipients as
1059 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1060 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1061 * <p>
1062 * Output: nothing.
1063 */
1064 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1065 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1066 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001067 * Activity Action: Handle an incoming phone call.
1068 * <p>Input: nothing.
1069 * <p>Output: nothing.
1070 */
1071 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1072 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1073 /**
1074 * Activity Action: Insert an empty item into the given container.
1075 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1076 * in which to place the data.
1077 * <p>Output: URI of the new data that was created.
1078 */
1079 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1080 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1081 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001082 * Activity Action: Create a new item in the given container, initializing it
1083 * from the current contents of the clipboard.
1084 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1085 * in which to place the data.
1086 * <p>Output: URI of the new data that was created.
1087 */
1088 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1089 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1090 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001091 * Activity Action: Delete the given data from its container.
1092 * <p>Input: {@link #getData} is URI of data to be deleted.
1093 * <p>Output: nothing.
1094 */
1095 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1096 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1097 /**
1098 * Activity Action: Run the data, whatever that means.
1099 * <p>Input: ? (Note: this is currently specific to the test harness.)
1100 * <p>Output: nothing.
1101 */
1102 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1103 public static final String ACTION_RUN = "android.intent.action.RUN";
1104 /**
1105 * Activity Action: Perform a data synchronization.
1106 * <p>Input: ?
1107 * <p>Output: ?
1108 */
1109 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1110 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1111 /**
1112 * Activity Action: Pick an activity given an intent, returning the class
1113 * selected.
1114 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1115 * used with {@link PackageManager#queryIntentActivities} to determine the
1116 * set of activities from which to pick.
1117 * <p>Output: Class name of the activity that was selected.
1118 */
1119 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1120 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1121 /**
1122 * Activity Action: Perform a search.
1123 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1124 * is the text to search for. If empty, simply
1125 * enter your search results Activity with the search UI activated.
1126 * <p>Output: nothing.
1127 */
1128 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1129 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1130 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001131 * Activity Action: Start the platform-defined tutorial
1132 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1133 * is the text to search for. If empty, simply
1134 * enter your search results Activity with the search UI activated.
1135 * <p>Output: nothing.
1136 */
1137 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1138 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1139 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001140 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001141 * <p>
1142 * Input: {@link android.app.SearchManager#QUERY
1143 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1144 * a url starts with http or https, the site will be opened. If it is plain
1145 * text, Google search will be applied.
1146 * <p>
1147 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001148 */
1149 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1150 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001151
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001152 /**
Jim Miller07994402012-05-02 14:22:27 -07001153 * Activity Action: Perform assist action.
1154 * <p>
Adam Skorydfc7fd72013-08-05 19:23:41 -07001155 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT},
1156 * {@link #EXTRA_ASSIST_SERVICES_PACKAGES}, and {@link #EXTRA_ASSIST_SERVICES_CONTEXTS} can
1157 * provide additional optional contextual information about where the user was when they
1158 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001159 * Output: nothing.
1160 */
1161 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1162 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001163
1164 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001165 * Activity Action: Perform voice assist action.
1166 * <p>
Adam Skorydfc7fd72013-08-05 19:23:41 -07001167 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT},
1168 * {@link #EXTRA_ASSIST_SERVICES_PACKAGES}, and {@link #EXTRA_ASSIST_SERVICES_CONTEXTS} can
1169 * provide additional optional contextual information about where the user was when they
1170 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001171 * Output: nothing.
1172 */
1173 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1174 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1175
1176 /**
1177 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1178 * containing the name of the current foreground application package at the time
1179 * the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001180 */
1181 public static final String EXTRA_ASSIST_PACKAGE
1182 = "android.intent.extra.ASSIST_PACKAGE";
1183
1184 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001185 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1186 * containing additional contextual information supplied by the current
1187 * foreground app at the time of the assist request. This is a {@link Bundle} of
1188 * additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001189 */
1190 public static final String EXTRA_ASSIST_CONTEXT
1191 = "android.intent.extra.ASSIST_CONTEXT";
1192
Jim Miller07994402012-05-02 14:22:27 -07001193 /**
Adam Skorydfc7fd72013-08-05 19:23:41 -07001194 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1195 * containing an the names of the application package of foreground services at the time
1196 * of the assist request. This is an array of {@link String}s, with one entry
1197 * per service.
1198 */
1199 public static final String EXTRA_ASSIST_SERVICES_PACKAGES
1200 = "android.intent.extra.ASSIST_SERVICES_PACKAGES";
1201
1202 /**
1203 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1204 * containing additional contextual information supplied by the current
1205 * foreground services at the time of the assist request. This is an array
1206 * of {@link Bundle}s of additional data, with one {@link Bundle} per service.
1207 */
1208 public static final String EXTRA_ASSIST_SERVICES_CONTEXTS
1209 = "android.intent.extra.ASSIST_SERVICES_CONTEXTS";
1210
1211
1212 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001213 * Activity Action: List all available applications
1214 * <p>Input: Nothing.
1215 * <p>Output: nothing.
1216 */
1217 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1218 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1219 /**
1220 * Activity Action: Show settings for choosing wallpaper
1221 * <p>Input: Nothing.
1222 * <p>Output: Nothing.
1223 */
1224 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1225 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1226
1227 /**
1228 * Activity Action: Show activity for reporting a bug.
1229 * <p>Input: Nothing.
1230 * <p>Output: Nothing.
1231 */
1232 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1233 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1234
1235 /**
1236 * Activity Action: Main entry point for factory tests. Only used when
1237 * the device is booting in factory test node. The implementing package
1238 * must be installed in the system image.
1239 * <p>Input: nothing
1240 * <p>Output: nothing
1241 */
1242 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1243
1244 /**
1245 * Activity Action: The user pressed the "call" button to go to the dialer
1246 * or other appropriate UI for placing a call.
1247 * <p>Input: Nothing.
1248 * <p>Output: Nothing.
1249 */
1250 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1251 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1252
1253 /**
1254 * Activity Action: Start Voice Command.
1255 * <p>Input: Nothing.
1256 * <p>Output: Nothing.
1257 */
1258 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1259 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001260
1261 /**
1262 * Activity Action: Start action associated with long pressing on the
1263 * search key.
1264 * <p>Input: Nothing.
1265 * <p>Output: Nothing.
1266 */
1267 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1268 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001269
Jacek Surazski86b6c532009-05-13 14:38:28 +02001270 /**
1271 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1272 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001273 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001274 * <p>Input: No data is specified. The bug report is passed in using
1275 * an {@link #EXTRA_BUG_REPORT} field.
1276 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001277 *
1278 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001279 */
1280 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1281 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001282
1283 /**
1284 * Activity Action: Show power usage information to the user.
1285 * <p>Input: Nothing.
1286 * <p>Output: Nothing.
1287 */
1288 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1289 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001290
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001291 /**
1292 * Activity Action: Setup wizard to launch after a platform update. This
1293 * activity should have a string meta-data field associated with it,
1294 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1295 * the platform for setup. The activity will be launched only if
1296 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1297 * same value.
1298 * <p>Input: Nothing.
1299 * <p>Output: Nothing.
1300 * @hide
1301 */
1302 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1303 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001304
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001305 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001306 * Activity Action: Show settings for managing network data usage of a
1307 * specific application. Applications should define an activity that offers
1308 * options to control data usage.
1309 */
1310 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1311 public static final String ACTION_MANAGE_NETWORK_USAGE =
1312 "android.intent.action.MANAGE_NETWORK_USAGE";
1313
1314 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001315 * Activity Action: Launch application installer.
1316 * <p>
1317 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001318 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1319 * you can also use "package:<package-name>" to install an application for the
1320 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001321 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1322 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1323 * <p>
1324 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1325 * succeeded.
1326 *
1327 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1328 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1329 * @see #EXTRA_RETURN_RESULT
1330 */
1331 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1332 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1333
1334 /**
1335 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1336 * package. Specifies the installer package name; this package will receive the
1337 * {@link #ACTION_APP_ERROR} intent.
1338 */
1339 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1340 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1341
1342 /**
1343 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1344 * package. Specifies that the application being installed should not be
1345 * treated as coming from an unknown source, but as coming from the app
1346 * invoking the Intent. For this to work you must start the installer with
1347 * startActivityForResult().
1348 */
1349 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1350 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1351
1352 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001353 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1354 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001355 * data field originated from.
1356 */
rich cannings706e8ba2012-08-20 13:20:14 -07001357 public static final String EXTRA_ORIGINATING_URI
1358 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001359
1360 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001361 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1362 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1363 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001364 */
1365 public static final String EXTRA_REFERRER
1366 = "android.intent.extra.REFERRER";
1367
1368 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001369 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1370 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1371 * @hide
1372 */
1373 public static final String EXTRA_ORIGINATING_UID
1374 = "android.intent.extra.ORIGINATING_UID";
1375
1376 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001377 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1378 * package. Tells the installer UI to skip the confirmation with the user
1379 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001380 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1381 * will no longer show an interstitial message about updating existing
1382 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001383 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001384 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001385 public static final String EXTRA_ALLOW_REPLACE
1386 = "android.intent.extra.ALLOW_REPLACE";
1387
1388 /**
1389 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1390 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1391 * return to the application the result code of the install/uninstall. The returned result
1392 * code will be {@link android.app.Activity#RESULT_OK} on success or
1393 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1394 */
1395 public static final String EXTRA_RETURN_RESULT
1396 = "android.intent.extra.RETURN_RESULT";
1397
1398 /**
1399 * Package manager install result code. @hide because result codes are not
1400 * yet ready to be exposed.
1401 */
1402 public static final String EXTRA_INSTALL_RESULT
1403 = "android.intent.extra.INSTALL_RESULT";
1404
1405 /**
1406 * Activity Action: Launch application uninstaller.
1407 * <p>
1408 * Input: The data must be a package: URI whose scheme specific part is
1409 * the package name of the current installed package to be uninstalled.
1410 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1411 * <p>
1412 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1413 * succeeded.
1414 */
1415 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1416 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1417
1418 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001419 * Specify whether the package should be uninstalled for all users.
1420 * @hide because these should not be part of normal application flow.
1421 */
1422 public static final String EXTRA_UNINSTALL_ALL_USERS
1423 = "android.intent.extra.UNINSTALL_ALL_USERS";
1424
1425 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001426 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1427 * describing the last run version of the platform that was setup.
1428 * @hide
1429 */
1430 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1431
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001432 // ---------------------------------------------------------------------
1433 // ---------------------------------------------------------------------
1434 // Standard intent broadcast actions (see action variable).
1435
1436 /**
1437 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001438 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001439 * <p class="note">This is a protected intent that can only be sent
1440 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001441 */
1442 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1443 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1444 /**
1445 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001446 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001447 * <p class="note">This is a protected intent that can only be sent
1448 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001449 */
1450 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1451 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001452
1453 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001454 * Broadcast Action: Sent after the system stops dreaming.
1455 *
1456 * <p class="note">This is a protected intent that can only be sent by the system.
1457 * It is only sent to registered receivers.</p>
1458 */
1459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1460 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1461
1462 /**
1463 * Broadcast Action: Sent after the system starts dreaming.
1464 *
1465 * <p class="note">This is a protected intent that can only be sent by the system.
1466 * It is only sent to registered receivers.</p>
1467 */
1468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1469 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1470
1471 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001472 * 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 -07001473 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001474 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001475 * <p class="note">This is a protected intent that can only be sent
1476 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001477 */
1478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001479 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001480
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001481 /**
1482 * Broadcast Action: The current time has changed. Sent every
1483 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001484 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001485 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1486 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001487 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001488 * <p class="note">This is a protected intent that can only be sent
1489 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001490 */
1491 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1492 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1493 /**
1494 * Broadcast Action: The time was set.
1495 */
1496 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1497 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1498 /**
1499 * Broadcast Action: The date has changed.
1500 */
1501 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1502 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1503 /**
1504 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1505 * <ul>
1506 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1507 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001508 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001509 * <p class="note">This is a protected intent that can only be sent
1510 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001511 */
1512 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1513 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1514 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001515 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1516 * DNS entries should be tossed.
1517 * @hide
1518 */
1519 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1520 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1521 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001522 * Alarm Changed Action: This is broadcast when the AlarmClock
1523 * application's alarm is set or unset. It is used by the
1524 * AlarmClock application and the StatusBar service.
1525 * @hide
1526 */
1527 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1528 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1529 /**
1530 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1531 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1532 * @hide
1533 */
1534 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1535 public static final String ACTION_SYNC_STATE_CHANGED
1536 = "android.intent.action.SYNC_STATE_CHANGED";
1537 /**
1538 * Broadcast Action: This is broadcast once, after the system has finished
1539 * booting. It can be used to perform application-specific initialization,
1540 * such as installing alarms. You must hold the
1541 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1542 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001543 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001544 * <p class="note">This is a protected intent that can only be sent
1545 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001546 */
1547 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1548 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1549 /**
1550 * Broadcast Action: This is broadcast when a user action should request a
1551 * temporary system dialog to dismiss. Some examples of temporary system
1552 * dialogs are the notification window-shade and the recent tasks dialog.
1553 */
1554 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1555 /**
1556 * Broadcast Action: Trigger the download and eventual installation
1557 * of a package.
1558 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001559 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001560 * <p class="note">This is a protected intent that can only be sent
1561 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001562 *
1563 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001564 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001565 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001566 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1567 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1568 /**
1569 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001570 * device. The data contains the name of the package. Note that the
1571 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001572 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001573 * <ul>
1574 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1575 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1576 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1577 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001578 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001579 * <p class="note">This is a protected intent that can only be sent
1580 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001581 */
1582 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1583 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1584 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001585 * Broadcast Action: A new version of an application package has been
1586 * installed, replacing an existing version that was previously installed.
1587 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001588 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001589 * <ul>
1590 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1591 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001592 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001593 * <p class="note">This is a protected intent that can only be sent
1594 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001595 */
1596 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1597 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1598 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001599 * Broadcast Action: A new version of your application has been installed
1600 * over an existing one. This is only sent to the application that was
1601 * replaced. It does not contain any additional data; to receive it, just
1602 * use an intent filter for this action.
1603 *
1604 * <p class="note">This is a protected intent that can only be sent
1605 * by the system.
1606 */
1607 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1608 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1609 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001610 * Broadcast Action: An existing application package has been removed from
1611 * the device. The data contains the name of the package. The package
1612 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001613 * <ul>
1614 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1615 * to the package.
1616 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1617 * application -- data and code -- is being removed.
1618 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1619 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1620 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001621 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001622 * <p class="note">This is a protected intent that can only be sent
1623 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001624 */
1625 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1626 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1627 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001628 * Broadcast Action: An existing application package has been completely
1629 * removed from the device. The data contains the name of the package.
1630 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1631 * {@link #EXTRA_DATA_REMOVED} is true and
1632 * {@link #EXTRA_REPLACING} is false of that broadcast.
1633 *
1634 * <ul>
1635 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1636 * to the package.
1637 * </ul>
1638 *
1639 * <p class="note">This is a protected intent that can only be sent
1640 * by the system.
1641 */
1642 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1643 public static final String ACTION_PACKAGE_FULLY_REMOVED
1644 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1645 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001646 * Broadcast Action: An existing application package has been changed (e.g.
1647 * a component has been enabled or disabled). The data contains the name of
1648 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001649 * <ul>
1650 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001651 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001652 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001653 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1654 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001655 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001656 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001657 * <p class="note">This is a protected intent that can only be sent
1658 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001659 */
1660 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1661 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1662 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001663 * @hide
1664 * Broadcast Action: Ask system services if there is any reason to
1665 * restart the given package. The data contains the name of the
1666 * package.
1667 * <ul>
1668 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1669 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1670 * </ul>
1671 *
1672 * <p class="note">This is a protected intent that can only be sent
1673 * by the system.
1674 */
1675 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1676 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1677 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001678 * Broadcast Action: The user has restarted a package, and all of its
1679 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001680 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001681 * be removed. Note that the restarted package does <em>not</em>
1682 * receive this broadcast.
1683 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001684 * <ul>
1685 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1686 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001687 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001688 * <p class="note">This is a protected intent that can only be sent
1689 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001690 */
1691 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1692 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1693 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001694 * Broadcast Action: The user has cleared the data of a package. This should
1695 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001696 * its persistent data is erased and this broadcast sent.
1697 * Note that the cleared package does <em>not</em>
1698 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001699 * <ul>
1700 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1701 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001702 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001703 * <p class="note">This is a protected intent that can only be sent
1704 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001705 */
1706 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1707 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1708 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001709 * Broadcast Action: A user ID has been removed from the system. The user
1710 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001711 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001712 * <p class="note">This is a protected intent that can only be sent
1713 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001714 */
1715 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1716 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001717
1718 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001719 * Broadcast Action: Sent to the installer package of an application
1720 * when that application is first launched (that is the first time it
1721 * is moved out of the stopped state). The data contains the name of the package.
1722 *
1723 * <p class="note">This is a protected intent that can only be sent
1724 * by the system.
1725 */
1726 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1727 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1728
1729 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001730 * Broadcast Action: Sent to the system package verifier when a package
1731 * needs to be verified. The data contains the package URI.
1732 * <p class="note">
1733 * This is a protected intent that can only be sent by the system.
1734 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001735 */
1736 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1737 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1738
1739 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001740 * Broadcast Action: Sent to the system package verifier when a package is
1741 * verified. The data contains the package URI.
1742 * <p class="note">
1743 * This is a protected intent that can only be sent by the system.
1744 */
1745 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1746 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1747
1748 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001749 * Broadcast Action: Resources for a set of packages (which were
1750 * previously unavailable) are currently
1751 * available since the media on which they exist is available.
1752 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1753 * list of packages whose availability changed.
1754 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1755 * list of uids of packages whose availability changed.
1756 * Note that the
1757 * packages in this list do <em>not</em> receive this broadcast.
1758 * The specified set of packages are now available on the system.
1759 * <p>Includes the following extras:
1760 * <ul>
1761 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1762 * whose resources(were previously unavailable) are currently available.
1763 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1764 * packages whose resources(were previously unavailable)
1765 * are currently available.
1766 * </ul>
1767 *
1768 * <p class="note">This is a protected intent that can only be sent
1769 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001770 */
1771 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001772 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1773 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001774
1775 /**
1776 * Broadcast Action: Resources for a set of packages are currently
1777 * unavailable since the media on which they exist is unavailable.
1778 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1779 * list of packages whose availability changed.
1780 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1781 * list of uids of packages whose availability changed.
1782 * The specified set of packages can no longer be
1783 * launched and are practically unavailable on the system.
1784 * <p>Inclues the following extras:
1785 * <ul>
1786 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1787 * whose resources are no longer available.
1788 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1789 * whose resources are no longer available.
1790 * </ul>
1791 *
1792 * <p class="note">This is a protected intent that can only be sent
1793 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001794 */
1795 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001796 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001797 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001798
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001799 /**
1800 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001801 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001802 * This should <em>only</em> be used to determine when the wallpaper
1803 * has changed to show the new wallpaper to the user. You should certainly
1804 * never, in response to this, change the wallpaper or other attributes of
1805 * it such as the suggested size. That would be crazy, right? You'd cause
1806 * all kinds of loops, especially if other apps are doing similar things,
1807 * right? Of course. So please don't do this.
1808 *
1809 * @deprecated Modern applications should use
1810 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1811 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1812 * shown behind their UI, rather than watching for this broadcast and
1813 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001814 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001815 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001816 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1817 /**
1818 * Broadcast Action: The current device {@link android.content.res.Configuration}
1819 * (orientation, locale, etc) has changed. When such a change happens, the
1820 * UIs (view hierarchy) will need to be rebuilt based on this new
1821 * information; for the most part, applications don't need to worry about
1822 * this, because the system will take care of stopping and restarting the
1823 * application to make sure it sees the new changes. Some system code that
1824 * can not be restarted will need to watch for this action and handle it
1825 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001826 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001827 * <p class="note">
1828 * You can <em>not</em> receive this through components declared
1829 * in manifests, only by explicitly registering for it with
1830 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1831 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001832 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001833 * <p class="note">This is a protected intent that can only be sent
1834 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001835 *
1836 * @see android.content.res.Configuration
1837 */
1838 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1839 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1840 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001841 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001842 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001843 * <p class="note">This is a protected intent that can only be sent
1844 * by the system.
1845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1848 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001849 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1850 * charging state, level, and other information about the battery.
1851 * See {@link android.os.BatteryManager} for documentation on the
1852 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001853 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001854 * <p class="note">
1855 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001856 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001857 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001858 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1859 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1860 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1861 * broadcasts that are sent and can be received through manifest
1862 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001863 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001864 * <p class="note">This is a protected intent that can only be sent
1865 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001866 */
1867 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1868 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1869 /**
1870 * Broadcast Action: Indicates low battery condition on the device.
1871 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001872 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001873 * <p class="note">This is a protected intent that can only be sent
1874 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001875 */
1876 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1877 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1878 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001879 * Broadcast Action: Indicates the battery is now okay after being low.
1880 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1881 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001882 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001883 * <p class="note">This is a protected intent that can only be sent
1884 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001885 */
1886 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1887 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1888 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001889 * Broadcast Action: External power has been connected to the device.
1890 * This is intended for applications that wish to register specifically to this notification.
1891 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1892 * stay active to receive this notification. This action can be used to implement actions
1893 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001894 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001895 * <p class="note">This is a protected intent that can only be sent
1896 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001897 */
1898 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001899 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001900 /**
1901 * Broadcast Action: External power has been removed from the device.
1902 * This is intended for applications that wish to register specifically to this notification.
1903 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1904 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001905 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001906 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001907 * <p class="note">This is a protected intent that can only be sent
1908 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001909 */
1910 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001911 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001912 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001913 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001914 * Broadcast Action: Device is shutting down.
1915 * This is broadcast when the device is being shut down (completely turned
1916 * off, not sleeping). Once the broadcast is complete, the final shutdown
1917 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001918 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001919 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001920 * <p class="note">This is a protected intent that can only be sent
1921 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001922 * <p>May include the following extras:
1923 * <ul>
1924 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1925 * shutdown is only for userspace processes. If not set, assumed to be false.
1926 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001927 */
1928 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001929 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001930 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001931 * Activity Action: Start this activity to request system shutdown.
1932 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1933 * to request confirmation from the user before shutting down.
1934 *
1935 * <p class="note">This is a protected intent that can only be sent
1936 * by the system.
1937 *
1938 * {@hide}
1939 */
1940 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1941 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001942 * Broadcast Action: A sticky broadcast that indicates low memory
1943 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001944 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001945 * <p class="note">This is a protected intent that can only be sent
1946 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001947 */
1948 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1949 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1950 /**
1951 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001952 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001953 * <p class="note">This is a protected intent that can only be sent
1954 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001955 */
1956 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1957 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1958 /**
Jake Hambybb371632010-08-23 18:16:48 -07001959 * Broadcast Action: A sticky broadcast that indicates a memory full
1960 * condition on the device. This is intended for activities that want
1961 * to be able to fill the data partition completely, leaving only
1962 * enough free space to prevent system-wide SQLite failures.
1963 *
1964 * <p class="note">This is a protected intent that can only be sent
1965 * by the system.
1966 *
1967 * {@hide}
1968 */
1969 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1970 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1971 /**
1972 * Broadcast Action: Indicates memory full condition on the device
1973 * no longer exists.
1974 *
1975 * <p class="note">This is a protected intent that can only be sent
1976 * by the system.
1977 *
1978 * {@hide}
1979 */
1980 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1981 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1982 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001983 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1984 * and package management should be started.
1985 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1986 * notification.
1987 */
1988 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1989 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1990 /**
1991 * Broadcast Action: The device has entered USB Mass Storage mode.
1992 * This is used mainly for the USB Settings panel.
1993 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1994 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001995 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001996 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001997 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001998 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1999
2000 /**
2001 * Broadcast Action: The device has exited USB Mass Storage mode.
2002 * This is used mainly for the USB Settings panel.
2003 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2004 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002005 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002006 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002007 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002008 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2009
2010 /**
2011 * Broadcast Action: External media has been removed.
2012 * The path to the mount point for the removed media is contained in the Intent.mData field.
2013 */
2014 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2015 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2016
2017 /**
2018 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002019 * 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 -07002020 */
2021 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2022 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2023
2024 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002025 * Broadcast Action: External media is present, and being disk-checked
2026 * 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 -08002027 */
2028 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2029 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2030
2031 /**
2032 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2033 * 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 -08002034 */
2035 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2036 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2037
2038 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002039 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002040 * 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 -07002041 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2042 * media was mounted read only.
2043 */
2044 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2045 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2046
2047 /**
2048 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002049 * 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 -07002050 */
2051 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2052 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2053
2054 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002055 * Broadcast Action: External media is no longer being shared via USB mass storage.
2056 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2057 *
2058 * @hide
2059 */
2060 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2061
2062 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002063 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2064 * The path to the mount point for the removed media is contained in the Intent.mData field.
2065 */
2066 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2067 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2068
2069 /**
2070 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002071 * 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 -07002072 */
2073 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2074 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2075
2076 /**
2077 * Broadcast Action: User has expressed the desire to remove the external storage media.
2078 * Applications should close all files they have open within the mount point when they receive this intent.
2079 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2080 */
2081 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2082 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2083
2084 /**
2085 * Broadcast Action: The media scanner has started scanning a directory.
2086 * The path to the directory being scanned is contained in the Intent.mData field.
2087 */
2088 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2089 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2090
2091 /**
2092 * Broadcast Action: The media scanner has finished scanning a directory.
2093 * The path to the scanned directory is contained in the Intent.mData field.
2094 */
2095 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2096 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2097
2098 /**
2099 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2100 * The path to the file is contained in the Intent.mData field.
2101 */
2102 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2103 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2104
2105 /**
2106 * Broadcast Action: The "Media Button" was pressed. Includes a single
2107 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2108 * caused the broadcast.
2109 */
2110 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2111 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2112
2113 /**
2114 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2115 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2116 * caused the broadcast.
2117 */
2118 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2119 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2120
2121 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2122 // location; they are not general-purpose actions.
2123
2124 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002125 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002126 */
2127 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2128 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2129 "android.intent.action.GTALK_CONNECTED";
2130
2131 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002132 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002133 */
2134 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2135 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2136 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002137
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002138 /**
2139 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002140 */
2141 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2142 public static final String ACTION_INPUT_METHOD_CHANGED =
2143 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002144
2145 /**
2146 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2147 * more radios have been turned off or on. The intent will have the following extra value:</p>
2148 * <ul>
2149 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2150 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2151 * turned off</li>
2152 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002153 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002154 * <p class="note">This is a protected intent that can only be sent
2155 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002156 */
2157 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2158 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2159
2160 /**
2161 * Broadcast Action: Some content providers have parts of their namespace
2162 * where they publish new events or items that the user may be especially
2163 * interested in. For these things, they may broadcast this action when the
2164 * set of interesting items change.
2165 *
2166 * For example, GmailProvider sends this notification when the set of unread
2167 * mail in the inbox changes.
2168 *
2169 * <p>The data of the intent identifies which part of which provider
2170 * changed. When queried through the content resolver, the data URI will
2171 * return the data set in question.
2172 *
2173 * <p>The intent will have the following extra values:
2174 * <ul>
2175 * <li><em>count</em> - The number of items in the data set. This is the
2176 * same as the number of items in the cursor returned by querying the
2177 * data URI. </li>
2178 * </ul>
2179 *
2180 * This intent will be sent at boot (if the count is non-zero) and when the
2181 * data set changes. It is possible for the data set to change without the
2182 * count changing (for example, if a new unread message arrives in the same
2183 * sync operation in which a message is archived). The phone should still
2184 * ring/vibrate/etc as normal in this case.
2185 */
2186 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2187 public static final String ACTION_PROVIDER_CHANGED =
2188 "android.intent.action.PROVIDER_CHANGED";
2189
2190 /**
2191 * Broadcast Action: Wired Headset plugged in or unplugged.
2192 *
2193 * <p>The intent will have the following extra values:
2194 * <ul>
2195 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2196 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002197 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002198 * </ul>
2199 * </ul>
2200 */
2201 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2202 public static final String ACTION_HEADSET_PLUG =
2203 "android.intent.action.HEADSET_PLUG";
2204
2205 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002206 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2207 *
2208 * <p>The intent will have the following extra values:
2209 * <ul>
2210 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2211 * <li><em>name</em> - Headset type, human readable string </li>
2212 * </ul>
2213 * </ul>
2214 * @hide
2215 */
2216 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002217 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2218 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002219
2220 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002221 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002222 *
2223 * <p>The intent will have the following extra values:
2224 * <ul>
2225 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2226 * <li><em>name</em> - Headset type, human readable string </li>
2227 * </ul>
2228 * </ul>
2229 * @hide
2230 */
2231 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002232 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2233 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002234
2235 /**
2236 * Broadcast Action: A HMDI cable was plugged or unplugged
2237 *
2238 * <p>The intent will have the following extra values:
2239 * <ul>
2240 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2241 * <li><em>name</em> - HDMI cable, human readable string </li>
2242 * </ul>
2243 * </ul>
2244 * @hide
2245 */
2246 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2247 public static final String ACTION_HDMI_AUDIO_PLUG =
2248 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002249
2250 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002251 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2252 *
2253 * <p>The intent will have the following extra values:
2254 * <ul>
2255 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2256 * <li><em>card</em> - ALSA card number (integer) </li>
2257 * <li><em>device</em> - ALSA device number (integer) </li>
2258 * </ul>
2259 * </ul>
2260 * @hide
2261 */
2262 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2263 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2264 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2265
2266 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002267 * Broadcast Action: A USB audio device was plugged in or unplugged.
2268 *
2269 * <p>The intent will have the following extra values:
2270 * <ul>
2271 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2272 * <li><em>card</em> - ALSA card number (integer) </li>
2273 * <li><em>device</em> - ALSA device number (integer) </li>
2274 * </ul>
2275 * </ul>
2276 * @hide
2277 */
2278 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2279 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2280 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2281
2282 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002283 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2284 * <ul>
2285 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2286 * </ul>
2287 *
2288 * <p class="note">This is a protected intent that can only be sent
2289 * by the system.
2290 *
2291 * @hide
2292 */
2293 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2294 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2295 = "android.intent.action.ADVANCED_SETTINGS";
2296
2297 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002298 * Broadcast Action: An outgoing call is about to be placed.
2299 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002300 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002301 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002302 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002303 * the phone number originally intended to be dialed.</li>
2304 * </ul>
2305 * <p>Once the broadcast is finished, the resultData is used as the actual
2306 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002307 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002308 * outgoing call in turn: for example, a parental control application
2309 * might verify that the user is authorized to place the call at that
2310 * time, then a number-rewriting application might add an area code if
2311 * one was not specified.</p>
2312 * <p>For consistency, any receiver whose purpose is to prohibit phone
2313 * calls should have a priority of 0, to ensure it will see the final
2314 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002315 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002316 * should have a positive priority.
2317 * Negative priorities are reserved for the system for this broadcast;
2318 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002319 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2320 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002321 * <p>Emergency calls cannot be intercepted using this mechanism, and
2322 * other calls cannot be modified to call emergency numbers using this
2323 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002324 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2325 * call to use their own service instead. Those apps should first prevent
2326 * the call from being placed by setting resultData to <code>null</code>
2327 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002328 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002329 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2330 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002331 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002332 * <p class="note">This is a protected intent that can only be sent
2333 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002334 */
2335 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2336 public static final String ACTION_NEW_OUTGOING_CALL =
2337 "android.intent.action.NEW_OUTGOING_CALL";
2338
2339 /**
2340 * Broadcast Action: Have the device reboot. This is only for use by
2341 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002342 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002343 * <p class="note">This is a protected intent that can only be sent
2344 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002345 */
2346 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2347 public static final String ACTION_REBOOT =
2348 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002349
Wei Huang97ecc9c2009-05-11 17:44:20 -07002350 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002351 * Broadcast Action: A sticky broadcast for changes in the physical
2352 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002353 *
2354 * <p>The intent will have the following extra values:
2355 * <ul>
2356 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002357 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002358 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002359 * <p>This is intended for monitoring the current physical dock state.
2360 * See {@link android.app.UiModeManager} for the normal API dealing with
2361 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002362 */
2363 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2364 public static final String ACTION_DOCK_EVENT =
2365 "android.intent.action.DOCK_EVENT";
2366
2367 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002368 * Broadcast Action: A broadcast when idle maintenance can be started.
2369 * This means that the user is not interacting with the device and is
2370 * not expected to do so soon. Typical use of the idle maintenance is
2371 * to perform somehow expensive tasks that can be postponed at a moment
2372 * when they will not degrade user experience.
2373 * <p>
2374 * <p class="note">In order to keep the device responsive in case of an
2375 * unexpected user interaction, implementations of a maintenance task
2376 * should be interruptible. In such a scenario a broadcast with action
2377 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2378 * should not do the maintenance work in
2379 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2380 * maintenance service by {@link Context#startService(Intent)}. Also
2381 * you should hold a wake lock while your maintenance service is running
2382 * to prevent the device going to sleep.
2383 * </p>
2384 * <p>
2385 * <p class="note">This is a protected intent that can only be sent by
2386 * the system.
2387 * </p>
2388 *
2389 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002390 *
2391 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002392 */
2393 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2394 public static final String ACTION_IDLE_MAINTENANCE_START =
2395 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2396
2397 /**
2398 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2399 * This means that the user was not interacting with the device as a result
2400 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2401 * was sent and now the user started interacting with the device. Typical
2402 * use of the idle maintenance is to perform somehow expensive tasks that
2403 * can be postponed at a moment when they will not degrade user experience.
2404 * <p>
2405 * <p class="note">In order to keep the device responsive in case of an
2406 * unexpected user interaction, implementations of a maintenance task
2407 * should be interruptible. Hence, on receiving a broadcast with this
2408 * action, the maintenance task should be interrupted as soon as possible.
2409 * In other words, you should not do the maintenance work in
2410 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2411 * maintenance service that was started on receiving of
2412 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2413 * lock you acquired when your maintenance service started.
2414 * </p>
2415 * <p class="note">This is a protected intent that can only be sent
2416 * by the system.
2417 *
2418 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002419 *
2420 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002421 */
2422 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2423 public static final String ACTION_IDLE_MAINTENANCE_END =
2424 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2425
2426 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002427 * Broadcast Action: a remote intent is to be broadcasted.
2428 *
2429 * A remote intent is used for remote RPC between devices. The remote intent
2430 * is serialized and sent from one device to another device. The receiving
2431 * device parses the remote intent and broadcasts it. Note that anyone can
2432 * broadcast a remote intent. However, if the intent receiver of the remote intent
2433 * does not trust intent broadcasts from arbitrary intent senders, it should require
2434 * the sender to hold certain permissions so only trusted sender's broadcast will be
2435 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002436 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002437 */
2438 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002439 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002440
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002441 /**
2442 * Broadcast Action: hook for permforming cleanup after a system update.
2443 *
2444 * The broadcast is sent when the system is booting, before the
2445 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2446 * image. A receiver for this should do its work and then disable itself
2447 * so that it does not get run again at the next boot.
2448 * @hide
2449 */
2450 public static final String ACTION_PRE_BOOT_COMPLETED =
2451 "android.intent.action.PRE_BOOT_COMPLETED";
2452
Amith Yamasani13593602012-03-22 16:16:17 -07002453 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002454 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002455 * on restricted users. The broadcast intent contains an extra
2456 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2457 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2458 * String[] depending on the restriction type.<p/>
2459 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002460 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2461 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2462 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002463 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2464 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002465 * @see RestrictionEntry
2466 */
2467 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2468 "android.intent.action.GET_RESTRICTION_ENTRIES";
2469
2470 /**
Amith Yamasani655d0e22013-06-12 14:19:10 -07002471 * Activity to challenge the user for a PIN that was configured when setting up
2472 * restrictions. Launch the activity using
2473 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2474 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2475 * challenge.<p/>
2476 * Before launching this activity, make sure that there is a PIN in effect, by calling
2477 * {@link android.os.UserManager#hasRestrictionsPin()}.
2478 */
2479 public static final String ACTION_RESTRICTIONS_PIN_CHALLENGE =
2480 "android.intent.action.RESTRICTIONS_PIN_CHALLENGE";
2481
2482 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002483 * Sent the first time a user is starting, to allow system apps to
2484 * perform one time initialization. (This will not be seen by third
2485 * party applications because a newly initialized user does not have any
2486 * third party applications installed for it.) This is sent early in
2487 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002488 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2489 * broadcast, since it is part of a visible user interaction; be as quick
2490 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002491 */
2492 public static final String ACTION_USER_INITIALIZE =
2493 "android.intent.action.USER_INITIALIZE";
2494
2495 /**
2496 * Sent when a user switch is happening, causing the process's user to be
2497 * brought to the foreground. This is only sent to receivers registered
2498 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2499 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002500 * foreground. This is sent as a foreground
2501 * broadcast, since it is part of a visible user interaction; be as quick
2502 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002503 */
2504 public static final String ACTION_USER_FOREGROUND =
2505 "android.intent.action.USER_FOREGROUND";
2506
2507 /**
2508 * Sent when a user switch is happening, causing the process's user to be
2509 * sent to the background. This is only sent to receivers registered
2510 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2511 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002512 * background. This is sent as a foreground
2513 * broadcast, since it is part of a visible user interaction; be as quick
2514 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002515 */
2516 public static final String ACTION_USER_BACKGROUND =
2517 "android.intent.action.USER_BACKGROUND";
2518
2519 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002520 * Broadcast sent to the system when a user is added. Carries an extra
2521 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2522 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002523 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002524 * @hide
2525 */
2526 public static final String ACTION_USER_ADDED =
2527 "android.intent.action.USER_ADDED";
2528
2529 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002530 * Broadcast sent by the system when a user is started. Carries an extra
2531 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002532 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002533 * that has been started. This is sent as a foreground
2534 * broadcast, since it is part of a visible user interaction; be as quick
2535 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002536 * @hide
2537 */
2538 public static final String ACTION_USER_STARTED =
2539 "android.intent.action.USER_STARTED";
2540
2541 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002542 * Broadcast sent when a user is in the process of starting. Carries an extra
2543 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2544 * sent to registered receivers, not manifest receivers. It is sent to all
2545 * users (including the one that is being started). You must hold
2546 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2547 * this broadcast. This is sent as a background broadcast, since
2548 * its result is not part of the primary UX flow; to safely keep track of
2549 * started/stopped state of a user you can use this in conjunction with
2550 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2551 * other user state broadcasts since those are foreground broadcasts so can
2552 * execute in a different order.
2553 * @hide
2554 */
2555 public static final String ACTION_USER_STARTING =
2556 "android.intent.action.USER_STARTING";
2557
2558 /**
2559 * Broadcast sent when a user is going to be stopped. Carries an extra
2560 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2561 * sent to registered receivers, not manifest receivers. It is sent to all
2562 * users (including the one that is being stopped). You must hold
2563 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2564 * this broadcast. The user will not stop until all receivers have
2565 * handled the broadcast. This is sent as a background broadcast, since
2566 * its result is not part of the primary UX flow; to safely keep track of
2567 * started/stopped state of a user you can use this in conjunction with
2568 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2569 * other user state broadcasts since those are foreground broadcasts so can
2570 * execute in a different order.
2571 * @hide
2572 */
2573 public static final String ACTION_USER_STOPPING =
2574 "android.intent.action.USER_STOPPING";
2575
2576 /**
2577 * Broadcast sent to the system when a user is stopped. Carries an extra
2578 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2579 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2580 * specific package. This is only sent to registered receivers, not manifest
2581 * receivers. It is sent to all running users <em>except</em> the one that
2582 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002583 * @hide
2584 */
2585 public static final String ACTION_USER_STOPPED =
2586 "android.intent.action.USER_STOPPED";
2587
2588 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002589 * 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 -07002590 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002591 * one that has been removed. The user will not be completely removed until all receivers have
2592 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002593 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002594 * @hide
2595 */
2596 public static final String ACTION_USER_REMOVED =
2597 "android.intent.action.USER_REMOVED";
2598
2599 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002600 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002601 * the userHandle of the user to become the current one. This is only sent to
2602 * registered receivers, not manifest receivers. It is sent to all running users.
2603 * You must hold
2604 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002605 * @hide
2606 */
2607 public static final String ACTION_USER_SWITCHED =
2608 "android.intent.action.USER_SWITCHED";
2609
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002610 /**
2611 * Broadcast sent to the system when a user's information changes. Carries an extra
2612 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002613 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002614 * @hide
2615 */
2616 public static final String ACTION_USER_INFO_CHANGED =
2617 "android.intent.action.USER_INFO_CHANGED";
2618
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002619 /**
2620 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2621 */
2622 public static final String ACTION_QUICK_CLOCK =
2623 "android.intent.action.QUICK_CLOCK";
2624
Michael Wright0087a142013-02-05 16:29:39 -08002625 /**
2626 * Broadcast Action: This is broadcast when a user action should request the
2627 * brightness setting dialog.
2628 * @hide
2629 */
2630 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2631 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2632
Justin Kohd378ad72013-04-01 12:18:26 -07002633 /**
2634 * Broadcast Action: A global button was pressed. Includes a single
2635 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2636 * caused the broadcast.
2637 * @hide
2638 */
2639 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2640
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002641 /**
2642 * Activity Action: Allow the user to select and open one or more existing
2643 * documents. Both read and write access to the documents will be granted
2644 * until explicitly revoked by the user.
2645 * <p>
2646 * Callers can restrict selection to a specific kind of data, such as
2647 * photos, by setting one or more MIME types in {@link #EXTRA_MIME_TYPES}.
2648 * <p>
2649 * If the caller can handle multiple returned items (the user performing
2650 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE} to
2651 * indicate this.
2652 * <p>
2653 * All returned URIs can be opened as a stream with
2654 * {@link ContentResolver#openInputStream(Uri)}.
2655 * <p>
2656 * Output: The URI of the item that was picked. This must be a content: URI
2657 * so that any receiver can access it.
2658 */
2659 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2660 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2661
2662 /**
2663 * Activity Action: Allow the user to create a new document. Both read and
2664 * write access to the document will be granted until explicitly revoked by
2665 * the user.
2666 * <p>
2667 * Callers can provide a hint document name by setting {@link #EXTRA_TITLE},
2668 * but the user may change this value before creating the file. Callers can
2669 * optionally hint at the MIME type being created by setting
2670 * {@link #setType(String)}.
2671 * <p>
2672 * All returned URIs can be opened as a stream with
2673 * {@link ContentResolver#openOutputStream(Uri)}.
2674 * <p>
2675 * Output: The URI of the item that was created. This must be a content: URI
2676 * so that any receiver can access it.
2677 */
2678 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2679 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2680
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002681 // ---------------------------------------------------------------------
2682 // ---------------------------------------------------------------------
2683 // Standard intent categories (see addCategory()).
2684
2685 /**
2686 * Set if the activity should be an option for the default action
2687 * (center press) to perform on a piece of data. Setting this will
2688 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002689 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002690 * Intent when initiating an action -- it is for use in intent filters
2691 * specified in packages.
2692 */
2693 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2694 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2695 /**
2696 * Activities that can be safely invoked from a browser must support this
2697 * category. For example, if the user is viewing a web page or an e-mail
2698 * and clicks on a link in the text, the Intent generated execute that
2699 * link will require the BROWSABLE category, so that only activities
2700 * supporting this category will be considered as possible actions. By
2701 * supporting this category, you are promising that there is nothing
2702 * damaging (without user intervention) that can happen by invoking any
2703 * matching Intent.
2704 */
2705 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2706 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2707 /**
2708 * Set if the activity should be considered as an alternative action to
2709 * the data the user is currently viewing. See also
2710 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2711 * applies to the selection in a list of items.
2712 *
2713 * <p>Supporting this category means that you would like your activity to be
2714 * displayed in the set of alternative things the user can do, usually as
2715 * part of the current activity's options menu. You will usually want to
2716 * include a specific label in the &lt;intent-filter&gt; of this action
2717 * describing to the user what it does.
2718 *
2719 * <p>The action of IntentFilter with this category is important in that it
2720 * describes the specific action the target will perform. This generally
2721 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2722 * a specific name such as "com.android.camera.action.CROP. Only one
2723 * alternative of any particular action will be shown to the user, so using
2724 * a specific action like this makes sure that your alternative will be
2725 * displayed while also allowing other applications to provide their own
2726 * overrides of that particular action.
2727 */
2728 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2729 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2730 /**
2731 * Set if the activity should be considered as an alternative selection
2732 * action to the data the user has currently selected. This is like
2733 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2734 * of items from which the user can select, giving them alternatives to the
2735 * default action that will be performed on it.
2736 */
2737 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2738 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2739 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002740 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002741 */
2742 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2743 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2744 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002745 * Should be displayed in the top-level launcher.
2746 */
2747 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2748 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2749 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002750 * Provides information about the package it is in; typically used if
2751 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2752 * a front-door to the user without having to be shown in the all apps list.
2753 */
2754 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2755 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2756 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002757 * This is the home activity, that is the first activity that is displayed
2758 * when the device boots.
2759 */
2760 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2761 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2762 /**
2763 * This activity is a preference panel.
2764 */
2765 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2766 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2767 /**
2768 * This activity is a development preference panel.
2769 */
2770 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2771 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2772 /**
2773 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002774 */
2775 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2776 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2777 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002778 * This activity allows the user to browse and download new applications.
2779 */
2780 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2781 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2782 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002783 * This activity may be exercised by the monkey or other automated test tools.
2784 */
2785 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2786 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2787 /**
2788 * To be used as a test (not part of the normal user experience).
2789 */
2790 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2791 /**
2792 * To be used as a unit test (run through the Test Harness).
2793 */
2794 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2795 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002796 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002797 * experience).
2798 */
2799 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2800 /**
2801 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
Dianne Hackborna53ee352013-02-20 12:47:02 -08002802 * ContentResolver.openInputStream. Openable URIs must support the columns in
2803 * {@link android.provider.OpenableColumns}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002804 * when queried, though it is allowable for those columns to be blank.
2805 */
2806 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2807 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2808
2809 /**
2810 * To be used as code under test for framework instrumentation tests.
2811 */
2812 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2813 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002814 /**
2815 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002816 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2817 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002818 */
2819 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2820 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2821 /**
2822 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002823 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2824 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002825 */
2826 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2827 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002828 /**
2829 * An activity to run when device is inserted into a analog (low end) dock.
2830 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2831 * information, see {@link android.app.UiModeManager}.
2832 */
2833 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2834 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2835
2836 /**
2837 * An activity to run when device is inserted into a digital (high end) dock.
2838 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2839 * information, see {@link android.app.UiModeManager}.
2840 */
2841 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2842 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002843
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002844 /**
2845 * Used to indicate that the activity can be used in a car environment.
2846 */
2847 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2848 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2849
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002850 // ---------------------------------------------------------------------
2851 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002852 // Application launch intent categories (see addCategory()).
2853
2854 /**
2855 * Used with {@link #ACTION_MAIN} to launch the browser application.
2856 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002857 * <p>NOTE: This should not be used as the primary key of an Intent,
2858 * since it will not result in the app launching with the correct
2859 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002860 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002861 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002862 */
2863 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2864 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2865
2866 /**
2867 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2868 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002869 * <p>NOTE: This should not be used as the primary key of an Intent,
2870 * since it will not result in the app launching with the correct
2871 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002872 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002873 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002874 */
2875 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2876 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2877
2878 /**
2879 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2880 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002881 * <p>NOTE: This should not be used as the primary key of an Intent,
2882 * since it will not result in the app launching with the correct
2883 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002884 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002885 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002886 */
2887 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2888 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2889
2890 /**
2891 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2892 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002893 * <p>NOTE: This should not be used as the primary key of an Intent,
2894 * since it will not result in the app launching with the correct
2895 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002896 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002897 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002898 */
2899 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2900 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2901
2902 /**
2903 * Used with {@link #ACTION_MAIN} to launch the email application.
2904 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002905 * <p>NOTE: This should not be used as the primary key of an Intent,
2906 * since it will not result in the app launching with the correct
2907 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002908 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002909 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002910 */
2911 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2912 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2913
2914 /**
2915 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2916 * The activity should be able to view and manipulate image and video files
2917 * stored on the device.
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_GALLERY = "android.intent.category.APP_GALLERY";
2926
2927 /**
2928 * Used with {@link #ACTION_MAIN} to launch the maps application.
2929 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002930 * <p>NOTE: This should not be used as the primary key of an Intent,
2931 * since it will not result in the app launching with the correct
2932 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002933 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002934 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002935 */
2936 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2937 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2938
2939 /**
2940 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2941 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002942 * <p>NOTE: This should not be used as the primary key of an Intent,
2943 * since it will not result in the app launching with the correct
2944 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002945 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002946 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002947 */
2948 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2949 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2950
2951 /**
2952 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002953 * The activity should be able to play, browse, or manipulate music files
2954 * stored on the device.
2955 * <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_MUSIC = "android.intent.category.APP_MUSIC";
2963
2964 // ---------------------------------------------------------------------
2965 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002966 // Standard extra data keys.
2967
2968 /**
2969 * The initial data to place in a newly created record. Use with
2970 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2971 * fields as would be given to the underlying ContentProvider.insert()
2972 * call.
2973 */
2974 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2975
2976 /**
2977 * A constant CharSequence that is associated with the Intent, used with
2978 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2979 * this may be a styled CharSequence, so you must use
2980 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2981 * retrieve it.
2982 */
2983 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2984
2985 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002986 * A constant String that is associated with the Intent, used with
2987 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2988 * as HTML formatted text. Note that you <em>must</em> also supply
2989 * {@link #EXTRA_TEXT}.
2990 */
2991 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2992
2993 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002994 * A content: URI holding a stream of data associated with the Intent,
2995 * used with {@link #ACTION_SEND} to supply the data being sent.
2996 */
2997 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2998
2999 /**
3000 * A String[] holding e-mail addresses that should be delivered to.
3001 */
3002 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3003
3004 /**
3005 * A String[] holding e-mail addresses that should be carbon copied.
3006 */
3007 public static final String EXTRA_CC = "android.intent.extra.CC";
3008
3009 /**
3010 * A String[] holding e-mail addresses that should be blind carbon copied.
3011 */
3012 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3013
3014 /**
3015 * A constant string holding the desired subject line of a message.
3016 */
3017 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3018
3019 /**
3020 * An Intent describing the choices you would like shown with
3021 * {@link #ACTION_PICK_ACTIVITY}.
3022 */
3023 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3024
3025 /**
3026 * A CharSequence dialog title to provide to the user when used with a
3027 * {@link #ACTION_CHOOSER}.
3028 */
3029 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3030
3031 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003032 * A Parcelable[] of {@link Intent} or
3033 * {@link android.content.pm.LabeledIntent} objects as set with
3034 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3035 * a the front of the list of choices, when shown to the user with a
3036 * {@link #ACTION_CHOOSER}.
3037 */
3038 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3039
3040 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003041 * A {@link android.view.KeyEvent} object containing the event that
3042 * triggered the creation of the Intent it is in.
3043 */
3044 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3045
3046 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003047 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3048 * before shutting down.
3049 *
3050 * {@hide}
3051 */
3052 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3053
3054 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003055 * 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 -07003056 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3057 * of restarting the application.
3058 */
3059 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3060
3061 /**
3062 * A String holding the phone number originally entered in
3063 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3064 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3065 */
3066 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003067
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003068 /**
3069 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3070 * intents to supply the uid the package had been assigned. Also an optional
3071 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3072 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3073 * purpose.
3074 */
3075 public static final String EXTRA_UID = "android.intent.extra.UID";
3076
3077 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003078 * @hide String array of package names.
3079 */
3080 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3081
3082 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003083 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3084 * intents to indicate whether this represents a full uninstall (removing
3085 * both the code and its data) or a partial uninstall (leaving its data,
3086 * implying that this is an update).
3087 */
3088 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003089
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003090 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003091 * @hide
3092 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3093 * intents to indicate that at this point the package has been removed for
3094 * all users on the device.
3095 */
3096 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3097 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3098
3099 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003100 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3101 * intents to indicate that this is a replacement of the package, so this
3102 * broadcast will immediately be followed by an add broadcast for a
3103 * different version of the same package.
3104 */
3105 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003106
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003107 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003108 * Used as an int extra field in {@link android.app.AlarmManager} intents
3109 * to tell the application being invoked how many pending alarms are being
3110 * delievered with the intent. For one-shot alarms this will always be 1.
3111 * For recurring alarms, this might be greater than 1 if the device was
3112 * asleep or powered off at the time an earlier alarm would have been
3113 * delivered.
3114 */
3115 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003116
Jacek Surazski86b6c532009-05-13 14:38:28 +02003117 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003118 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3119 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003120 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3121 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003122 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3123 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3124 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003125 */
3126 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3127
3128 /**
3129 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3130 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003131 */
3132 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3133
3134 /**
3135 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3136 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003137 */
3138 public static final int EXTRA_DOCK_STATE_DESK = 1;
3139
3140 /**
3141 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3142 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003143 */
3144 public static final int EXTRA_DOCK_STATE_CAR = 2;
3145
3146 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003147 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3148 * to represent that the phone is in a analog (low end) dock.
3149 */
3150 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3151
3152 /**
3153 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3154 * to represent that the phone is in a digital (high end) dock.
3155 */
3156 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3157
3158 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003159 * Boolean that can be supplied as meta-data with a dock activity, to
3160 * indicate that the dock should take over the home key when it is active.
3161 */
3162 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003163
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003164 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003165 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3166 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003167 */
3168 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3169
3170 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003171 * Used in the extra field in the remote intent. It's astring token passed with the
3172 * remote intent.
3173 */
3174 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3175 "android.intent.extra.remote_intent_token";
3176
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003177 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003178 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003179 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003180 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003181 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003182 "android.intent.extra.changed_component_name";
3183
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003184 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003185 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003186 * and contains a string array of all of the components that have changed. If
3187 * the state of the overall package has changed, then it will contain an entry
3188 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003189 */
3190 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3191 "android.intent.extra.changed_component_name_list";
3192
3193 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003194 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003195 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3196 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003197 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003198 */
3199 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3200 "android.intent.extra.changed_package_list";
3201
3202 /**
3203 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003204 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3205 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003206 * and contains an integer array of uids of all of the components
3207 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003208 */
3209 public static final String EXTRA_CHANGED_UID_LIST =
3210 "android.intent.extra.changed_uid_list";
3211
3212 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003213 * @hide
3214 * Magic extra system code can use when binding, to give a label for
3215 * who it is that has bound to a service. This is an integer giving
3216 * a framework string resource that can be displayed to the user.
3217 */
3218 public static final String EXTRA_CLIENT_LABEL =
3219 "android.intent.extra.client_label";
3220
3221 /**
3222 * @hide
3223 * Magic extra system code can use when binding, to give a PendingIntent object
3224 * that can be launched for the user to disable the system's use of this
3225 * service.
3226 */
3227 public static final String EXTRA_CLIENT_INTENT =
3228 "android.intent.extra.client_intent";
3229
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003230 /**
3231 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3232 * data that is on the local device. This is a boolean extra; the default
3233 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3234 * the user to select media that is already on the device, not requiring it
3235 * be downloaded from a remote service when opened. Another way to look
3236 * at it is that such content should generally have a "_data" column to the
3237 * path of the content on local external storage.
3238 */
3239 public static final String EXTRA_LOCAL_ONLY =
3240 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003241
Amith Yamasani13593602012-03-22 16:16:17 -07003242 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003243 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3244 * user to select and return multiple items. This is a boolean extra; the default
3245 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3246 * present the user with a UI where they can pick multiple items that are all
3247 * returned to the caller. When this happens, they should be returned as
3248 * the {@link #getClipData()} part of the result Intent.
3249 */
3250 public static final String EXTRA_ALLOW_MULTIPLE =
3251 "android.intent.extra.ALLOW_MULTIPLE";
3252
3253 /**
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003254 * The userHandle carried with broadcast intents related to addition, removal and switching of
3255 * users
Amith Yamasani13593602012-03-22 16:16:17 -07003256 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3257 * @hide
3258 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003259 public static final String EXTRA_USER_HANDLE =
3260 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003261
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003262 /**
3263 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003264 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3265 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003266 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003267 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3268
3269 /**
3270 * Extra sent in the intent to the BroadcastReceiver that handles
3271 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3272 * the restrictions as key/value pairs.
3273 */
3274 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3275 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003276
Amith Yamasani86118ba2013-03-28 14:33:16 -07003277 /**
3278 * Extra used in the response from a BroadcastReceiver that handles
3279 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3280 */
3281 public static final String EXTRA_RESTRICTIONS_INTENT =
3282 "android.intent.extra.restrictions_intent";
3283
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003284 /**
3285 * Extra used to communicate set of acceptable MIME types for
Jeff Sharkey9ab3fd42013-05-01 18:12:12 -07003286 * {@link #ACTION_GET_CONTENT} or {@link #ACTION_OPEN_DOCUMENT}. The type of the
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003287 * extra is <code>ArrayList&lt;String&gt;</code>.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003288 */
3289 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3290
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003291 /**
3292 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3293 * this shutdown is only for the user space of the system, not a complete shutdown.
3294 * Hardware should not be shut down when this is true. The default if not supplied
3295 * is false.
3296 */
3297 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3298 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3299
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003300 // ---------------------------------------------------------------------
3301 // ---------------------------------------------------------------------
3302 // Intent flags (see mFlags variable).
3303
3304 /**
3305 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003306 * perform read operations on the Uri in the Intent's data and any URIs
3307 * specified in its ClipData. When applying to an Intent's ClipData,
3308 * all URIs as well as recursive traversals through data or other ClipData
3309 * in Intent items will be granted; only the grant flags of the top-level
3310 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003311 */
3312 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3313 /**
3314 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003315 * perform write operations on the Uri in the Intent's data and any URIs
3316 * specified in its ClipData. When applying to an Intent's ClipData,
3317 * all URIs as well as recursive traversals through data or other ClipData
3318 * in Intent items will be granted; only the grant flags of the top-level
3319 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003320 */
3321 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3322 /**
3323 * Can be set by the caller to indicate that this Intent is coming from
3324 * a background operation, not from direct user interaction.
3325 */
3326 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3327 /**
3328 * A flag you can enable for debugging: when set, log messages will be
3329 * printed during the resolution of this intent to show you what has
3330 * been found to create the final resolved list.
3331 */
3332 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003333 /**
3334 * If set, this intent will not match any components in packages that
3335 * are currently stopped. If this is not set, then the default behavior
3336 * is to include such applications in the result.
3337 */
3338 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3339 /**
3340 * If set, this intent will always match any components in packages that
3341 * are currently stopped. This is the default behavior when
3342 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3343 * flags are set, this one wins (it allows overriding of exclude for
3344 * places where the framework may automatically set the exclude flag).
3345 */
3346 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003347
3348 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003349 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3350 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the grant will be remembered
3351 * until explicitly revoked with
3352 * {@link Context#revokeUriPermission(Uri, int)}. These grants persist
3353 * across device reboots.
3354 */
3355 public static final int FLAG_PERSIST_GRANT_URI_PERMISSION = 0x00000040;
3356
3357 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003358 * If set, the new activity is not kept in the history stack. As soon as
3359 * the user navigates away from it, the activity is finished. This may also
3360 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3361 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003362 */
3363 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3364 /**
3365 * If set, the activity will not be launched if it is already running
3366 * at the top of the history stack.
3367 */
3368 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3369 /**
3370 * If set, this activity will become the start of a new task on this
3371 * history stack. A task (from the activity that started it to the
3372 * next task activity) defines an atomic group of activities that the
3373 * user can move to. Tasks can be moved to the foreground and background;
3374 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003375 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003376 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3377 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003378 *
3379 * <p>This flag is generally used by activities that want
3380 * to present a "launcher" style behavior: they give the user a list of
3381 * separate things that can be done, which otherwise run completely
3382 * independently of the activity launching them.
3383 *
3384 * <p>When using this flag, if a task is already running for the activity
3385 * you are now starting, then a new activity will not be started; instead,
3386 * the current task will simply be brought to the front of the screen with
3387 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3388 * to disable this behavior.
3389 *
3390 * <p>This flag can not be used when the caller is requesting a result from
3391 * the activity being launched.
3392 */
3393 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3394 /**
3395 * <strong>Do not use this flag unless you are implementing your own
3396 * top-level application launcher.</strong> Used in conjunction with
3397 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3398 * behavior of bringing an existing task to the foreground. When set,
3399 * a new task is <em>always</em> started to host the Activity for the
3400 * Intent, regardless of whether there is already an existing task running
3401 * the same thing.
3402 *
3403 * <p><strong>Because the default system does not include graphical task management,
3404 * you should not use this flag unless you provide some way for a user to
3405 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003406 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003407 * <p>This flag is ignored if
3408 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3409 *
Scott Main7aee61f2011-02-08 11:25:01 -08003410 * <p>See
3411 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3412 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003413 */
3414 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3415 /**
3416 * If set, and the activity being launched is already running in the
3417 * current task, then instead of launching a new instance of that activity,
3418 * all of the other activities on top of it will be closed and this Intent
3419 * will be delivered to the (now on top) old activity as a new Intent.
3420 *
3421 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3422 * If D calls startActivity() with an Intent that resolves to the component
3423 * of activity B, then C and D will be finished and B receive the given
3424 * Intent, resulting in the stack now being: A, B.
3425 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003426 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003427 * either receive the new intent you are starting here in its
3428 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003429 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003430 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3431 * the same intent, then it will be finished and re-created; for all other
3432 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3433 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003434 *
3435 * <p>This launch mode can also be used to good effect in conjunction with
3436 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3437 * of a task, it will bring any currently running instance of that task
3438 * to the foreground, and then clear it to its root state. This is
3439 * especially useful, for example, when launching an activity from the
3440 * notification manager.
3441 *
Scott Main7aee61f2011-02-08 11:25:01 -08003442 * <p>See
3443 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3444 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003445 */
3446 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3447 /**
3448 * If set and this intent is being used to launch a new activity from an
3449 * existing one, then the reply target of the existing activity will be
3450 * transfered to the new activity. This way the new activity can call
3451 * {@link android.app.Activity#setResult} and have that result sent back to
3452 * the reply target of the original activity.
3453 */
3454 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3455 /**
3456 * If set and this intent is being used to launch a new activity from an
3457 * existing one, the current activity will not be counted as the top
3458 * activity for deciding whether the new intent should be delivered to
3459 * the top instead of starting a new one. The previous activity will
3460 * be used as the top, with the assumption being that the current activity
3461 * will finish itself immediately.
3462 */
3463 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3464 /**
3465 * If set, the new activity is not kept in the list of recently launched
3466 * activities.
3467 */
3468 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3469 /**
3470 * This flag is not normally set by application code, but set for you by
3471 * the system as described in the
3472 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3473 * launchMode} documentation for the singleTask mode.
3474 */
3475 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3476 /**
3477 * If set, and this activity is either being started in a new task or
3478 * bringing to the top an existing task, then it will be launched as
3479 * the front door of the task. This will result in the application of
3480 * any affinities needed to have that task in the proper state (either
3481 * moving activities to or from it), or simply resetting that task to
3482 * its initial state if needed.
3483 */
3484 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3485 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003486 * This flag is not normally set by application code, but set for you by
3487 * the system if this activity is being launched from history
3488 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003489 */
3490 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003491 /**
3492 * If set, this marks a point in the task's activity stack that should
3493 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003494 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003495 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3496 * the user re-launching it from home), this activity and all on top of
3497 * it will be finished so that the user does not return to them, but
3498 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003499 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003500 * <p>This is useful for cases where you have a logical break in your
3501 * application. For example, an e-mail application may have a command
3502 * to view an attachment, which launches an image view activity to
3503 * display it. This activity should be part of the e-mail application's
3504 * task, since it is a part of the task the user is involved in. However,
3505 * if the user leaves that task, and later selects the e-mail app from
3506 * home, we may like them to return to the conversation they were
3507 * viewing, not the picture attachment, since that is confusing. By
3508 * setting this flag when launching the image viewer, that viewer and
3509 * any activities it starts will be removed the next time the user returns
3510 * to mail.
3511 */
3512 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003513 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003514 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003515 * callback from occurring on the current frontmost activity before it is
3516 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003517 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003518 * <p>Typically, an activity can rely on that callback to indicate that an
3519 * explicit user action has caused their activity to be moved out of the
3520 * foreground. The callback marks an appropriate point in the activity's
3521 * lifecycle for it to dismiss any notifications that it intends to display
3522 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003523 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003524 * <p>If an activity is ever started via any non-user-driven events such as
3525 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3526 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003527 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003528 */
3529 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003530 /**
3531 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3532 * this flag will cause the launched activity to be brought to the front of its
3533 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003534 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003535 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3536 * If D calls startActivity() with an Intent that resolves to the component
3537 * of activity B, then B will be brought to the front of the history stack,
3538 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003539 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003540 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003541 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003542 */
3543 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003544 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003545 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3546 * this flag will prevent the system from applying an activity transition
3547 * animation to go to the next activity state. This doesn't mean an
3548 * animation will never run -- if another activity change happens that doesn't
3549 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003550 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003551 * when you are going to do a series of activity operations but the
3552 * animation seen by the user shouldn't be driven by the first activity
3553 * change but rather a later one.
3554 */
3555 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3556 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003557 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3558 * this flag will cause any existing task that would be associated with the
3559 * activity to be cleared before the activity is started. That is, the activity
3560 * becomes the new root of an otherwise empty task, and any old activities
3561 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3562 */
3563 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3564 /**
3565 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3566 * this flag will cause a newly launching task to be placed on top of the current
3567 * home activity task (if there is one). That is, pressing back from the task
3568 * will always return the user to home even if that was not the last activity they
3569 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3570 */
3571 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3572 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003573 * If set, when sending a broadcast only registered receivers will be
3574 * called -- no BroadcastReceiver components will be launched.
3575 */
3576 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003577 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003578 * If set, when sending a broadcast the new broadcast will replace
3579 * any existing pending broadcast that matches it. Matching is defined
3580 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3581 * true for the intents of the two broadcasts. When a match is found,
3582 * the new broadcast (and receivers associated with it) will replace the
3583 * existing one in the pending broadcast list, remaining at the same
3584 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003585 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003586 * <p>This flag is most typically used with sticky broadcasts, which
3587 * only care about delivering the most recent values of the broadcast
3588 * to their receivers.
3589 */
3590 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3591 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003592 * If set, when sending a broadcast the recipient is allowed to run at
3593 * foreground priority, with a shorter timeout interval. During normal
3594 * broadcasts the receivers are not automatically hoisted out of the
3595 * background priority class.
3596 */
3597 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3598 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003599 * If set, when sending a broadcast <i>before boot has completed</i> only
3600 * registered receivers will be called -- no BroadcastReceiver components
3601 * will be launched. Sticky intent state will be recorded properly even
3602 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3603 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003604 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003605 * <p>This flag is only for use by system sevices as a convenience to
3606 * avoid having to implement a more complex mechanism around detection
3607 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003608 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003609 * @hide
3610 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003611 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003612 /**
3613 * Set when this broadcast is for a boot upgrade, a special mode that
3614 * allows the broadcast to be sent before the system is ready and launches
3615 * the app process with no providers running in it.
3616 * @hide
3617 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003618 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003619
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003620 /**
3621 * @hide Flags that can't be changed with PendingIntent.
3622 */
3623 public static final int IMMUTABLE_FLAGS =
3624 FLAG_GRANT_READ_URI_PERMISSION
3625 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003626
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003627 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003628 // ---------------------------------------------------------------------
3629 // toUri() and parseUri() options.
3630
3631 /**
3632 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3633 * always has the "intent:" scheme. This syntax can be used when you want
3634 * to later disambiguate between URIs that are intended to describe an
3635 * Intent vs. all others that should be treated as raw URIs. When used
3636 * with {@link #parseUri}, any other scheme will result in a generic
3637 * VIEW action for that raw URI.
3638 */
3639 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003640
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003641 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003642
3643 private String mAction;
3644 private Uri mData;
3645 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003646 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003647 private ComponentName mComponent;
3648 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003649 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003650 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003651 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003652 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003653 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003654
3655 // ---------------------------------------------------------------------
3656
3657 /**
3658 * Create an empty intent.
3659 */
3660 public Intent() {
3661 }
3662
3663 /**
3664 * Copy constructor.
3665 */
3666 public Intent(Intent o) {
3667 this.mAction = o.mAction;
3668 this.mData = o.mData;
3669 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003670 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003671 this.mComponent = o.mComponent;
3672 this.mFlags = o.mFlags;
3673 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003674 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003675 }
3676 if (o.mExtras != null) {
3677 this.mExtras = new Bundle(o.mExtras);
3678 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003679 if (o.mSourceBounds != null) {
3680 this.mSourceBounds = new Rect(o.mSourceBounds);
3681 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003682 if (o.mSelector != null) {
3683 this.mSelector = new Intent(o.mSelector);
3684 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003685 if (o.mClipData != null) {
3686 this.mClipData = new ClipData(o.mClipData);
3687 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003688 }
3689
3690 @Override
3691 public Object clone() {
3692 return new Intent(this);
3693 }
3694
3695 private Intent(Intent o, boolean all) {
3696 this.mAction = o.mAction;
3697 this.mData = o.mData;
3698 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003699 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003700 this.mComponent = o.mComponent;
3701 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003702 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003703 }
3704 }
3705
3706 /**
3707 * Make a clone of only the parts of the Intent that are relevant for
3708 * filter matching: the action, data, type, component, and categories.
3709 */
3710 public Intent cloneFilter() {
3711 return new Intent(this, false);
3712 }
3713
3714 /**
3715 * Create an intent with a given action. All other fields (data, type,
3716 * class) are null. Note that the action <em>must</em> be in a
3717 * namespace because Intents are used globally in the system -- for
3718 * example the system VIEW action is android.intent.action.VIEW; an
3719 * application's custom action would be something like
3720 * com.google.app.myapp.CUSTOM_ACTION.
3721 *
3722 * @param action The Intent action, such as ACTION_VIEW.
3723 */
3724 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003725 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003726 }
3727
3728 /**
3729 * Create an intent with a given action and for a given data url. Note
3730 * that the action <em>must</em> be in a namespace because Intents are
3731 * used globally in the system -- for example the system VIEW action is
3732 * android.intent.action.VIEW; an application's custom action would be
3733 * something like com.google.app.myapp.CUSTOM_ACTION.
3734 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003735 * <p><em>Note: scheme and host name matching in the Android framework is
3736 * case-sensitive, unlike the formal RFC. As a result,
3737 * you should always ensure that you write your Uri with these elements
3738 * using lower case letters, and normalize any Uris you receive from
3739 * outside of Android to ensure the scheme and host is lower case.</em></p>
3740 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003741 * @param action The Intent action, such as ACTION_VIEW.
3742 * @param uri The Intent data URI.
3743 */
3744 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003745 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003746 mData = uri;
3747 }
3748
3749 /**
3750 * Create an intent for a specific component. All other fields (action, data,
3751 * type, class) are null, though they can be modified later with explicit
3752 * calls. This provides a convenient way to create an intent that is
3753 * intended to execute a hard-coded class name, rather than relying on the
3754 * system to find an appropriate class for you; see {@link #setComponent}
3755 * for more information on the repercussions of this.
3756 *
3757 * @param packageContext A Context of the application package implementing
3758 * this class.
3759 * @param cls The component class that is to be used for the intent.
3760 *
3761 * @see #setClass
3762 * @see #setComponent
3763 * @see #Intent(String, android.net.Uri , Context, Class)
3764 */
3765 public Intent(Context packageContext, Class<?> cls) {
3766 mComponent = new ComponentName(packageContext, cls);
3767 }
3768
3769 /**
3770 * Create an intent for a specific component with a specified action and data.
3771 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3772 * construct the Intent and then calling {@link #setClass} to set its
3773 * class.
3774 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003775 * <p><em>Note: scheme and host name matching in the Android framework is
3776 * case-sensitive, unlike the formal RFC. As a result,
3777 * you should always ensure that you write your Uri with these elements
3778 * using lower case letters, and normalize any Uris you receive from
3779 * outside of Android to ensure the scheme and host is lower case.</em></p>
3780 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003781 * @param action The Intent action, such as ACTION_VIEW.
3782 * @param uri The Intent data URI.
3783 * @param packageContext A Context of the application package implementing
3784 * this class.
3785 * @param cls The component class that is to be used for the intent.
3786 *
3787 * @see #Intent(String, android.net.Uri)
3788 * @see #Intent(Context, Class)
3789 * @see #setClass
3790 * @see #setComponent
3791 */
3792 public Intent(String action, Uri uri,
3793 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003794 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003795 mData = uri;
3796 mComponent = new ComponentName(packageContext, cls);
3797 }
3798
3799 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003800 * Create an intent to launch the main (root) activity of a task. This
3801 * is the Intent that is started when the application's is launched from
3802 * Home. For anything else that wants to launch an application in the
3803 * same way, it is important that they use an Intent structured the same
3804 * way, and can use this function to ensure this is the case.
3805 *
3806 * <p>The returned Intent has the given Activity component as its explicit
3807 * component, {@link #ACTION_MAIN} as its action, and includes the
3808 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3809 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3810 * to do that through {@link #addFlags(int)} on the returned Intent.
3811 *
3812 * @param mainActivity The main activity component that this Intent will
3813 * launch.
3814 * @return Returns a newly created Intent that can be used to launch the
3815 * activity as a main application entry.
3816 *
3817 * @see #setClass
3818 * @see #setComponent
3819 */
3820 public static Intent makeMainActivity(ComponentName mainActivity) {
3821 Intent intent = new Intent(ACTION_MAIN);
3822 intent.setComponent(mainActivity);
3823 intent.addCategory(CATEGORY_LAUNCHER);
3824 return intent;
3825 }
3826
3827 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003828 * Make an Intent for the main activity of an application, without
3829 * specifying a specific activity to run but giving a selector to find
3830 * the activity. This results in a final Intent that is structured
3831 * the same as when the application is launched from
3832 * Home. For anything else that wants to launch an application in the
3833 * same way, it is important that they use an Intent structured the same
3834 * way, and can use this function to ensure this is the case.
3835 *
3836 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3837 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3838 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3839 * to do that through {@link #addFlags(int)} on the returned Intent.
3840 *
3841 * @param selectorAction The action name of the Intent's selector.
3842 * @param selectorCategory The name of a category to add to the Intent's
3843 * selector.
3844 * @return Returns a newly created Intent that can be used to launch the
3845 * activity as a main application entry.
3846 *
3847 * @see #setSelector(Intent)
3848 */
3849 public static Intent makeMainSelectorActivity(String selectorAction,
3850 String selectorCategory) {
3851 Intent intent = new Intent(ACTION_MAIN);
3852 intent.addCategory(CATEGORY_LAUNCHER);
3853 Intent selector = new Intent();
3854 selector.setAction(selectorAction);
3855 selector.addCategory(selectorCategory);
3856 intent.setSelector(selector);
3857 return intent;
3858 }
3859
3860 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003861 * Make an Intent that can be used to re-launch an application's task
3862 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3863 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3864 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3865 *
3866 * @param mainActivity The activity component that is the root of the
3867 * task; this is the activity that has been published in the application's
3868 * manifest as the main launcher icon.
3869 *
3870 * @return Returns a newly created Intent that can be used to relaunch the
3871 * activity's task in its root state.
3872 */
3873 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3874 Intent intent = makeMainActivity(mainActivity);
3875 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3876 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3877 return intent;
3878 }
3879
3880 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003881 * Call {@link #parseUri} with 0 flags.
3882 * @deprecated Use {@link #parseUri} instead.
3883 */
3884 @Deprecated
3885 public static Intent getIntent(String uri) throws URISyntaxException {
3886 return parseUri(uri, 0);
3887 }
Tom Taylord4a47292009-12-21 13:59:18 -08003888
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003889 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003890 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003891 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003892 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003893 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003894 *
3895 * <p>The URI given here must not be relative -- that is, it must include
3896 * the scheme and full path.
3897 *
3898 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003899 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003900 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003901 *
3902 * @return Intent The newly created Intent object.
3903 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003904 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3905 * it bad (as parsed by the Uri class) or the Intent data within the
3906 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003907 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003908 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003909 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003910 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003911 int i = 0;
3912 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003913 // Validate intent scheme for if requested.
3914 if ((flags&URI_INTENT_SCHEME) != 0) {
3915 if (!uri.startsWith("intent:")) {
3916 Intent intent = new Intent(ACTION_VIEW);
3917 try {
3918 intent.setData(Uri.parse(uri));
3919 } catch (IllegalArgumentException e) {
3920 throw new URISyntaxException(uri, e.getMessage());
3921 }
3922 return intent;
3923 }
3924 }
Tom Taylord4a47292009-12-21 13:59:18 -08003925
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003926 // simple case
3927 i = uri.lastIndexOf("#");
3928 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3929
3930 // old format Intent URI
3931 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003932
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003933 // new format
3934 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003935 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003936
3937 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003938 String data = i >= 0 ? uri.substring(0, i) : null;
3939 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003940 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003941
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003942 // loop over contents of Intent, all name=value;
3943 while (!uri.startsWith("end", i)) {
3944 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003945 if (eq < 0) eq = i-1;
3946 int semi = uri.indexOf(';', i);
3947 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003948
3949 // action
3950 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003951 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003952 }
3953
3954 // categories
3955 else if (uri.startsWith("category=", i)) {
3956 intent.addCategory(value);
3957 }
3958
3959 // type
3960 else if (uri.startsWith("type=", i)) {
3961 intent.mType = value;
3962 }
3963
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003964 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003965 else if (uri.startsWith("launchFlags=", i)) {
3966 intent.mFlags = Integer.decode(value).intValue();
3967 }
3968
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003969 // package
3970 else if (uri.startsWith("package=", i)) {
3971 intent.mPackage = value;
3972 }
3973
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003974 // component
3975 else if (uri.startsWith("component=", i)) {
3976 intent.mComponent = ComponentName.unflattenFromString(value);
3977 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003978
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003979 // scheme
3980 else if (uri.startsWith("scheme=", i)) {
3981 scheme = value;
3982 }
3983
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003984 // source bounds
3985 else if (uri.startsWith("sourceBounds=", i)) {
3986 intent.mSourceBounds = Rect.unflattenFromString(value);
3987 }
3988
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003989 // selector
3990 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3991 intent = new Intent();
3992 }
3993
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003994 // extra
3995 else {
3996 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003997 // create Bundle if it doesn't already exist
3998 if (intent.mExtras == null) intent.mExtras = new Bundle();
3999 Bundle b = intent.mExtras;
4000 // add EXTRA
4001 if (uri.startsWith("S.", i)) b.putString(key, value);
4002 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4003 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4004 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4005 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4006 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4007 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4008 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4009 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4010 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4011 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004012
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004013 // move to the next item
4014 i = semi + 1;
4015 }
4016
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004017 if (intent != baseIntent) {
4018 // The Intent had a selector; fix it up.
4019 baseIntent.setSelector(intent);
4020 intent = baseIntent;
4021 }
4022
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004023 if (data != null) {
4024 if (data.startsWith("intent:")) {
4025 data = data.substring(7);
4026 if (scheme != null) {
4027 data = scheme + ':' + data;
4028 }
4029 }
Tom Taylord4a47292009-12-21 13:59:18 -08004030
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004031 if (data.length() > 0) {
4032 try {
4033 intent.mData = Uri.parse(data);
4034 } catch (IllegalArgumentException e) {
4035 throw new URISyntaxException(uri, e.getMessage());
4036 }
4037 }
4038 }
Tom Taylord4a47292009-12-21 13:59:18 -08004039
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004040 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004041
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004042 } catch (IndexOutOfBoundsException e) {
4043 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4044 }
4045 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004046
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004047 public static Intent getIntentOld(String uri) throws URISyntaxException {
4048 Intent intent;
4049
4050 int i = uri.lastIndexOf('#');
4051 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004052 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004053 final int intentFragmentStart = i;
4054 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004055
4056 i++;
4057
4058 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004059 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004060 i += 7;
4061 int j = uri.indexOf(')', i);
4062 action = uri.substring(i, j);
4063 i = j + 1;
4064 }
4065
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004066 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004067
4068 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004069 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004070 i += 11;
4071 int j = uri.indexOf(')', i);
4072 while (i < j) {
4073 int sep = uri.indexOf('!', i);
4074 if (sep < 0) sep = j;
4075 if (i < sep) {
4076 intent.addCategory(uri.substring(i, sep));
4077 }
4078 i = sep + 1;
4079 }
4080 i = j + 1;
4081 }
4082
4083 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004084 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004085 i += 5;
4086 int j = uri.indexOf(')', i);
4087 intent.mType = uri.substring(i, j);
4088 i = j + 1;
4089 }
4090
4091 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004092 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004093 i += 12;
4094 int j = uri.indexOf(')', i);
4095 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4096 i = j + 1;
4097 }
4098
4099 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004100 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004101 i += 10;
4102 int j = uri.indexOf(')', i);
4103 int sep = uri.indexOf('!', i);
4104 if (sep >= 0 && sep < j) {
4105 String pkg = uri.substring(i, sep);
4106 String cls = uri.substring(sep + 1, j);
4107 intent.mComponent = new ComponentName(pkg, cls);
4108 }
4109 i = j + 1;
4110 }
4111
4112 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004113 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004114 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004115
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004116 final int closeParen = uri.indexOf(')', i);
4117 if (closeParen == -1) throw new URISyntaxException(uri,
4118 "EXTRA missing trailing ')'", i);
4119
4120 while (i < closeParen) {
4121 // fetch the key value
4122 int j = uri.indexOf('=', i);
4123 if (j <= i + 1 || i >= closeParen) {
4124 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4125 }
4126 char type = uri.charAt(i);
4127 i++;
4128 String key = uri.substring(i, j);
4129 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004130
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004131 // get type-value
4132 j = uri.indexOf('!', i);
4133 if (j == -1 || j >= closeParen) j = closeParen;
4134 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4135 String value = uri.substring(i, j);
4136 i = j;
4137
4138 // create Bundle if it doesn't already exist
4139 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004140
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004141 // add item to bundle
4142 try {
4143 switch (type) {
4144 case 'S':
4145 intent.mExtras.putString(key, Uri.decode(value));
4146 break;
4147 case 'B':
4148 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4149 break;
4150 case 'b':
4151 intent.mExtras.putByte(key, Byte.parseByte(value));
4152 break;
4153 case 'c':
4154 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4155 break;
4156 case 'd':
4157 intent.mExtras.putDouble(key, Double.parseDouble(value));
4158 break;
4159 case 'f':
4160 intent.mExtras.putFloat(key, Float.parseFloat(value));
4161 break;
4162 case 'i':
4163 intent.mExtras.putInt(key, Integer.parseInt(value));
4164 break;
4165 case 'l':
4166 intent.mExtras.putLong(key, Long.parseLong(value));
4167 break;
4168 case 's':
4169 intent.mExtras.putShort(key, Short.parseShort(value));
4170 break;
4171 default:
4172 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4173 }
4174 } catch (NumberFormatException e) {
4175 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4176 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004177
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004178 char ch = uri.charAt(i);
4179 if (ch == ')') break;
4180 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4181 i++;
4182 }
4183 }
4184
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004185 if (isIntentFragment) {
4186 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4187 } else {
4188 intent.mData = Uri.parse(uri);
4189 }
Tom Taylord4a47292009-12-21 13:59:18 -08004190
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004191 if (intent.mAction == null) {
4192 // By default, if no action is specified, then use VIEW.
4193 intent.mAction = ACTION_VIEW;
4194 }
4195
4196 } else {
4197 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4198 }
4199
4200 return intent;
4201 }
4202
4203 /**
4204 * Retrieve the general action to be performed, such as
4205 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4206 * the information in the intent should be interpreted -- most importantly,
4207 * what to do with the data returned by {@link #getData}.
4208 *
4209 * @return The action of this intent or null if none is specified.
4210 *
4211 * @see #setAction
4212 */
4213 public String getAction() {
4214 return mAction;
4215 }
4216
4217 /**
4218 * Retrieve data this intent is operating on. This URI specifies the name
4219 * of the data; often it uses the content: scheme, specifying data in a
4220 * content provider. Other schemes may be handled by specific activities,
4221 * such as http: by the web browser.
4222 *
4223 * @return The URI of the data this intent is targeting or null.
4224 *
4225 * @see #getScheme
4226 * @see #setData
4227 */
4228 public Uri getData() {
4229 return mData;
4230 }
4231
4232 /**
4233 * The same as {@link #getData()}, but returns the URI as an encoded
4234 * String.
4235 */
4236 public String getDataString() {
4237 return mData != null ? mData.toString() : null;
4238 }
4239
4240 /**
4241 * Return the scheme portion of the intent's data. If the data is null or
4242 * does not include a scheme, null is returned. Otherwise, the scheme
4243 * prefix without the final ':' is returned, i.e. "http".
4244 *
4245 * <p>This is the same as calling getData().getScheme() (and checking for
4246 * null data).
4247 *
4248 * @return The scheme of this intent.
4249 *
4250 * @see #getData
4251 */
4252 public String getScheme() {
4253 return mData != null ? mData.getScheme() : null;
4254 }
4255
4256 /**
4257 * Retrieve any explicit MIME type included in the intent. This is usually
4258 * null, as the type is determined by the intent data.
4259 *
4260 * @return If a type was manually set, it is returned; else null is
4261 * returned.
4262 *
4263 * @see #resolveType(ContentResolver)
4264 * @see #setType
4265 */
4266 public String getType() {
4267 return mType;
4268 }
4269
4270 /**
4271 * Return the MIME data type of this intent. If the type field is
4272 * explicitly set, that is simply returned. Otherwise, if the data is set,
4273 * the type of that data is returned. If neither fields are set, a null is
4274 * returned.
4275 *
4276 * @return The MIME type of this intent.
4277 *
4278 * @see #getType
4279 * @see #resolveType(ContentResolver)
4280 */
4281 public String resolveType(Context context) {
4282 return resolveType(context.getContentResolver());
4283 }
4284
4285 /**
4286 * Return the MIME data type of this intent. If the type field is
4287 * explicitly set, that is simply returned. Otherwise, if the data is set,
4288 * the type of that data is returned. If neither fields are set, a null is
4289 * returned.
4290 *
4291 * @param resolver A ContentResolver that can be used to determine the MIME
4292 * type of the intent's data.
4293 *
4294 * @return The MIME type of this intent.
4295 *
4296 * @see #getType
4297 * @see #resolveType(Context)
4298 */
4299 public String resolveType(ContentResolver resolver) {
4300 if (mType != null) {
4301 return mType;
4302 }
4303 if (mData != null) {
4304 if ("content".equals(mData.getScheme())) {
4305 return resolver.getType(mData);
4306 }
4307 }
4308 return null;
4309 }
4310
4311 /**
4312 * Return the MIME data type of this intent, only if it will be needed for
4313 * intent resolution. This is not generally useful for application code;
4314 * it is used by the frameworks for communicating with back-end system
4315 * services.
4316 *
4317 * @param resolver A ContentResolver that can be used to determine the MIME
4318 * type of the intent's data.
4319 *
4320 * @return The MIME type of this intent, or null if it is unknown or not
4321 * needed.
4322 */
4323 public String resolveTypeIfNeeded(ContentResolver resolver) {
4324 if (mComponent != null) {
4325 return mType;
4326 }
4327 return resolveType(resolver);
4328 }
4329
4330 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004331 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004332 *
4333 * @param category The category to check.
4334 *
4335 * @return boolean True if the intent contains the category, else false.
4336 *
4337 * @see #getCategories
4338 * @see #addCategory
4339 */
4340 public boolean hasCategory(String category) {
4341 return mCategories != null && mCategories.contains(category);
4342 }
4343
4344 /**
4345 * Return the set of all categories in the intent. If there are no categories,
4346 * returns NULL.
4347 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004348 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004349 *
4350 * @see #hasCategory
4351 * @see #addCategory
4352 */
4353 public Set<String> getCategories() {
4354 return mCategories;
4355 }
4356
4357 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004358 * Return the specific selector associated with this Intent. If there is
4359 * none, returns null. See {@link #setSelector} for more information.
4360 *
4361 * @see #setSelector
4362 */
4363 public Intent getSelector() {
4364 return mSelector;
4365 }
4366
4367 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004368 * Return the {@link ClipData} associated with this Intent. If there is
4369 * none, returns null. See {@link #setClipData} for more information.
4370 *
4371 * @see #setClipData;
4372 */
4373 public ClipData getClipData() {
4374 return mClipData;
4375 }
4376
4377 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004378 * Sets the ClassLoader that will be used when unmarshalling
4379 * any Parcelable values from the extras of this Intent.
4380 *
4381 * @param loader a ClassLoader, or null to use the default loader
4382 * at the time of unmarshalling.
4383 */
4384 public void setExtrasClassLoader(ClassLoader loader) {
4385 if (mExtras != null) {
4386 mExtras.setClassLoader(loader);
4387 }
4388 }
4389
4390 /**
4391 * Returns true if an extra value is associated with the given name.
4392 * @param name the extra's name
4393 * @return true if the given extra is present.
4394 */
4395 public boolean hasExtra(String name) {
4396 return mExtras != null && mExtras.containsKey(name);
4397 }
4398
4399 /**
4400 * Returns true if the Intent's extras contain a parcelled file descriptor.
4401 * @return true if the Intent contains a parcelled file descriptor.
4402 */
4403 public boolean hasFileDescriptors() {
4404 return mExtras != null && mExtras.hasFileDescriptors();
4405 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004406
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004407 /** @hide */
4408 public void setAllowFds(boolean allowFds) {
4409 if (mExtras != null) {
4410 mExtras.setAllowFds(allowFds);
4411 }
4412 }
4413
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004414 /**
4415 * Retrieve extended data from the intent.
4416 *
4417 * @param name The name of the desired item.
4418 *
4419 * @return the value of an item that previously added with putExtra()
4420 * or null if none was found.
4421 *
4422 * @deprecated
4423 * @hide
4424 */
4425 @Deprecated
4426 public Object getExtra(String name) {
4427 return getExtra(name, null);
4428 }
4429
4430 /**
4431 * Retrieve extended data from the intent.
4432 *
4433 * @param name The name of the desired item.
4434 * @param defaultValue the value to be returned if no value of the desired
4435 * type is stored with the given name.
4436 *
4437 * @return the value of an item that previously added with putExtra()
4438 * or the default value if none was found.
4439 *
4440 * @see #putExtra(String, boolean)
4441 */
4442 public boolean getBooleanExtra(String name, boolean defaultValue) {
4443 return mExtras == null ? defaultValue :
4444 mExtras.getBoolean(name, defaultValue);
4445 }
4446
4447 /**
4448 * Retrieve extended data from the intent.
4449 *
4450 * @param name The name of the desired item.
4451 * @param defaultValue the value to be returned if no value of the desired
4452 * type is stored with the given name.
4453 *
4454 * @return the value of an item that previously added with putExtra()
4455 * or the default value if none was found.
4456 *
4457 * @see #putExtra(String, byte)
4458 */
4459 public byte getByteExtra(String name, byte defaultValue) {
4460 return mExtras == null ? defaultValue :
4461 mExtras.getByte(name, defaultValue);
4462 }
4463
4464 /**
4465 * Retrieve extended data from the intent.
4466 *
4467 * @param name The name of the desired item.
4468 * @param defaultValue the value to be returned if no value of the desired
4469 * type is stored with the given name.
4470 *
4471 * @return the value of an item that previously added with putExtra()
4472 * or the default value if none was found.
4473 *
4474 * @see #putExtra(String, short)
4475 */
4476 public short getShortExtra(String name, short defaultValue) {
4477 return mExtras == null ? defaultValue :
4478 mExtras.getShort(name, defaultValue);
4479 }
4480
4481 /**
4482 * Retrieve extended data from the intent.
4483 *
4484 * @param name The name of the desired item.
4485 * @param defaultValue the value to be returned if no value of the desired
4486 * type is stored with the given name.
4487 *
4488 * @return the value of an item that previously added with putExtra()
4489 * or the default value if none was found.
4490 *
4491 * @see #putExtra(String, char)
4492 */
4493 public char getCharExtra(String name, char defaultValue) {
4494 return mExtras == null ? defaultValue :
4495 mExtras.getChar(name, defaultValue);
4496 }
4497
4498 /**
4499 * Retrieve extended data from the intent.
4500 *
4501 * @param name The name of the desired item.
4502 * @param defaultValue the value to be returned if no value of the desired
4503 * type is stored with the given name.
4504 *
4505 * @return the value of an item that previously added with putExtra()
4506 * or the default value if none was found.
4507 *
4508 * @see #putExtra(String, int)
4509 */
4510 public int getIntExtra(String name, int defaultValue) {
4511 return mExtras == null ? defaultValue :
4512 mExtras.getInt(name, defaultValue);
4513 }
4514
4515 /**
4516 * Retrieve extended data from the intent.
4517 *
4518 * @param name The name of the desired item.
4519 * @param defaultValue the value to be returned if no value of the desired
4520 * type is stored with the given name.
4521 *
4522 * @return the value of an item that previously added with putExtra()
4523 * or the default value if none was found.
4524 *
4525 * @see #putExtra(String, long)
4526 */
4527 public long getLongExtra(String name, long defaultValue) {
4528 return mExtras == null ? defaultValue :
4529 mExtras.getLong(name, defaultValue);
4530 }
4531
4532 /**
4533 * Retrieve extended data from the intent.
4534 *
4535 * @param name The name of the desired item.
4536 * @param defaultValue the value to be returned if no value of the desired
4537 * type is stored with the given name.
4538 *
4539 * @return the value of an item that previously added with putExtra(),
4540 * or the default value if no such item is present
4541 *
4542 * @see #putExtra(String, float)
4543 */
4544 public float getFloatExtra(String name, float defaultValue) {
4545 return mExtras == null ? defaultValue :
4546 mExtras.getFloat(name, defaultValue);
4547 }
4548
4549 /**
4550 * Retrieve extended data from the intent.
4551 *
4552 * @param name The name of the desired item.
4553 * @param defaultValue the value to be returned if no value of the desired
4554 * type is stored with the given name.
4555 *
4556 * @return the value of an item that previously added with putExtra()
4557 * or the default value if none was found.
4558 *
4559 * @see #putExtra(String, double)
4560 */
4561 public double getDoubleExtra(String name, double defaultValue) {
4562 return mExtras == null ? defaultValue :
4563 mExtras.getDouble(name, defaultValue);
4564 }
4565
4566 /**
4567 * Retrieve extended data from the intent.
4568 *
4569 * @param name The name of the desired item.
4570 *
4571 * @return the value of an item that previously added with putExtra()
4572 * or null if no String value was found.
4573 *
4574 * @see #putExtra(String, String)
4575 */
4576 public String getStringExtra(String name) {
4577 return mExtras == null ? null : mExtras.getString(name);
4578 }
4579
4580 /**
4581 * Retrieve extended data from the intent.
4582 *
4583 * @param name The name of the desired item.
4584 *
4585 * @return the value of an item that previously added with putExtra()
4586 * or null if no CharSequence value was found.
4587 *
4588 * @see #putExtra(String, CharSequence)
4589 */
4590 public CharSequence getCharSequenceExtra(String name) {
4591 return mExtras == null ? null : mExtras.getCharSequence(name);
4592 }
4593
4594 /**
4595 * Retrieve extended data from the intent.
4596 *
4597 * @param name The name of the desired item.
4598 *
4599 * @return the value of an item that previously added with putExtra()
4600 * or null if no Parcelable value was found.
4601 *
4602 * @see #putExtra(String, Parcelable)
4603 */
4604 public <T extends Parcelable> T getParcelableExtra(String name) {
4605 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4606 }
4607
4608 /**
4609 * Retrieve extended data from the intent.
4610 *
4611 * @param name The name of the desired item.
4612 *
4613 * @return the value of an item that previously added with putExtra()
4614 * or null if no Parcelable[] value was found.
4615 *
4616 * @see #putExtra(String, Parcelable[])
4617 */
4618 public Parcelable[] getParcelableArrayExtra(String name) {
4619 return mExtras == null ? null : mExtras.getParcelableArray(name);
4620 }
4621
4622 /**
4623 * Retrieve extended data from the intent.
4624 *
4625 * @param name The name of the desired item.
4626 *
4627 * @return the value of an item that previously added with putExtra()
4628 * or null if no ArrayList<Parcelable> value was found.
4629 *
4630 * @see #putParcelableArrayListExtra(String, ArrayList)
4631 */
4632 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4633 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4634 }
4635
4636 /**
4637 * Retrieve extended data from the intent.
4638 *
4639 * @param name The name of the desired item.
4640 *
4641 * @return the value of an item that previously added with putExtra()
4642 * or null if no Serializable value was found.
4643 *
4644 * @see #putExtra(String, Serializable)
4645 */
4646 public Serializable getSerializableExtra(String name) {
4647 return mExtras == null ? null : mExtras.getSerializable(name);
4648 }
4649
4650 /**
4651 * Retrieve extended data from the intent.
4652 *
4653 * @param name The name of the desired item.
4654 *
4655 * @return the value of an item that previously added with putExtra()
4656 * or null if no ArrayList<Integer> value was found.
4657 *
4658 * @see #putIntegerArrayListExtra(String, ArrayList)
4659 */
4660 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4661 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4662 }
4663
4664 /**
4665 * Retrieve extended data from the intent.
4666 *
4667 * @param name The name of the desired item.
4668 *
4669 * @return the value of an item that previously added with putExtra()
4670 * or null if no ArrayList<String> value was found.
4671 *
4672 * @see #putStringArrayListExtra(String, ArrayList)
4673 */
4674 public ArrayList<String> getStringArrayListExtra(String name) {
4675 return mExtras == null ? null : mExtras.getStringArrayList(name);
4676 }
4677
4678 /**
4679 * Retrieve extended data from the intent.
4680 *
4681 * @param name The name of the desired item.
4682 *
4683 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004684 * or null if no ArrayList<CharSequence> value was found.
4685 *
4686 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4687 */
4688 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4689 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4690 }
4691
4692 /**
4693 * Retrieve extended data from the intent.
4694 *
4695 * @param name The name of the desired item.
4696 *
4697 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004698 * or null if no boolean array value was found.
4699 *
4700 * @see #putExtra(String, boolean[])
4701 */
4702 public boolean[] getBooleanArrayExtra(String name) {
4703 return mExtras == null ? null : mExtras.getBooleanArray(name);
4704 }
4705
4706 /**
4707 * Retrieve extended data from the intent.
4708 *
4709 * @param name The name of the desired item.
4710 *
4711 * @return the value of an item that previously added with putExtra()
4712 * or null if no byte array value was found.
4713 *
4714 * @see #putExtra(String, byte[])
4715 */
4716 public byte[] getByteArrayExtra(String name) {
4717 return mExtras == null ? null : mExtras.getByteArray(name);
4718 }
4719
4720 /**
4721 * Retrieve extended data from the intent.
4722 *
4723 * @param name The name of the desired item.
4724 *
4725 * @return the value of an item that previously added with putExtra()
4726 * or null if no short array value was found.
4727 *
4728 * @see #putExtra(String, short[])
4729 */
4730 public short[] getShortArrayExtra(String name) {
4731 return mExtras == null ? null : mExtras.getShortArray(name);
4732 }
4733
4734 /**
4735 * Retrieve extended data from the intent.
4736 *
4737 * @param name The name of the desired item.
4738 *
4739 * @return the value of an item that previously added with putExtra()
4740 * or null if no char array value was found.
4741 *
4742 * @see #putExtra(String, char[])
4743 */
4744 public char[] getCharArrayExtra(String name) {
4745 return mExtras == null ? null : mExtras.getCharArray(name);
4746 }
4747
4748 /**
4749 * Retrieve extended data from the intent.
4750 *
4751 * @param name The name of the desired item.
4752 *
4753 * @return the value of an item that previously added with putExtra()
4754 * or null if no int array value was found.
4755 *
4756 * @see #putExtra(String, int[])
4757 */
4758 public int[] getIntArrayExtra(String name) {
4759 return mExtras == null ? null : mExtras.getIntArray(name);
4760 }
4761
4762 /**
4763 * Retrieve extended data from the intent.
4764 *
4765 * @param name The name of the desired item.
4766 *
4767 * @return the value of an item that previously added with putExtra()
4768 * or null if no long array value was found.
4769 *
4770 * @see #putExtra(String, long[])
4771 */
4772 public long[] getLongArrayExtra(String name) {
4773 return mExtras == null ? null : mExtras.getLongArray(name);
4774 }
4775
4776 /**
4777 * Retrieve extended data from the intent.
4778 *
4779 * @param name The name of the desired item.
4780 *
4781 * @return the value of an item that previously added with putExtra()
4782 * or null if no float array value was found.
4783 *
4784 * @see #putExtra(String, float[])
4785 */
4786 public float[] getFloatArrayExtra(String name) {
4787 return mExtras == null ? null : mExtras.getFloatArray(name);
4788 }
4789
4790 /**
4791 * Retrieve extended data from the intent.
4792 *
4793 * @param name The name of the desired item.
4794 *
4795 * @return the value of an item that previously added with putExtra()
4796 * or null if no double array value was found.
4797 *
4798 * @see #putExtra(String, double[])
4799 */
4800 public double[] getDoubleArrayExtra(String name) {
4801 return mExtras == null ? null : mExtras.getDoubleArray(name);
4802 }
4803
4804 /**
4805 * Retrieve extended data from the intent.
4806 *
4807 * @param name The name of the desired item.
4808 *
4809 * @return the value of an item that previously added with putExtra()
4810 * or null if no String array value was found.
4811 *
4812 * @see #putExtra(String, String[])
4813 */
4814 public String[] getStringArrayExtra(String name) {
4815 return mExtras == null ? null : mExtras.getStringArray(name);
4816 }
4817
4818 /**
4819 * Retrieve extended data from the intent.
4820 *
4821 * @param name The name of the desired item.
4822 *
4823 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004824 * or null if no CharSequence array value was found.
4825 *
4826 * @see #putExtra(String, CharSequence[])
4827 */
4828 public CharSequence[] getCharSequenceArrayExtra(String name) {
4829 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4830 }
4831
4832 /**
4833 * Retrieve extended data from the intent.
4834 *
4835 * @param name The name of the desired item.
4836 *
4837 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004838 * or null if no Bundle value was found.
4839 *
4840 * @see #putExtra(String, Bundle)
4841 */
4842 public Bundle getBundleExtra(String name) {
4843 return mExtras == null ? null : mExtras.getBundle(name);
4844 }
4845
4846 /**
4847 * Retrieve extended data from the intent.
4848 *
4849 * @param name The name of the desired item.
4850 *
4851 * @return the value of an item that previously added with putExtra()
4852 * or null if no IBinder value was found.
4853 *
4854 * @see #putExtra(String, IBinder)
4855 *
4856 * @deprecated
4857 * @hide
4858 */
4859 @Deprecated
4860 public IBinder getIBinderExtra(String name) {
4861 return mExtras == null ? null : mExtras.getIBinder(name);
4862 }
4863
4864 /**
4865 * Retrieve extended data from the intent.
4866 *
4867 * @param name The name of the desired item.
4868 * @param defaultValue The default value to return in case no item is
4869 * associated with the key 'name'
4870 *
4871 * @return the value of an item that previously added with putExtra()
4872 * or defaultValue if none was found.
4873 *
4874 * @see #putExtra
4875 *
4876 * @deprecated
4877 * @hide
4878 */
4879 @Deprecated
4880 public Object getExtra(String name, Object defaultValue) {
4881 Object result = defaultValue;
4882 if (mExtras != null) {
4883 Object result2 = mExtras.get(name);
4884 if (result2 != null) {
4885 result = result2;
4886 }
4887 }
4888
4889 return result;
4890 }
4891
4892 /**
4893 * Retrieves a map of extended data from the intent.
4894 *
4895 * @return the map of all extras previously added with putExtra(),
4896 * or null if none have been added.
4897 */
4898 public Bundle getExtras() {
4899 return (mExtras != null)
4900 ? new Bundle(mExtras)
4901 : null;
4902 }
4903
4904 /**
4905 * Retrieve any special flags associated with this intent. You will
4906 * normally just set them with {@link #setFlags} and let the system
4907 * take the appropriate action with them.
4908 *
4909 * @return int The currently set flags.
4910 *
4911 * @see #setFlags
4912 */
4913 public int getFlags() {
4914 return mFlags;
4915 }
4916
Dianne Hackborne7f97212011-02-24 14:40:20 -08004917 /** @hide */
4918 public boolean isExcludingStopped() {
4919 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4920 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4921 }
4922
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004923 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004924 * Retrieve the application package name this Intent is limited to. When
4925 * resolving an Intent, if non-null this limits the resolution to only
4926 * components in the given application package.
4927 *
4928 * @return The name of the application package for the Intent.
4929 *
4930 * @see #resolveActivity
4931 * @see #setPackage
4932 */
4933 public String getPackage() {
4934 return mPackage;
4935 }
4936
4937 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004938 * Retrieve the concrete component associated with the intent. When receiving
4939 * an intent, this is the component that was found to best handle it (that is,
4940 * yourself) and will always be non-null; in all other cases it will be
4941 * null unless explicitly set.
4942 *
4943 * @return The name of the application component to handle the intent.
4944 *
4945 * @see #resolveActivity
4946 * @see #setComponent
4947 */
4948 public ComponentName getComponent() {
4949 return mComponent;
4950 }
4951
4952 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004953 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4954 * used as a hint to the receiver for animations and the like. Null means that there
4955 * is no source bounds.
4956 */
4957 public Rect getSourceBounds() {
4958 return mSourceBounds;
4959 }
4960
4961 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004962 * Return the Activity component that should be used to handle this intent.
4963 * The appropriate component is determined based on the information in the
4964 * intent, evaluated as follows:
4965 *
4966 * <p>If {@link #getComponent} returns an explicit class, that is returned
4967 * without any further consideration.
4968 *
4969 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4970 * category to be considered.
4971 *
4972 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4973 * action.
4974 *
4975 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4976 * this type.
4977 *
4978 * <p>If {@link #addCategory} has added any categories, the activity must
4979 * handle ALL of the categories specified.
4980 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004981 * <p>If {@link #getPackage} is non-NULL, only activity components in
4982 * that application package will be considered.
4983 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004984 * <p>If there are no activities that satisfy all of these conditions, a
4985 * null string is returned.
4986 *
4987 * <p>If multiple activities are found to satisfy the intent, the one with
4988 * the highest priority will be used. If there are multiple activities
4989 * with the same priority, the system will either pick the best activity
4990 * based on user preference, or resolve to a system class that will allow
4991 * the user to pick an activity and forward from there.
4992 *
4993 * <p>This method is implemented simply by calling
4994 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4995 * true.</p>
4996 * <p> This API is called for you as part of starting an activity from an
4997 * intent. You do not normally need to call it yourself.</p>
4998 *
4999 * @param pm The package manager with which to resolve the Intent.
5000 *
5001 * @return Name of the component implementing an activity that can
5002 * display the intent.
5003 *
5004 * @see #setComponent
5005 * @see #getComponent
5006 * @see #resolveActivityInfo
5007 */
5008 public ComponentName resolveActivity(PackageManager pm) {
5009 if (mComponent != null) {
5010 return mComponent;
5011 }
5012
5013 ResolveInfo info = pm.resolveActivity(
5014 this, PackageManager.MATCH_DEFAULT_ONLY);
5015 if (info != null) {
5016 return new ComponentName(
5017 info.activityInfo.applicationInfo.packageName,
5018 info.activityInfo.name);
5019 }
5020
5021 return null;
5022 }
5023
5024 /**
5025 * Resolve the Intent into an {@link ActivityInfo}
5026 * describing the activity that should execute the intent. Resolution
5027 * follows the same rules as described for {@link #resolveActivity}, but
5028 * you get back the completely information about the resolved activity
5029 * instead of just its class name.
5030 *
5031 * @param pm The package manager with which to resolve the Intent.
5032 * @param flags Addition information to retrieve as per
5033 * {@link PackageManager#getActivityInfo(ComponentName, int)
5034 * PackageManager.getActivityInfo()}.
5035 *
5036 * @return PackageManager.ActivityInfo
5037 *
5038 * @see #resolveActivity
5039 */
5040 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5041 ActivityInfo ai = null;
5042 if (mComponent != null) {
5043 try {
5044 ai = pm.getActivityInfo(mComponent, flags);
5045 } catch (PackageManager.NameNotFoundException e) {
5046 // ignore
5047 }
5048 } else {
5049 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005050 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005051 if (info != null) {
5052 ai = info.activityInfo;
5053 }
5054 }
5055
5056 return ai;
5057 }
5058
5059 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005060 * Special function for use by the system to resolve service
5061 * intents to system apps. Throws an exception if there are
5062 * multiple potential matches to the Intent. Returns null if
5063 * there are no matches.
5064 * @hide
5065 */
5066 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5067 if (mComponent != null) {
5068 return mComponent;
5069 }
5070
5071 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5072 if (results == null) {
5073 return null;
5074 }
5075 ComponentName comp = null;
5076 for (int i=0; i<results.size(); i++) {
5077 ResolveInfo ri = results.get(i);
5078 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5079 continue;
5080 }
5081 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5082 ri.serviceInfo.name);
5083 if (comp != null) {
5084 throw new IllegalStateException("Multiple system services handle " + this
5085 + ": " + comp + ", " + foundComp);
5086 }
5087 comp = foundComp;
5088 }
5089 return comp;
5090 }
5091
5092 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005093 * Set the general action to be performed.
5094 *
5095 * @param action An action name, such as ACTION_VIEW. Application-specific
5096 * actions should be prefixed with the vendor's package name.
5097 *
5098 * @return Returns the same Intent object, for chaining multiple calls
5099 * into a single statement.
5100 *
5101 * @see #getAction
5102 */
5103 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005104 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005105 return this;
5106 }
5107
5108 /**
5109 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005110 * clears any type that was previously set by {@link #setType} or
5111 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005112 *
Nick Pellyccae4122012-01-09 14:12:58 -08005113 * <p><em>Note: scheme matching in the Android framework is
5114 * case-sensitive, unlike the formal RFC. As a result,
5115 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005116 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005117 * {@link #setDataAndNormalize}
5118 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005119 *
Nick Pellyccae4122012-01-09 14:12:58 -08005120 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005121 *
5122 * @return Returns the same Intent object, for chaining multiple calls
5123 * into a single statement.
5124 *
5125 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005126 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005127 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005128 */
5129 public Intent setData(Uri data) {
5130 mData = data;
5131 mType = null;
5132 return this;
5133 }
5134
5135 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005136 * Normalize and set the data this intent is operating on.
5137 *
5138 * <p>This method automatically clears any type that was
5139 * previously set (for example, by {@link #setType}).
5140 *
5141 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005142 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005143 * so really this is just a convenience method for
5144 * <pre>
5145 * setData(data.normalize())
5146 * </pre>
5147 *
5148 * @param data The Uri of the data this intent is now targeting.
5149 *
5150 * @return Returns the same Intent object, for chaining multiple calls
5151 * into a single statement.
5152 *
5153 * @see #getData
5154 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005155 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005156 */
5157 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005158 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005159 }
5160
5161 /**
5162 * Set an explicit MIME data type.
5163 *
5164 * <p>This is used to create intents that only specify a type and not data,
5165 * for example to indicate the type of data to return.
5166 *
5167 * <p>This method automatically clears any data that was
5168 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005169 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005170 * <p><em>Note: MIME type matching in the Android framework is
5171 * case-sensitive, unlike formal RFC MIME types. As a result,
5172 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005173 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5174 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005175 *
5176 * @param type The MIME type of the data being handled by this intent.
5177 *
5178 * @return Returns the same Intent object, for chaining multiple calls
5179 * into a single statement.
5180 *
5181 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005182 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005183 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005184 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005185 */
5186 public Intent setType(String type) {
5187 mData = null;
5188 mType = type;
5189 return this;
5190 }
5191
5192 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005193 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005194 *
Nick Pellyccae4122012-01-09 14:12:58 -08005195 * <p>This is used to create intents that only specify a type and not data,
5196 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005197 *
Nick Pellyccae4122012-01-09 14:12:58 -08005198 * <p>This method automatically clears any data that was
5199 * previously set (for example by {@link #setData}).
5200 *
5201 * <p>The MIME type is normalized using
5202 * {@link #normalizeMimeType} before it is set,
5203 * so really this is just a convenience method for
5204 * <pre>
5205 * setType(Intent.normalizeMimeType(type))
5206 * </pre>
5207 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005208 * @param type The MIME type of the data being handled by this intent.
5209 *
5210 * @return Returns the same Intent object, for chaining multiple calls
5211 * into a single statement.
5212 *
Nick Pellyccae4122012-01-09 14:12:58 -08005213 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005214 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005215 * @see #normalizeMimeType
5216 */
5217 public Intent setTypeAndNormalize(String type) {
5218 return setType(normalizeMimeType(type));
5219 }
5220
5221 /**
5222 * (Usually optional) Set the data for the intent along with an explicit
5223 * MIME data type. This method should very rarely be used -- it allows you
5224 * to override the MIME type that would ordinarily be inferred from the
5225 * data with your own type given here.
5226 *
5227 * <p><em>Note: MIME type and Uri scheme matching in the
5228 * Android framework is case-sensitive, unlike the formal RFC definitions.
5229 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005230 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005231 * {@link #setDataAndTypeAndNormalize}
5232 * to ensure that they are converted to lower case.</em>
5233 *
5234 * @param data The Uri of the data this intent is now targeting.
5235 * @param type The MIME type of the data being handled by this intent.
5236 *
5237 * @return Returns the same Intent object, for chaining multiple calls
5238 * into a single statement.
5239 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005240 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005241 * @see #setData
5242 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005243 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005244 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005245 */
5246 public Intent setDataAndType(Uri data, String type) {
5247 mData = data;
5248 mType = type;
5249 return this;
5250 }
5251
5252 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005253 * (Usually optional) Normalize and set both the data Uri and an explicit
5254 * MIME data type. This method should very rarely be used -- it allows you
5255 * to override the MIME type that would ordinarily be inferred from the
5256 * data with your own type given here.
5257 *
5258 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005259 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005260 * before they are set, so really this is just a convenience method for
5261 * <pre>
5262 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5263 * </pre>
5264 *
5265 * @param data The Uri of the data this intent is now targeting.
5266 * @param type The MIME type of the data being handled by this intent.
5267 *
5268 * @return Returns the same Intent object, for chaining multiple calls
5269 * into a single statement.
5270 *
5271 * @see #setType
5272 * @see #setData
5273 * @see #setDataAndType
5274 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005275 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005276 */
5277 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005278 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005279 }
5280
5281 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005282 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005283 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005284 * activities that provide <em>all</em> of the requested categories will be
5285 * used.
5286 *
5287 * @param category The desired category. This can be either one of the
5288 * predefined Intent categories, or a custom category in your own
5289 * namespace.
5290 *
5291 * @return Returns the same Intent object, for chaining multiple calls
5292 * into a single statement.
5293 *
5294 * @see #hasCategory
5295 * @see #removeCategory
5296 */
5297 public Intent addCategory(String category) {
5298 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005299 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005300 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005301 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005302 return this;
5303 }
5304
5305 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005306 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005307 *
5308 * @param category The category to remove.
5309 *
5310 * @see #addCategory
5311 */
5312 public void removeCategory(String category) {
5313 if (mCategories != null) {
5314 mCategories.remove(category);
5315 if (mCategories.size() == 0) {
5316 mCategories = null;
5317 }
5318 }
5319 }
5320
5321 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005322 * Set a selector for this Intent. This is a modification to the kinds of
5323 * things the Intent will match. If the selector is set, it will be used
5324 * when trying to find entities that can handle the Intent, instead of the
5325 * main contents of the Intent. This allows you build an Intent containing
5326 * a generic protocol while targeting it more specifically.
5327 *
5328 * <p>An example of where this may be used is with things like
5329 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5330 * Intent that will launch the Browser application. However, the correct
5331 * main entry point of an application is actually {@link #ACTION_MAIN}
5332 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5333 * used to specify the actual Activity to launch. If you launch the browser
5334 * with something different, undesired behavior may happen if the user has
5335 * previously or later launches it the normal way, since they do not match.
5336 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5337 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5338 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5339 *
5340 * <p>Setting a selector does not impact the behavior of
5341 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5342 * desired behavior of a selector -- it does not impact the base meaning
5343 * of the Intent, just what kinds of things will be matched against it
5344 * when determining who can handle it.</p>
5345 *
5346 * <p>You can not use both a selector and {@link #setPackage(String)} on
5347 * the same base Intent.</p>
5348 *
5349 * @param selector The desired selector Intent; set to null to not use
5350 * a special selector.
5351 */
5352 public void setSelector(Intent selector) {
5353 if (selector == this) {
5354 throw new IllegalArgumentException(
5355 "Intent being set as a selector of itself");
5356 }
5357 if (selector != null && mPackage != null) {
5358 throw new IllegalArgumentException(
5359 "Can't set selector when package name is already set");
5360 }
5361 mSelector = selector;
5362 }
5363
5364 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005365 * Set a {@link ClipData} associated with this Intent. This replaces any
5366 * previously set ClipData.
5367 *
5368 * <p>The ClipData in an intent is not used for Intent matching or other
5369 * such operations. Semantically it is like extras, used to transmit
5370 * additional data with the Intent. The main feature of using this over
5371 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5372 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5373 * items included in the clip data. This is useful, in particular, if
5374 * you want to transmit an Intent containing multiple <code>content:</code>
5375 * URIs for which the recipient may not have global permission to access the
5376 * content provider.
5377 *
5378 * <p>If the ClipData contains items that are themselves Intents, any
5379 * grant flags in those Intents will be ignored. Only the top-level flags
5380 * of the main Intent are respected, and will be applied to all Uri or
5381 * Intent items in the clip (or sub-items of the clip).
5382 *
5383 * <p>The MIME type, label, and icon in the ClipData object are not
5384 * directly used by Intent. Applications should generally rely on the
5385 * MIME type of the Intent itself, not what it may find in the ClipData.
5386 * A common practice is to construct a ClipData for use with an Intent
5387 * with a MIME type of "*\/*".
5388 *
5389 * @param clip The new clip to set. May be null to clear the current clip.
5390 */
5391 public void setClipData(ClipData clip) {
5392 mClipData = clip;
5393 }
5394
5395 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005396 * Add extended data to the intent. The name must include a package
5397 * prefix, for example the app com.android.contacts would use names
5398 * like "com.android.contacts.ShowAll".
5399 *
5400 * @param name The name of the extra data, with package prefix.
5401 * @param value The boolean data value.
5402 *
5403 * @return Returns the same Intent object, for chaining multiple calls
5404 * into a single statement.
5405 *
5406 * @see #putExtras
5407 * @see #removeExtra
5408 * @see #getBooleanExtra(String, boolean)
5409 */
5410 public Intent putExtra(String name, boolean value) {
5411 if (mExtras == null) {
5412 mExtras = new Bundle();
5413 }
5414 mExtras.putBoolean(name, value);
5415 return this;
5416 }
5417
5418 /**
5419 * Add extended data to the intent. The name must include a package
5420 * prefix, for example the app com.android.contacts would use names
5421 * like "com.android.contacts.ShowAll".
5422 *
5423 * @param name The name of the extra data, with package prefix.
5424 * @param value The byte data value.
5425 *
5426 * @return Returns the same Intent object, for chaining multiple calls
5427 * into a single statement.
5428 *
5429 * @see #putExtras
5430 * @see #removeExtra
5431 * @see #getByteExtra(String, byte)
5432 */
5433 public Intent putExtra(String name, byte value) {
5434 if (mExtras == null) {
5435 mExtras = new Bundle();
5436 }
5437 mExtras.putByte(name, value);
5438 return this;
5439 }
5440
5441 /**
5442 * Add extended data to the intent. The name must include a package
5443 * prefix, for example the app com.android.contacts would use names
5444 * like "com.android.contacts.ShowAll".
5445 *
5446 * @param name The name of the extra data, with package prefix.
5447 * @param value The char data value.
5448 *
5449 * @return Returns the same Intent object, for chaining multiple calls
5450 * into a single statement.
5451 *
5452 * @see #putExtras
5453 * @see #removeExtra
5454 * @see #getCharExtra(String, char)
5455 */
5456 public Intent putExtra(String name, char value) {
5457 if (mExtras == null) {
5458 mExtras = new Bundle();
5459 }
5460 mExtras.putChar(name, value);
5461 return this;
5462 }
5463
5464 /**
5465 * Add extended data to the intent. The name must include a package
5466 * prefix, for example the app com.android.contacts would use names
5467 * like "com.android.contacts.ShowAll".
5468 *
5469 * @param name The name of the extra data, with package prefix.
5470 * @param value The short data value.
5471 *
5472 * @return Returns the same Intent object, for chaining multiple calls
5473 * into a single statement.
5474 *
5475 * @see #putExtras
5476 * @see #removeExtra
5477 * @see #getShortExtra(String, short)
5478 */
5479 public Intent putExtra(String name, short value) {
5480 if (mExtras == null) {
5481 mExtras = new Bundle();
5482 }
5483 mExtras.putShort(name, value);
5484 return this;
5485 }
5486
5487 /**
5488 * Add extended data to the intent. The name must include a package
5489 * prefix, for example the app com.android.contacts would use names
5490 * like "com.android.contacts.ShowAll".
5491 *
5492 * @param name The name of the extra data, with package prefix.
5493 * @param value The integer data value.
5494 *
5495 * @return Returns the same Intent object, for chaining multiple calls
5496 * into a single statement.
5497 *
5498 * @see #putExtras
5499 * @see #removeExtra
5500 * @see #getIntExtra(String, int)
5501 */
5502 public Intent putExtra(String name, int value) {
5503 if (mExtras == null) {
5504 mExtras = new Bundle();
5505 }
5506 mExtras.putInt(name, value);
5507 return this;
5508 }
5509
5510 /**
5511 * Add extended data to the intent. The name must include a package
5512 * prefix, for example the app com.android.contacts would use names
5513 * like "com.android.contacts.ShowAll".
5514 *
5515 * @param name The name of the extra data, with package prefix.
5516 * @param value The long data value.
5517 *
5518 * @return Returns the same Intent object, for chaining multiple calls
5519 * into a single statement.
5520 *
5521 * @see #putExtras
5522 * @see #removeExtra
5523 * @see #getLongExtra(String, long)
5524 */
5525 public Intent putExtra(String name, long value) {
5526 if (mExtras == null) {
5527 mExtras = new Bundle();
5528 }
5529 mExtras.putLong(name, value);
5530 return this;
5531 }
5532
5533 /**
5534 * Add extended data to the intent. The name must include a package
5535 * prefix, for example the app com.android.contacts would use names
5536 * like "com.android.contacts.ShowAll".
5537 *
5538 * @param name The name of the extra data, with package prefix.
5539 * @param value The float data value.
5540 *
5541 * @return Returns the same Intent object, for chaining multiple calls
5542 * into a single statement.
5543 *
5544 * @see #putExtras
5545 * @see #removeExtra
5546 * @see #getFloatExtra(String, float)
5547 */
5548 public Intent putExtra(String name, float value) {
5549 if (mExtras == null) {
5550 mExtras = new Bundle();
5551 }
5552 mExtras.putFloat(name, value);
5553 return this;
5554 }
5555
5556 /**
5557 * Add extended data to the intent. The name must include a package
5558 * prefix, for example the app com.android.contacts would use names
5559 * like "com.android.contacts.ShowAll".
5560 *
5561 * @param name The name of the extra data, with package prefix.
5562 * @param value The double data value.
5563 *
5564 * @return Returns the same Intent object, for chaining multiple calls
5565 * into a single statement.
5566 *
5567 * @see #putExtras
5568 * @see #removeExtra
5569 * @see #getDoubleExtra(String, double)
5570 */
5571 public Intent putExtra(String name, double value) {
5572 if (mExtras == null) {
5573 mExtras = new Bundle();
5574 }
5575 mExtras.putDouble(name, value);
5576 return this;
5577 }
5578
5579 /**
5580 * Add extended data to the intent. The name must include a package
5581 * prefix, for example the app com.android.contacts would use names
5582 * like "com.android.contacts.ShowAll".
5583 *
5584 * @param name The name of the extra data, with package prefix.
5585 * @param value The String data value.
5586 *
5587 * @return Returns the same Intent object, for chaining multiple calls
5588 * into a single statement.
5589 *
5590 * @see #putExtras
5591 * @see #removeExtra
5592 * @see #getStringExtra(String)
5593 */
5594 public Intent putExtra(String name, String value) {
5595 if (mExtras == null) {
5596 mExtras = new Bundle();
5597 }
5598 mExtras.putString(name, value);
5599 return this;
5600 }
5601
5602 /**
5603 * Add extended data to the intent. The name must include a package
5604 * prefix, for example the app com.android.contacts would use names
5605 * like "com.android.contacts.ShowAll".
5606 *
5607 * @param name The name of the extra data, with package prefix.
5608 * @param value The CharSequence data value.
5609 *
5610 * @return Returns the same Intent object, for chaining multiple calls
5611 * into a single statement.
5612 *
5613 * @see #putExtras
5614 * @see #removeExtra
5615 * @see #getCharSequenceExtra(String)
5616 */
5617 public Intent putExtra(String name, CharSequence value) {
5618 if (mExtras == null) {
5619 mExtras = new Bundle();
5620 }
5621 mExtras.putCharSequence(name, value);
5622 return this;
5623 }
5624
5625 /**
5626 * Add extended data to the intent. The name must include a package
5627 * prefix, for example the app com.android.contacts would use names
5628 * like "com.android.contacts.ShowAll".
5629 *
5630 * @param name The name of the extra data, with package prefix.
5631 * @param value The Parcelable data value.
5632 *
5633 * @return Returns the same Intent object, for chaining multiple calls
5634 * into a single statement.
5635 *
5636 * @see #putExtras
5637 * @see #removeExtra
5638 * @see #getParcelableExtra(String)
5639 */
5640 public Intent putExtra(String name, Parcelable value) {
5641 if (mExtras == null) {
5642 mExtras = new Bundle();
5643 }
5644 mExtras.putParcelable(name, value);
5645 return this;
5646 }
5647
5648 /**
5649 * Add extended data to the intent. The name must include a package
5650 * prefix, for example the app com.android.contacts would use names
5651 * like "com.android.contacts.ShowAll".
5652 *
5653 * @param name The name of the extra data, with package prefix.
5654 * @param value The Parcelable[] data value.
5655 *
5656 * @return Returns the same Intent object, for chaining multiple calls
5657 * into a single statement.
5658 *
5659 * @see #putExtras
5660 * @see #removeExtra
5661 * @see #getParcelableArrayExtra(String)
5662 */
5663 public Intent putExtra(String name, Parcelable[] value) {
5664 if (mExtras == null) {
5665 mExtras = new Bundle();
5666 }
5667 mExtras.putParcelableArray(name, value);
5668 return this;
5669 }
5670
5671 /**
5672 * Add extended data to the intent. The name must include a package
5673 * prefix, for example the app com.android.contacts would use names
5674 * like "com.android.contacts.ShowAll".
5675 *
5676 * @param name The name of the extra data, with package prefix.
5677 * @param value The ArrayList<Parcelable> data value.
5678 *
5679 * @return Returns the same Intent object, for chaining multiple calls
5680 * into a single statement.
5681 *
5682 * @see #putExtras
5683 * @see #removeExtra
5684 * @see #getParcelableArrayListExtra(String)
5685 */
5686 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5687 if (mExtras == null) {
5688 mExtras = new Bundle();
5689 }
5690 mExtras.putParcelableArrayList(name, value);
5691 return this;
5692 }
5693
5694 /**
5695 * Add extended data to the intent. The name must include a package
5696 * prefix, for example the app com.android.contacts would use names
5697 * like "com.android.contacts.ShowAll".
5698 *
5699 * @param name The name of the extra data, with package prefix.
5700 * @param value The ArrayList<Integer> data value.
5701 *
5702 * @return Returns the same Intent object, for chaining multiple calls
5703 * into a single statement.
5704 *
5705 * @see #putExtras
5706 * @see #removeExtra
5707 * @see #getIntegerArrayListExtra(String)
5708 */
5709 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5710 if (mExtras == null) {
5711 mExtras = new Bundle();
5712 }
5713 mExtras.putIntegerArrayList(name, value);
5714 return this;
5715 }
5716
5717 /**
5718 * Add extended data to the intent. The name must include a package
5719 * prefix, for example the app com.android.contacts would use names
5720 * like "com.android.contacts.ShowAll".
5721 *
5722 * @param name The name of the extra data, with package prefix.
5723 * @param value The ArrayList<String> data value.
5724 *
5725 * @return Returns the same Intent object, for chaining multiple calls
5726 * into a single statement.
5727 *
5728 * @see #putExtras
5729 * @see #removeExtra
5730 * @see #getStringArrayListExtra(String)
5731 */
5732 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5733 if (mExtras == null) {
5734 mExtras = new Bundle();
5735 }
5736 mExtras.putStringArrayList(name, value);
5737 return this;
5738 }
5739
5740 /**
5741 * Add extended data to the intent. The name must include a package
5742 * prefix, for example the app com.android.contacts would use names
5743 * like "com.android.contacts.ShowAll".
5744 *
5745 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005746 * @param value The ArrayList<CharSequence> data value.
5747 *
5748 * @return Returns the same Intent object, for chaining multiple calls
5749 * into a single statement.
5750 *
5751 * @see #putExtras
5752 * @see #removeExtra
5753 * @see #getCharSequenceArrayListExtra(String)
5754 */
5755 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5756 if (mExtras == null) {
5757 mExtras = new Bundle();
5758 }
5759 mExtras.putCharSequenceArrayList(name, value);
5760 return this;
5761 }
5762
5763 /**
5764 * Add extended data to the intent. The name must include a package
5765 * prefix, for example the app com.android.contacts would use names
5766 * like "com.android.contacts.ShowAll".
5767 *
5768 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005769 * @param value The Serializable data value.
5770 *
5771 * @return Returns the same Intent object, for chaining multiple calls
5772 * into a single statement.
5773 *
5774 * @see #putExtras
5775 * @see #removeExtra
5776 * @see #getSerializableExtra(String)
5777 */
5778 public Intent putExtra(String name, Serializable value) {
5779 if (mExtras == null) {
5780 mExtras = new Bundle();
5781 }
5782 mExtras.putSerializable(name, value);
5783 return this;
5784 }
5785
5786 /**
5787 * Add extended data to the intent. The name must include a package
5788 * prefix, for example the app com.android.contacts would use names
5789 * like "com.android.contacts.ShowAll".
5790 *
5791 * @param name The name of the extra data, with package prefix.
5792 * @param value The boolean array data value.
5793 *
5794 * @return Returns the same Intent object, for chaining multiple calls
5795 * into a single statement.
5796 *
5797 * @see #putExtras
5798 * @see #removeExtra
5799 * @see #getBooleanArrayExtra(String)
5800 */
5801 public Intent putExtra(String name, boolean[] value) {
5802 if (mExtras == null) {
5803 mExtras = new Bundle();
5804 }
5805 mExtras.putBooleanArray(name, value);
5806 return this;
5807 }
5808
5809 /**
5810 * Add extended data to the intent. The name must include a package
5811 * prefix, for example the app com.android.contacts would use names
5812 * like "com.android.contacts.ShowAll".
5813 *
5814 * @param name The name of the extra data, with package prefix.
5815 * @param value The byte array data value.
5816 *
5817 * @return Returns the same Intent object, for chaining multiple calls
5818 * into a single statement.
5819 *
5820 * @see #putExtras
5821 * @see #removeExtra
5822 * @see #getByteArrayExtra(String)
5823 */
5824 public Intent putExtra(String name, byte[] value) {
5825 if (mExtras == null) {
5826 mExtras = new Bundle();
5827 }
5828 mExtras.putByteArray(name, value);
5829 return this;
5830 }
5831
5832 /**
5833 * Add extended data to the intent. The name must include a package
5834 * prefix, for example the app com.android.contacts would use names
5835 * like "com.android.contacts.ShowAll".
5836 *
5837 * @param name The name of the extra data, with package prefix.
5838 * @param value The short array data value.
5839 *
5840 * @return Returns the same Intent object, for chaining multiple calls
5841 * into a single statement.
5842 *
5843 * @see #putExtras
5844 * @see #removeExtra
5845 * @see #getShortArrayExtra(String)
5846 */
5847 public Intent putExtra(String name, short[] value) {
5848 if (mExtras == null) {
5849 mExtras = new Bundle();
5850 }
5851 mExtras.putShortArray(name, value);
5852 return this;
5853 }
5854
5855 /**
5856 * Add extended data to the intent. The name must include a package
5857 * prefix, for example the app com.android.contacts would use names
5858 * like "com.android.contacts.ShowAll".
5859 *
5860 * @param name The name of the extra data, with package prefix.
5861 * @param value The char array data value.
5862 *
5863 * @return Returns the same Intent object, for chaining multiple calls
5864 * into a single statement.
5865 *
5866 * @see #putExtras
5867 * @see #removeExtra
5868 * @see #getCharArrayExtra(String)
5869 */
5870 public Intent putExtra(String name, char[] value) {
5871 if (mExtras == null) {
5872 mExtras = new Bundle();
5873 }
5874 mExtras.putCharArray(name, value);
5875 return this;
5876 }
5877
5878 /**
5879 * Add extended data to the intent. The name must include a package
5880 * prefix, for example the app com.android.contacts would use names
5881 * like "com.android.contacts.ShowAll".
5882 *
5883 * @param name The name of the extra data, with package prefix.
5884 * @param value The int array data value.
5885 *
5886 * @return Returns the same Intent object, for chaining multiple calls
5887 * into a single statement.
5888 *
5889 * @see #putExtras
5890 * @see #removeExtra
5891 * @see #getIntArrayExtra(String)
5892 */
5893 public Intent putExtra(String name, int[] value) {
5894 if (mExtras == null) {
5895 mExtras = new Bundle();
5896 }
5897 mExtras.putIntArray(name, value);
5898 return this;
5899 }
5900
5901 /**
5902 * Add extended data to the intent. The name must include a package
5903 * prefix, for example the app com.android.contacts would use names
5904 * like "com.android.contacts.ShowAll".
5905 *
5906 * @param name The name of the extra data, with package prefix.
5907 * @param value The byte array data value.
5908 *
5909 * @return Returns the same Intent object, for chaining multiple calls
5910 * into a single statement.
5911 *
5912 * @see #putExtras
5913 * @see #removeExtra
5914 * @see #getLongArrayExtra(String)
5915 */
5916 public Intent putExtra(String name, long[] value) {
5917 if (mExtras == null) {
5918 mExtras = new Bundle();
5919 }
5920 mExtras.putLongArray(name, value);
5921 return this;
5922 }
5923
5924 /**
5925 * Add extended data to the intent. The name must include a package
5926 * prefix, for example the app com.android.contacts would use names
5927 * like "com.android.contacts.ShowAll".
5928 *
5929 * @param name The name of the extra data, with package prefix.
5930 * @param value The float array data value.
5931 *
5932 * @return Returns the same Intent object, for chaining multiple calls
5933 * into a single statement.
5934 *
5935 * @see #putExtras
5936 * @see #removeExtra
5937 * @see #getFloatArrayExtra(String)
5938 */
5939 public Intent putExtra(String name, float[] value) {
5940 if (mExtras == null) {
5941 mExtras = new Bundle();
5942 }
5943 mExtras.putFloatArray(name, value);
5944 return this;
5945 }
5946
5947 /**
5948 * Add extended data to the intent. The name must include a package
5949 * prefix, for example the app com.android.contacts would use names
5950 * like "com.android.contacts.ShowAll".
5951 *
5952 * @param name The name of the extra data, with package prefix.
5953 * @param value The double array data value.
5954 *
5955 * @return Returns the same Intent object, for chaining multiple calls
5956 * into a single statement.
5957 *
5958 * @see #putExtras
5959 * @see #removeExtra
5960 * @see #getDoubleArrayExtra(String)
5961 */
5962 public Intent putExtra(String name, double[] value) {
5963 if (mExtras == null) {
5964 mExtras = new Bundle();
5965 }
5966 mExtras.putDoubleArray(name, value);
5967 return this;
5968 }
5969
5970 /**
5971 * Add extended data to the intent. The name must include a package
5972 * prefix, for example the app com.android.contacts would use names
5973 * like "com.android.contacts.ShowAll".
5974 *
5975 * @param name The name of the extra data, with package prefix.
5976 * @param value The String array data value.
5977 *
5978 * @return Returns the same Intent object, for chaining multiple calls
5979 * into a single statement.
5980 *
5981 * @see #putExtras
5982 * @see #removeExtra
5983 * @see #getStringArrayExtra(String)
5984 */
5985 public Intent putExtra(String name, String[] value) {
5986 if (mExtras == null) {
5987 mExtras = new Bundle();
5988 }
5989 mExtras.putStringArray(name, value);
5990 return this;
5991 }
5992
5993 /**
5994 * Add extended data to the intent. The name must include a package
5995 * prefix, for example the app com.android.contacts would use names
5996 * like "com.android.contacts.ShowAll".
5997 *
5998 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005999 * @param value The CharSequence array data value.
6000 *
6001 * @return Returns the same Intent object, for chaining multiple calls
6002 * into a single statement.
6003 *
6004 * @see #putExtras
6005 * @see #removeExtra
6006 * @see #getCharSequenceArrayExtra(String)
6007 */
6008 public Intent putExtra(String name, CharSequence[] value) {
6009 if (mExtras == null) {
6010 mExtras = new Bundle();
6011 }
6012 mExtras.putCharSequenceArray(name, value);
6013 return this;
6014 }
6015
6016 /**
6017 * Add extended data to the intent. The name must include a package
6018 * prefix, for example the app com.android.contacts would use names
6019 * like "com.android.contacts.ShowAll".
6020 *
6021 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006022 * @param value The Bundle data value.
6023 *
6024 * @return Returns the same Intent object, for chaining multiple calls
6025 * into a single statement.
6026 *
6027 * @see #putExtras
6028 * @see #removeExtra
6029 * @see #getBundleExtra(String)
6030 */
6031 public Intent putExtra(String name, Bundle value) {
6032 if (mExtras == null) {
6033 mExtras = new Bundle();
6034 }
6035 mExtras.putBundle(name, value);
6036 return this;
6037 }
6038
6039 /**
6040 * Add extended data to the intent. The name must include a package
6041 * prefix, for example the app com.android.contacts would use names
6042 * like "com.android.contacts.ShowAll".
6043 *
6044 * @param name The name of the extra data, with package prefix.
6045 * @param value The IBinder data value.
6046 *
6047 * @return Returns the same Intent object, for chaining multiple calls
6048 * into a single statement.
6049 *
6050 * @see #putExtras
6051 * @see #removeExtra
6052 * @see #getIBinderExtra(String)
6053 *
6054 * @deprecated
6055 * @hide
6056 */
6057 @Deprecated
6058 public Intent putExtra(String name, IBinder value) {
6059 if (mExtras == null) {
6060 mExtras = new Bundle();
6061 }
6062 mExtras.putIBinder(name, value);
6063 return this;
6064 }
6065
6066 /**
6067 * Copy all extras in 'src' in to this intent.
6068 *
6069 * @param src Contains the extras to copy.
6070 *
6071 * @see #putExtra
6072 */
6073 public Intent putExtras(Intent src) {
6074 if (src.mExtras != null) {
6075 if (mExtras == null) {
6076 mExtras = new Bundle(src.mExtras);
6077 } else {
6078 mExtras.putAll(src.mExtras);
6079 }
6080 }
6081 return this;
6082 }
6083
6084 /**
6085 * Add a set of extended data to the intent. The keys must include a package
6086 * prefix, for example the app com.android.contacts would use names
6087 * like "com.android.contacts.ShowAll".
6088 *
6089 * @param extras The Bundle of extras to add to this intent.
6090 *
6091 * @see #putExtra
6092 * @see #removeExtra
6093 */
6094 public Intent putExtras(Bundle extras) {
6095 if (mExtras == null) {
6096 mExtras = new Bundle();
6097 }
6098 mExtras.putAll(extras);
6099 return this;
6100 }
6101
6102 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006103 * Completely replace the extras in the Intent with the extras in the
6104 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006105 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006106 * @param src The exact extras contained in this Intent are copied
6107 * into the target intent, replacing any that were previously there.
6108 */
6109 public Intent replaceExtras(Intent src) {
6110 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6111 return this;
6112 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006113
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006114 /**
6115 * Completely replace the extras in the Intent with the given Bundle of
6116 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006117 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006118 * @param extras The new set of extras in the Intent, or null to erase
6119 * all extras.
6120 */
6121 public Intent replaceExtras(Bundle extras) {
6122 mExtras = extras != null ? new Bundle(extras) : null;
6123 return this;
6124 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006125
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006126 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006127 * Remove extended data from the intent.
6128 *
6129 * @see #putExtra
6130 */
6131 public void removeExtra(String name) {
6132 if (mExtras != null) {
6133 mExtras.remove(name);
6134 if (mExtras.size() == 0) {
6135 mExtras = null;
6136 }
6137 }
6138 }
6139
6140 /**
6141 * Set special flags controlling how this intent is handled. Most values
6142 * here depend on the type of component being executed by the Intent,
6143 * specifically the FLAG_ACTIVITY_* flags are all for use with
6144 * {@link Context#startActivity Context.startActivity()} and the
6145 * FLAG_RECEIVER_* flags are all for use with
6146 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6147 *
Scott Main7aee61f2011-02-08 11:25:01 -08006148 * <p>See the
6149 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6150 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006151 * the behavior of your application.
6152 *
6153 * @param flags The desired flags.
6154 *
6155 * @return Returns the same Intent object, for chaining multiple calls
6156 * into a single statement.
6157 *
6158 * @see #getFlags
6159 * @see #addFlags
6160 *
6161 * @see #FLAG_GRANT_READ_URI_PERMISSION
6162 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6163 * @see #FLAG_DEBUG_LOG_RESOLUTION
6164 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006165 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006166 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006167 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006168 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006169 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6170 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006171 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006172 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
6173 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006174 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006175 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006176 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006177 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6178 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006179 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006180 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006181 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006182 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6183 */
6184 public Intent setFlags(int flags) {
6185 mFlags = flags;
6186 return this;
6187 }
6188
6189 /**
6190 * Add additional flags to the intent (or with existing flags
6191 * value).
6192 *
6193 * @param flags The new flags to set.
6194 *
6195 * @return Returns the same Intent object, for chaining multiple calls
6196 * into a single statement.
6197 *
6198 * @see #setFlags
6199 */
6200 public Intent addFlags(int flags) {
6201 mFlags |= flags;
6202 return this;
6203 }
6204
6205 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006206 * (Usually optional) Set an explicit application package name that limits
6207 * the components this Intent will resolve to. If left to the default
6208 * value of null, all components in all applications will considered.
6209 * If non-null, the Intent can only match the components in the given
6210 * application package.
6211 *
6212 * @param packageName The name of the application package to handle the
6213 * intent, or null to allow any application package.
6214 *
6215 * @return Returns the same Intent object, for chaining multiple calls
6216 * into a single statement.
6217 *
6218 * @see #getPackage
6219 * @see #resolveActivity
6220 */
6221 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006222 if (packageName != null && mSelector != null) {
6223 throw new IllegalArgumentException(
6224 "Can't set package name when selector is already set");
6225 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006226 mPackage = packageName;
6227 return this;
6228 }
6229
6230 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006231 * (Usually optional) Explicitly set the component to handle the intent.
6232 * If left with the default value of null, the system will determine the
6233 * appropriate class to use based on the other fields (action, data,
6234 * type, categories) in the Intent. If this class is defined, the
6235 * specified class will always be used regardless of the other fields. You
6236 * should only set this value when you know you absolutely want a specific
6237 * class to be used; otherwise it is better to let the system find the
6238 * appropriate class so that you will respect the installed applications
6239 * and user preferences.
6240 *
6241 * @param component The name of the application component to handle the
6242 * intent, or null to let the system find one for you.
6243 *
6244 * @return Returns the same Intent object, for chaining multiple calls
6245 * into a single statement.
6246 *
6247 * @see #setClass
6248 * @see #setClassName(Context, String)
6249 * @see #setClassName(String, String)
6250 * @see #getComponent
6251 * @see #resolveActivity
6252 */
6253 public Intent setComponent(ComponentName component) {
6254 mComponent = component;
6255 return this;
6256 }
6257
6258 /**
6259 * Convenience for calling {@link #setComponent} with an
6260 * explicit class name.
6261 *
6262 * @param packageContext A Context of the application package implementing
6263 * this class.
6264 * @param className The name of a class inside of the application package
6265 * that will be used as the component for this Intent.
6266 *
6267 * @return Returns the same Intent object, for chaining multiple calls
6268 * into a single statement.
6269 *
6270 * @see #setComponent
6271 * @see #setClass
6272 */
6273 public Intent setClassName(Context packageContext, String className) {
6274 mComponent = new ComponentName(packageContext, className);
6275 return this;
6276 }
6277
6278 /**
6279 * Convenience for calling {@link #setComponent} with an
6280 * explicit application package name and class name.
6281 *
6282 * @param packageName The name of the package implementing the desired
6283 * component.
6284 * @param className The name of a class inside of the application package
6285 * that will be used as the component for this Intent.
6286 *
6287 * @return Returns the same Intent object, for chaining multiple calls
6288 * into a single statement.
6289 *
6290 * @see #setComponent
6291 * @see #setClass
6292 */
6293 public Intent setClassName(String packageName, String className) {
6294 mComponent = new ComponentName(packageName, className);
6295 return this;
6296 }
6297
6298 /**
6299 * Convenience for calling {@link #setComponent(ComponentName)} with the
6300 * name returned by a {@link Class} object.
6301 *
6302 * @param packageContext A Context of the application package implementing
6303 * this class.
6304 * @param cls The class name to set, equivalent to
6305 * <code>setClassName(context, cls.getName())</code>.
6306 *
6307 * @return Returns the same Intent object, for chaining multiple calls
6308 * into a single statement.
6309 *
6310 * @see #setComponent
6311 */
6312 public Intent setClass(Context packageContext, Class<?> cls) {
6313 mComponent = new ComponentName(packageContext, cls);
6314 return this;
6315 }
6316
6317 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006318 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6319 * used as a hint to the receiver for animations and the like. Null means that there
6320 * is no source bounds.
6321 */
6322 public void setSourceBounds(Rect r) {
6323 if (r != null) {
6324 mSourceBounds = new Rect(r);
6325 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006326 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006327 }
6328 }
6329
6330 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006331 * Use with {@link #fillIn} to allow the current action value to be
6332 * overwritten, even if it is already set.
6333 */
6334 public static final int FILL_IN_ACTION = 1<<0;
6335
6336 /**
6337 * Use with {@link #fillIn} to allow the current data or type value
6338 * overwritten, even if it is already set.
6339 */
6340 public static final int FILL_IN_DATA = 1<<1;
6341
6342 /**
6343 * Use with {@link #fillIn} to allow the current categories to be
6344 * overwritten, even if they are already set.
6345 */
6346 public static final int FILL_IN_CATEGORIES = 1<<2;
6347
6348 /**
6349 * Use with {@link #fillIn} to allow the current component value to be
6350 * overwritten, even if it is already set.
6351 */
6352 public static final int FILL_IN_COMPONENT = 1<<3;
6353
6354 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006355 * Use with {@link #fillIn} to allow the current package value to be
6356 * overwritten, even if it is already set.
6357 */
6358 public static final int FILL_IN_PACKAGE = 1<<4;
6359
6360 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006361 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006362 * overwritten, even if it is already set.
6363 */
6364 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6365
6366 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006367 * Use with {@link #fillIn} to allow the current selector to be
6368 * overwritten, even if it is already set.
6369 */
6370 public static final int FILL_IN_SELECTOR = 1<<6;
6371
6372 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006373 * Use with {@link #fillIn} to allow the current ClipData to be
6374 * overwritten, even if it is already set.
6375 */
6376 public static final int FILL_IN_CLIP_DATA = 1<<7;
6377
6378 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006379 * Copy the contents of <var>other</var> in to this object, but only
6380 * where fields are not defined by this object. For purposes of a field
6381 * being defined, the following pieces of data in the Intent are
6382 * considered to be separate fields:
6383 *
6384 * <ul>
6385 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006386 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006387 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6388 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006389 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006390 * <li> component, as set by {@link #setComponent(ComponentName)} or
6391 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006392 * <li> source bounds, as set by {@link #setSourceBounds}.
6393 * <li> selector, as set by {@link #setSelector(Intent)}.
6394 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006395 * <li> each top-level name in the associated extras.
6396 * </ul>
6397 *
6398 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006399 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006400 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6401 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6402 * the restriction where the corresponding field will not be replaced if
6403 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006404 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006405 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6406 * is explicitly specified. The selector will only be copied if
6407 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006408 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006409 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6410 * and Intent B with {action="gotit", data-type="some/thing",
6411 * categories="one","two"}.
6412 *
6413 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6414 * containing: {action="gotit", data-type="some/thing",
6415 * categories="bar"}.
6416 *
6417 * @param other Another Intent whose values are to be used to fill in
6418 * the current one.
6419 * @param flags Options to control which fields can be filled in.
6420 *
6421 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006422 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006423 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6424 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006425 */
6426 public int fillIn(Intent other, int flags) {
6427 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006428 if (other.mAction != null
6429 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006430 mAction = other.mAction;
6431 changes |= FILL_IN_ACTION;
6432 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006433 if ((other.mData != null || other.mType != null)
6434 && ((mData == null && mType == null)
6435 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006436 mData = other.mData;
6437 mType = other.mType;
6438 changes |= FILL_IN_DATA;
6439 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006440 if (other.mCategories != null
6441 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006442 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006443 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006444 }
6445 changes |= FILL_IN_CATEGORIES;
6446 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006447 if (other.mPackage != null
6448 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006449 // Only do this if mSelector is not set.
6450 if (mSelector == null) {
6451 mPackage = other.mPackage;
6452 changes |= FILL_IN_PACKAGE;
6453 }
6454 }
6455 // Selector is special: it can only be set if explicitly allowed,
6456 // for the same reason as the component name.
6457 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6458 if (mPackage == null) {
6459 mSelector = new Intent(other.mSelector);
6460 mPackage = null;
6461 changes |= FILL_IN_SELECTOR;
6462 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006463 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006464 if (other.mClipData != null
6465 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6466 mClipData = other.mClipData;
6467 changes |= FILL_IN_CLIP_DATA;
6468 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006469 // Component is special: it can -only- be set if explicitly allowed,
6470 // since otherwise the sender could force the intent somewhere the
6471 // originator didn't intend.
6472 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006473 mComponent = other.mComponent;
6474 changes |= FILL_IN_COMPONENT;
6475 }
6476 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006477 if (other.mSourceBounds != null
6478 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6479 mSourceBounds = new Rect(other.mSourceBounds);
6480 changes |= FILL_IN_SOURCE_BOUNDS;
6481 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006482 if (mExtras == null) {
6483 if (other.mExtras != null) {
6484 mExtras = new Bundle(other.mExtras);
6485 }
6486 } else if (other.mExtras != null) {
6487 try {
6488 Bundle newb = new Bundle(other.mExtras);
6489 newb.putAll(mExtras);
6490 mExtras = newb;
6491 } catch (RuntimeException e) {
6492 // Modifying the extras can cause us to unparcel the contents
6493 // of the bundle, and if we do this in the system process that
6494 // may fail. We really should handle this (i.e., the Bundle
6495 // impl shouldn't be on top of a plain map), but for now just
6496 // ignore it and keep the original contents. :(
6497 Log.w("Intent", "Failure filling in extras", e);
6498 }
6499 }
6500 return changes;
6501 }
6502
6503 /**
6504 * Wrapper class holding an Intent and implementing comparisons on it for
6505 * the purpose of filtering. The class implements its
6506 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6507 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6508 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6509 * on the wrapped Intent.
6510 */
6511 public static final class FilterComparison {
6512 private final Intent mIntent;
6513 private final int mHashCode;
6514
6515 public FilterComparison(Intent intent) {
6516 mIntent = intent;
6517 mHashCode = intent.filterHashCode();
6518 }
6519
6520 /**
6521 * Return the Intent that this FilterComparison represents.
6522 * @return Returns the Intent held by the FilterComparison. Do
6523 * not modify!
6524 */
6525 public Intent getIntent() {
6526 return mIntent;
6527 }
6528
6529 @Override
6530 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006531 if (obj instanceof FilterComparison) {
6532 Intent other = ((FilterComparison)obj).mIntent;
6533 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006534 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006535 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006536 }
6537
6538 @Override
6539 public int hashCode() {
6540 return mHashCode;
6541 }
6542 }
6543
6544 /**
6545 * Determine if two intents are the same for the purposes of intent
6546 * resolution (filtering). That is, if their action, data, type,
6547 * class, and categories are the same. This does <em>not</em> compare
6548 * any extra data included in the intents.
6549 *
6550 * @param other The other Intent to compare against.
6551 *
6552 * @return Returns true if action, data, type, class, and categories
6553 * are the same.
6554 */
6555 public boolean filterEquals(Intent other) {
6556 if (other == null) {
6557 return false;
6558 }
6559 if (mAction != other.mAction) {
6560 if (mAction != null) {
6561 if (!mAction.equals(other.mAction)) {
6562 return false;
6563 }
6564 } else {
6565 if (!other.mAction.equals(mAction)) {
6566 return false;
6567 }
6568 }
6569 }
6570 if (mData != other.mData) {
6571 if (mData != null) {
6572 if (!mData.equals(other.mData)) {
6573 return false;
6574 }
6575 } else {
6576 if (!other.mData.equals(mData)) {
6577 return false;
6578 }
6579 }
6580 }
6581 if (mType != other.mType) {
6582 if (mType != null) {
6583 if (!mType.equals(other.mType)) {
6584 return false;
6585 }
6586 } else {
6587 if (!other.mType.equals(mType)) {
6588 return false;
6589 }
6590 }
6591 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006592 if (mPackage != other.mPackage) {
6593 if (mPackage != null) {
6594 if (!mPackage.equals(other.mPackage)) {
6595 return false;
6596 }
6597 } else {
6598 if (!other.mPackage.equals(mPackage)) {
6599 return false;
6600 }
6601 }
6602 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006603 if (mComponent != other.mComponent) {
6604 if (mComponent != null) {
6605 if (!mComponent.equals(other.mComponent)) {
6606 return false;
6607 }
6608 } else {
6609 if (!other.mComponent.equals(mComponent)) {
6610 return false;
6611 }
6612 }
6613 }
6614 if (mCategories != other.mCategories) {
6615 if (mCategories != null) {
6616 if (!mCategories.equals(other.mCategories)) {
6617 return false;
6618 }
6619 } else {
6620 if (!other.mCategories.equals(mCategories)) {
6621 return false;
6622 }
6623 }
6624 }
6625
6626 return true;
6627 }
6628
6629 /**
6630 * Generate hash code that matches semantics of filterEquals().
6631 *
6632 * @return Returns the hash value of the action, data, type, class, and
6633 * categories.
6634 *
6635 * @see #filterEquals
6636 */
6637 public int filterHashCode() {
6638 int code = 0;
6639 if (mAction != null) {
6640 code += mAction.hashCode();
6641 }
6642 if (mData != null) {
6643 code += mData.hashCode();
6644 }
6645 if (mType != null) {
6646 code += mType.hashCode();
6647 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006648 if (mPackage != null) {
6649 code += mPackage.hashCode();
6650 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006651 if (mComponent != null) {
6652 code += mComponent.hashCode();
6653 }
6654 if (mCategories != null) {
6655 code += mCategories.hashCode();
6656 }
6657 return code;
6658 }
6659
6660 @Override
6661 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006662 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006663
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006664 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006665 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006666 b.append(" }");
6667
6668 return b.toString();
6669 }
6670
6671 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006672 public String toInsecureString() {
6673 StringBuilder b = new StringBuilder(128);
6674
6675 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006676 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006677 b.append(" }");
6678
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006679 return b.toString();
6680 }
Romain Guy4969af72009-06-17 10:53:19 -07006681
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006682 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006683 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006684 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006685
6686 b.append("Intent { ");
6687 toShortString(b, false, true, true, true);
6688 b.append(" }");
6689
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006690 return b.toString();
6691 }
6692
6693 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006694 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6695 StringBuilder b = new StringBuilder(128);
6696 toShortString(b, secure, comp, extras, clip);
6697 return b.toString();
6698 }
6699
6700 /** @hide */
6701 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6702 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006703 boolean first = true;
6704 if (mAction != null) {
6705 b.append("act=").append(mAction);
6706 first = false;
6707 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006708 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006709 if (!first) {
6710 b.append(' ');
6711 }
6712 first = false;
6713 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006714 for (int i=0; i<mCategories.size(); i++) {
6715 if (i > 0) b.append(',');
6716 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006717 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006718 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006719 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006720 if (mData != null) {
6721 if (!first) {
6722 b.append(' ');
6723 }
6724 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006725 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006726 if (secure) {
6727 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006728 } else {
6729 b.append(mData);
6730 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006731 }
6732 if (mType != null) {
6733 if (!first) {
6734 b.append(' ');
6735 }
6736 first = false;
6737 b.append("typ=").append(mType);
6738 }
6739 if (mFlags != 0) {
6740 if (!first) {
6741 b.append(' ');
6742 }
6743 first = false;
6744 b.append("flg=0x").append(Integer.toHexString(mFlags));
6745 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006746 if (mPackage != null) {
6747 if (!first) {
6748 b.append(' ');
6749 }
6750 first = false;
6751 b.append("pkg=").append(mPackage);
6752 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006753 if (comp && mComponent != null) {
6754 if (!first) {
6755 b.append(' ');
6756 }
6757 first = false;
6758 b.append("cmp=").append(mComponent.flattenToShortString());
6759 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006760 if (mSourceBounds != null) {
6761 if (!first) {
6762 b.append(' ');
6763 }
6764 first = false;
6765 b.append("bnds=").append(mSourceBounds.toShortString());
6766 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006767 if (mClipData != null) {
6768 if (!first) {
6769 b.append(' ');
6770 }
6771 first = false;
6772 if (clip) {
6773 b.append("clip={");
6774 mClipData.toShortString(b);
6775 b.append('}');
6776 } else {
6777 b.append("(has clip)");
6778 }
6779 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006780 if (extras && mExtras != null) {
6781 if (!first) {
6782 b.append(' ');
6783 }
6784 first = false;
6785 b.append("(has extras)");
6786 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006787 if (mSelector != null) {
6788 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006789 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006790 b.append("}");
6791 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006792 }
6793
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006794 /**
6795 * Call {@link #toUri} with 0 flags.
6796 * @deprecated Use {@link #toUri} instead.
6797 */
6798 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006799 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006800 return toUri(0);
6801 }
6802
6803 /**
6804 * Convert this Intent into a String holding a URI representation of it.
6805 * The returned URI string has been properly URI encoded, so it can be
6806 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6807 * Intent's data as the base URI, with an additional fragment describing
6808 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006809 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006810 * <p>You can convert the returned string back to an Intent with
6811 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006812 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006813 * @param flags Additional operating flags. Either 0 or
6814 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006815 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006816 * @return Returns a URI encoding URI string describing the entire contents
6817 * of the Intent.
6818 */
6819 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006820 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006821 String scheme = null;
6822 if (mData != null) {
6823 String data = mData.toString();
6824 if ((flags&URI_INTENT_SCHEME) != 0) {
6825 final int N = data.length();
6826 for (int i=0; i<N; i++) {
6827 char c = data.charAt(i);
6828 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6829 || c == '.' || c == '-') {
6830 continue;
6831 }
6832 if (c == ':' && i > 0) {
6833 // Valid scheme.
6834 scheme = data.substring(0, i);
6835 uri.append("intent:");
6836 data = data.substring(i+1);
6837 break;
6838 }
Tom Taylord4a47292009-12-21 13:59:18 -08006839
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006840 // No scheme.
6841 break;
6842 }
6843 }
6844 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006845
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006846 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6847 uri.append("intent:");
6848 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006849
6850 uri.append("#Intent;");
6851
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006852 toUriInner(uri, scheme, flags);
6853 if (mSelector != null) {
6854 uri.append("SEL;");
6855 // Note that for now we are not going to try to handle the
6856 // data part; not clear how to represent this as a URI, and
6857 // not much utility in it.
6858 mSelector.toUriInner(uri, null, flags);
6859 }
6860
6861 uri.append("end");
6862
6863 return uri.toString();
6864 }
6865
6866 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006867 if (scheme != null) {
6868 uri.append("scheme=").append(scheme).append(';');
6869 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006870 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006871 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006872 }
6873 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006874 for (int i=0; i<mCategories.size(); i++) {
6875 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006876 }
6877 }
6878 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006879 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006880 }
6881 if (mFlags != 0) {
6882 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6883 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006884 if (mPackage != null) {
6885 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6886 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006887 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006888 uri.append("component=").append(Uri.encode(
6889 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006890 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006891 if (mSourceBounds != null) {
6892 uri.append("sourceBounds=")
6893 .append(Uri.encode(mSourceBounds.flattenToString()))
6894 .append(';');
6895 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006896 if (mExtras != null) {
6897 for (String key : mExtras.keySet()) {
6898 final Object value = mExtras.get(key);
6899 char entryType =
6900 value instanceof String ? 'S' :
6901 value instanceof Boolean ? 'B' :
6902 value instanceof Byte ? 'b' :
6903 value instanceof Character ? 'c' :
6904 value instanceof Double ? 'd' :
6905 value instanceof Float ? 'f' :
6906 value instanceof Integer ? 'i' :
6907 value instanceof Long ? 'l' :
6908 value instanceof Short ? 's' :
6909 '\0';
6910
6911 if (entryType != '\0') {
6912 uri.append(entryType);
6913 uri.append('.');
6914 uri.append(Uri.encode(key));
6915 uri.append('=');
6916 uri.append(Uri.encode(value.toString()));
6917 uri.append(';');
6918 }
6919 }
6920 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006921 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006922
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006923 public int describeContents() {
6924 return (mExtras != null) ? mExtras.describeContents() : 0;
6925 }
6926
6927 public void writeToParcel(Parcel out, int flags) {
6928 out.writeString(mAction);
6929 Uri.writeToParcel(out, mData);
6930 out.writeString(mType);
6931 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006932 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006933 ComponentName.writeToParcel(mComponent, out);
6934
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006935 if (mSourceBounds != null) {
6936 out.writeInt(1);
6937 mSourceBounds.writeToParcel(out, flags);
6938 } else {
6939 out.writeInt(0);
6940 }
6941
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006942 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006943 final int N = mCategories.size();
6944 out.writeInt(N);
6945 for (int i=0; i<N; i++) {
6946 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006947 }
6948 } else {
6949 out.writeInt(0);
6950 }
6951
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006952 if (mSelector != null) {
6953 out.writeInt(1);
6954 mSelector.writeToParcel(out, flags);
6955 } else {
6956 out.writeInt(0);
6957 }
6958
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006959 if (mClipData != null) {
6960 out.writeInt(1);
6961 mClipData.writeToParcel(out, flags);
6962 } else {
6963 out.writeInt(0);
6964 }
6965
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006966 out.writeBundle(mExtras);
6967 }
6968
6969 public static final Parcelable.Creator<Intent> CREATOR
6970 = new Parcelable.Creator<Intent>() {
6971 public Intent createFromParcel(Parcel in) {
6972 return new Intent(in);
6973 }
6974 public Intent[] newArray(int size) {
6975 return new Intent[size];
6976 }
6977 };
6978
Dianne Hackborneb034652009-09-07 00:49:58 -07006979 /** @hide */
6980 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006981 readFromParcel(in);
6982 }
6983
6984 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006985 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006986 mData = Uri.CREATOR.createFromParcel(in);
6987 mType = in.readString();
6988 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006989 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006990 mComponent = ComponentName.readFromParcel(in);
6991
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006992 if (in.readInt() != 0) {
6993 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6994 }
6995
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006996 int N = in.readInt();
6997 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006998 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006999 int i;
7000 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007001 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007002 }
7003 } else {
7004 mCategories = null;
7005 }
7006
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007007 if (in.readInt() != 0) {
7008 mSelector = new Intent(in);
7009 }
7010
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007011 if (in.readInt() != 0) {
7012 mClipData = new ClipData(in);
7013 }
7014
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007015 mExtras = in.readBundle();
7016 }
7017
7018 /**
7019 * Parses the "intent" element (and its children) from XML and instantiates
7020 * an Intent object. The given XML parser should be located at the tag
7021 * where parsing should start (often named "intent"), from which the
7022 * basic action, data, type, and package and class name will be
7023 * retrieved. The function will then parse in to any child elements,
7024 * looking for <category android:name="xxx"> tags to add categories and
7025 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7026 * to the intent.
7027 *
7028 * @param resources The Resources to use when inflating resources.
7029 * @param parser The XML parser pointing at an "intent" tag.
7030 * @param attrs The AttributeSet interface for retrieving extended
7031 * attribute data at the current <var>parser</var> location.
7032 * @return An Intent object matching the XML data.
7033 * @throws XmlPullParserException If there was an XML parsing error.
7034 * @throws IOException If there was an I/O error.
7035 */
7036 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7037 throws XmlPullParserException, IOException {
7038 Intent intent = new Intent();
7039
7040 TypedArray sa = resources.obtainAttributes(attrs,
7041 com.android.internal.R.styleable.Intent);
7042
7043 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7044
7045 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7046 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7047 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7048
7049 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7050 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7051 if (packageName != null && className != null) {
7052 intent.setComponent(new ComponentName(packageName, className));
7053 }
7054
7055 sa.recycle();
7056
7057 int outerDepth = parser.getDepth();
7058 int type;
7059 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7060 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7061 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7062 continue;
7063 }
7064
7065 String nodeName = parser.getName();
7066 if (nodeName.equals("category")) {
7067 sa = resources.obtainAttributes(attrs,
7068 com.android.internal.R.styleable.IntentCategory);
7069 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7070 sa.recycle();
7071
7072 if (cat != null) {
7073 intent.addCategory(cat);
7074 }
7075 XmlUtils.skipCurrentTag(parser);
7076
7077 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007078 if (intent.mExtras == null) {
7079 intent.mExtras = new Bundle();
7080 }
7081 resources.parseBundleExtra("extra", attrs, intent.mExtras);
7082 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007083
7084 } else {
7085 XmlUtils.skipCurrentTag(parser);
7086 }
7087 }
7088
7089 return intent;
7090 }
Nick Pellyccae4122012-01-09 14:12:58 -08007091
7092 /**
7093 * Normalize a MIME data type.
7094 *
7095 * <p>A normalized MIME type has white-space trimmed,
7096 * content-type parameters removed, and is lower-case.
7097 * This aligns the type with Android best practices for
7098 * intent filtering.
7099 *
7100 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7101 * "text/x-vCard" becomes "text/x-vcard".
7102 *
7103 * <p>All MIME types received from outside Android (such as user input,
7104 * or external sources like Bluetooth, NFC, or the Internet) should
7105 * be normalized before they are used to create an Intent.
7106 *
7107 * @param type MIME data type to normalize
7108 * @return normalized MIME data type, or null if the input was null
7109 * @see {@link #setType}
7110 * @see {@link #setTypeAndNormalize}
7111 */
7112 public static String normalizeMimeType(String type) {
7113 if (type == null) {
7114 return null;
7115 }
7116
Elliott Hughescb64d432013-08-02 10:00:44 -07007117 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007118
7119 final int semicolonIndex = type.indexOf(';');
7120 if (semicolonIndex != -1) {
7121 type = type.substring(0, semicolonIndex);
7122 }
7123 return type;
7124 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007125
7126 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007127 * Prepare this {@link Intent} to leave an app process.
7128 *
7129 * @hide
7130 */
7131 public void prepareToLeaveProcess() {
7132 setAllowFds(false);
7133
7134 if (mSelector != null) {
7135 mSelector.prepareToLeaveProcess();
7136 }
7137 if (mClipData != null) {
7138 mClipData.prepareToLeaveProcess();
7139 }
7140
7141 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7142 // There are several ACTION_MEDIA_* broadcasts that send file://
7143 // Uris, so only check common actions.
7144 if (ACTION_VIEW.equals(mAction) ||
7145 ACTION_EDIT.equals(mAction) ||
7146 ACTION_ATTACH_DATA.equals(mAction)) {
7147 mData.checkFileUriExposed("Intent.getData()");
7148 }
7149 }
7150 }
7151
7152 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007153 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007154 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7155 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007156 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007157 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007158 * @hide
7159 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007160 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007161 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007162 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007163
7164 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007165 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007166
7167 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007168 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007169 try {
7170 // Inspect target intent to see if we need to migrate
7171 final Intent target = getParcelableExtra(EXTRA_INTENT);
7172 if (target != null && target.migrateExtraStreamToClipData()) {
7173 // Since we migrated in child, we need to promote ClipData
7174 // and flags to ourselves to grant.
7175 setClipData(target.getClipData());
7176 addFlags(target.getFlags()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07007177 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION
7178 | FLAG_PERSIST_GRANT_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007179 return true;
7180 } else {
7181 return false;
7182 }
7183 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007184 }
7185
7186 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007187 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007188 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7189 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7190 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7191 if (stream != null || text != null || htmlText != null) {
7192 final ClipData clipData = new ClipData(
7193 null, new String[] { getType() },
7194 new ClipData.Item(text, htmlText, null, stream));
7195 setClipData(clipData);
7196 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007197 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007198 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007199 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007200 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007201
7202 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007203 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007204 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7205 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7206 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7207 int num = -1;
7208 if (streams != null) {
7209 num = streams.size();
7210 }
7211 if (texts != null) {
7212 if (num >= 0 && num != texts.size()) {
7213 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007214 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007215 }
7216 num = texts.size();
7217 }
7218 if (htmlTexts != null) {
7219 if (num >= 0 && num != htmlTexts.size()) {
7220 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007221 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007222 }
7223 num = htmlTexts.size();
7224 }
7225 if (num > 0) {
7226 final ClipData clipData = new ClipData(
7227 null, new String[] { getType() },
7228 makeClipItem(streams, texts, htmlTexts, 0));
7229
7230 for (int i = 1; i < num; i++) {
7231 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7232 }
7233
7234 setClipData(clipData);
7235 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007236 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007237 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007238 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007239 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007240 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007241
7242 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007243 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007244
7245 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7246 ArrayList<String> htmlTexts, int which) {
7247 Uri uri = streams != null ? streams.get(which) : null;
7248 CharSequence text = texts != null ? texts.get(which) : null;
7249 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7250 return new ClipData.Item(text, htmlText, null, uri);
7251 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007252}