blob: 4ef42ca42a3edc3d0f4f8057ada8e587fef5d3f3 [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
Tor Norbyed9273d62013-05-30 15:59:53 -070024import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070025import android.annotation.SdkConstant;
26import android.annotation.SdkConstant.SdkConstantType;
27import android.content.pm.ActivityInfo;
28import android.content.pm.PackageManager;
29import android.content.pm.ResolveInfo;
30import android.content.res.Resources;
31import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080032import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070033import android.net.Uri;
34import android.os.Bundle;
35import android.os.IBinder;
36import android.os.Parcel;
37import android.os.Parcelable;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070038import android.os.StrictMode;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070039import android.provider.DocumentsContract;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070040import android.util.AttributeSet;
41import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080042
43import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070044
45import java.io.IOException;
46import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070047import java.lang.annotation.Retention;
48import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070049import java.net.URISyntaxException;
50import java.util.ArrayList;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070051import java.util.Iterator;
Dianne Hackborn221ea892013-08-04 16:50:16 -070052import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080053import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054import java.util.Set;
55
56/**
57 * An intent is an abstract description of an operation to be performed. It
58 * can be used with {@link Context#startActivity(Intent) startActivity} to
59 * launch an {@link android.app.Activity},
60 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
61 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
62 * and {@link android.content.Context#startService} or
63 * {@link android.content.Context#bindService} to communicate with a
64 * background {@link android.app.Service}.
65 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070066 * <p>An Intent provides a facility for performing late runtime binding between the code in
67 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070068 * can be thought of as the glue between activities. It is basically a passive data structure
69 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070070 *
71 * <div class="special reference">
72 * <h3>Developer Guides</h3>
73 * <p>For information about how to create and resolve intents, read the
74 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
75 * developer guide.</p>
76 * </div>
77 *
78 * <a name="IntentStructure"></a>
79 * <h3>Intent Structure</h3>
80 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070081 *
82 * <ul>
83 * <li> <p><b>action</b> -- The general action to be performed, such as
84 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
85 * etc.</p>
86 * </li>
87 * <li> <p><b>data</b> -- The data to operate on, such as a person record
88 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
89 * </li>
90 * </ul>
91 *
92 *
93 * <p>Some examples of action/data pairs are:</p>
94 *
95 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070096 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070097 * information about the person whose identifier is "1".</p>
98 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070099 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700100 * the phone dialer with the person filled in.</p>
101 * </li>
102 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
103 * the phone dialer with the given number filled in. Note how the
104 * VIEW action does what what is considered the most reasonable thing for
105 * a particular URI.</p>
106 * </li>
107 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
108 * the phone dialer with the given number filled in.</p>
109 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700110 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700111 * information about the person whose identifier is "1".</p>
112 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700113 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700114 * a list of people, which the user can browse through. This example is a
115 * typical top-level entry into the Contacts application, showing you the
116 * list of people. Selecting a particular person to view would result in a
117 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
118 * being used to start an activity to display that person.</p>
119 * </li>
120 * </ul>
121 *
122 * <p>In addition to these primary attributes, there are a number of secondary
123 * attributes that you can also include with an intent:</p>
124 *
125 * <ul>
126 * <li> <p><b>category</b> -- Gives additional information about the action
127 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
128 * appear in the Launcher as a top-level application, while
129 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
130 * of alternative actions the user can perform on a piece of data.</p>
131 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
132 * intent data. Normally the type is inferred from the data itself.
133 * By setting this attribute, you disable that evaluation and force
134 * an explicit type.</p>
135 * <li> <p><b>component</b> -- Specifies an explicit name of a component
136 * class to use for the intent. Normally this is determined by looking
137 * at the other information in the intent (the action, data/type, and
138 * categories) and matching that with a component that can handle it.
139 * If this attribute is set then none of the evaluation is performed,
140 * and this component is used exactly as is. By specifying this attribute,
141 * all of the other Intent attributes become optional.</p>
142 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
143 * This can be used to provide extended information to the component.
144 * For example, if we have a action to send an e-mail message, we could
145 * also include extra pieces of data here to supply a subject, body,
146 * etc.</p>
147 * </ul>
148 *
149 * <p>Here are some examples of other operations you can specify as intents
150 * using these additional parameters:</p>
151 *
152 * <ul>
153 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
154 * Launch the home screen.</p>
155 * </li>
156 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
157 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
158 * vnd.android.cursor.item/phone}</i></b>
159 * -- Display the list of people's phone numbers, allowing the user to
160 * browse through them and pick one and return it to the parent activity.</p>
161 * </li>
162 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
163 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
164 * -- Display all pickers for data that can be opened with
165 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
166 * allowing the user to pick one of them and then some data inside of it
167 * and returning the resulting URI to the caller. This can be used,
168 * for example, in an e-mail application to allow the user to pick some
169 * data to include as an attachment.</p>
170 * </li>
171 * </ul>
172 *
173 * <p>There are a variety of standard Intent action and category constants
174 * defined in the Intent class, but applications can also define their own.
175 * These strings use java style scoping, to ensure they are unique -- for
176 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700177 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700178 *
179 * <p>Put together, the set of actions, data types, categories, and extra data
180 * defines a language for the system allowing for the expression of phrases
181 * such as "call john smith's cell". As applications are added to the system,
182 * they can extend this language by adding new actions, types, and categories, or
183 * they can modify the behavior of existing phrases by supplying their own
184 * activities that handle them.</p>
185 *
186 * <a name="IntentResolution"></a>
187 * <h3>Intent Resolution</h3>
188 *
189 * <p>There are two primary forms of intents you will use.
190 *
191 * <ul>
192 * <li> <p><b>Explicit Intents</b> have specified a component (via
193 * {@link #setComponent} or {@link #setClass}), which provides the exact
194 * class to be run. Often these will not include any other information,
195 * simply being a way for an application to launch various internal
196 * activities it has as the user interacts with the application.
197 *
198 * <li> <p><b>Implicit Intents</b> have not specified a component;
199 * instead, they must include enough information for the system to
200 * determine which of the available components is best to run for that
201 * intent.
202 * </ul>
203 *
204 * <p>When using implicit intents, given such an arbitrary intent we need to
205 * know what to do with it. This is handled by the process of <em>Intent
206 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
207 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
208 * more activities/receivers) that can handle it.</p>
209 *
210 * <p>The intent resolution mechanism basically revolves around matching an
211 * Intent against all of the &lt;intent-filter&gt; descriptions in the
212 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
213 * objects explicitly registered with {@link Context#registerReceiver}.) More
214 * details on this can be found in the documentation on the {@link
215 * IntentFilter} class.</p>
216 *
217 * <p>There are three pieces of information in the Intent that are used for
218 * resolution: the action, type, and category. Using this information, a query
219 * is done on the {@link PackageManager} for a component that can handle the
220 * intent. The appropriate component is determined based on the intent
221 * information supplied in the <code>AndroidManifest.xml</code> file as
222 * follows:</p>
223 *
224 * <ul>
225 * <li> <p>The <b>action</b>, if given, must be listed by the component as
226 * one it handles.</p>
227 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
228 * already supplied in the Intent. Like the action, if a type is
229 * included in the intent (either explicitly or implicitly in its
230 * data), then this must be listed by the component as one it handles.</p>
231 * <li> For data that is not a <code>content:</code> URI and where no explicit
232 * type is included in the Intent, instead the <b>scheme</b> of the
233 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
234 * considered. Again like the action, if we are matching a scheme it
235 * must be listed by the component as one it can handle.
236 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
237 * by the activity as categories it handles. That is, if you include
238 * the categories {@link #CATEGORY_LAUNCHER} and
239 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
240 * with an intent that lists <em>both</em> of those categories.
241 * Activities will very often need to support the
242 * {@link #CATEGORY_DEFAULT} so that they can be found by
243 * {@link Context#startActivity Context.startActivity()}.</p>
244 * </ul>
245 *
246 * <p>For example, consider the Note Pad sample application that
247 * allows user to browse through a list of notes data and view details about
248 * individual items. Text in italics indicate places were you would replace a
249 * name with one specific to your own package.</p>
250 *
251 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
252 * package="<i>com.android.notepad</i>"&gt;
253 * &lt;application android:icon="@drawable/app_notes"
254 * android:label="@string/app_name"&gt;
255 *
256 * &lt;provider class=".NotePadProvider"
257 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
258 *
259 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
260 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700261 * &lt;action android:name="android.intent.action.MAIN" /&gt;
262 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700263 * &lt;/intent-filter&gt;
264 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700265 * &lt;action android:name="android.intent.action.VIEW" /&gt;
266 * &lt;action android:name="android.intent.action.EDIT" /&gt;
267 * &lt;action android:name="android.intent.action.PICK" /&gt;
268 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
269 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700270 * &lt;/intent-filter&gt;
271 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700272 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
273 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
274 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700275 * &lt;/intent-filter&gt;
276 * &lt;/activity&gt;
277 *
278 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
279 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700280 * &lt;action android:name="android.intent.action.VIEW" /&gt;
281 * &lt;action android:name="android.intent.action.EDIT" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 *
286 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700287 * &lt;action android:name="android.intent.action.INSERT" /&gt;
288 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
289 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700290 * &lt;/intent-filter&gt;
291 *
292 * &lt;/activity&gt;
293 *
294 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
295 * android:theme="@android:style/Theme.Dialog"&gt;
296 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700297 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
298 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
299 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
300 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
301 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700302 * &lt;/intent-filter&gt;
303 * &lt;/activity&gt;
304 *
305 * &lt;/application&gt;
306 * &lt;/manifest&gt;</pre>
307 *
308 * <p>The first activity,
309 * <code>com.android.notepad.NotesList</code>, serves as our main
310 * entry into the app. It can do three things as described by its three intent
311 * templates:
312 * <ol>
313 * <li><pre>
314 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700315 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
316 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700317 * &lt;/intent-filter&gt;</pre>
318 * <p>This provides a top-level entry into the NotePad application: the standard
319 * MAIN action is a main entry point (not requiring any other information in
320 * the Intent), and the LAUNCHER category says that this entry point should be
321 * listed in the application launcher.</p>
322 * <li><pre>
323 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700324 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
325 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
326 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
327 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
328 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700329 * &lt;/intent-filter&gt;</pre>
330 * <p>This declares the things that the activity can do on a directory of
331 * notes. The type being supported is given with the &lt;type&gt; tag, where
332 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
333 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
334 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
335 * The activity allows the user to view or edit the directory of data (via
336 * the VIEW and EDIT actions), or to pick a particular note and return it
337 * to the caller (via the PICK action). Note also the DEFAULT category
338 * supplied here: this is <em>required</em> for the
339 * {@link Context#startActivity Context.startActivity} method to resolve your
340 * activity when its component name is not explicitly specified.</p>
341 * <li><pre>
342 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700343 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
344 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
345 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700346 * &lt;/intent-filter&gt;</pre>
347 * <p>This filter describes the ability return to the caller a note selected by
348 * the user without needing to know where it came from. The data type
349 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
350 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
351 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
352 * The GET_CONTENT action is similar to the PICK action, where the activity
353 * will return to its caller a piece of data selected by the user. Here,
354 * however, the caller specifies the type of data they desire instead of
355 * the type of data the user will be picking from.</p>
356 * </ol>
357 *
358 * <p>Given these capabilities, the following intents will resolve to the
359 * NotesList activity:</p>
360 *
361 * <ul>
362 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
363 * activities that can be used as top-level entry points into an
364 * application.</p>
365 * <li> <p><b>{ action=android.app.action.MAIN,
366 * category=android.app.category.LAUNCHER }</b> is the actual intent
367 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700368 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700369 * data=content://com.google.provider.NotePad/notes }</b>
370 * displays a list of all the notes under
371 * "content://com.google.provider.NotePad/notes", which
372 * the user can browse through and see the details on.</p>
373 * <li> <p><b>{ action=android.app.action.PICK
374 * data=content://com.google.provider.NotePad/notes }</b>
375 * provides a list of the notes under
376 * "content://com.google.provider.NotePad/notes", from which
377 * the user can pick a note whose data URL is returned back to the caller.</p>
378 * <li> <p><b>{ action=android.app.action.GET_CONTENT
379 * type=vnd.android.cursor.item/vnd.google.note }</b>
380 * is similar to the pick action, but allows the caller to specify the
381 * kind of data they want back so that the system can find the appropriate
382 * activity to pick something of that data type.</p>
383 * </ul>
384 *
385 * <p>The second activity,
386 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
387 * note entry and allows them to edit it. It can do two things as described
388 * by its two intent templates:
389 * <ol>
390 * <li><pre>
391 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700392 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
393 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
394 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
395 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700396 * &lt;/intent-filter&gt;</pre>
397 * <p>The first, primary, purpose of this activity is to let the user interact
398 * with a single note, as decribed by the MIME type
399 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
400 * either VIEW a note or allow the user to EDIT it. Again we support the
401 * DEFAULT category to allow the activity to be launched without explicitly
402 * specifying its component.</p>
403 * <li><pre>
404 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700405 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
406 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
407 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700408 * &lt;/intent-filter&gt;</pre>
409 * <p>The secondary use of this activity is to insert a new note entry into
410 * an existing directory of notes. This is used when the user creates a new
411 * note: the INSERT action is executed on the directory of notes, causing
412 * this activity to run and have the user create the new note data which
413 * it then adds to the content provider.</p>
414 * </ol>
415 *
416 * <p>Given these capabilities, the following intents will resolve to the
417 * NoteEditor activity:</p>
418 *
419 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700420 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700421 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
422 * shows the user the content of note <var>{ID}</var>.</p>
423 * <li> <p><b>{ action=android.app.action.EDIT
424 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
425 * allows the user to edit the content of note <var>{ID}</var>.</p>
426 * <li> <p><b>{ action=android.app.action.INSERT
427 * data=content://com.google.provider.NotePad/notes }</b>
428 * creates a new, empty note in the notes list at
429 * "content://com.google.provider.NotePad/notes"
430 * and allows the user to edit it. If they keep their changes, the URI
431 * of the newly created note is returned to the caller.</p>
432 * </ul>
433 *
434 * <p>The last activity,
435 * <code>com.android.notepad.TitleEditor</code>, allows the user to
436 * edit the title of a note. This could be implemented as a class that the
437 * application directly invokes (by explicitly setting its component in
438 * the Intent), but here we show a way you can publish alternative
439 * operations on existing data:</p>
440 *
441 * <pre>
442 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700443 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
444 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
445 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
446 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
447 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700448 * &lt;/intent-filter&gt;</pre>
449 *
450 * <p>In the single intent template here, we
451 * have created our own private action called
452 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
453 * edit the title of a note. It must be invoked on a specific note
454 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
455 * view and edit actions, but here displays and edits the title contained
456 * in the note data.
457 *
458 * <p>In addition to supporting the default category as usual, our title editor
459 * also supports two other standard categories: ALTERNATIVE and
460 * SELECTED_ALTERNATIVE. Implementing
461 * these categories allows others to find the special action it provides
462 * without directly knowing about it, through the
463 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
464 * more often to build dynamic menu items with
465 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
466 * template here was also supply an explicit name for the template
467 * (via <code>android:label="@string/resolve_title"</code>) to better control
468 * what the user sees when presented with this activity as an alternative
469 * action to the data they are viewing.
470 *
471 * <p>Given these capabilities, the following intent will resolve to the
472 * TitleEditor activity:</p>
473 *
474 * <ul>
475 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
476 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
477 * displays and allows the user to edit the title associated
478 * with note <var>{ID}</var>.</p>
479 * </ul>
480 *
481 * <h3>Standard Activity Actions</h3>
482 *
483 * <p>These are the current standard actions that Intent defines for launching
484 * activities (usually through {@link Context#startActivity}. The most
485 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
486 * {@link #ACTION_EDIT}.
487 *
488 * <ul>
489 * <li> {@link #ACTION_MAIN}
490 * <li> {@link #ACTION_VIEW}
491 * <li> {@link #ACTION_ATTACH_DATA}
492 * <li> {@link #ACTION_EDIT}
493 * <li> {@link #ACTION_PICK}
494 * <li> {@link #ACTION_CHOOSER}
495 * <li> {@link #ACTION_GET_CONTENT}
496 * <li> {@link #ACTION_DIAL}
497 * <li> {@link #ACTION_CALL}
498 * <li> {@link #ACTION_SEND}
499 * <li> {@link #ACTION_SENDTO}
500 * <li> {@link #ACTION_ANSWER}
501 * <li> {@link #ACTION_INSERT}
502 * <li> {@link #ACTION_DELETE}
503 * <li> {@link #ACTION_RUN}
504 * <li> {@link #ACTION_SYNC}
505 * <li> {@link #ACTION_PICK_ACTIVITY}
506 * <li> {@link #ACTION_SEARCH}
507 * <li> {@link #ACTION_WEB_SEARCH}
508 * <li> {@link #ACTION_FACTORY_TEST}
509 * </ul>
510 *
511 * <h3>Standard Broadcast Actions</h3>
512 *
513 * <p>These are the current standard actions that Intent defines for receiving
514 * broadcasts (usually through {@link Context#registerReceiver} or a
515 * &lt;receiver&gt; tag in a manifest).
516 *
517 * <ul>
518 * <li> {@link #ACTION_TIME_TICK}
519 * <li> {@link #ACTION_TIME_CHANGED}
520 * <li> {@link #ACTION_TIMEZONE_CHANGED}
521 * <li> {@link #ACTION_BOOT_COMPLETED}
522 * <li> {@link #ACTION_PACKAGE_ADDED}
523 * <li> {@link #ACTION_PACKAGE_CHANGED}
524 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800525 * <li> {@link #ACTION_PACKAGE_RESTARTED}
526 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700527 * <li> {@link #ACTION_UID_REMOVED}
528 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700529 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700530 * <li> {@link #ACTION_POWER_DISCONNECTED}
531 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700532 * </ul>
533 *
534 * <h3>Standard Categories</h3>
535 *
536 * <p>These are the current standard categories that can be used to further
537 * clarify an Intent via {@link #addCategory}.
538 *
539 * <ul>
540 * <li> {@link #CATEGORY_DEFAULT}
541 * <li> {@link #CATEGORY_BROWSABLE}
542 * <li> {@link #CATEGORY_TAB}
543 * <li> {@link #CATEGORY_ALTERNATIVE}
544 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
545 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800546 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700547 * <li> {@link #CATEGORY_HOME}
548 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400550 * <li> {@link #CATEGORY_CAR_DOCK}
551 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500552 * <li> {@link #CATEGORY_LE_DESK_DOCK}
553 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200554 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700555 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700556 * </ul>
557 *
558 * <h3>Standard Extra Data</h3>
559 *
560 * <p>These are the current standard fields that can be used as extra data via
561 * {@link #putExtra}.
562 *
563 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800564 * <li> {@link #EXTRA_ALARM_COUNT}
565 * <li> {@link #EXTRA_BCC}
566 * <li> {@link #EXTRA_CC}
567 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
568 * <li> {@link #EXTRA_DATA_REMOVED}
569 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500570 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
571 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800572 * <li> {@link #EXTRA_DOCK_STATE_CAR}
573 * <li> {@link #EXTRA_DOCK_STATE_DESK}
574 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
575 * <li> {@link #EXTRA_DONT_KILL_APP}
576 * <li> {@link #EXTRA_EMAIL}
577 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700578 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800579 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700580 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800581 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700582 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800583 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
584 * <li> {@link #EXTRA_REPLACING}
585 * <li> {@link #EXTRA_SHORTCUT_ICON}
586 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
587 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700588 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800589 * <li> {@link #EXTRA_SHORTCUT_NAME}
590 * <li> {@link #EXTRA_SUBJECT}
591 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700592 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800593 * <li> {@link #EXTRA_TITLE}
594 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 * </ul>
596 *
597 * <h3>Flags</h3>
598 *
599 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800600 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
601 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700602 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800603public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700604 // ---------------------------------------------------------------------
605 // ---------------------------------------------------------------------
606 // Standard intent activity actions (see action variable).
607
608 /**
609 * Activity Action: Start as a main entry point, does not expect to
610 * receive data.
611 * <p>Input: nothing
612 * <p>Output: nothing
613 */
614 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
615 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800616
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700617 /**
618 * Activity Action: Display the data to the user. This is the most common
619 * action performed on data -- it is the generic action you can use on
620 * a piece of data to get the most reasonable thing to occur. For example,
621 * when used on a contacts entry it will view the entry; when used on a
622 * mailto: URI it will bring up a compose window filled with the information
623 * supplied by the URI; when used with a tel: URI it will invoke the
624 * dialer.
625 * <p>Input: {@link #getData} is URI from which to retrieve data.
626 * <p>Output: nothing.
627 */
628 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
629 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800630
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700631 /**
632 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
633 * performed on a piece of data.
634 */
635 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800636
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700637 /**
638 * Used to indicate that some piece of data should be attached to some other
639 * place. For example, image data could be attached to a contact. It is up
640 * to the recipient to decide where the data should be attached; the intent
641 * does not specify the ultimate destination.
642 * <p>Input: {@link #getData} is URI of data to be attached.
643 * <p>Output: nothing.
644 */
645 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
646 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800647
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700648 /**
649 * Activity Action: Provide explicit editable access to the given data.
650 * <p>Input: {@link #getData} is URI of data to be edited.
651 * <p>Output: nothing.
652 */
653 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
654 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800655
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700656 /**
657 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
658 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
659 * The extras can contain type specific data to pass through to the editing/creating
660 * activity.
661 * <p>Output: The URI of the item that was picked. This must be a content:
662 * URI so that any receiver can access it.
663 */
664 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
665 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800666
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700667 /**
668 * Activity Action: Pick an item from the data, returning what was selected.
669 * <p>Input: {@link #getData} is URI containing a directory of data
670 * (vnd.android.cursor.dir/*) from which to pick an item.
671 * <p>Output: The URI of the item that was picked.
672 */
673 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
674 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800675
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700676 /**
677 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800678 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700679 * <p>Output: An Intent representing the shortcut. The intent must contain three
680 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
681 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800682 * (value: ShortcutIconResource).</p>
683 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700684 * @see #EXTRA_SHORTCUT_INTENT
685 * @see #EXTRA_SHORTCUT_NAME
686 * @see #EXTRA_SHORTCUT_ICON
687 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
688 * @see android.content.Intent.ShortcutIconResource
689 */
690 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
691 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
692
693 /**
694 * The name of the extra used to define the Intent of a shortcut.
695 *
696 * @see #ACTION_CREATE_SHORTCUT
697 */
698 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
699 /**
700 * The name of the extra used to define the name of a shortcut.
701 *
702 * @see #ACTION_CREATE_SHORTCUT
703 */
704 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
705 /**
706 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
707 *
708 * @see #ACTION_CREATE_SHORTCUT
709 */
710 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
711 /**
712 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
713 *
714 * @see #ACTION_CREATE_SHORTCUT
715 * @see android.content.Intent.ShortcutIconResource
716 */
717 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
718 "android.intent.extra.shortcut.ICON_RESOURCE";
719
720 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800721 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700722 *
723 * @see Intent#ACTION_CREATE_SHORTCUT
724 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800725 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
726 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700727 */
728 public static class ShortcutIconResource implements Parcelable {
729 /**
730 * The package name of the application containing the icon.
731 */
732 public String packageName;
733
734 /**
735 * The resource name of the icon, including package, name and type.
736 */
737 public String resourceName;
738
739 /**
740 * Creates a new ShortcutIconResource for the specified context and resource
741 * identifier.
742 *
743 * @param context The context of the application.
744 * @param resourceId The resource idenfitier for the icon.
745 * @return A new ShortcutIconResource with the specified's context package name
746 * and icon resource idenfitier.
747 */
748 public static ShortcutIconResource fromContext(Context context, int resourceId) {
749 ShortcutIconResource icon = new ShortcutIconResource();
750 icon.packageName = context.getPackageName();
751 icon.resourceName = context.getResources().getResourceName(resourceId);
752 return icon;
753 }
754
755 /**
756 * Used to read a ShortcutIconResource from a Parcel.
757 */
758 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
759 new Parcelable.Creator<ShortcutIconResource>() {
760
761 public ShortcutIconResource createFromParcel(Parcel source) {
762 ShortcutIconResource icon = new ShortcutIconResource();
763 icon.packageName = source.readString();
764 icon.resourceName = source.readString();
765 return icon;
766 }
767
768 public ShortcutIconResource[] newArray(int size) {
769 return new ShortcutIconResource[size];
770 }
771 };
772
773 /**
774 * No special parcel contents.
775 */
776 public int describeContents() {
777 return 0;
778 }
779
780 public void writeToParcel(Parcel dest, int flags) {
781 dest.writeString(packageName);
782 dest.writeString(resourceName);
783 }
784
785 @Override
786 public String toString() {
787 return resourceName;
788 }
789 }
790
791 /**
792 * Activity Action: Display an activity chooser, allowing the user to pick
793 * what they want to before proceeding. This can be used as an alternative
794 * to the standard activity picker that is displayed by the system when
795 * you try to start an activity with multiple possible matches, with these
796 * differences in behavior:
797 * <ul>
798 * <li>You can specify the title that will appear in the activity chooser.
799 * <li>The user does not have the option to make one of the matching
800 * activities a preferred activity, and all possible activities will
801 * always be shown even if one of them is currently marked as the
802 * preferred activity.
803 * </ul>
804 * <p>
805 * This action should be used when the user will naturally expect to
806 * select an activity in order to proceed. An example if when not to use
807 * it is when the user clicks on a "mailto:" link. They would naturally
808 * expect to go directly to their mail app, so startActivity() should be
809 * called directly: it will
810 * either launch the current preferred app, or put up a dialog allowing the
811 * user to pick an app to use and optionally marking that as preferred.
812 * <p>
813 * In contrast, if the user is selecting a menu item to send a picture
814 * they are viewing to someone else, there are many different things they
815 * may want to do at this point: send it through e-mail, upload it to a
816 * web service, etc. In this case the CHOOSER action should be used, to
817 * always present to the user a list of the things they can do, with a
818 * nice title given by the caller such as "Send this photo with:".
819 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700820 * If you need to grant URI permissions through a chooser, you must specify
821 * the permissions to be granted on the ACTION_CHOOSER Intent
822 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
823 * {@link #setClipData} to specify the URIs to be granted as well as
824 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
825 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
826 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700827 * As a convenience, an Intent of this form can be created with the
828 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700829 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700830 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700831 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
832 * and can optionally have a {@link #EXTRA_TITLE} field containing the
833 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700834 * <p>
835 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700836 */
837 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
838 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
839
840 /**
841 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
842 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700843 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
844 * target intent, also optionally supplying a title. If the target
845 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
846 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
847 * set in the returned chooser intent, with its ClipData set appropriately:
848 * either a direct reflection of {@link #getClipData()} if that is non-null,
849 * or a new ClipData build from {@link #getData()}.
850 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700851 * @param target The Intent that the user will be selecting an activity
852 * to perform.
853 * @param title Optional title that will be displayed in the chooser.
854 * @return Return a new Intent object that you can hand to
855 * {@link Context#startActivity(Intent) Context.startActivity()} and
856 * related methods.
857 */
858 public static Intent createChooser(Intent target, CharSequence title) {
859 Intent intent = new Intent(ACTION_CHOOSER);
860 intent.putExtra(EXTRA_INTENT, target);
861 if (title != null) {
862 intent.putExtra(EXTRA_TITLE, title);
863 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700864
865 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700866 int permFlags = target.getFlags()
867 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
868 if (permFlags != 0) {
869 ClipData targetClipData = target.getClipData();
870 if (targetClipData == null && target.getData() != null) {
871 ClipData.Item item = new ClipData.Item(target.getData());
872 String[] mimeTypes;
873 if (target.getType() != null) {
874 mimeTypes = new String[] { target.getType() };
875 } else {
876 mimeTypes = new String[] { };
877 }
878 targetClipData = new ClipData(null, mimeTypes, item);
879 }
880 if (targetClipData != null) {
881 intent.setClipData(targetClipData);
882 intent.addFlags(permFlags);
883 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700884 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700885
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700886 return intent;
887 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700888
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700889 /**
890 * Activity Action: Allow the user to select a particular kind of data and
891 * return it. This is different than {@link #ACTION_PICK} in that here we
892 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800893 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700894 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900895 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700896 * etc.
897 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900898 * 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 -0700899 * of data, such as a person contact, you set the MIME type to the kind of
900 * data you want and launch it with {@link Context#startActivity(Intent)}.
901 * The system will then launch the best application to select that kind
902 * of data for you.
903 * <p>
904 * You may also be interested in any of a set of types of content the user
905 * can pick. For example, an e-mail application that wants to allow the
906 * user to add an attachment to an e-mail message can use this action to
907 * bring up a list of all of the types of content the user can attach.
908 * <p>
909 * In this case, you should wrap the GET_CONTENT intent with a chooser
910 * (through {@link #createChooser}), which will give the proper interface
911 * for the user to pick how to send your data and allow you to specify
912 * a prompt indicating what they are doing. You will usually specify a
913 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
914 * broad range of content types the user can select from.
915 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900916 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700917 * only pick from data that can be represented as a stream. This is
918 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
919 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800920 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900921 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800922 * is locally available on the device. For example, if this extra is set
923 * to true then an image picker should not show any pictures that are available
924 * from a remote server but not already on the local device (thus requiring
925 * they be downloaded when opened).
926 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800927 * If the caller can handle multiple returned items (the user performing
928 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
929 * to indicate this.
930 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700931 * Input: {@link #getType} is the desired MIME type to retrieve. Note
932 * that no URI is supplied in the intent, as there are no constraints on
933 * where the returned data originally comes from. You may also include the
934 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800935 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800936 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
937 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700938 * <p>
939 * Output: The URI of the item that was picked. This must be a content:
940 * URI so that any receiver can access it.
941 */
942 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
943 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
944 /**
945 * Activity Action: Dial a number as specified by the data. This shows a
946 * UI with the number being dialed, allowing the user to explicitly
947 * initiate the call.
948 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
949 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
950 * number.
951 * <p>Output: nothing.
952 */
953 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
954 public static final String ACTION_DIAL = "android.intent.action.DIAL";
955 /**
956 * Activity Action: Perform a call to someone specified by the data.
957 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
958 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
959 * number.
960 * <p>Output: nothing.
961 *
962 * <p>Note: there will be restrictions on which applications can initiate a
963 * call; most applications should use the {@link #ACTION_DIAL}.
964 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
965 * numbers. Applications can <strong>dial</strong> emergency numbers using
966 * {@link #ACTION_DIAL}, however.
967 */
968 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
969 public static final String ACTION_CALL = "android.intent.action.CALL";
970 /**
971 * Activity Action: Perform a call to an emergency number specified by the
972 * data.
973 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
974 * tel: URI of an explicit phone number.
975 * <p>Output: nothing.
976 * @hide
977 */
978 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
979 /**
980 * Activity action: Perform a call to any number (emergency or not)
981 * specified by the data.
982 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
983 * tel: URI of an explicit phone number.
984 * <p>Output: nothing.
985 * @hide
986 */
987 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
988 /**
989 * Activity Action: Send a message to someone specified by the data.
990 * <p>Input: {@link #getData} is URI describing the target.
991 * <p>Output: nothing.
992 */
993 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
994 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
995 /**
996 * Activity Action: Deliver some data to someone else. Who the data is
997 * being delivered to is not specified; it is up to the receiver of this
998 * action to ask the user where the data should be sent.
999 * <p>
1000 * When launching a SEND intent, you should usually wrap it in a chooser
1001 * (through {@link #createChooser}), which will give the proper interface
1002 * for the user to pick how to send your data and allow you to specify
1003 * a prompt indicating what they are doing.
1004 * <p>
1005 * Input: {@link #getType} is the MIME type of the data being sent.
1006 * get*Extra can have either a {@link #EXTRA_TEXT}
1007 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1008 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1009 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1010 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001011 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1012 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1013 * your text with HTML formatting.
1014 * <p>
1015 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1016 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1017 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1018 * content: URIs and other advanced features of {@link ClipData}. If
1019 * using this approach, you still must supply the same data through the
1020 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1021 * for compatibility with old applications. If you don't set a ClipData,
1022 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001023 * <p>
1024 * Optional standard extras, which may be interpreted by some recipients as
1025 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1026 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1027 * <p>
1028 * Output: nothing.
1029 */
1030 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1031 public static final String ACTION_SEND = "android.intent.action.SEND";
1032 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001033 * Activity Action: Deliver multiple data to someone else.
1034 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001035 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001036 * <p>
1037 * Input: {@link #getType} is the MIME type of the data being sent.
1038 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001039 * #EXTRA_STREAM} field, containing the data to be sent. If using
1040 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1041 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001042 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001043 * Multiple types are supported, and receivers should handle mixed types
1044 * whenever possible. The right way for the receiver to check them is to
1045 * use the content resolver on each URI. The intent sender should try to
1046 * put the most concrete mime type in the intent type, but it can fall
1047 * back to {@literal <type>/*} or {@literal *}/* as needed.
1048 * <p>
1049 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1050 * be image/jpg, but if you are sending image/jpg and image/png, then the
1051 * intent's type should be image/*.
1052 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001053 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1054 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1055 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1056 * content: URIs and other advanced features of {@link ClipData}. If
1057 * using this approach, you still must supply the same data through the
1058 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1059 * for compatibility with old applications. If you don't set a ClipData,
1060 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1061 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001062 * Optional standard extras, which may be interpreted by some recipients as
1063 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1064 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1065 * <p>
1066 * Output: nothing.
1067 */
1068 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1069 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1070 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001071 * Activity Action: Handle an incoming phone call.
1072 * <p>Input: nothing.
1073 * <p>Output: nothing.
1074 */
1075 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1076 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1077 /**
1078 * Activity Action: Insert an empty item into the given container.
1079 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1080 * in which to place the data.
1081 * <p>Output: URI of the new data that was created.
1082 */
1083 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1084 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1085 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001086 * Activity Action: Create a new item in the given container, initializing it
1087 * from the current contents of the clipboard.
1088 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1089 * in which to place the data.
1090 * <p>Output: URI of the new data that was created.
1091 */
1092 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1093 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1094 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001095 * Activity Action: Delete the given data from its container.
1096 * <p>Input: {@link #getData} is URI of data to be deleted.
1097 * <p>Output: nothing.
1098 */
1099 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1100 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1101 /**
1102 * Activity Action: Run the data, whatever that means.
1103 * <p>Input: ? (Note: this is currently specific to the test harness.)
1104 * <p>Output: nothing.
1105 */
1106 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1107 public static final String ACTION_RUN = "android.intent.action.RUN";
1108 /**
1109 * Activity Action: Perform a data synchronization.
1110 * <p>Input: ?
1111 * <p>Output: ?
1112 */
1113 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1114 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1115 /**
1116 * Activity Action: Pick an activity given an intent, returning the class
1117 * selected.
1118 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1119 * used with {@link PackageManager#queryIntentActivities} to determine the
1120 * set of activities from which to pick.
1121 * <p>Output: Class name of the activity that was selected.
1122 */
1123 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1124 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1125 /**
1126 * Activity Action: Perform a search.
1127 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1128 * is the text to search for. If empty, simply
1129 * enter your search results Activity with the search UI activated.
1130 * <p>Output: nothing.
1131 */
1132 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1133 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1134 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001135 * Activity Action: Start the platform-defined tutorial
1136 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1137 * is the text to search for. If empty, simply
1138 * enter your search results Activity with the search UI activated.
1139 * <p>Output: nothing.
1140 */
1141 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1142 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1143 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001144 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001145 * <p>
1146 * Input: {@link android.app.SearchManager#QUERY
1147 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1148 * a url starts with http or https, the site will be opened. If it is plain
1149 * text, Google search will be applied.
1150 * <p>
1151 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001152 */
1153 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1154 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001155
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001156 /**
Jim Miller07994402012-05-02 14:22:27 -07001157 * Activity Action: Perform assist action.
1158 * <p>
Adam Skorydfc7fd72013-08-05 19:23:41 -07001159 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT},
1160 * {@link #EXTRA_ASSIST_SERVICES_PACKAGES}, and {@link #EXTRA_ASSIST_SERVICES_CONTEXTS} can
1161 * provide additional optional contextual information about where the user was when they
1162 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001163 * Output: nothing.
1164 */
1165 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1166 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001167
1168 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001169 * Activity Action: Perform voice assist action.
1170 * <p>
Adam Skorydfc7fd72013-08-05 19:23:41 -07001171 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT},
1172 * {@link #EXTRA_ASSIST_SERVICES_PACKAGES}, and {@link #EXTRA_ASSIST_SERVICES_CONTEXTS} can
1173 * provide additional optional contextual information about where the user was when they
1174 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001175 * Output: nothing.
1176 */
1177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1178 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1179
1180 /**
1181 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1182 * containing the name of the current foreground application package at the time
1183 * the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001184 */
1185 public static final String EXTRA_ASSIST_PACKAGE
1186 = "android.intent.extra.ASSIST_PACKAGE";
1187
1188 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001189 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1190 * containing additional contextual information supplied by the current
1191 * foreground app at the time of the assist request. This is a {@link Bundle} of
1192 * additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001193 */
1194 public static final String EXTRA_ASSIST_CONTEXT
1195 = "android.intent.extra.ASSIST_CONTEXT";
1196
Jim Miller07994402012-05-02 14:22:27 -07001197 /**
Adam Skorydfc7fd72013-08-05 19:23:41 -07001198 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
Jeff Brown511cd352013-08-23 17:43:37 -07001199 * containing the application package names of foreground services at the time
Adam Skorydfc7fd72013-08-05 19:23:41 -07001200 * of the assist request. This is an array of {@link String}s, with one entry
1201 * per service.
1202 */
1203 public static final String EXTRA_ASSIST_SERVICES_PACKAGES
1204 = "android.intent.extra.ASSIST_SERVICES_PACKAGES";
1205
1206 /**
1207 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1208 * containing additional contextual information supplied by the current
1209 * foreground services at the time of the assist request. This is an array
1210 * of {@link Bundle}s of additional data, with one {@link Bundle} per service.
1211 */
1212 public static final String EXTRA_ASSIST_SERVICES_CONTEXTS
1213 = "android.intent.extra.ASSIST_SERVICES_CONTEXTS";
1214
1215
1216 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001217 * Activity Action: List all available applications
1218 * <p>Input: Nothing.
1219 * <p>Output: nothing.
1220 */
1221 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1222 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1223 /**
1224 * Activity Action: Show settings for choosing wallpaper
1225 * <p>Input: Nothing.
1226 * <p>Output: Nothing.
1227 */
1228 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1229 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1230
1231 /**
1232 * Activity Action: Show activity for reporting a bug.
1233 * <p>Input: Nothing.
1234 * <p>Output: Nothing.
1235 */
1236 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1237 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1238
1239 /**
1240 * Activity Action: Main entry point for factory tests. Only used when
1241 * the device is booting in factory test node. The implementing package
1242 * must be installed in the system image.
1243 * <p>Input: nothing
1244 * <p>Output: nothing
1245 */
1246 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1247
1248 /**
1249 * Activity Action: The user pressed the "call" button to go to the dialer
1250 * or other appropriate UI for placing a call.
1251 * <p>Input: Nothing.
1252 * <p>Output: Nothing.
1253 */
1254 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1255 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1256
1257 /**
1258 * Activity Action: Start Voice Command.
1259 * <p>Input: Nothing.
1260 * <p>Output: Nothing.
1261 */
1262 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1263 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001264
1265 /**
1266 * Activity Action: Start action associated with long pressing on the
1267 * search key.
1268 * <p>Input: Nothing.
1269 * <p>Output: Nothing.
1270 */
1271 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1272 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001273
Jacek Surazski86b6c532009-05-13 14:38:28 +02001274 /**
1275 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1276 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001277 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001278 * <p>Input: No data is specified. The bug report is passed in using
1279 * an {@link #EXTRA_BUG_REPORT} field.
1280 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001281 *
1282 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001283 */
1284 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1285 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001286
1287 /**
1288 * Activity Action: Show power usage information to the user.
1289 * <p>Input: Nothing.
1290 * <p>Output: Nothing.
1291 */
1292 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1293 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001294
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001295 /**
1296 * Activity Action: Setup wizard to launch after a platform update. This
1297 * activity should have a string meta-data field associated with it,
1298 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1299 * the platform for setup. The activity will be launched only if
1300 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1301 * same value.
1302 * <p>Input: Nothing.
1303 * <p>Output: Nothing.
1304 * @hide
1305 */
1306 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1307 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001308
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001309 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001310 * Activity Action: Show settings for managing network data usage of a
1311 * specific application. Applications should define an activity that offers
1312 * options to control data usage.
1313 */
1314 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1315 public static final String ACTION_MANAGE_NETWORK_USAGE =
1316 "android.intent.action.MANAGE_NETWORK_USAGE";
1317
1318 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001319 * Activity Action: Launch application installer.
1320 * <p>
1321 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001322 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1323 * you can also use "package:<package-name>" to install an application for the
1324 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001325 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1326 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1327 * <p>
1328 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1329 * succeeded.
1330 *
1331 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1332 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1333 * @see #EXTRA_RETURN_RESULT
1334 */
1335 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1336 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1337
1338 /**
1339 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1340 * package. Specifies the installer package name; this package will receive the
1341 * {@link #ACTION_APP_ERROR} intent.
1342 */
1343 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1344 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1345
1346 /**
1347 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1348 * package. Specifies that the application being installed should not be
1349 * treated as coming from an unknown source, but as coming from the app
1350 * invoking the Intent. For this to work you must start the installer with
1351 * startActivityForResult().
1352 */
1353 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1354 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1355
1356 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001357 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1358 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001359 * data field originated from.
1360 */
rich cannings706e8ba2012-08-20 13:20:14 -07001361 public static final String EXTRA_ORIGINATING_URI
1362 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001363
1364 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001365 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1366 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1367 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001368 */
1369 public static final String EXTRA_REFERRER
1370 = "android.intent.extra.REFERRER";
1371
1372 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001373 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1374 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1375 * @hide
1376 */
1377 public static final String EXTRA_ORIGINATING_UID
1378 = "android.intent.extra.ORIGINATING_UID";
1379
1380 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001381 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1382 * package. Tells the installer UI to skip the confirmation with the user
1383 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001384 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1385 * will no longer show an interstitial message about updating existing
1386 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001387 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001388 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001389 public static final String EXTRA_ALLOW_REPLACE
1390 = "android.intent.extra.ALLOW_REPLACE";
1391
1392 /**
1393 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1394 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1395 * return to the application the result code of the install/uninstall. The returned result
1396 * code will be {@link android.app.Activity#RESULT_OK} on success or
1397 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1398 */
1399 public static final String EXTRA_RETURN_RESULT
1400 = "android.intent.extra.RETURN_RESULT";
1401
1402 /**
1403 * Package manager install result code. @hide because result codes are not
1404 * yet ready to be exposed.
1405 */
1406 public static final String EXTRA_INSTALL_RESULT
1407 = "android.intent.extra.INSTALL_RESULT";
1408
1409 /**
1410 * Activity Action: Launch application uninstaller.
1411 * <p>
1412 * Input: The data must be a package: URI whose scheme specific part is
1413 * the package name of the current installed package to be uninstalled.
1414 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1415 * <p>
1416 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1417 * succeeded.
1418 */
1419 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1420 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1421
1422 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001423 * Specify whether the package should be uninstalled for all users.
1424 * @hide because these should not be part of normal application flow.
1425 */
1426 public static final String EXTRA_UNINSTALL_ALL_USERS
1427 = "android.intent.extra.UNINSTALL_ALL_USERS";
1428
1429 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001430 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1431 * describing the last run version of the platform that was setup.
1432 * @hide
1433 */
1434 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1435
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001436 // ---------------------------------------------------------------------
1437 // ---------------------------------------------------------------------
1438 // Standard intent broadcast actions (see action variable).
1439
1440 /**
1441 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001442 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001443 * <p class="note">This is a protected intent that can only be sent
1444 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001445 */
1446 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1447 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1448 /**
1449 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001450 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001451 * <p class="note">This is a protected intent that can only be sent
1452 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001453 */
1454 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1455 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001456
1457 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001458 * Broadcast Action: Sent after the system stops dreaming.
1459 *
1460 * <p class="note">This is a protected intent that can only be sent by the system.
1461 * It is only sent to registered receivers.</p>
1462 */
1463 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1464 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1465
1466 /**
1467 * Broadcast Action: Sent after the system starts dreaming.
1468 *
1469 * <p class="note">This is a protected intent that can only be sent by the system.
1470 * It is only sent to registered receivers.</p>
1471 */
1472 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1473 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1474
1475 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001476 * 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 -07001477 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001478 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001479 * <p class="note">This is a protected intent that can only be sent
1480 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001481 */
1482 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001483 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001484
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001485 /**
1486 * Broadcast Action: The current time has changed. Sent every
1487 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001488 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001489 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1490 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001491 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001492 * <p class="note">This is a protected intent that can only be sent
1493 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001494 */
1495 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1496 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1497 /**
1498 * Broadcast Action: The time was set.
1499 */
1500 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1501 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1502 /**
1503 * Broadcast Action: The date has changed.
1504 */
1505 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1506 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1507 /**
1508 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1509 * <ul>
1510 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1511 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001512 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001513 * <p class="note">This is a protected intent that can only be sent
1514 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001515 */
1516 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1517 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1518 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001519 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1520 * DNS entries should be tossed.
1521 * @hide
1522 */
1523 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1524 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1525 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001526 * Alarm Changed Action: This is broadcast when the AlarmClock
1527 * application's alarm is set or unset. It is used by the
1528 * AlarmClock application and the StatusBar service.
1529 * @hide
1530 */
1531 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1532 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1533 /**
1534 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1535 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1536 * @hide
1537 */
1538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1539 public static final String ACTION_SYNC_STATE_CHANGED
1540 = "android.intent.action.SYNC_STATE_CHANGED";
1541 /**
1542 * Broadcast Action: This is broadcast once, after the system has finished
1543 * booting. It can be used to perform application-specific initialization,
1544 * such as installing alarms. You must hold the
1545 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1546 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001547 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001548 * <p class="note">This is a protected intent that can only be sent
1549 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001550 */
1551 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1552 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1553 /**
1554 * Broadcast Action: This is broadcast when a user action should request a
1555 * temporary system dialog to dismiss. Some examples of temporary system
1556 * dialogs are the notification window-shade and the recent tasks dialog.
1557 */
1558 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1559 /**
1560 * Broadcast Action: Trigger the download and eventual installation
1561 * of a package.
1562 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001563 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001564 * <p class="note">This is a protected intent that can only be sent
1565 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001566 *
1567 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001568 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001569 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001570 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1571 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1572 /**
1573 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001574 * device. The data contains the name of the package. Note that the
1575 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001576 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001577 * <ul>
1578 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1579 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1580 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1581 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001582 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001583 * <p class="note">This is a protected intent that can only be sent
1584 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001585 */
1586 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1587 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1588 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001589 * Broadcast Action: A new version of an application package has been
1590 * installed, replacing an existing version that was previously installed.
1591 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001592 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001593 * <ul>
1594 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1595 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001596 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001597 * <p class="note">This is a protected intent that can only be sent
1598 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001599 */
1600 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1601 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1602 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001603 * Broadcast Action: A new version of your application has been installed
1604 * over an existing one. This is only sent to the application that was
1605 * replaced. It does not contain any additional data; to receive it, just
1606 * use an intent filter for this action.
1607 *
1608 * <p class="note">This is a protected intent that can only be sent
1609 * by the system.
1610 */
1611 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1612 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1613 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001614 * Broadcast Action: An existing application package has been removed from
1615 * the device. The data contains the name of the package. The package
1616 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001617 * <ul>
1618 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1619 * to the package.
1620 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1621 * application -- data and code -- is being removed.
1622 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1623 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1624 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001625 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001626 * <p class="note">This is a protected intent that can only be sent
1627 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001628 */
1629 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1630 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1631 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001632 * Broadcast Action: An existing application package has been completely
1633 * removed from the device. The data contains the name of the package.
1634 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1635 * {@link #EXTRA_DATA_REMOVED} is true and
1636 * {@link #EXTRA_REPLACING} is false of that broadcast.
1637 *
1638 * <ul>
1639 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1640 * to the package.
1641 * </ul>
1642 *
1643 * <p class="note">This is a protected intent that can only be sent
1644 * by the system.
1645 */
1646 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1647 public static final String ACTION_PACKAGE_FULLY_REMOVED
1648 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1649 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001650 * Broadcast Action: An existing application package has been changed (e.g.
1651 * a component has been enabled or disabled). The data contains the name of
1652 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001653 * <ul>
1654 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001655 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001656 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001657 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1658 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001659 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001660 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001661 * <p class="note">This is a protected intent that can only be sent
1662 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001663 */
1664 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1665 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1666 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001667 * @hide
1668 * Broadcast Action: Ask system services if there is any reason to
1669 * restart the given package. The data contains the name of the
1670 * package.
1671 * <ul>
1672 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1673 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1674 * </ul>
1675 *
1676 * <p class="note">This is a protected intent that can only be sent
1677 * by the system.
1678 */
1679 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1680 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1681 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001682 * Broadcast Action: The user has restarted a package, and all of its
1683 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001684 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001685 * be removed. Note that the restarted package does <em>not</em>
1686 * receive this broadcast.
1687 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001688 * <ul>
1689 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1690 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001691 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001692 * <p class="note">This is a protected intent that can only be sent
1693 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001694 */
1695 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1696 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1697 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001698 * Broadcast Action: The user has cleared the data of a package. This should
1699 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001700 * its persistent data is erased and this broadcast sent.
1701 * Note that the cleared package does <em>not</em>
1702 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001703 * <ul>
1704 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1705 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001706 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001707 * <p class="note">This is a protected intent that can only be sent
1708 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001709 */
1710 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1711 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1712 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001713 * Broadcast Action: A user ID has been removed from the system. The user
1714 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001715 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001716 * <p class="note">This is a protected intent that can only be sent
1717 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001718 */
1719 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1720 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001721
1722 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001723 * Broadcast Action: Sent to the installer package of an application
1724 * when that application is first launched (that is the first time it
1725 * is moved out of the stopped state). The data contains the name of the package.
1726 *
1727 * <p class="note">This is a protected intent that can only be sent
1728 * by the system.
1729 */
1730 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1731 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1732
1733 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001734 * Broadcast Action: Sent to the system package verifier when a package
1735 * needs to be verified. The data contains the package URI.
1736 * <p class="note">
1737 * This is a protected intent that can only be sent by the system.
1738 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001739 */
1740 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1741 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1742
1743 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001744 * Broadcast Action: Sent to the system package verifier when a package is
1745 * verified. The data contains the package URI.
1746 * <p class="note">
1747 * This is a protected intent that can only be sent by the system.
1748 */
1749 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1750 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1751
1752 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001753 * Broadcast Action: Resources for a set of packages (which were
1754 * previously unavailable) are currently
1755 * available since the media on which they exist is available.
1756 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1757 * list of packages whose availability changed.
1758 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1759 * list of uids of packages whose availability changed.
1760 * Note that the
1761 * packages in this list do <em>not</em> receive this broadcast.
1762 * The specified set of packages are now available on the system.
1763 * <p>Includes the following extras:
1764 * <ul>
1765 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1766 * whose resources(were previously unavailable) are currently available.
1767 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1768 * packages whose resources(were previously unavailable)
1769 * are currently available.
1770 * </ul>
1771 *
1772 * <p class="note">This is a protected intent that can only be sent
1773 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001774 */
1775 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001776 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1777 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001778
1779 /**
1780 * Broadcast Action: Resources for a set of packages are currently
1781 * unavailable since the media on which they exist is unavailable.
1782 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1783 * list of packages whose availability changed.
1784 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1785 * list of uids of packages whose availability changed.
1786 * The specified set of packages can no longer be
1787 * launched and are practically unavailable on the system.
1788 * <p>Inclues the following extras:
1789 * <ul>
1790 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1791 * whose resources are no longer available.
1792 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1793 * whose resources are no longer available.
1794 * </ul>
1795 *
1796 * <p class="note">This is a protected intent that can only be sent
1797 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001798 */
1799 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001800 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001801 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001802
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001803 /**
1804 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001805 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001806 * This should <em>only</em> be used to determine when the wallpaper
1807 * has changed to show the new wallpaper to the user. You should certainly
1808 * never, in response to this, change the wallpaper or other attributes of
1809 * it such as the suggested size. That would be crazy, right? You'd cause
1810 * all kinds of loops, especially if other apps are doing similar things,
1811 * right? Of course. So please don't do this.
1812 *
1813 * @deprecated Modern applications should use
1814 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1815 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1816 * shown behind their UI, rather than watching for this broadcast and
1817 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001818 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001819 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001820 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1821 /**
1822 * Broadcast Action: The current device {@link android.content.res.Configuration}
1823 * (orientation, locale, etc) has changed. When such a change happens, the
1824 * UIs (view hierarchy) will need to be rebuilt based on this new
1825 * information; for the most part, applications don't need to worry about
1826 * this, because the system will take care of stopping and restarting the
1827 * application to make sure it sees the new changes. Some system code that
1828 * can not be restarted will need to watch for this action and handle it
1829 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001830 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001831 * <p class="note">
1832 * You can <em>not</em> receive this through components declared
1833 * in manifests, only by explicitly registering for it with
1834 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1835 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001836 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001837 * <p class="note">This is a protected intent that can only be sent
1838 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001839 *
1840 * @see android.content.res.Configuration
1841 */
1842 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1843 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1844 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001845 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001846 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001847 * <p class="note">This is a protected intent that can only be sent
1848 * by the system.
1849 */
1850 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1851 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1852 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001853 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1854 * charging state, level, and other information about the battery.
1855 * See {@link android.os.BatteryManager} for documentation on the
1856 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001857 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001858 * <p class="note">
1859 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001860 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001861 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001862 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1863 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1864 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1865 * broadcasts that are sent and can be received through manifest
1866 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001867 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001868 * <p class="note">This is a protected intent that can only be sent
1869 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001870 */
1871 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1872 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1873 /**
1874 * Broadcast Action: Indicates low battery condition on the device.
1875 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001876 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001877 * <p class="note">This is a protected intent that can only be sent
1878 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001879 */
1880 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1881 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1882 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001883 * Broadcast Action: Indicates the battery is now okay after being low.
1884 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1885 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001886 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001887 * <p class="note">This is a protected intent that can only be sent
1888 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001889 */
1890 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1891 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1892 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001893 * Broadcast Action: External power has been connected to the device.
1894 * This is intended for applications that wish to register specifically to this notification.
1895 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1896 * stay active to receive this notification. This action can be used to implement actions
1897 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001898 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001899 * <p class="note">This is a protected intent that can only be sent
1900 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001901 */
1902 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001903 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001904 /**
1905 * Broadcast Action: External power has been removed from the device.
1906 * This is intended for applications that wish to register specifically to this notification.
1907 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1908 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001909 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001910 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001911 * <p class="note">This is a protected intent that can only be sent
1912 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001913 */
1914 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001915 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001916 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001917 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001918 * Broadcast Action: Device is shutting down.
1919 * This is broadcast when the device is being shut down (completely turned
1920 * off, not sleeping). Once the broadcast is complete, the final shutdown
1921 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001922 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001923 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001924 * <p class="note">This is a protected intent that can only be sent
1925 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001926 * <p>May include the following extras:
1927 * <ul>
1928 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1929 * shutdown is only for userspace processes. If not set, assumed to be false.
1930 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001931 */
1932 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001933 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001934 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001935 * Activity Action: Start this activity to request system shutdown.
1936 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1937 * to request confirmation from the user before shutting down.
1938 *
1939 * <p class="note">This is a protected intent that can only be sent
1940 * by the system.
1941 *
1942 * {@hide}
1943 */
1944 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1945 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001946 * Broadcast Action: A sticky broadcast that indicates low memory
1947 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001948 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001949 * <p class="note">This is a protected intent that can only be sent
1950 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001951 */
1952 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1953 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1954 /**
1955 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001956 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001957 * <p class="note">This is a protected intent that can only be sent
1958 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001959 */
1960 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1961 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1962 /**
Jake Hambybb371632010-08-23 18:16:48 -07001963 * Broadcast Action: A sticky broadcast that indicates a memory full
1964 * condition on the device. This is intended for activities that want
1965 * to be able to fill the data partition completely, leaving only
1966 * enough free space to prevent system-wide SQLite failures.
1967 *
1968 * <p class="note">This is a protected intent that can only be sent
1969 * by the system.
1970 *
1971 * {@hide}
1972 */
1973 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1974 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1975 /**
1976 * Broadcast Action: Indicates memory full condition on the device
1977 * no longer exists.
1978 *
1979 * <p class="note">This is a protected intent that can only be sent
1980 * by the system.
1981 *
1982 * {@hide}
1983 */
1984 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1985 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1986 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001987 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1988 * and package management should be started.
1989 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1990 * notification.
1991 */
1992 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1993 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1994 /**
1995 * Broadcast Action: The device has entered USB Mass Storage mode.
1996 * This is used mainly for the USB Settings panel.
1997 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1998 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001999 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002000 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002001 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002002 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2003
2004 /**
2005 * Broadcast Action: The device has exited USB Mass Storage mode.
2006 * This is used mainly for the USB Settings panel.
2007 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2008 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002009 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002010 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002011 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002012 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2013
2014 /**
2015 * Broadcast Action: External media has been removed.
2016 * The path to the mount point for the removed media is contained in the Intent.mData field.
2017 */
2018 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2019 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2020
2021 /**
2022 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002023 * 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 -07002024 */
2025 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2026 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2027
2028 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002029 * Broadcast Action: External media is present, and being disk-checked
2030 * 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 -08002031 */
2032 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2033 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2034
2035 /**
2036 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2037 * 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 -08002038 */
2039 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2040 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2041
2042 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002043 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002044 * 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 -07002045 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2046 * media was mounted read only.
2047 */
2048 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2049 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2050
2051 /**
2052 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002053 * 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 -07002054 */
2055 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2056 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2057
2058 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002059 * Broadcast Action: External media is no longer being shared via USB mass storage.
2060 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2061 *
2062 * @hide
2063 */
2064 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2065
2066 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002067 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2068 * The path to the mount point for the removed media is contained in the Intent.mData field.
2069 */
2070 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2071 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2072
2073 /**
2074 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002075 * 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 -07002076 */
2077 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2078 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2079
2080 /**
2081 * Broadcast Action: User has expressed the desire to remove the external storage media.
2082 * Applications should close all files they have open within the mount point when they receive this intent.
2083 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2084 */
2085 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2086 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2087
2088 /**
2089 * Broadcast Action: The media scanner has started scanning a directory.
2090 * The path to the directory being scanned is contained in the Intent.mData field.
2091 */
2092 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2093 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2094
2095 /**
2096 * Broadcast Action: The media scanner has finished scanning a directory.
2097 * The path to the scanned directory is contained in the Intent.mData field.
2098 */
2099 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2100 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2101
2102 /**
2103 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2104 * The path to the file is contained in the Intent.mData field.
2105 */
2106 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2107 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2108
2109 /**
2110 * Broadcast Action: The "Media Button" was pressed. Includes a single
2111 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2112 * caused the broadcast.
2113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2115 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2116
2117 /**
2118 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2119 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2120 * caused the broadcast.
2121 */
2122 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2123 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2124
2125 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2126 // location; they are not general-purpose actions.
2127
2128 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002129 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002130 */
2131 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2132 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2133 "android.intent.action.GTALK_CONNECTED";
2134
2135 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002136 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002137 */
2138 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2139 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2140 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002141
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002142 /**
2143 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002144 */
2145 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2146 public static final String ACTION_INPUT_METHOD_CHANGED =
2147 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002148
2149 /**
2150 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2151 * more radios have been turned off or on. The intent will have the following extra value:</p>
2152 * <ul>
2153 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2154 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2155 * turned off</li>
2156 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002157 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002158 * <p class="note">This is a protected intent that can only be sent
2159 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002160 */
2161 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2162 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2163
2164 /**
2165 * Broadcast Action: Some content providers have parts of their namespace
2166 * where they publish new events or items that the user may be especially
2167 * interested in. For these things, they may broadcast this action when the
2168 * set of interesting items change.
2169 *
2170 * For example, GmailProvider sends this notification when the set of unread
2171 * mail in the inbox changes.
2172 *
2173 * <p>The data of the intent identifies which part of which provider
2174 * changed. When queried through the content resolver, the data URI will
2175 * return the data set in question.
2176 *
2177 * <p>The intent will have the following extra values:
2178 * <ul>
2179 * <li><em>count</em> - The number of items in the data set. This is the
2180 * same as the number of items in the cursor returned by querying the
2181 * data URI. </li>
2182 * </ul>
2183 *
2184 * This intent will be sent at boot (if the count is non-zero) and when the
2185 * data set changes. It is possible for the data set to change without the
2186 * count changing (for example, if a new unread message arrives in the same
2187 * sync operation in which a message is archived). The phone should still
2188 * ring/vibrate/etc as normal in this case.
2189 */
2190 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2191 public static final String ACTION_PROVIDER_CHANGED =
2192 "android.intent.action.PROVIDER_CHANGED";
2193
2194 /**
2195 * Broadcast Action: Wired Headset plugged in or unplugged.
2196 *
2197 * <p>The intent will have the following extra values:
2198 * <ul>
2199 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2200 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002201 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002202 * </ul>
2203 * </ul>
2204 */
2205 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2206 public static final String ACTION_HEADSET_PLUG =
2207 "android.intent.action.HEADSET_PLUG";
2208
2209 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002210 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2211 *
2212 * <p>The intent will have the following extra values:
2213 * <ul>
2214 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2215 * <li><em>name</em> - Headset type, human readable string </li>
2216 * </ul>
2217 * </ul>
2218 * @hide
2219 */
2220 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002221 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2222 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002223
2224 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002225 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002226 *
2227 * <p>The intent will have the following extra values:
2228 * <ul>
2229 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2230 * <li><em>name</em> - Headset type, human readable string </li>
2231 * </ul>
2232 * </ul>
2233 * @hide
2234 */
2235 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002236 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2237 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002238
2239 /**
2240 * Broadcast Action: A HMDI cable was plugged or unplugged
2241 *
2242 * <p>The intent will have the following extra values:
2243 * <ul>
2244 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2245 * <li><em>name</em> - HDMI cable, human readable string </li>
2246 * </ul>
2247 * </ul>
2248 * @hide
2249 */
2250 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2251 public static final String ACTION_HDMI_AUDIO_PLUG =
2252 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002253
2254 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002255 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2256 *
2257 * <p>The intent will have the following extra values:
2258 * <ul>
2259 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2260 * <li><em>card</em> - ALSA card number (integer) </li>
2261 * <li><em>device</em> - ALSA device number (integer) </li>
2262 * </ul>
2263 * </ul>
2264 * @hide
2265 */
2266 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2267 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2268 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2269
2270 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002271 * Broadcast Action: A USB audio device was plugged in or unplugged.
2272 *
2273 * <p>The intent will have the following extra values:
2274 * <ul>
2275 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2276 * <li><em>card</em> - ALSA card number (integer) </li>
2277 * <li><em>device</em> - ALSA device number (integer) </li>
2278 * </ul>
2279 * </ul>
2280 * @hide
2281 */
2282 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2283 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2284 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2285
2286 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002287 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2288 * <ul>
2289 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2290 * </ul>
2291 *
2292 * <p class="note">This is a protected intent that can only be sent
2293 * by the system.
2294 *
2295 * @hide
2296 */
2297 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2298 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2299 = "android.intent.action.ADVANCED_SETTINGS";
2300
2301 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002302 * Broadcast Action: An outgoing call is about to be placed.
2303 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002304 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002305 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002306 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002307 * the phone number originally intended to be dialed.</li>
2308 * </ul>
2309 * <p>Once the broadcast is finished, the resultData is used as the actual
2310 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002311 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002312 * outgoing call in turn: for example, a parental control application
2313 * might verify that the user is authorized to place the call at that
2314 * time, then a number-rewriting application might add an area code if
2315 * one was not specified.</p>
2316 * <p>For consistency, any receiver whose purpose is to prohibit phone
2317 * calls should have a priority of 0, to ensure it will see the final
2318 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002319 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002320 * should have a positive priority.
2321 * Negative priorities are reserved for the system for this broadcast;
2322 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002323 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2324 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002325 * <p>Emergency calls cannot be intercepted using this mechanism, and
2326 * other calls cannot be modified to call emergency numbers using this
2327 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002328 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2329 * call to use their own service instead. Those apps should first prevent
2330 * the call from being placed by setting resultData to <code>null</code>
2331 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002332 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002333 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2334 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002335 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002336 * <p class="note">This is a protected intent that can only be sent
2337 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002338 */
2339 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2340 public static final String ACTION_NEW_OUTGOING_CALL =
2341 "android.intent.action.NEW_OUTGOING_CALL";
2342
2343 /**
2344 * Broadcast Action: Have the device reboot. This is only for use by
2345 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002346 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002347 * <p class="note">This is a protected intent that can only be sent
2348 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002349 */
2350 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2351 public static final String ACTION_REBOOT =
2352 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002353
Wei Huang97ecc9c2009-05-11 17:44:20 -07002354 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002355 * Broadcast Action: A sticky broadcast for changes in the physical
2356 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002357 *
2358 * <p>The intent will have the following extra values:
2359 * <ul>
2360 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002361 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002362 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002363 * <p>This is intended for monitoring the current physical dock state.
2364 * See {@link android.app.UiModeManager} for the normal API dealing with
2365 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002366 */
2367 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2368 public static final String ACTION_DOCK_EVENT =
2369 "android.intent.action.DOCK_EVENT";
2370
2371 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002372 * Broadcast Action: A broadcast when idle maintenance can be started.
2373 * This means that the user is not interacting with the device and is
2374 * not expected to do so soon. Typical use of the idle maintenance is
2375 * to perform somehow expensive tasks that can be postponed at a moment
2376 * when they will not degrade user experience.
2377 * <p>
2378 * <p class="note">In order to keep the device responsive in case of an
2379 * unexpected user interaction, implementations of a maintenance task
2380 * should be interruptible. In such a scenario a broadcast with action
2381 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2382 * should not do the maintenance work in
2383 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2384 * maintenance service by {@link Context#startService(Intent)}. Also
2385 * you should hold a wake lock while your maintenance service is running
2386 * to prevent the device going to sleep.
2387 * </p>
2388 * <p>
2389 * <p class="note">This is a protected intent that can only be sent by
2390 * the system.
2391 * </p>
2392 *
2393 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002394 *
2395 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002396 */
2397 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2398 public static final String ACTION_IDLE_MAINTENANCE_START =
2399 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2400
2401 /**
2402 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2403 * This means that the user was not interacting with the device as a result
2404 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2405 * was sent and now the user started interacting with the device. Typical
2406 * use of the idle maintenance is to perform somehow expensive tasks that
2407 * can be postponed at a moment when they will not degrade user experience.
2408 * <p>
2409 * <p class="note">In order to keep the device responsive in case of an
2410 * unexpected user interaction, implementations of a maintenance task
2411 * should be interruptible. Hence, on receiving a broadcast with this
2412 * action, the maintenance task should be interrupted as soon as possible.
2413 * In other words, you should not do the maintenance work in
2414 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2415 * maintenance service that was started on receiving of
2416 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2417 * lock you acquired when your maintenance service started.
2418 * </p>
2419 * <p class="note">This is a protected intent that can only be sent
2420 * by the system.
2421 *
2422 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002423 *
2424 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002425 */
2426 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2427 public static final String ACTION_IDLE_MAINTENANCE_END =
2428 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2429
2430 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002431 * Broadcast Action: a remote intent is to be broadcasted.
2432 *
2433 * A remote intent is used for remote RPC between devices. The remote intent
2434 * is serialized and sent from one device to another device. The receiving
2435 * device parses the remote intent and broadcasts it. Note that anyone can
2436 * broadcast a remote intent. However, if the intent receiver of the remote intent
2437 * does not trust intent broadcasts from arbitrary intent senders, it should require
2438 * the sender to hold certain permissions so only trusted sender's broadcast will be
2439 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002440 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002441 */
2442 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002443 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002444
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002445 /**
2446 * Broadcast Action: hook for permforming cleanup after a system update.
2447 *
2448 * The broadcast is sent when the system is booting, before the
2449 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2450 * image. A receiver for this should do its work and then disable itself
2451 * so that it does not get run again at the next boot.
2452 * @hide
2453 */
2454 public static final String ACTION_PRE_BOOT_COMPLETED =
2455 "android.intent.action.PRE_BOOT_COMPLETED";
2456
Amith Yamasani13593602012-03-22 16:16:17 -07002457 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002458 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002459 * on restricted users. The broadcast intent contains an extra
2460 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2461 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2462 * String[] depending on the restriction type.<p/>
2463 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002464 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2465 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2466 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002467 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2468 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002469 * @see RestrictionEntry
2470 */
2471 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2472 "android.intent.action.GET_RESTRICTION_ENTRIES";
2473
2474 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002475 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002476 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002477 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2478 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2479 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002480 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2481 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2482 * challenge.<p/>
2483 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002484 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002485 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002486 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2487 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002488
2489 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002490 * Sent the first time a user is starting, to allow system apps to
2491 * perform one time initialization. (This will not be seen by third
2492 * party applications because a newly initialized user does not have any
2493 * third party applications installed for it.) This is sent early in
2494 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002495 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2496 * broadcast, since it is part of a visible user interaction; be as quick
2497 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002498 */
2499 public static final String ACTION_USER_INITIALIZE =
2500 "android.intent.action.USER_INITIALIZE";
2501
2502 /**
2503 * Sent when a user switch is happening, causing the process's user to be
2504 * brought to the foreground. This is only sent to receivers registered
2505 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2506 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002507 * foreground. This is sent as a foreground
2508 * broadcast, since it is part of a visible user interaction; be as quick
2509 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002510 */
2511 public static final String ACTION_USER_FOREGROUND =
2512 "android.intent.action.USER_FOREGROUND";
2513
2514 /**
2515 * Sent when a user switch is happening, causing the process's user to be
2516 * sent to the background. This is only sent to receivers registered
2517 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2518 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002519 * background. This is sent as a foreground
2520 * broadcast, since it is part of a visible user interaction; be as quick
2521 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002522 */
2523 public static final String ACTION_USER_BACKGROUND =
2524 "android.intent.action.USER_BACKGROUND";
2525
2526 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002527 * Broadcast sent to the system when a user is added. Carries an extra
2528 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2529 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002530 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002531 * @hide
2532 */
2533 public static final String ACTION_USER_ADDED =
2534 "android.intent.action.USER_ADDED";
2535
2536 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002537 * Broadcast sent by the system when a user is started. Carries an extra
2538 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002539 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002540 * that has been started. This is sent as a foreground
2541 * broadcast, since it is part of a visible user interaction; be as quick
2542 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002543 * @hide
2544 */
2545 public static final String ACTION_USER_STARTED =
2546 "android.intent.action.USER_STARTED";
2547
2548 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002549 * Broadcast sent when a user is in the process of starting. Carries an extra
2550 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2551 * sent to registered receivers, not manifest receivers. It is sent to all
2552 * users (including the one that is being started). You must hold
2553 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2554 * this broadcast. This is sent as a background broadcast, since
2555 * its result is not part of the primary UX flow; to safely keep track of
2556 * started/stopped state of a user you can use this in conjunction with
2557 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2558 * other user state broadcasts since those are foreground broadcasts so can
2559 * execute in a different order.
2560 * @hide
2561 */
2562 public static final String ACTION_USER_STARTING =
2563 "android.intent.action.USER_STARTING";
2564
2565 /**
2566 * Broadcast sent when a user is going to be stopped. Carries an extra
2567 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2568 * sent to registered receivers, not manifest receivers. It is sent to all
2569 * users (including the one that is being stopped). You must hold
2570 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2571 * this broadcast. The user will not stop until all receivers have
2572 * handled the broadcast. This is sent as a background broadcast, since
2573 * its result is not part of the primary UX flow; to safely keep track of
2574 * started/stopped state of a user you can use this in conjunction with
2575 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2576 * other user state broadcasts since those are foreground broadcasts so can
2577 * execute in a different order.
2578 * @hide
2579 */
2580 public static final String ACTION_USER_STOPPING =
2581 "android.intent.action.USER_STOPPING";
2582
2583 /**
2584 * Broadcast sent to the system when a user is stopped. Carries an extra
2585 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2586 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2587 * specific package. This is only sent to registered receivers, not manifest
2588 * receivers. It is sent to all running users <em>except</em> the one that
2589 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002590 * @hide
2591 */
2592 public static final String ACTION_USER_STOPPED =
2593 "android.intent.action.USER_STOPPED";
2594
2595 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002596 * 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 -07002597 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002598 * one that has been removed. The user will not be completely removed until all receivers have
2599 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002600 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002601 * @hide
2602 */
2603 public static final String ACTION_USER_REMOVED =
2604 "android.intent.action.USER_REMOVED";
2605
2606 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002607 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002608 * the userHandle of the user to become the current one. This is only sent to
2609 * registered receivers, not manifest receivers. It is sent to all running users.
2610 * You must hold
2611 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002612 * @hide
2613 */
2614 public static final String ACTION_USER_SWITCHED =
2615 "android.intent.action.USER_SWITCHED";
2616
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002617 /**
2618 * Broadcast sent to the system when a user's information changes. Carries an extra
2619 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002620 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002621 * @hide
2622 */
2623 public static final String ACTION_USER_INFO_CHANGED =
2624 "android.intent.action.USER_INFO_CHANGED";
2625
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002626 /**
2627 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2628 */
2629 public static final String ACTION_QUICK_CLOCK =
2630 "android.intent.action.QUICK_CLOCK";
2631
Michael Wright0087a142013-02-05 16:29:39 -08002632 /**
2633 * Broadcast Action: This is broadcast when a user action should request the
2634 * brightness setting dialog.
2635 * @hide
2636 */
2637 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2638 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2639
Justin Kohd378ad72013-04-01 12:18:26 -07002640 /**
2641 * Broadcast Action: A global button was pressed. Includes a single
2642 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2643 * caused the broadcast.
2644 * @hide
2645 */
2646 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2647
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002648 /**
2649 * Activity Action: Allow the user to select and open one or more existing
2650 * documents. Both read and write access to the documents will be granted
2651 * until explicitly revoked by the user.
2652 * <p>
2653 * Callers can restrict selection to a specific kind of data, such as
2654 * photos, by setting one or more MIME types in {@link #EXTRA_MIME_TYPES}.
2655 * <p>
2656 * If the caller can handle multiple returned items (the user performing
2657 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE} to
2658 * indicate this.
2659 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002660 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2661 * returned URIs can be opened with
2662 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002663 * <p>
2664 * Output: The URI of the item that was picked. This must be a content: URI
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002665 * so that any receiver can access it. If multiple documents were selected,
2666 * they are returned in {@link #getClipData()}.
2667 *
2668 * @see DocumentsContract
2669 * @see DocumentsContract#getOpenDocuments(Context)
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002670 */
2671 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2672 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2673
2674 /**
2675 * Activity Action: Allow the user to create a new document. Both read and
2676 * write access to the document will be granted until explicitly revoked by
2677 * the user.
2678 * <p>
2679 * Callers can provide a hint document name by setting {@link #EXTRA_TITLE},
2680 * but the user may change this value before creating the file. Callers can
2681 * optionally hint at the MIME type being created by setting
2682 * {@link #setType(String)}.
2683 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002684 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2685 * returned URIs can be opened with
2686 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002687 * <p>
2688 * Output: The URI of the item that was created. This must be a content: URI
2689 * so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002690 *
2691 * @see DocumentsContract
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002692 */
2693 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2694 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2695
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002696 // ---------------------------------------------------------------------
2697 // ---------------------------------------------------------------------
2698 // Standard intent categories (see addCategory()).
2699
2700 /**
2701 * Set if the activity should be an option for the default action
2702 * (center press) to perform on a piece of data. Setting this will
2703 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002704 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002705 * Intent when initiating an action -- it is for use in intent filters
2706 * specified in packages.
2707 */
2708 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2709 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2710 /**
2711 * Activities that can be safely invoked from a browser must support this
2712 * category. For example, if the user is viewing a web page or an e-mail
2713 * and clicks on a link in the text, the Intent generated execute that
2714 * link will require the BROWSABLE category, so that only activities
2715 * supporting this category will be considered as possible actions. By
2716 * supporting this category, you are promising that there is nothing
2717 * damaging (without user intervention) that can happen by invoking any
2718 * matching Intent.
2719 */
2720 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2721 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2722 /**
2723 * Set if the activity should be considered as an alternative action to
2724 * the data the user is currently viewing. See also
2725 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2726 * applies to the selection in a list of items.
2727 *
2728 * <p>Supporting this category means that you would like your activity to be
2729 * displayed in the set of alternative things the user can do, usually as
2730 * part of the current activity's options menu. You will usually want to
2731 * include a specific label in the &lt;intent-filter&gt; of this action
2732 * describing to the user what it does.
2733 *
2734 * <p>The action of IntentFilter with this category is important in that it
2735 * describes the specific action the target will perform. This generally
2736 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2737 * a specific name such as "com.android.camera.action.CROP. Only one
2738 * alternative of any particular action will be shown to the user, so using
2739 * a specific action like this makes sure that your alternative will be
2740 * displayed while also allowing other applications to provide their own
2741 * overrides of that particular action.
2742 */
2743 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2744 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2745 /**
2746 * Set if the activity should be considered as an alternative selection
2747 * action to the data the user has currently selected. This is like
2748 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2749 * of items from which the user can select, giving them alternatives to the
2750 * default action that will be performed on it.
2751 */
2752 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2753 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2754 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002755 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002756 */
2757 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2758 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2759 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002760 * Should be displayed in the top-level launcher.
2761 */
2762 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2763 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2764 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002765 * Provides information about the package it is in; typically used if
2766 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2767 * a front-door to the user without having to be shown in the all apps list.
2768 */
2769 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2770 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2771 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002772 * This is the home activity, that is the first activity that is displayed
2773 * when the device boots.
2774 */
2775 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2776 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2777 /**
2778 * This activity is a preference panel.
2779 */
2780 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2781 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2782 /**
2783 * This activity is a development preference panel.
2784 */
2785 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2786 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2787 /**
2788 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002789 */
2790 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2791 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2792 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002793 * This activity allows the user to browse and download new applications.
2794 */
2795 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2796 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2797 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002798 * This activity may be exercised by the monkey or other automated test tools.
2799 */
2800 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2801 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2802 /**
2803 * To be used as a test (not part of the normal user experience).
2804 */
2805 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2806 /**
2807 * To be used as a unit test (run through the Test Harness).
2808 */
2809 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2810 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002811 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002812 * experience).
2813 */
2814 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2815 /**
2816 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
Dianne Hackborna53ee352013-02-20 12:47:02 -08002817 * ContentResolver.openInputStream. Openable URIs must support the columns in
2818 * {@link android.provider.OpenableColumns}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002819 * when queried, though it is allowable for those columns to be blank.
2820 */
2821 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2822 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2823
2824 /**
2825 * To be used as code under test for framework instrumentation tests.
2826 */
2827 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2828 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002829 /**
2830 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002831 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2832 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002833 */
2834 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2835 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2836 /**
2837 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002838 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2839 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002840 */
2841 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2842 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002843 /**
2844 * An activity to run when device is inserted into a analog (low end) dock.
2845 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2846 * information, see {@link android.app.UiModeManager}.
2847 */
2848 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2849 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2850
2851 /**
2852 * An activity to run when device is inserted into a digital (high end) dock.
2853 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2854 * information, see {@link android.app.UiModeManager}.
2855 */
2856 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2857 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002858
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002859 /**
2860 * Used to indicate that the activity can be used in a car environment.
2861 */
2862 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2863 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2864
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002865 // ---------------------------------------------------------------------
2866 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002867 // Application launch intent categories (see addCategory()).
2868
2869 /**
2870 * Used with {@link #ACTION_MAIN} to launch the browser application.
2871 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002872 * <p>NOTE: This should not be used as the primary key of an Intent,
2873 * since it will not result in the app launching with the correct
2874 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002875 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002876 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002877 */
2878 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2879 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2880
2881 /**
2882 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2883 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002884 * <p>NOTE: This should not be used as the primary key of an Intent,
2885 * since it will not result in the app launching with the correct
2886 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002887 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002888 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002889 */
2890 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2891 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2892
2893 /**
2894 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2895 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002896 * <p>NOTE: This should not be used as the primary key of an Intent,
2897 * since it will not result in the app launching with the correct
2898 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002899 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002900 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002901 */
2902 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2903 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2904
2905 /**
2906 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2907 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002908 * <p>NOTE: This should not be used as the primary key of an Intent,
2909 * since it will not result in the app launching with the correct
2910 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002911 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002912 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002913 */
2914 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2915 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2916
2917 /**
2918 * Used with {@link #ACTION_MAIN} to launch the email application.
2919 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002920 * <p>NOTE: This should not be used as the primary key of an Intent,
2921 * since it will not result in the app launching with the correct
2922 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002923 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002924 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002925 */
2926 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2927 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2928
2929 /**
2930 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2931 * The activity should be able to view and manipulate image and video files
2932 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002933 * <p>NOTE: This should not be used as the primary key of an Intent,
2934 * since it will not result in the app launching with the correct
2935 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002936 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002937 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002938 */
2939 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2940 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2941
2942 /**
2943 * Used with {@link #ACTION_MAIN} to launch the maps application.
2944 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002945 * <p>NOTE: This should not be used as the primary key of an Intent,
2946 * since it will not result in the app launching with the correct
2947 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002948 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002949 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002950 */
2951 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2952 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2953
2954 /**
2955 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2956 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002957 * <p>NOTE: This should not be used as the primary key of an Intent,
2958 * since it will not result in the app launching with the correct
2959 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002960 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002961 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002962 */
2963 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2964 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2965
2966 /**
2967 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002968 * The activity should be able to play, browse, or manipulate music files
2969 * stored on the device.
2970 * <p>NOTE: This should not be used as the primary key of an Intent,
2971 * since it will not result in the app launching with the correct
2972 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002973 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002974 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002975 */
2976 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2977 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2978
2979 // ---------------------------------------------------------------------
2980 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002981 // Standard extra data keys.
2982
2983 /**
2984 * The initial data to place in a newly created record. Use with
2985 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2986 * fields as would be given to the underlying ContentProvider.insert()
2987 * call.
2988 */
2989 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2990
2991 /**
2992 * A constant CharSequence that is associated with the Intent, used with
2993 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2994 * this may be a styled CharSequence, so you must use
2995 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2996 * retrieve it.
2997 */
2998 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2999
3000 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003001 * A constant String that is associated with the Intent, used with
3002 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3003 * as HTML formatted text. Note that you <em>must</em> also supply
3004 * {@link #EXTRA_TEXT}.
3005 */
3006 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3007
3008 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003009 * A content: URI holding a stream of data associated with the Intent,
3010 * used with {@link #ACTION_SEND} to supply the data being sent.
3011 */
3012 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3013
3014 /**
3015 * A String[] holding e-mail addresses that should be delivered to.
3016 */
3017 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3018
3019 /**
3020 * A String[] holding e-mail addresses that should be carbon copied.
3021 */
3022 public static final String EXTRA_CC = "android.intent.extra.CC";
3023
3024 /**
3025 * A String[] holding e-mail addresses that should be blind carbon copied.
3026 */
3027 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3028
3029 /**
3030 * A constant string holding the desired subject line of a message.
3031 */
3032 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3033
3034 /**
3035 * An Intent describing the choices you would like shown with
3036 * {@link #ACTION_PICK_ACTIVITY}.
3037 */
3038 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3039
3040 /**
3041 * A CharSequence dialog title to provide to the user when used with a
3042 * {@link #ACTION_CHOOSER}.
3043 */
3044 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3045
3046 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003047 * A Parcelable[] of {@link Intent} or
3048 * {@link android.content.pm.LabeledIntent} objects as set with
3049 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3050 * a the front of the list of choices, when shown to the user with a
3051 * {@link #ACTION_CHOOSER}.
3052 */
3053 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3054
3055 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003056 * A {@link android.view.KeyEvent} object containing the event that
3057 * triggered the creation of the Intent it is in.
3058 */
3059 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3060
3061 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003062 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3063 * before shutting down.
3064 *
3065 * {@hide}
3066 */
3067 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3068
3069 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003070 * 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 -07003071 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3072 * of restarting the application.
3073 */
3074 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3075
3076 /**
3077 * A String holding the phone number originally entered in
3078 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3079 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3080 */
3081 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003082
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003083 /**
3084 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3085 * intents to supply the uid the package had been assigned. Also an optional
3086 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3087 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3088 * purpose.
3089 */
3090 public static final String EXTRA_UID = "android.intent.extra.UID";
3091
3092 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003093 * @hide String array of package names.
3094 */
3095 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3096
3097 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003098 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3099 * intents to indicate whether this represents a full uninstall (removing
3100 * both the code and its data) or a partial uninstall (leaving its data,
3101 * implying that this is an update).
3102 */
3103 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003104
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003105 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003106 * @hide
3107 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3108 * intents to indicate that at this point the package has been removed for
3109 * all users on the device.
3110 */
3111 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3112 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3113
3114 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003115 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3116 * intents to indicate that this is a replacement of the package, so this
3117 * broadcast will immediately be followed by an add broadcast for a
3118 * different version of the same package.
3119 */
3120 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003121
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003122 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003123 * Used as an int extra field in {@link android.app.AlarmManager} intents
3124 * to tell the application being invoked how many pending alarms are being
3125 * delievered with the intent. For one-shot alarms this will always be 1.
3126 * For recurring alarms, this might be greater than 1 if the device was
3127 * asleep or powered off at the time an earlier alarm would have been
3128 * delivered.
3129 */
3130 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003131
Jacek Surazski86b6c532009-05-13 14:38:28 +02003132 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003133 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3134 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003135 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3136 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003137 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3138 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3139 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003140 */
3141 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3142
3143 /**
3144 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3145 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003146 */
3147 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3148
3149 /**
3150 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3151 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003152 */
3153 public static final int EXTRA_DOCK_STATE_DESK = 1;
3154
3155 /**
3156 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3157 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003158 */
3159 public static final int EXTRA_DOCK_STATE_CAR = 2;
3160
3161 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003162 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3163 * to represent that the phone is in a analog (low end) dock.
3164 */
3165 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3166
3167 /**
3168 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3169 * to represent that the phone is in a digital (high end) dock.
3170 */
3171 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3172
3173 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003174 * Boolean that can be supplied as meta-data with a dock activity, to
3175 * indicate that the dock should take over the home key when it is active.
3176 */
3177 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003178
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003179 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003180 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3181 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003182 */
3183 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3184
3185 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003186 * Used in the extra field in the remote intent. It's astring token passed with the
3187 * remote intent.
3188 */
3189 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3190 "android.intent.extra.remote_intent_token";
3191
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003192 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003193 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003194 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003195 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003196 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003197 "android.intent.extra.changed_component_name";
3198
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003199 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003200 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003201 * and contains a string array of all of the components that have changed. If
3202 * the state of the overall package has changed, then it will contain an entry
3203 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003204 */
3205 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3206 "android.intent.extra.changed_component_name_list";
3207
3208 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003209 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003210 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3211 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003212 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003213 */
3214 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3215 "android.intent.extra.changed_package_list";
3216
3217 /**
3218 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003219 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3220 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003221 * and contains an integer array of uids of all of the components
3222 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003223 */
3224 public static final String EXTRA_CHANGED_UID_LIST =
3225 "android.intent.extra.changed_uid_list";
3226
3227 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003228 * @hide
3229 * Magic extra system code can use when binding, to give a label for
3230 * who it is that has bound to a service. This is an integer giving
3231 * a framework string resource that can be displayed to the user.
3232 */
3233 public static final String EXTRA_CLIENT_LABEL =
3234 "android.intent.extra.client_label";
3235
3236 /**
3237 * @hide
3238 * Magic extra system code can use when binding, to give a PendingIntent object
3239 * that can be launched for the user to disable the system's use of this
3240 * service.
3241 */
3242 public static final String EXTRA_CLIENT_INTENT =
3243 "android.intent.extra.client_intent";
3244
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003245 /**
3246 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3247 * data that is on the local device. This is a boolean extra; the default
3248 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3249 * the user to select media that is already on the device, not requiring it
3250 * be downloaded from a remote service when opened. Another way to look
3251 * at it is that such content should generally have a "_data" column to the
3252 * path of the content on local external storage.
3253 */
3254 public static final String EXTRA_LOCAL_ONLY =
3255 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003256
Amith Yamasani13593602012-03-22 16:16:17 -07003257 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003258 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3259 * user to select and return multiple items. This is a boolean extra; the default
3260 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3261 * present the user with a UI where they can pick multiple items that are all
3262 * returned to the caller. When this happens, they should be returned as
3263 * the {@link #getClipData()} part of the result Intent.
3264 */
3265 public static final String EXTRA_ALLOW_MULTIPLE =
3266 "android.intent.extra.ALLOW_MULTIPLE";
3267
3268 /**
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003269 * The userHandle carried with broadcast intents related to addition, removal and switching of
3270 * users
Amith Yamasani13593602012-03-22 16:16:17 -07003271 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3272 * @hide
3273 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003274 public static final String EXTRA_USER_HANDLE =
3275 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003276
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003277 /**
3278 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003279 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3280 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003281 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003282 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3283
3284 /**
3285 * Extra sent in the intent to the BroadcastReceiver that handles
3286 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3287 * the restrictions as key/value pairs.
3288 */
3289 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3290 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003291
Amith Yamasani86118ba2013-03-28 14:33:16 -07003292 /**
3293 * Extra used in the response from a BroadcastReceiver that handles
3294 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3295 */
3296 public static final String EXTRA_RESTRICTIONS_INTENT =
3297 "android.intent.extra.restrictions_intent";
3298
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003299 /**
3300 * Extra used to communicate set of acceptable MIME types for
Jeff Sharkey9ab3fd42013-05-01 18:12:12 -07003301 * {@link #ACTION_GET_CONTENT} or {@link #ACTION_OPEN_DOCUMENT}. The type of the
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003302 * extra is <code>ArrayList&lt;String&gt;</code>.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003303 */
3304 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3305
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003306 /**
3307 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3308 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003309 * When this is true, hardware devices can use this information to determine that
3310 * they shouldn't do a complete shutdown of their device since this is not a
3311 * complete shutdown down to the kernel, but only user space restarting.
3312 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003313 */
3314 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3315 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3316
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003317 // ---------------------------------------------------------------------
3318 // ---------------------------------------------------------------------
3319 // Intent flags (see mFlags variable).
3320
Tor Norbyed9273d62013-05-30 15:59:53 -07003321 /** @hide */
3322 @IntDef(flag = true,
3323 value = {FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION})
3324 @Retention(RetentionPolicy.SOURCE)
3325 public @interface GrantUriMode {}
3326
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003327 /**
3328 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003329 * perform read operations on the Uri in the Intent's data and any URIs
3330 * specified in its ClipData. When applying to an Intent's ClipData,
3331 * all URIs as well as recursive traversals through data or other ClipData
3332 * in Intent items will be granted; only the grant flags of the top-level
3333 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003334 */
3335 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3336 /**
3337 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003338 * perform write operations on the Uri in the Intent's data and any URIs
3339 * specified in its ClipData. When applying to an Intent's ClipData,
3340 * all URIs as well as recursive traversals through data or other ClipData
3341 * in Intent items will be granted; only the grant flags of the top-level
3342 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003343 */
3344 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3345 /**
3346 * Can be set by the caller to indicate that this Intent is coming from
3347 * a background operation, not from direct user interaction.
3348 */
3349 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3350 /**
3351 * A flag you can enable for debugging: when set, log messages will be
3352 * printed during the resolution of this intent to show you what has
3353 * been found to create the final resolved list.
3354 */
3355 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003356 /**
3357 * If set, this intent will not match any components in packages that
3358 * are currently stopped. If this is not set, then the default behavior
3359 * is to include such applications in the result.
3360 */
3361 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3362 /**
3363 * If set, this intent will always match any components in packages that
3364 * are currently stopped. This is the default behavior when
3365 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3366 * flags are set, this one wins (it allows overriding of exclude for
3367 * places where the framework may automatically set the exclude flag).
3368 */
3369 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003370
3371 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003372 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3373 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the grant will be remembered
3374 * until explicitly revoked with
3375 * {@link Context#revokeUriPermission(Uri, int)}. These grants persist
3376 * across device reboots.
3377 */
3378 public static final int FLAG_PERSIST_GRANT_URI_PERMISSION = 0x00000040;
3379
3380 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003381 * If set, the new activity is not kept in the history stack. As soon as
3382 * the user navigates away from it, the activity is finished. This may also
3383 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3384 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003385 */
3386 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3387 /**
3388 * If set, the activity will not be launched if it is already running
3389 * at the top of the history stack.
3390 */
3391 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3392 /**
3393 * If set, this activity will become the start of a new task on this
3394 * history stack. A task (from the activity that started it to the
3395 * next task activity) defines an atomic group of activities that the
3396 * user can move to. Tasks can be moved to the foreground and background;
3397 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003398 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003399 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3400 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003401 *
3402 * <p>This flag is generally used by activities that want
3403 * to present a "launcher" style behavior: they give the user a list of
3404 * separate things that can be done, which otherwise run completely
3405 * independently of the activity launching them.
3406 *
3407 * <p>When using this flag, if a task is already running for the activity
3408 * you are now starting, then a new activity will not be started; instead,
3409 * the current task will simply be brought to the front of the screen with
3410 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3411 * to disable this behavior.
3412 *
3413 * <p>This flag can not be used when the caller is requesting a result from
3414 * the activity being launched.
3415 */
3416 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3417 /**
3418 * <strong>Do not use this flag unless you are implementing your own
3419 * top-level application launcher.</strong> Used in conjunction with
3420 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3421 * behavior of bringing an existing task to the foreground. When set,
3422 * a new task is <em>always</em> started to host the Activity for the
3423 * Intent, regardless of whether there is already an existing task running
3424 * the same thing.
3425 *
3426 * <p><strong>Because the default system does not include graphical task management,
3427 * you should not use this flag unless you provide some way for a user to
3428 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003429 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003430 * <p>This flag is ignored if
3431 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3432 *
Scott Main7aee61f2011-02-08 11:25:01 -08003433 * <p>See
3434 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3435 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003436 */
3437 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3438 /**
3439 * If set, and the activity being launched is already running in the
3440 * current task, then instead of launching a new instance of that activity,
3441 * all of the other activities on top of it will be closed and this Intent
3442 * will be delivered to the (now on top) old activity as a new Intent.
3443 *
3444 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3445 * If D calls startActivity() with an Intent that resolves to the component
3446 * of activity B, then C and D will be finished and B receive the given
3447 * Intent, resulting in the stack now being: A, B.
3448 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003449 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003450 * either receive the new intent you are starting here in its
3451 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003452 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003453 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3454 * the same intent, then it will be finished and re-created; for all other
3455 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3456 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003457 *
3458 * <p>This launch mode can also be used to good effect in conjunction with
3459 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3460 * of a task, it will bring any currently running instance of that task
3461 * to the foreground, and then clear it to its root state. This is
3462 * especially useful, for example, when launching an activity from the
3463 * notification manager.
3464 *
Scott Main7aee61f2011-02-08 11:25:01 -08003465 * <p>See
3466 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3467 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003468 */
3469 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3470 /**
3471 * If set and this intent is being used to launch a new activity from an
3472 * existing one, then the reply target of the existing activity will be
3473 * transfered to the new activity. This way the new activity can call
3474 * {@link android.app.Activity#setResult} and have that result sent back to
3475 * the reply target of the original activity.
3476 */
3477 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3478 /**
3479 * If set and this intent is being used to launch a new activity from an
3480 * existing one, the current activity will not be counted as the top
3481 * activity for deciding whether the new intent should be delivered to
3482 * the top instead of starting a new one. The previous activity will
3483 * be used as the top, with the assumption being that the current activity
3484 * will finish itself immediately.
3485 */
3486 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3487 /**
3488 * If set, the new activity is not kept in the list of recently launched
3489 * activities.
3490 */
3491 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3492 /**
3493 * This flag is not normally set by application code, but set for you by
3494 * the system as described in the
3495 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3496 * launchMode} documentation for the singleTask mode.
3497 */
3498 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3499 /**
3500 * If set, and this activity is either being started in a new task or
3501 * bringing to the top an existing task, then it will be launched as
3502 * the front door of the task. This will result in the application of
3503 * any affinities needed to have that task in the proper state (either
3504 * moving activities to or from it), or simply resetting that task to
3505 * its initial state if needed.
3506 */
3507 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3508 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003509 * This flag is not normally set by application code, but set for you by
3510 * the system if this activity is being launched from history
3511 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003512 */
3513 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003514 /**
3515 * If set, this marks a point in the task's activity stack that should
3516 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003517 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003518 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3519 * the user re-launching it from home), this activity and all on top of
3520 * it will be finished so that the user does not return to them, but
3521 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003522 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003523 * <p>This is useful for cases where you have a logical break in your
3524 * application. For example, an e-mail application may have a command
3525 * to view an attachment, which launches an image view activity to
3526 * display it. This activity should be part of the e-mail application's
3527 * task, since it is a part of the task the user is involved in. However,
3528 * if the user leaves that task, and later selects the e-mail app from
3529 * home, we may like them to return to the conversation they were
3530 * viewing, not the picture attachment, since that is confusing. By
3531 * setting this flag when launching the image viewer, that viewer and
3532 * any activities it starts will be removed the next time the user returns
3533 * to mail.
3534 */
3535 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003536 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003537 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003538 * callback from occurring on the current frontmost activity before it is
3539 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003540 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003541 * <p>Typically, an activity can rely on that callback to indicate that an
3542 * explicit user action has caused their activity to be moved out of the
3543 * foreground. The callback marks an appropriate point in the activity's
3544 * lifecycle for it to dismiss any notifications that it intends to display
3545 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003546 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003547 * <p>If an activity is ever started via any non-user-driven events such as
3548 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3549 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003550 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003551 */
3552 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003553 /**
3554 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3555 * this flag will cause the launched activity to be brought to the front of its
3556 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003557 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003558 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3559 * If D calls startActivity() with an Intent that resolves to the component
3560 * of activity B, then B will be brought to the front of the history stack,
3561 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003562 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003563 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003564 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003565 */
3566 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003567 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003568 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3569 * this flag will prevent the system from applying an activity transition
3570 * animation to go to the next activity state. This doesn't mean an
3571 * animation will never run -- if another activity change happens that doesn't
3572 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003573 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003574 * when you are going to do a series of activity operations but the
3575 * animation seen by the user shouldn't be driven by the first activity
3576 * change but rather a later one.
3577 */
3578 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3579 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003580 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3581 * this flag will cause any existing task that would be associated with the
3582 * activity to be cleared before the activity is started. That is, the activity
3583 * becomes the new root of an otherwise empty task, and any old activities
3584 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3585 */
3586 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3587 /**
3588 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3589 * this flag will cause a newly launching task to be placed on top of the current
3590 * home activity task (if there is one). That is, pressing back from the task
3591 * will always return the user to home even if that was not the last activity they
3592 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3593 */
3594 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3595 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003596 * If set, when sending a broadcast only registered receivers will be
3597 * called -- no BroadcastReceiver components will be launched.
3598 */
3599 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003600 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003601 * If set, when sending a broadcast the new broadcast will replace
3602 * any existing pending broadcast that matches it. Matching is defined
3603 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3604 * true for the intents of the two broadcasts. When a match is found,
3605 * the new broadcast (and receivers associated with it) will replace the
3606 * existing one in the pending broadcast list, remaining at the same
3607 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003608 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003609 * <p>This flag is most typically used with sticky broadcasts, which
3610 * only care about delivering the most recent values of the broadcast
3611 * to their receivers.
3612 */
3613 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3614 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003615 * If set, when sending a broadcast the recipient is allowed to run at
3616 * foreground priority, with a shorter timeout interval. During normal
3617 * broadcasts the receivers are not automatically hoisted out of the
3618 * background priority class.
3619 */
3620 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3621 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003622 * If set, when sending a broadcast <i>before boot has completed</i> only
3623 * registered receivers will be called -- no BroadcastReceiver components
3624 * will be launched. Sticky intent state will be recorded properly even
3625 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3626 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003627 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003628 * <p>This flag is only for use by system sevices as a convenience to
3629 * avoid having to implement a more complex mechanism around detection
3630 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003631 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003632 * @hide
3633 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003634 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003635 /**
3636 * Set when this broadcast is for a boot upgrade, a special mode that
3637 * allows the broadcast to be sent before the system is ready and launches
3638 * the app process with no providers running in it.
3639 * @hide
3640 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003641 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003642
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003643 /**
3644 * @hide Flags that can't be changed with PendingIntent.
3645 */
3646 public static final int IMMUTABLE_FLAGS =
3647 FLAG_GRANT_READ_URI_PERMISSION
3648 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003650 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003651 // ---------------------------------------------------------------------
3652 // toUri() and parseUri() options.
3653
3654 /**
3655 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3656 * always has the "intent:" scheme. This syntax can be used when you want
3657 * to later disambiguate between URIs that are intended to describe an
3658 * Intent vs. all others that should be treated as raw URIs. When used
3659 * with {@link #parseUri}, any other scheme will result in a generic
3660 * VIEW action for that raw URI.
3661 */
3662 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003663
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003664 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003665
3666 private String mAction;
3667 private Uri mData;
3668 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003669 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003670 private ComponentName mComponent;
3671 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003672 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003673 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003674 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003675 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003676 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003677
3678 // ---------------------------------------------------------------------
3679
3680 /**
3681 * Create an empty intent.
3682 */
3683 public Intent() {
3684 }
3685
3686 /**
3687 * Copy constructor.
3688 */
3689 public Intent(Intent o) {
3690 this.mAction = o.mAction;
3691 this.mData = o.mData;
3692 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003693 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003694 this.mComponent = o.mComponent;
3695 this.mFlags = o.mFlags;
3696 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003697 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003698 }
3699 if (o.mExtras != null) {
3700 this.mExtras = new Bundle(o.mExtras);
3701 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003702 if (o.mSourceBounds != null) {
3703 this.mSourceBounds = new Rect(o.mSourceBounds);
3704 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003705 if (o.mSelector != null) {
3706 this.mSelector = new Intent(o.mSelector);
3707 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003708 if (o.mClipData != null) {
3709 this.mClipData = new ClipData(o.mClipData);
3710 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003711 }
3712
3713 @Override
3714 public Object clone() {
3715 return new Intent(this);
3716 }
3717
3718 private Intent(Intent o, boolean all) {
3719 this.mAction = o.mAction;
3720 this.mData = o.mData;
3721 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003722 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003723 this.mComponent = o.mComponent;
3724 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003725 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003726 }
3727 }
3728
3729 /**
3730 * Make a clone of only the parts of the Intent that are relevant for
3731 * filter matching: the action, data, type, component, and categories.
3732 */
3733 public Intent cloneFilter() {
3734 return new Intent(this, false);
3735 }
3736
3737 /**
3738 * Create an intent with a given action. All other fields (data, type,
3739 * class) are null. Note that the action <em>must</em> be in a
3740 * namespace because Intents are used globally in the system -- for
3741 * example the system VIEW action is android.intent.action.VIEW; an
3742 * application's custom action would be something like
3743 * com.google.app.myapp.CUSTOM_ACTION.
3744 *
3745 * @param action The Intent action, such as ACTION_VIEW.
3746 */
3747 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003748 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003749 }
3750
3751 /**
3752 * Create an intent with a given action and for a given data url. Note
3753 * that the action <em>must</em> be in a namespace because Intents are
3754 * used globally in the system -- for example the system VIEW action is
3755 * android.intent.action.VIEW; an application's custom action would be
3756 * something like com.google.app.myapp.CUSTOM_ACTION.
3757 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003758 * <p><em>Note: scheme and host name matching in the Android framework is
3759 * case-sensitive, unlike the formal RFC. As a result,
3760 * you should always ensure that you write your Uri with these elements
3761 * using lower case letters, and normalize any Uris you receive from
3762 * outside of Android to ensure the scheme and host is lower case.</em></p>
3763 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003764 * @param action The Intent action, such as ACTION_VIEW.
3765 * @param uri The Intent data URI.
3766 */
3767 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003768 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003769 mData = uri;
3770 }
3771
3772 /**
3773 * Create an intent for a specific component. All other fields (action, data,
3774 * type, class) are null, though they can be modified later with explicit
3775 * calls. This provides a convenient way to create an intent that is
3776 * intended to execute a hard-coded class name, rather than relying on the
3777 * system to find an appropriate class for you; see {@link #setComponent}
3778 * for more information on the repercussions of this.
3779 *
3780 * @param packageContext A Context of the application package implementing
3781 * this class.
3782 * @param cls The component class that is to be used for the intent.
3783 *
3784 * @see #setClass
3785 * @see #setComponent
3786 * @see #Intent(String, android.net.Uri , Context, Class)
3787 */
3788 public Intent(Context packageContext, Class<?> cls) {
3789 mComponent = new ComponentName(packageContext, cls);
3790 }
3791
3792 /**
3793 * Create an intent for a specific component with a specified action and data.
3794 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3795 * construct the Intent and then calling {@link #setClass} to set its
3796 * class.
3797 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003798 * <p><em>Note: scheme and host name matching in the Android framework is
3799 * case-sensitive, unlike the formal RFC. As a result,
3800 * you should always ensure that you write your Uri with these elements
3801 * using lower case letters, and normalize any Uris you receive from
3802 * outside of Android to ensure the scheme and host is lower case.</em></p>
3803 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003804 * @param action The Intent action, such as ACTION_VIEW.
3805 * @param uri The Intent data URI.
3806 * @param packageContext A Context of the application package implementing
3807 * this class.
3808 * @param cls The component class that is to be used for the intent.
3809 *
3810 * @see #Intent(String, android.net.Uri)
3811 * @see #Intent(Context, Class)
3812 * @see #setClass
3813 * @see #setComponent
3814 */
3815 public Intent(String action, Uri uri,
3816 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003817 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003818 mData = uri;
3819 mComponent = new ComponentName(packageContext, cls);
3820 }
3821
3822 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003823 * Create an intent to launch the main (root) activity of a task. This
3824 * is the Intent that is started when the application's is launched from
3825 * Home. For anything else that wants to launch an application in the
3826 * same way, it is important that they use an Intent structured the same
3827 * way, and can use this function to ensure this is the case.
3828 *
3829 * <p>The returned Intent has the given Activity component as its explicit
3830 * component, {@link #ACTION_MAIN} as its action, and includes the
3831 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3832 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3833 * to do that through {@link #addFlags(int)} on the returned Intent.
3834 *
3835 * @param mainActivity The main activity component that this Intent will
3836 * launch.
3837 * @return Returns a newly created Intent that can be used to launch the
3838 * activity as a main application entry.
3839 *
3840 * @see #setClass
3841 * @see #setComponent
3842 */
3843 public static Intent makeMainActivity(ComponentName mainActivity) {
3844 Intent intent = new Intent(ACTION_MAIN);
3845 intent.setComponent(mainActivity);
3846 intent.addCategory(CATEGORY_LAUNCHER);
3847 return intent;
3848 }
3849
3850 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003851 * Make an Intent for the main activity of an application, without
3852 * specifying a specific activity to run but giving a selector to find
3853 * the activity. This results in a final Intent that is structured
3854 * the same as when the application is launched from
3855 * Home. For anything else that wants to launch an application in the
3856 * same way, it is important that they use an Intent structured the same
3857 * way, and can use this function to ensure this is the case.
3858 *
3859 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3860 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3861 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3862 * to do that through {@link #addFlags(int)} on the returned Intent.
3863 *
3864 * @param selectorAction The action name of the Intent's selector.
3865 * @param selectorCategory The name of a category to add to the Intent's
3866 * selector.
3867 * @return Returns a newly created Intent that can be used to launch the
3868 * activity as a main application entry.
3869 *
3870 * @see #setSelector(Intent)
3871 */
3872 public static Intent makeMainSelectorActivity(String selectorAction,
3873 String selectorCategory) {
3874 Intent intent = new Intent(ACTION_MAIN);
3875 intent.addCategory(CATEGORY_LAUNCHER);
3876 Intent selector = new Intent();
3877 selector.setAction(selectorAction);
3878 selector.addCategory(selectorCategory);
3879 intent.setSelector(selector);
3880 return intent;
3881 }
3882
3883 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003884 * Make an Intent that can be used to re-launch an application's task
3885 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3886 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3887 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3888 *
3889 * @param mainActivity The activity component that is the root of the
3890 * task; this is the activity that has been published in the application's
3891 * manifest as the main launcher icon.
3892 *
3893 * @return Returns a newly created Intent that can be used to relaunch the
3894 * activity's task in its root state.
3895 */
3896 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3897 Intent intent = makeMainActivity(mainActivity);
3898 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3899 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3900 return intent;
3901 }
3902
3903 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003904 * Call {@link #parseUri} with 0 flags.
3905 * @deprecated Use {@link #parseUri} instead.
3906 */
3907 @Deprecated
3908 public static Intent getIntent(String uri) throws URISyntaxException {
3909 return parseUri(uri, 0);
3910 }
Tom Taylord4a47292009-12-21 13:59:18 -08003911
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003912 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003913 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003914 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003915 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003916 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003917 *
3918 * <p>The URI given here must not be relative -- that is, it must include
3919 * the scheme and full path.
3920 *
3921 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003922 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003923 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003924 *
3925 * @return Intent The newly created Intent object.
3926 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003927 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3928 * it bad (as parsed by the Uri class) or the Intent data within the
3929 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003930 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003931 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003932 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003933 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003934 int i = 0;
3935 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003936 // Validate intent scheme for if requested.
3937 if ((flags&URI_INTENT_SCHEME) != 0) {
3938 if (!uri.startsWith("intent:")) {
3939 Intent intent = new Intent(ACTION_VIEW);
3940 try {
3941 intent.setData(Uri.parse(uri));
3942 } catch (IllegalArgumentException e) {
3943 throw new URISyntaxException(uri, e.getMessage());
3944 }
3945 return intent;
3946 }
3947 }
Tom Taylord4a47292009-12-21 13:59:18 -08003948
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003949 // simple case
3950 i = uri.lastIndexOf("#");
3951 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3952
3953 // old format Intent URI
3954 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003955
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003956 // new format
3957 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003958 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003959
3960 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003961 String data = i >= 0 ? uri.substring(0, i) : null;
3962 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003963 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003964
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003965 // loop over contents of Intent, all name=value;
3966 while (!uri.startsWith("end", i)) {
3967 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003968 if (eq < 0) eq = i-1;
3969 int semi = uri.indexOf(';', i);
3970 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003971
3972 // action
3973 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003974 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003975 }
3976
3977 // categories
3978 else if (uri.startsWith("category=", i)) {
3979 intent.addCategory(value);
3980 }
3981
3982 // type
3983 else if (uri.startsWith("type=", i)) {
3984 intent.mType = value;
3985 }
3986
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003987 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003988 else if (uri.startsWith("launchFlags=", i)) {
3989 intent.mFlags = Integer.decode(value).intValue();
3990 }
3991
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003992 // package
3993 else if (uri.startsWith("package=", i)) {
3994 intent.mPackage = value;
3995 }
3996
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003997 // component
3998 else if (uri.startsWith("component=", i)) {
3999 intent.mComponent = ComponentName.unflattenFromString(value);
4000 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004001
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004002 // scheme
4003 else if (uri.startsWith("scheme=", i)) {
4004 scheme = value;
4005 }
4006
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004007 // source bounds
4008 else if (uri.startsWith("sourceBounds=", i)) {
4009 intent.mSourceBounds = Rect.unflattenFromString(value);
4010 }
4011
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004012 // selector
4013 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4014 intent = new Intent();
4015 }
4016
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004017 // extra
4018 else {
4019 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004020 // create Bundle if it doesn't already exist
4021 if (intent.mExtras == null) intent.mExtras = new Bundle();
4022 Bundle b = intent.mExtras;
4023 // add EXTRA
4024 if (uri.startsWith("S.", i)) b.putString(key, value);
4025 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4026 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4027 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4028 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4029 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4030 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4031 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4032 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4033 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4034 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004035
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004036 // move to the next item
4037 i = semi + 1;
4038 }
4039
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004040 if (intent != baseIntent) {
4041 // The Intent had a selector; fix it up.
4042 baseIntent.setSelector(intent);
4043 intent = baseIntent;
4044 }
4045
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004046 if (data != null) {
4047 if (data.startsWith("intent:")) {
4048 data = data.substring(7);
4049 if (scheme != null) {
4050 data = scheme + ':' + data;
4051 }
4052 }
Tom Taylord4a47292009-12-21 13:59:18 -08004053
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004054 if (data.length() > 0) {
4055 try {
4056 intent.mData = Uri.parse(data);
4057 } catch (IllegalArgumentException e) {
4058 throw new URISyntaxException(uri, e.getMessage());
4059 }
4060 }
4061 }
Tom Taylord4a47292009-12-21 13:59:18 -08004062
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004063 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004064
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004065 } catch (IndexOutOfBoundsException e) {
4066 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4067 }
4068 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004069
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004070 public static Intent getIntentOld(String uri) throws URISyntaxException {
4071 Intent intent;
4072
4073 int i = uri.lastIndexOf('#');
4074 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004075 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004076 final int intentFragmentStart = i;
4077 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004078
4079 i++;
4080
4081 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004082 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004083 i += 7;
4084 int j = uri.indexOf(')', i);
4085 action = uri.substring(i, j);
4086 i = j + 1;
4087 }
4088
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004089 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004090
4091 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004092 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004093 i += 11;
4094 int j = uri.indexOf(')', i);
4095 while (i < j) {
4096 int sep = uri.indexOf('!', i);
4097 if (sep < 0) sep = j;
4098 if (i < sep) {
4099 intent.addCategory(uri.substring(i, sep));
4100 }
4101 i = sep + 1;
4102 }
4103 i = j + 1;
4104 }
4105
4106 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004107 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004108 i += 5;
4109 int j = uri.indexOf(')', i);
4110 intent.mType = uri.substring(i, j);
4111 i = j + 1;
4112 }
4113
4114 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004115 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004116 i += 12;
4117 int j = uri.indexOf(')', i);
4118 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4119 i = j + 1;
4120 }
4121
4122 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004123 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004124 i += 10;
4125 int j = uri.indexOf(')', i);
4126 int sep = uri.indexOf('!', i);
4127 if (sep >= 0 && sep < j) {
4128 String pkg = uri.substring(i, sep);
4129 String cls = uri.substring(sep + 1, j);
4130 intent.mComponent = new ComponentName(pkg, cls);
4131 }
4132 i = j + 1;
4133 }
4134
4135 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004136 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004137 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004138
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004139 final int closeParen = uri.indexOf(')', i);
4140 if (closeParen == -1) throw new URISyntaxException(uri,
4141 "EXTRA missing trailing ')'", i);
4142
4143 while (i < closeParen) {
4144 // fetch the key value
4145 int j = uri.indexOf('=', i);
4146 if (j <= i + 1 || i >= closeParen) {
4147 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4148 }
4149 char type = uri.charAt(i);
4150 i++;
4151 String key = uri.substring(i, j);
4152 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004153
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004154 // get type-value
4155 j = uri.indexOf('!', i);
4156 if (j == -1 || j >= closeParen) j = closeParen;
4157 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4158 String value = uri.substring(i, j);
4159 i = j;
4160
4161 // create Bundle if it doesn't already exist
4162 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004163
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004164 // add item to bundle
4165 try {
4166 switch (type) {
4167 case 'S':
4168 intent.mExtras.putString(key, Uri.decode(value));
4169 break;
4170 case 'B':
4171 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4172 break;
4173 case 'b':
4174 intent.mExtras.putByte(key, Byte.parseByte(value));
4175 break;
4176 case 'c':
4177 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4178 break;
4179 case 'd':
4180 intent.mExtras.putDouble(key, Double.parseDouble(value));
4181 break;
4182 case 'f':
4183 intent.mExtras.putFloat(key, Float.parseFloat(value));
4184 break;
4185 case 'i':
4186 intent.mExtras.putInt(key, Integer.parseInt(value));
4187 break;
4188 case 'l':
4189 intent.mExtras.putLong(key, Long.parseLong(value));
4190 break;
4191 case 's':
4192 intent.mExtras.putShort(key, Short.parseShort(value));
4193 break;
4194 default:
4195 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4196 }
4197 } catch (NumberFormatException e) {
4198 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4199 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004200
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004201 char ch = uri.charAt(i);
4202 if (ch == ')') break;
4203 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4204 i++;
4205 }
4206 }
4207
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004208 if (isIntentFragment) {
4209 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4210 } else {
4211 intent.mData = Uri.parse(uri);
4212 }
Tom Taylord4a47292009-12-21 13:59:18 -08004213
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004214 if (intent.mAction == null) {
4215 // By default, if no action is specified, then use VIEW.
4216 intent.mAction = ACTION_VIEW;
4217 }
4218
4219 } else {
4220 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4221 }
4222
4223 return intent;
4224 }
4225
4226 /**
4227 * Retrieve the general action to be performed, such as
4228 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4229 * the information in the intent should be interpreted -- most importantly,
4230 * what to do with the data returned by {@link #getData}.
4231 *
4232 * @return The action of this intent or null if none is specified.
4233 *
4234 * @see #setAction
4235 */
4236 public String getAction() {
4237 return mAction;
4238 }
4239
4240 /**
4241 * Retrieve data this intent is operating on. This URI specifies the name
4242 * of the data; often it uses the content: scheme, specifying data in a
4243 * content provider. Other schemes may be handled by specific activities,
4244 * such as http: by the web browser.
4245 *
4246 * @return The URI of the data this intent is targeting or null.
4247 *
4248 * @see #getScheme
4249 * @see #setData
4250 */
4251 public Uri getData() {
4252 return mData;
4253 }
4254
4255 /**
4256 * The same as {@link #getData()}, but returns the URI as an encoded
4257 * String.
4258 */
4259 public String getDataString() {
4260 return mData != null ? mData.toString() : null;
4261 }
4262
4263 /**
4264 * Return the scheme portion of the intent's data. If the data is null or
4265 * does not include a scheme, null is returned. Otherwise, the scheme
4266 * prefix without the final ':' is returned, i.e. "http".
4267 *
4268 * <p>This is the same as calling getData().getScheme() (and checking for
4269 * null data).
4270 *
4271 * @return The scheme of this intent.
4272 *
4273 * @see #getData
4274 */
4275 public String getScheme() {
4276 return mData != null ? mData.getScheme() : null;
4277 }
4278
4279 /**
4280 * Retrieve any explicit MIME type included in the intent. This is usually
4281 * null, as the type is determined by the intent data.
4282 *
4283 * @return If a type was manually set, it is returned; else null is
4284 * returned.
4285 *
4286 * @see #resolveType(ContentResolver)
4287 * @see #setType
4288 */
4289 public String getType() {
4290 return mType;
4291 }
4292
4293 /**
4294 * Return the MIME data type of this intent. If the type field is
4295 * explicitly set, that is simply returned. Otherwise, if the data is set,
4296 * the type of that data is returned. If neither fields are set, a null is
4297 * returned.
4298 *
4299 * @return The MIME type of this intent.
4300 *
4301 * @see #getType
4302 * @see #resolveType(ContentResolver)
4303 */
4304 public String resolveType(Context context) {
4305 return resolveType(context.getContentResolver());
4306 }
4307
4308 /**
4309 * Return the MIME data type of this intent. If the type field is
4310 * explicitly set, that is simply returned. Otherwise, if the data is set,
4311 * the type of that data is returned. If neither fields are set, a null is
4312 * returned.
4313 *
4314 * @param resolver A ContentResolver that can be used to determine the MIME
4315 * type of the intent's data.
4316 *
4317 * @return The MIME type of this intent.
4318 *
4319 * @see #getType
4320 * @see #resolveType(Context)
4321 */
4322 public String resolveType(ContentResolver resolver) {
4323 if (mType != null) {
4324 return mType;
4325 }
4326 if (mData != null) {
4327 if ("content".equals(mData.getScheme())) {
4328 return resolver.getType(mData);
4329 }
4330 }
4331 return null;
4332 }
4333
4334 /**
4335 * Return the MIME data type of this intent, only if it will be needed for
4336 * intent resolution. This is not generally useful for application code;
4337 * it is used by the frameworks for communicating with back-end system
4338 * services.
4339 *
4340 * @param resolver A ContentResolver that can be used to determine the MIME
4341 * type of the intent's data.
4342 *
4343 * @return The MIME type of this intent, or null if it is unknown or not
4344 * needed.
4345 */
4346 public String resolveTypeIfNeeded(ContentResolver resolver) {
4347 if (mComponent != null) {
4348 return mType;
4349 }
4350 return resolveType(resolver);
4351 }
4352
4353 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004354 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004355 *
4356 * @param category The category to check.
4357 *
4358 * @return boolean True if the intent contains the category, else false.
4359 *
4360 * @see #getCategories
4361 * @see #addCategory
4362 */
4363 public boolean hasCategory(String category) {
4364 return mCategories != null && mCategories.contains(category);
4365 }
4366
4367 /**
4368 * Return the set of all categories in the intent. If there are no categories,
4369 * returns NULL.
4370 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004371 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004372 *
4373 * @see #hasCategory
4374 * @see #addCategory
4375 */
4376 public Set<String> getCategories() {
4377 return mCategories;
4378 }
4379
4380 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004381 * Return the specific selector associated with this Intent. If there is
4382 * none, returns null. See {@link #setSelector} for more information.
4383 *
4384 * @see #setSelector
4385 */
4386 public Intent getSelector() {
4387 return mSelector;
4388 }
4389
4390 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004391 * Return the {@link ClipData} associated with this Intent. If there is
4392 * none, returns null. See {@link #setClipData} for more information.
4393 *
4394 * @see #setClipData;
4395 */
4396 public ClipData getClipData() {
4397 return mClipData;
4398 }
4399
4400 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004401 * Sets the ClassLoader that will be used when unmarshalling
4402 * any Parcelable values from the extras of this Intent.
4403 *
4404 * @param loader a ClassLoader, or null to use the default loader
4405 * at the time of unmarshalling.
4406 */
4407 public void setExtrasClassLoader(ClassLoader loader) {
4408 if (mExtras != null) {
4409 mExtras.setClassLoader(loader);
4410 }
4411 }
4412
4413 /**
4414 * Returns true if an extra value is associated with the given name.
4415 * @param name the extra's name
4416 * @return true if the given extra is present.
4417 */
4418 public boolean hasExtra(String name) {
4419 return mExtras != null && mExtras.containsKey(name);
4420 }
4421
4422 /**
4423 * Returns true if the Intent's extras contain a parcelled file descriptor.
4424 * @return true if the Intent contains a parcelled file descriptor.
4425 */
4426 public boolean hasFileDescriptors() {
4427 return mExtras != null && mExtras.hasFileDescriptors();
4428 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004429
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004430 /** @hide */
4431 public void setAllowFds(boolean allowFds) {
4432 if (mExtras != null) {
4433 mExtras.setAllowFds(allowFds);
4434 }
4435 }
4436
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004437 /**
4438 * Retrieve extended data from the intent.
4439 *
4440 * @param name The name of the desired item.
4441 *
4442 * @return the value of an item that previously added with putExtra()
4443 * or null if none was found.
4444 *
4445 * @deprecated
4446 * @hide
4447 */
4448 @Deprecated
4449 public Object getExtra(String name) {
4450 return getExtra(name, null);
4451 }
4452
4453 /**
4454 * Retrieve extended data from the intent.
4455 *
4456 * @param name The name of the desired item.
4457 * @param defaultValue the value to be returned if no value of the desired
4458 * type is stored with the given name.
4459 *
4460 * @return the value of an item that previously added with putExtra()
4461 * or the default value if none was found.
4462 *
4463 * @see #putExtra(String, boolean)
4464 */
4465 public boolean getBooleanExtra(String name, boolean defaultValue) {
4466 return mExtras == null ? defaultValue :
4467 mExtras.getBoolean(name, defaultValue);
4468 }
4469
4470 /**
4471 * Retrieve extended data from the intent.
4472 *
4473 * @param name The name of the desired item.
4474 * @param defaultValue the value to be returned if no value of the desired
4475 * type is stored with the given name.
4476 *
4477 * @return the value of an item that previously added with putExtra()
4478 * or the default value if none was found.
4479 *
4480 * @see #putExtra(String, byte)
4481 */
4482 public byte getByteExtra(String name, byte defaultValue) {
4483 return mExtras == null ? defaultValue :
4484 mExtras.getByte(name, defaultValue);
4485 }
4486
4487 /**
4488 * Retrieve extended data from the intent.
4489 *
4490 * @param name The name of the desired item.
4491 * @param defaultValue the value to be returned if no value of the desired
4492 * type is stored with the given name.
4493 *
4494 * @return the value of an item that previously added with putExtra()
4495 * or the default value if none was found.
4496 *
4497 * @see #putExtra(String, short)
4498 */
4499 public short getShortExtra(String name, short defaultValue) {
4500 return mExtras == null ? defaultValue :
4501 mExtras.getShort(name, defaultValue);
4502 }
4503
4504 /**
4505 * Retrieve extended data from the intent.
4506 *
4507 * @param name The name of the desired item.
4508 * @param defaultValue the value to be returned if no value of the desired
4509 * type is stored with the given name.
4510 *
4511 * @return the value of an item that previously added with putExtra()
4512 * or the default value if none was found.
4513 *
4514 * @see #putExtra(String, char)
4515 */
4516 public char getCharExtra(String name, char defaultValue) {
4517 return mExtras == null ? defaultValue :
4518 mExtras.getChar(name, defaultValue);
4519 }
4520
4521 /**
4522 * Retrieve extended data from the intent.
4523 *
4524 * @param name The name of the desired item.
4525 * @param defaultValue the value to be returned if no value of the desired
4526 * type is stored with the given name.
4527 *
4528 * @return the value of an item that previously added with putExtra()
4529 * or the default value if none was found.
4530 *
4531 * @see #putExtra(String, int)
4532 */
4533 public int getIntExtra(String name, int defaultValue) {
4534 return mExtras == null ? defaultValue :
4535 mExtras.getInt(name, defaultValue);
4536 }
4537
4538 /**
4539 * Retrieve extended data from the intent.
4540 *
4541 * @param name The name of the desired item.
4542 * @param defaultValue the value to be returned if no value of the desired
4543 * type is stored with the given name.
4544 *
4545 * @return the value of an item that previously added with putExtra()
4546 * or the default value if none was found.
4547 *
4548 * @see #putExtra(String, long)
4549 */
4550 public long getLongExtra(String name, long defaultValue) {
4551 return mExtras == null ? defaultValue :
4552 mExtras.getLong(name, defaultValue);
4553 }
4554
4555 /**
4556 * Retrieve extended data from the intent.
4557 *
4558 * @param name The name of the desired item.
4559 * @param defaultValue the value to be returned if no value of the desired
4560 * type is stored with the given name.
4561 *
4562 * @return the value of an item that previously added with putExtra(),
4563 * or the default value if no such item is present
4564 *
4565 * @see #putExtra(String, float)
4566 */
4567 public float getFloatExtra(String name, float defaultValue) {
4568 return mExtras == null ? defaultValue :
4569 mExtras.getFloat(name, defaultValue);
4570 }
4571
4572 /**
4573 * Retrieve extended data from the intent.
4574 *
4575 * @param name The name of the desired item.
4576 * @param defaultValue the value to be returned if no value of the desired
4577 * type is stored with the given name.
4578 *
4579 * @return the value of an item that previously added with putExtra()
4580 * or the default value if none was found.
4581 *
4582 * @see #putExtra(String, double)
4583 */
4584 public double getDoubleExtra(String name, double defaultValue) {
4585 return mExtras == null ? defaultValue :
4586 mExtras.getDouble(name, defaultValue);
4587 }
4588
4589 /**
4590 * Retrieve extended data from the intent.
4591 *
4592 * @param name The name of the desired item.
4593 *
4594 * @return the value of an item that previously added with putExtra()
4595 * or null if no String value was found.
4596 *
4597 * @see #putExtra(String, String)
4598 */
4599 public String getStringExtra(String name) {
4600 return mExtras == null ? null : mExtras.getString(name);
4601 }
4602
4603 /**
4604 * Retrieve extended data from the intent.
4605 *
4606 * @param name The name of the desired item.
4607 *
4608 * @return the value of an item that previously added with putExtra()
4609 * or null if no CharSequence value was found.
4610 *
4611 * @see #putExtra(String, CharSequence)
4612 */
4613 public CharSequence getCharSequenceExtra(String name) {
4614 return mExtras == null ? null : mExtras.getCharSequence(name);
4615 }
4616
4617 /**
4618 * Retrieve extended data from the intent.
4619 *
4620 * @param name The name of the desired item.
4621 *
4622 * @return the value of an item that previously added with putExtra()
4623 * or null if no Parcelable value was found.
4624 *
4625 * @see #putExtra(String, Parcelable)
4626 */
4627 public <T extends Parcelable> T getParcelableExtra(String name) {
4628 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4629 }
4630
4631 /**
4632 * Retrieve extended data from the intent.
4633 *
4634 * @param name The name of the desired item.
4635 *
4636 * @return the value of an item that previously added with putExtra()
4637 * or null if no Parcelable[] value was found.
4638 *
4639 * @see #putExtra(String, Parcelable[])
4640 */
4641 public Parcelable[] getParcelableArrayExtra(String name) {
4642 return mExtras == null ? null : mExtras.getParcelableArray(name);
4643 }
4644
4645 /**
4646 * Retrieve extended data from the intent.
4647 *
4648 * @param name The name of the desired item.
4649 *
4650 * @return the value of an item that previously added with putExtra()
4651 * or null if no ArrayList<Parcelable> value was found.
4652 *
4653 * @see #putParcelableArrayListExtra(String, ArrayList)
4654 */
4655 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4656 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4657 }
4658
4659 /**
4660 * Retrieve extended data from the intent.
4661 *
4662 * @param name The name of the desired item.
4663 *
4664 * @return the value of an item that previously added with putExtra()
4665 * or null if no Serializable value was found.
4666 *
4667 * @see #putExtra(String, Serializable)
4668 */
4669 public Serializable getSerializableExtra(String name) {
4670 return mExtras == null ? null : mExtras.getSerializable(name);
4671 }
4672
4673 /**
4674 * Retrieve extended data from the intent.
4675 *
4676 * @param name The name of the desired item.
4677 *
4678 * @return the value of an item that previously added with putExtra()
4679 * or null if no ArrayList<Integer> value was found.
4680 *
4681 * @see #putIntegerArrayListExtra(String, ArrayList)
4682 */
4683 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4684 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4685 }
4686
4687 /**
4688 * Retrieve extended data from the intent.
4689 *
4690 * @param name The name of the desired item.
4691 *
4692 * @return the value of an item that previously added with putExtra()
4693 * or null if no ArrayList<String> value was found.
4694 *
4695 * @see #putStringArrayListExtra(String, ArrayList)
4696 */
4697 public ArrayList<String> getStringArrayListExtra(String name) {
4698 return mExtras == null ? null : mExtras.getStringArrayList(name);
4699 }
4700
4701 /**
4702 * Retrieve extended data from the intent.
4703 *
4704 * @param name The name of the desired item.
4705 *
4706 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004707 * or null if no ArrayList<CharSequence> value was found.
4708 *
4709 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4710 */
4711 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4712 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4713 }
4714
4715 /**
4716 * Retrieve extended data from the intent.
4717 *
4718 * @param name The name of the desired item.
4719 *
4720 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004721 * or null if no boolean array value was found.
4722 *
4723 * @see #putExtra(String, boolean[])
4724 */
4725 public boolean[] getBooleanArrayExtra(String name) {
4726 return mExtras == null ? null : mExtras.getBooleanArray(name);
4727 }
4728
4729 /**
4730 * Retrieve extended data from the intent.
4731 *
4732 * @param name The name of the desired item.
4733 *
4734 * @return the value of an item that previously added with putExtra()
4735 * or null if no byte array value was found.
4736 *
4737 * @see #putExtra(String, byte[])
4738 */
4739 public byte[] getByteArrayExtra(String name) {
4740 return mExtras == null ? null : mExtras.getByteArray(name);
4741 }
4742
4743 /**
4744 * Retrieve extended data from the intent.
4745 *
4746 * @param name The name of the desired item.
4747 *
4748 * @return the value of an item that previously added with putExtra()
4749 * or null if no short array value was found.
4750 *
4751 * @see #putExtra(String, short[])
4752 */
4753 public short[] getShortArrayExtra(String name) {
4754 return mExtras == null ? null : mExtras.getShortArray(name);
4755 }
4756
4757 /**
4758 * Retrieve extended data from the intent.
4759 *
4760 * @param name The name of the desired item.
4761 *
4762 * @return the value of an item that previously added with putExtra()
4763 * or null if no char array value was found.
4764 *
4765 * @see #putExtra(String, char[])
4766 */
4767 public char[] getCharArrayExtra(String name) {
4768 return mExtras == null ? null : mExtras.getCharArray(name);
4769 }
4770
4771 /**
4772 * Retrieve extended data from the intent.
4773 *
4774 * @param name The name of the desired item.
4775 *
4776 * @return the value of an item that previously added with putExtra()
4777 * or null if no int array value was found.
4778 *
4779 * @see #putExtra(String, int[])
4780 */
4781 public int[] getIntArrayExtra(String name) {
4782 return mExtras == null ? null : mExtras.getIntArray(name);
4783 }
4784
4785 /**
4786 * Retrieve extended data from the intent.
4787 *
4788 * @param name The name of the desired item.
4789 *
4790 * @return the value of an item that previously added with putExtra()
4791 * or null if no long array value was found.
4792 *
4793 * @see #putExtra(String, long[])
4794 */
4795 public long[] getLongArrayExtra(String name) {
4796 return mExtras == null ? null : mExtras.getLongArray(name);
4797 }
4798
4799 /**
4800 * Retrieve extended data from the intent.
4801 *
4802 * @param name The name of the desired item.
4803 *
4804 * @return the value of an item that previously added with putExtra()
4805 * or null if no float array value was found.
4806 *
4807 * @see #putExtra(String, float[])
4808 */
4809 public float[] getFloatArrayExtra(String name) {
4810 return mExtras == null ? null : mExtras.getFloatArray(name);
4811 }
4812
4813 /**
4814 * Retrieve extended data from the intent.
4815 *
4816 * @param name The name of the desired item.
4817 *
4818 * @return the value of an item that previously added with putExtra()
4819 * or null if no double array value was found.
4820 *
4821 * @see #putExtra(String, double[])
4822 */
4823 public double[] getDoubleArrayExtra(String name) {
4824 return mExtras == null ? null : mExtras.getDoubleArray(name);
4825 }
4826
4827 /**
4828 * Retrieve extended data from the intent.
4829 *
4830 * @param name The name of the desired item.
4831 *
4832 * @return the value of an item that previously added with putExtra()
4833 * or null if no String array value was found.
4834 *
4835 * @see #putExtra(String, String[])
4836 */
4837 public String[] getStringArrayExtra(String name) {
4838 return mExtras == null ? null : mExtras.getStringArray(name);
4839 }
4840
4841 /**
4842 * Retrieve extended data from the intent.
4843 *
4844 * @param name The name of the desired item.
4845 *
4846 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004847 * or null if no CharSequence array value was found.
4848 *
4849 * @see #putExtra(String, CharSequence[])
4850 */
4851 public CharSequence[] getCharSequenceArrayExtra(String name) {
4852 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4853 }
4854
4855 /**
4856 * Retrieve extended data from the intent.
4857 *
4858 * @param name The name of the desired item.
4859 *
4860 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004861 * or null if no Bundle value was found.
4862 *
4863 * @see #putExtra(String, Bundle)
4864 */
4865 public Bundle getBundleExtra(String name) {
4866 return mExtras == null ? null : mExtras.getBundle(name);
4867 }
4868
4869 /**
4870 * Retrieve extended data from the intent.
4871 *
4872 * @param name The name of the desired item.
4873 *
4874 * @return the value of an item that previously added with putExtra()
4875 * or null if no IBinder value was found.
4876 *
4877 * @see #putExtra(String, IBinder)
4878 *
4879 * @deprecated
4880 * @hide
4881 */
4882 @Deprecated
4883 public IBinder getIBinderExtra(String name) {
4884 return mExtras == null ? null : mExtras.getIBinder(name);
4885 }
4886
4887 /**
4888 * Retrieve extended data from the intent.
4889 *
4890 * @param name The name of the desired item.
4891 * @param defaultValue The default value to return in case no item is
4892 * associated with the key 'name'
4893 *
4894 * @return the value of an item that previously added with putExtra()
4895 * or defaultValue if none was found.
4896 *
4897 * @see #putExtra
4898 *
4899 * @deprecated
4900 * @hide
4901 */
4902 @Deprecated
4903 public Object getExtra(String name, Object defaultValue) {
4904 Object result = defaultValue;
4905 if (mExtras != null) {
4906 Object result2 = mExtras.get(name);
4907 if (result2 != null) {
4908 result = result2;
4909 }
4910 }
4911
4912 return result;
4913 }
4914
4915 /**
4916 * Retrieves a map of extended data from the intent.
4917 *
4918 * @return the map of all extras previously added with putExtra(),
4919 * or null if none have been added.
4920 */
4921 public Bundle getExtras() {
4922 return (mExtras != null)
4923 ? new Bundle(mExtras)
4924 : null;
4925 }
4926
4927 /**
4928 * Retrieve any special flags associated with this intent. You will
4929 * normally just set them with {@link #setFlags} and let the system
4930 * take the appropriate action with them.
4931 *
4932 * @return int The currently set flags.
4933 *
4934 * @see #setFlags
4935 */
4936 public int getFlags() {
4937 return mFlags;
4938 }
4939
Dianne Hackborne7f97212011-02-24 14:40:20 -08004940 /** @hide */
4941 public boolean isExcludingStopped() {
4942 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4943 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4944 }
4945
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004946 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004947 * Retrieve the application package name this Intent is limited to. When
4948 * resolving an Intent, if non-null this limits the resolution to only
4949 * components in the given application package.
4950 *
4951 * @return The name of the application package for the Intent.
4952 *
4953 * @see #resolveActivity
4954 * @see #setPackage
4955 */
4956 public String getPackage() {
4957 return mPackage;
4958 }
4959
4960 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004961 * Retrieve the concrete component associated with the intent. When receiving
4962 * an intent, this is the component that was found to best handle it (that is,
4963 * yourself) and will always be non-null; in all other cases it will be
4964 * null unless explicitly set.
4965 *
4966 * @return The name of the application component to handle the intent.
4967 *
4968 * @see #resolveActivity
4969 * @see #setComponent
4970 */
4971 public ComponentName getComponent() {
4972 return mComponent;
4973 }
4974
4975 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004976 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4977 * used as a hint to the receiver for animations and the like. Null means that there
4978 * is no source bounds.
4979 */
4980 public Rect getSourceBounds() {
4981 return mSourceBounds;
4982 }
4983
4984 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004985 * Return the Activity component that should be used to handle this intent.
4986 * The appropriate component is determined based on the information in the
4987 * intent, evaluated as follows:
4988 *
4989 * <p>If {@link #getComponent} returns an explicit class, that is returned
4990 * without any further consideration.
4991 *
4992 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4993 * category to be considered.
4994 *
4995 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4996 * action.
4997 *
4998 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4999 * this type.
5000 *
5001 * <p>If {@link #addCategory} has added any categories, the activity must
5002 * handle ALL of the categories specified.
5003 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005004 * <p>If {@link #getPackage} is non-NULL, only activity components in
5005 * that application package will be considered.
5006 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005007 * <p>If there are no activities that satisfy all of these conditions, a
5008 * null string is returned.
5009 *
5010 * <p>If multiple activities are found to satisfy the intent, the one with
5011 * the highest priority will be used. If there are multiple activities
5012 * with the same priority, the system will either pick the best activity
5013 * based on user preference, or resolve to a system class that will allow
5014 * the user to pick an activity and forward from there.
5015 *
5016 * <p>This method is implemented simply by calling
5017 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5018 * true.</p>
5019 * <p> This API is called for you as part of starting an activity from an
5020 * intent. You do not normally need to call it yourself.</p>
5021 *
5022 * @param pm The package manager with which to resolve the Intent.
5023 *
5024 * @return Name of the component implementing an activity that can
5025 * display the intent.
5026 *
5027 * @see #setComponent
5028 * @see #getComponent
5029 * @see #resolveActivityInfo
5030 */
5031 public ComponentName resolveActivity(PackageManager pm) {
5032 if (mComponent != null) {
5033 return mComponent;
5034 }
5035
5036 ResolveInfo info = pm.resolveActivity(
5037 this, PackageManager.MATCH_DEFAULT_ONLY);
5038 if (info != null) {
5039 return new ComponentName(
5040 info.activityInfo.applicationInfo.packageName,
5041 info.activityInfo.name);
5042 }
5043
5044 return null;
5045 }
5046
5047 /**
5048 * Resolve the Intent into an {@link ActivityInfo}
5049 * describing the activity that should execute the intent. Resolution
5050 * follows the same rules as described for {@link #resolveActivity}, but
5051 * you get back the completely information about the resolved activity
5052 * instead of just its class name.
5053 *
5054 * @param pm The package manager with which to resolve the Intent.
5055 * @param flags Addition information to retrieve as per
5056 * {@link PackageManager#getActivityInfo(ComponentName, int)
5057 * PackageManager.getActivityInfo()}.
5058 *
5059 * @return PackageManager.ActivityInfo
5060 *
5061 * @see #resolveActivity
5062 */
5063 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5064 ActivityInfo ai = null;
5065 if (mComponent != null) {
5066 try {
5067 ai = pm.getActivityInfo(mComponent, flags);
5068 } catch (PackageManager.NameNotFoundException e) {
5069 // ignore
5070 }
5071 } else {
5072 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005073 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005074 if (info != null) {
5075 ai = info.activityInfo;
5076 }
5077 }
5078
5079 return ai;
5080 }
5081
5082 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005083 * Special function for use by the system to resolve service
5084 * intents to system apps. Throws an exception if there are
5085 * multiple potential matches to the Intent. Returns null if
5086 * there are no matches.
5087 * @hide
5088 */
5089 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5090 if (mComponent != null) {
5091 return mComponent;
5092 }
5093
5094 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5095 if (results == null) {
5096 return null;
5097 }
5098 ComponentName comp = null;
5099 for (int i=0; i<results.size(); i++) {
5100 ResolveInfo ri = results.get(i);
5101 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5102 continue;
5103 }
5104 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5105 ri.serviceInfo.name);
5106 if (comp != null) {
5107 throw new IllegalStateException("Multiple system services handle " + this
5108 + ": " + comp + ", " + foundComp);
5109 }
5110 comp = foundComp;
5111 }
5112 return comp;
5113 }
5114
5115 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005116 * Set the general action to be performed.
5117 *
5118 * @param action An action name, such as ACTION_VIEW. Application-specific
5119 * actions should be prefixed with the vendor's package name.
5120 *
5121 * @return Returns the same Intent object, for chaining multiple calls
5122 * into a single statement.
5123 *
5124 * @see #getAction
5125 */
5126 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005127 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005128 return this;
5129 }
5130
5131 /**
5132 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005133 * clears any type that was previously set by {@link #setType} or
5134 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005135 *
Nick Pellyccae4122012-01-09 14:12:58 -08005136 * <p><em>Note: scheme matching in the Android framework is
5137 * case-sensitive, unlike the formal RFC. As a result,
5138 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005139 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005140 * {@link #setDataAndNormalize}
5141 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005142 *
Nick Pellyccae4122012-01-09 14:12:58 -08005143 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005144 *
5145 * @return Returns the same Intent object, for chaining multiple calls
5146 * into a single statement.
5147 *
5148 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005149 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005150 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005151 */
5152 public Intent setData(Uri data) {
5153 mData = data;
5154 mType = null;
5155 return this;
5156 }
5157
5158 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005159 * Normalize and set the data this intent is operating on.
5160 *
5161 * <p>This method automatically clears any type that was
5162 * previously set (for example, by {@link #setType}).
5163 *
5164 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005165 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005166 * so really this is just a convenience method for
5167 * <pre>
5168 * setData(data.normalize())
5169 * </pre>
5170 *
5171 * @param data The Uri of the data this intent is now targeting.
5172 *
5173 * @return Returns the same Intent object, for chaining multiple calls
5174 * into a single statement.
5175 *
5176 * @see #getData
5177 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005178 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005179 */
5180 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005181 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005182 }
5183
5184 /**
5185 * Set an explicit MIME data type.
5186 *
5187 * <p>This is used to create intents that only specify a type and not data,
5188 * for example to indicate the type of data to return.
5189 *
5190 * <p>This method automatically clears any data that was
5191 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005192 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005193 * <p><em>Note: MIME type matching in the Android framework is
5194 * case-sensitive, unlike formal RFC MIME types. As a result,
5195 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005196 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5197 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005198 *
5199 * @param type The MIME type of the data being handled by this intent.
5200 *
5201 * @return Returns the same Intent object, for chaining multiple calls
5202 * into a single statement.
5203 *
5204 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005205 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005206 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005207 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005208 */
5209 public Intent setType(String type) {
5210 mData = null;
5211 mType = type;
5212 return this;
5213 }
5214
5215 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005216 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005217 *
Nick Pellyccae4122012-01-09 14:12:58 -08005218 * <p>This is used to create intents that only specify a type and not data,
5219 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005220 *
Nick Pellyccae4122012-01-09 14:12:58 -08005221 * <p>This method automatically clears any data that was
5222 * previously set (for example by {@link #setData}).
5223 *
5224 * <p>The MIME type is normalized using
5225 * {@link #normalizeMimeType} before it is set,
5226 * so really this is just a convenience method for
5227 * <pre>
5228 * setType(Intent.normalizeMimeType(type))
5229 * </pre>
5230 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005231 * @param type The MIME type of the data being handled by this intent.
5232 *
5233 * @return Returns the same Intent object, for chaining multiple calls
5234 * into a single statement.
5235 *
Nick Pellyccae4122012-01-09 14:12:58 -08005236 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005237 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005238 * @see #normalizeMimeType
5239 */
5240 public Intent setTypeAndNormalize(String type) {
5241 return setType(normalizeMimeType(type));
5242 }
5243
5244 /**
5245 * (Usually optional) Set the data for the intent along with an explicit
5246 * MIME data type. This method should very rarely be used -- it allows you
5247 * to override the MIME type that would ordinarily be inferred from the
5248 * data with your own type given here.
5249 *
5250 * <p><em>Note: MIME type and Uri scheme matching in the
5251 * Android framework is case-sensitive, unlike the formal RFC definitions.
5252 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005253 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005254 * {@link #setDataAndTypeAndNormalize}
5255 * to ensure that they are converted to lower case.</em>
5256 *
5257 * @param data The Uri of the data this intent is now targeting.
5258 * @param type The MIME type of the data being handled by this intent.
5259 *
5260 * @return Returns the same Intent object, for chaining multiple calls
5261 * into a single statement.
5262 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005263 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005264 * @see #setData
5265 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005266 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005267 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005268 */
5269 public Intent setDataAndType(Uri data, String type) {
5270 mData = data;
5271 mType = type;
5272 return this;
5273 }
5274
5275 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005276 * (Usually optional) Normalize and set both the data Uri and an explicit
5277 * MIME data type. This method should very rarely be used -- it allows you
5278 * to override the MIME type that would ordinarily be inferred from the
5279 * data with your own type given here.
5280 *
5281 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005282 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005283 * before they are set, so really this is just a convenience method for
5284 * <pre>
5285 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5286 * </pre>
5287 *
5288 * @param data The Uri of the data this intent is now targeting.
5289 * @param type The MIME type of the data being handled by this intent.
5290 *
5291 * @return Returns the same Intent object, for chaining multiple calls
5292 * into a single statement.
5293 *
5294 * @see #setType
5295 * @see #setData
5296 * @see #setDataAndType
5297 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005298 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005299 */
5300 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005301 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005302 }
5303
5304 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005305 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005306 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005307 * activities that provide <em>all</em> of the requested categories will be
5308 * used.
5309 *
5310 * @param category The desired category. This can be either one of the
5311 * predefined Intent categories, or a custom category in your own
5312 * namespace.
5313 *
5314 * @return Returns the same Intent object, for chaining multiple calls
5315 * into a single statement.
5316 *
5317 * @see #hasCategory
5318 * @see #removeCategory
5319 */
5320 public Intent addCategory(String category) {
5321 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005322 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005323 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005324 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005325 return this;
5326 }
5327
5328 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005329 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005330 *
5331 * @param category The category to remove.
5332 *
5333 * @see #addCategory
5334 */
5335 public void removeCategory(String category) {
5336 if (mCategories != null) {
5337 mCategories.remove(category);
5338 if (mCategories.size() == 0) {
5339 mCategories = null;
5340 }
5341 }
5342 }
5343
5344 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005345 * Set a selector for this Intent. This is a modification to the kinds of
5346 * things the Intent will match. If the selector is set, it will be used
5347 * when trying to find entities that can handle the Intent, instead of the
5348 * main contents of the Intent. This allows you build an Intent containing
5349 * a generic protocol while targeting it more specifically.
5350 *
5351 * <p>An example of where this may be used is with things like
5352 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5353 * Intent that will launch the Browser application. However, the correct
5354 * main entry point of an application is actually {@link #ACTION_MAIN}
5355 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5356 * used to specify the actual Activity to launch. If you launch the browser
5357 * with something different, undesired behavior may happen if the user has
5358 * previously or later launches it the normal way, since they do not match.
5359 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5360 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5361 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5362 *
5363 * <p>Setting a selector does not impact the behavior of
5364 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5365 * desired behavior of a selector -- it does not impact the base meaning
5366 * of the Intent, just what kinds of things will be matched against it
5367 * when determining who can handle it.</p>
5368 *
5369 * <p>You can not use both a selector and {@link #setPackage(String)} on
5370 * the same base Intent.</p>
5371 *
5372 * @param selector The desired selector Intent; set to null to not use
5373 * a special selector.
5374 */
5375 public void setSelector(Intent selector) {
5376 if (selector == this) {
5377 throw new IllegalArgumentException(
5378 "Intent being set as a selector of itself");
5379 }
5380 if (selector != null && mPackage != null) {
5381 throw new IllegalArgumentException(
5382 "Can't set selector when package name is already set");
5383 }
5384 mSelector = selector;
5385 }
5386
5387 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005388 * Set a {@link ClipData} associated with this Intent. This replaces any
5389 * previously set ClipData.
5390 *
5391 * <p>The ClipData in an intent is not used for Intent matching or other
5392 * such operations. Semantically it is like extras, used to transmit
5393 * additional data with the Intent. The main feature of using this over
5394 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5395 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5396 * items included in the clip data. This is useful, in particular, if
5397 * you want to transmit an Intent containing multiple <code>content:</code>
5398 * URIs for which the recipient may not have global permission to access the
5399 * content provider.
5400 *
5401 * <p>If the ClipData contains items that are themselves Intents, any
5402 * grant flags in those Intents will be ignored. Only the top-level flags
5403 * of the main Intent are respected, and will be applied to all Uri or
5404 * Intent items in the clip (or sub-items of the clip).
5405 *
5406 * <p>The MIME type, label, and icon in the ClipData object are not
5407 * directly used by Intent. Applications should generally rely on the
5408 * MIME type of the Intent itself, not what it may find in the ClipData.
5409 * A common practice is to construct a ClipData for use with an Intent
5410 * with a MIME type of "*\/*".
5411 *
5412 * @param clip The new clip to set. May be null to clear the current clip.
5413 */
5414 public void setClipData(ClipData clip) {
5415 mClipData = clip;
5416 }
5417
5418 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005419 * 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 boolean 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 #getBooleanExtra(String, boolean)
5432 */
5433 public Intent putExtra(String name, boolean value) {
5434 if (mExtras == null) {
5435 mExtras = new Bundle();
5436 }
5437 mExtras.putBoolean(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 byte 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 #getByteExtra(String, byte)
5455 */
5456 public Intent putExtra(String name, byte value) {
5457 if (mExtras == null) {
5458 mExtras = new Bundle();
5459 }
5460 mExtras.putByte(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 char 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 #getCharExtra(String, char)
5478 */
5479 public Intent putExtra(String name, char value) {
5480 if (mExtras == null) {
5481 mExtras = new Bundle();
5482 }
5483 mExtras.putChar(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 short 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 #getShortExtra(String, short)
5501 */
5502 public Intent putExtra(String name, short value) {
5503 if (mExtras == null) {
5504 mExtras = new Bundle();
5505 }
5506 mExtras.putShort(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 integer 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 #getIntExtra(String, int)
5524 */
5525 public Intent putExtra(String name, int value) {
5526 if (mExtras == null) {
5527 mExtras = new Bundle();
5528 }
5529 mExtras.putInt(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 long 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 #getLongExtra(String, long)
5547 */
5548 public Intent putExtra(String name, long value) {
5549 if (mExtras == null) {
5550 mExtras = new Bundle();
5551 }
5552 mExtras.putLong(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 float 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 #getFloatExtra(String, float)
5570 */
5571 public Intent putExtra(String name, float value) {
5572 if (mExtras == null) {
5573 mExtras = new Bundle();
5574 }
5575 mExtras.putFloat(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 double 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 #getDoubleExtra(String, double)
5593 */
5594 public Intent putExtra(String name, double value) {
5595 if (mExtras == null) {
5596 mExtras = new Bundle();
5597 }
5598 mExtras.putDouble(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 String 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 #getStringExtra(String)
5616 */
5617 public Intent putExtra(String name, String value) {
5618 if (mExtras == null) {
5619 mExtras = new Bundle();
5620 }
5621 mExtras.putString(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 CharSequence 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 #getCharSequenceExtra(String)
5639 */
5640 public Intent putExtra(String name, CharSequence value) {
5641 if (mExtras == null) {
5642 mExtras = new Bundle();
5643 }
5644 mExtras.putCharSequence(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 #getParcelableExtra(String)
5662 */
5663 public Intent putExtra(String name, Parcelable value) {
5664 if (mExtras == null) {
5665 mExtras = new Bundle();
5666 }
5667 mExtras.putParcelable(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 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 #getParcelableArrayExtra(String)
5685 */
5686 public Intent putExtra(String name, Parcelable[] value) {
5687 if (mExtras == null) {
5688 mExtras = new Bundle();
5689 }
5690 mExtras.putParcelableArray(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<Parcelable> 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 #getParcelableArrayListExtra(String)
5708 */
5709 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5710 if (mExtras == null) {
5711 mExtras = new Bundle();
5712 }
5713 mExtras.putParcelableArrayList(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<Integer> 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 #getIntegerArrayListExtra(String)
5731 */
5732 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5733 if (mExtras == null) {
5734 mExtras = new Bundle();
5735 }
5736 mExtras.putIntegerArrayList(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.
5746 * @param value The ArrayList<String> 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 #getStringArrayListExtra(String)
5754 */
5755 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5756 if (mExtras == null) {
5757 mExtras = new Bundle();
5758 }
5759 mExtras.putStringArrayList(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.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005769 * @param value The ArrayList<CharSequence> 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 #getCharSequenceArrayListExtra(String)
5777 */
5778 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5779 if (mExtras == null) {
5780 mExtras = new Bundle();
5781 }
5782 mExtras.putCharSequenceArrayList(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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005792 * @param value The Serializable 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 #getSerializableExtra(String)
5800 */
5801 public Intent putExtra(String name, Serializable value) {
5802 if (mExtras == null) {
5803 mExtras = new Bundle();
5804 }
5805 mExtras.putSerializable(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 boolean 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 #getBooleanArrayExtra(String)
5823 */
5824 public Intent putExtra(String name, boolean[] value) {
5825 if (mExtras == null) {
5826 mExtras = new Bundle();
5827 }
5828 mExtras.putBooleanArray(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 byte 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 #getByteArrayExtra(String)
5846 */
5847 public Intent putExtra(String name, byte[] value) {
5848 if (mExtras == null) {
5849 mExtras = new Bundle();
5850 }
5851 mExtras.putByteArray(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 short 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 #getShortArrayExtra(String)
5869 */
5870 public Intent putExtra(String name, short[] value) {
5871 if (mExtras == null) {
5872 mExtras = new Bundle();
5873 }
5874 mExtras.putShortArray(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 char 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 #getCharArrayExtra(String)
5892 */
5893 public Intent putExtra(String name, char[] value) {
5894 if (mExtras == null) {
5895 mExtras = new Bundle();
5896 }
5897 mExtras.putCharArray(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 int 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 #getIntArrayExtra(String)
5915 */
5916 public Intent putExtra(String name, int[] value) {
5917 if (mExtras == null) {
5918 mExtras = new Bundle();
5919 }
5920 mExtras.putIntArray(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 byte 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 #getLongArrayExtra(String)
5938 */
5939 public Intent putExtra(String name, long[] value) {
5940 if (mExtras == null) {
5941 mExtras = new Bundle();
5942 }
5943 mExtras.putLongArray(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 float 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 #getFloatArrayExtra(String)
5961 */
5962 public Intent putExtra(String name, float[] value) {
5963 if (mExtras == null) {
5964 mExtras = new Bundle();
5965 }
5966 mExtras.putFloatArray(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 double 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 #getDoubleArrayExtra(String)
5984 */
5985 public Intent putExtra(String name, double[] value) {
5986 if (mExtras == null) {
5987 mExtras = new Bundle();
5988 }
5989 mExtras.putDoubleArray(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.
5999 * @param value The String 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 #getStringArrayExtra(String)
6007 */
6008 public Intent putExtra(String name, String[] value) {
6009 if (mExtras == null) {
6010 mExtras = new Bundle();
6011 }
6012 mExtras.putStringArray(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.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006022 * @param value The CharSequence array 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 #getCharSequenceArrayExtra(String)
6030 */
6031 public Intent putExtra(String name, CharSequence[] value) {
6032 if (mExtras == null) {
6033 mExtras = new Bundle();
6034 }
6035 mExtras.putCharSequenceArray(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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006045 * @param value The Bundle 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 #getBundleExtra(String)
6053 */
6054 public Intent putExtra(String name, Bundle value) {
6055 if (mExtras == null) {
6056 mExtras = new Bundle();
6057 }
6058 mExtras.putBundle(name, value);
6059 return this;
6060 }
6061
6062 /**
6063 * Add extended data to the intent. The name must include a package
6064 * prefix, for example the app com.android.contacts would use names
6065 * like "com.android.contacts.ShowAll".
6066 *
6067 * @param name The name of the extra data, with package prefix.
6068 * @param value The IBinder data value.
6069 *
6070 * @return Returns the same Intent object, for chaining multiple calls
6071 * into a single statement.
6072 *
6073 * @see #putExtras
6074 * @see #removeExtra
6075 * @see #getIBinderExtra(String)
6076 *
6077 * @deprecated
6078 * @hide
6079 */
6080 @Deprecated
6081 public Intent putExtra(String name, IBinder value) {
6082 if (mExtras == null) {
6083 mExtras = new Bundle();
6084 }
6085 mExtras.putIBinder(name, value);
6086 return this;
6087 }
6088
6089 /**
6090 * Copy all extras in 'src' in to this intent.
6091 *
6092 * @param src Contains the extras to copy.
6093 *
6094 * @see #putExtra
6095 */
6096 public Intent putExtras(Intent src) {
6097 if (src.mExtras != null) {
6098 if (mExtras == null) {
6099 mExtras = new Bundle(src.mExtras);
6100 } else {
6101 mExtras.putAll(src.mExtras);
6102 }
6103 }
6104 return this;
6105 }
6106
6107 /**
6108 * Add a set of extended data to the intent. The keys must include a package
6109 * prefix, for example the app com.android.contacts would use names
6110 * like "com.android.contacts.ShowAll".
6111 *
6112 * @param extras The Bundle of extras to add to this intent.
6113 *
6114 * @see #putExtra
6115 * @see #removeExtra
6116 */
6117 public Intent putExtras(Bundle extras) {
6118 if (mExtras == null) {
6119 mExtras = new Bundle();
6120 }
6121 mExtras.putAll(extras);
6122 return this;
6123 }
6124
6125 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006126 * Completely replace the extras in the Intent with the extras in the
6127 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006128 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006129 * @param src The exact extras contained in this Intent are copied
6130 * into the target intent, replacing any that were previously there.
6131 */
6132 public Intent replaceExtras(Intent src) {
6133 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6134 return this;
6135 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006136
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006137 /**
6138 * Completely replace the extras in the Intent with the given Bundle of
6139 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006140 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006141 * @param extras The new set of extras in the Intent, or null to erase
6142 * all extras.
6143 */
6144 public Intent replaceExtras(Bundle extras) {
6145 mExtras = extras != null ? new Bundle(extras) : null;
6146 return this;
6147 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006148
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006149 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006150 * Remove extended data from the intent.
6151 *
6152 * @see #putExtra
6153 */
6154 public void removeExtra(String name) {
6155 if (mExtras != null) {
6156 mExtras.remove(name);
6157 if (mExtras.size() == 0) {
6158 mExtras = null;
6159 }
6160 }
6161 }
6162
6163 /**
6164 * Set special flags controlling how this intent is handled. Most values
6165 * here depend on the type of component being executed by the Intent,
6166 * specifically the FLAG_ACTIVITY_* flags are all for use with
6167 * {@link Context#startActivity Context.startActivity()} and the
6168 * FLAG_RECEIVER_* flags are all for use with
6169 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6170 *
Scott Main7aee61f2011-02-08 11:25:01 -08006171 * <p>See the
6172 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6173 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006174 * the behavior of your application.
6175 *
6176 * @param flags The desired flags.
6177 *
6178 * @return Returns the same Intent object, for chaining multiple calls
6179 * into a single statement.
6180 *
6181 * @see #getFlags
6182 * @see #addFlags
6183 *
6184 * @see #FLAG_GRANT_READ_URI_PERMISSION
6185 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6186 * @see #FLAG_DEBUG_LOG_RESOLUTION
6187 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006188 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006189 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006190 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006191 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006192 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6193 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006194 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006195 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
6196 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006197 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006198 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006199 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006200 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6201 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006202 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006203 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006204 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006205 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6206 */
6207 public Intent setFlags(int flags) {
6208 mFlags = flags;
6209 return this;
6210 }
6211
6212 /**
6213 * Add additional flags to the intent (or with existing flags
6214 * value).
6215 *
6216 * @param flags The new flags to set.
6217 *
6218 * @return Returns the same Intent object, for chaining multiple calls
6219 * into a single statement.
6220 *
6221 * @see #setFlags
6222 */
6223 public Intent addFlags(int flags) {
6224 mFlags |= flags;
6225 return this;
6226 }
6227
6228 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006229 * (Usually optional) Set an explicit application package name that limits
6230 * the components this Intent will resolve to. If left to the default
6231 * value of null, all components in all applications will considered.
6232 * If non-null, the Intent can only match the components in the given
6233 * application package.
6234 *
6235 * @param packageName The name of the application package to handle the
6236 * intent, or null to allow any application package.
6237 *
6238 * @return Returns the same Intent object, for chaining multiple calls
6239 * into a single statement.
6240 *
6241 * @see #getPackage
6242 * @see #resolveActivity
6243 */
6244 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006245 if (packageName != null && mSelector != null) {
6246 throw new IllegalArgumentException(
6247 "Can't set package name when selector is already set");
6248 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006249 mPackage = packageName;
6250 return this;
6251 }
6252
6253 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006254 * (Usually optional) Explicitly set the component to handle the intent.
6255 * If left with the default value of null, the system will determine the
6256 * appropriate class to use based on the other fields (action, data,
6257 * type, categories) in the Intent. If this class is defined, the
6258 * specified class will always be used regardless of the other fields. You
6259 * should only set this value when you know you absolutely want a specific
6260 * class to be used; otherwise it is better to let the system find the
6261 * appropriate class so that you will respect the installed applications
6262 * and user preferences.
6263 *
6264 * @param component The name of the application component to handle the
6265 * intent, or null to let the system find one for you.
6266 *
6267 * @return Returns the same Intent object, for chaining multiple calls
6268 * into a single statement.
6269 *
6270 * @see #setClass
6271 * @see #setClassName(Context, String)
6272 * @see #setClassName(String, String)
6273 * @see #getComponent
6274 * @see #resolveActivity
6275 */
6276 public Intent setComponent(ComponentName component) {
6277 mComponent = component;
6278 return this;
6279 }
6280
6281 /**
6282 * Convenience for calling {@link #setComponent} with an
6283 * explicit class name.
6284 *
6285 * @param packageContext A Context of the application package implementing
6286 * this class.
6287 * @param className The name of a class inside of the application package
6288 * that will be used as the component for this Intent.
6289 *
6290 * @return Returns the same Intent object, for chaining multiple calls
6291 * into a single statement.
6292 *
6293 * @see #setComponent
6294 * @see #setClass
6295 */
6296 public Intent setClassName(Context packageContext, String className) {
6297 mComponent = new ComponentName(packageContext, className);
6298 return this;
6299 }
6300
6301 /**
6302 * Convenience for calling {@link #setComponent} with an
6303 * explicit application package name and class name.
6304 *
6305 * @param packageName The name of the package implementing the desired
6306 * component.
6307 * @param className The name of a class inside of the application package
6308 * that will be used as the component for this Intent.
6309 *
6310 * @return Returns the same Intent object, for chaining multiple calls
6311 * into a single statement.
6312 *
6313 * @see #setComponent
6314 * @see #setClass
6315 */
6316 public Intent setClassName(String packageName, String className) {
6317 mComponent = new ComponentName(packageName, className);
6318 return this;
6319 }
6320
6321 /**
6322 * Convenience for calling {@link #setComponent(ComponentName)} with the
6323 * name returned by a {@link Class} object.
6324 *
6325 * @param packageContext A Context of the application package implementing
6326 * this class.
6327 * @param cls The class name to set, equivalent to
6328 * <code>setClassName(context, cls.getName())</code>.
6329 *
6330 * @return Returns the same Intent object, for chaining multiple calls
6331 * into a single statement.
6332 *
6333 * @see #setComponent
6334 */
6335 public Intent setClass(Context packageContext, Class<?> cls) {
6336 mComponent = new ComponentName(packageContext, cls);
6337 return this;
6338 }
6339
6340 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006341 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6342 * used as a hint to the receiver for animations and the like. Null means that there
6343 * is no source bounds.
6344 */
6345 public void setSourceBounds(Rect r) {
6346 if (r != null) {
6347 mSourceBounds = new Rect(r);
6348 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006349 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006350 }
6351 }
6352
Tor Norbyed9273d62013-05-30 15:59:53 -07006353 /** @hide */
6354 @IntDef(flag = true,
6355 value = {
6356 FILL_IN_ACTION,
6357 FILL_IN_DATA,
6358 FILL_IN_CATEGORIES,
6359 FILL_IN_COMPONENT,
6360 FILL_IN_PACKAGE,
6361 FILL_IN_SOURCE_BOUNDS,
6362 FILL_IN_SELECTOR,
6363 FILL_IN_CLIP_DATA
6364 })
6365 @Retention(RetentionPolicy.SOURCE)
6366 public @interface FillInFlags {}
6367
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006368 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006369 * Use with {@link #fillIn} to allow the current action value to be
6370 * overwritten, even if it is already set.
6371 */
6372 public static final int FILL_IN_ACTION = 1<<0;
6373
6374 /**
6375 * Use with {@link #fillIn} to allow the current data or type value
6376 * overwritten, even if it is already set.
6377 */
6378 public static final int FILL_IN_DATA = 1<<1;
6379
6380 /**
6381 * Use with {@link #fillIn} to allow the current categories to be
6382 * overwritten, even if they are already set.
6383 */
6384 public static final int FILL_IN_CATEGORIES = 1<<2;
6385
6386 /**
6387 * Use with {@link #fillIn} to allow the current component value to be
6388 * overwritten, even if it is already set.
6389 */
6390 public static final int FILL_IN_COMPONENT = 1<<3;
6391
6392 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006393 * Use with {@link #fillIn} to allow the current package value to be
6394 * overwritten, even if it is already set.
6395 */
6396 public static final int FILL_IN_PACKAGE = 1<<4;
6397
6398 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006399 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006400 * overwritten, even if it is already set.
6401 */
6402 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6403
6404 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006405 * Use with {@link #fillIn} to allow the current selector to be
6406 * overwritten, even if it is already set.
6407 */
6408 public static final int FILL_IN_SELECTOR = 1<<6;
6409
6410 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006411 * Use with {@link #fillIn} to allow the current ClipData to be
6412 * overwritten, even if it is already set.
6413 */
6414 public static final int FILL_IN_CLIP_DATA = 1<<7;
6415
6416 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006417 * Copy the contents of <var>other</var> in to this object, but only
6418 * where fields are not defined by this object. For purposes of a field
6419 * being defined, the following pieces of data in the Intent are
6420 * considered to be separate fields:
6421 *
6422 * <ul>
6423 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006424 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006425 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6426 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006427 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006428 * <li> component, as set by {@link #setComponent(ComponentName)} or
6429 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006430 * <li> source bounds, as set by {@link #setSourceBounds}.
6431 * <li> selector, as set by {@link #setSelector(Intent)}.
6432 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006433 * <li> each top-level name in the associated extras.
6434 * </ul>
6435 *
6436 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006437 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006438 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6439 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6440 * the restriction where the corresponding field will not be replaced if
6441 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006442 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006443 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6444 * is explicitly specified. The selector will only be copied if
6445 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006446 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006447 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6448 * and Intent B with {action="gotit", data-type="some/thing",
6449 * categories="one","two"}.
6450 *
6451 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6452 * containing: {action="gotit", data-type="some/thing",
6453 * categories="bar"}.
6454 *
6455 * @param other Another Intent whose values are to be used to fill in
6456 * the current one.
6457 * @param flags Options to control which fields can be filled in.
6458 *
6459 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006460 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006461 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6462 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6463 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006464 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006465 @FillInFlags
6466 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006467 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006468 if (other.mAction != null
6469 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006470 mAction = other.mAction;
6471 changes |= FILL_IN_ACTION;
6472 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006473 if ((other.mData != null || other.mType != null)
6474 && ((mData == null && mType == null)
6475 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006476 mData = other.mData;
6477 mType = other.mType;
6478 changes |= FILL_IN_DATA;
6479 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006480 if (other.mCategories != null
6481 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006482 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006483 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006484 }
6485 changes |= FILL_IN_CATEGORIES;
6486 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006487 if (other.mPackage != null
6488 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006489 // Only do this if mSelector is not set.
6490 if (mSelector == null) {
6491 mPackage = other.mPackage;
6492 changes |= FILL_IN_PACKAGE;
6493 }
6494 }
6495 // Selector is special: it can only be set if explicitly allowed,
6496 // for the same reason as the component name.
6497 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6498 if (mPackage == null) {
6499 mSelector = new Intent(other.mSelector);
6500 mPackage = null;
6501 changes |= FILL_IN_SELECTOR;
6502 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006503 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006504 if (other.mClipData != null
6505 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6506 mClipData = other.mClipData;
6507 changes |= FILL_IN_CLIP_DATA;
6508 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006509 // Component is special: it can -only- be set if explicitly allowed,
6510 // since otherwise the sender could force the intent somewhere the
6511 // originator didn't intend.
6512 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006513 mComponent = other.mComponent;
6514 changes |= FILL_IN_COMPONENT;
6515 }
6516 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006517 if (other.mSourceBounds != null
6518 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6519 mSourceBounds = new Rect(other.mSourceBounds);
6520 changes |= FILL_IN_SOURCE_BOUNDS;
6521 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006522 if (mExtras == null) {
6523 if (other.mExtras != null) {
6524 mExtras = new Bundle(other.mExtras);
6525 }
6526 } else if (other.mExtras != null) {
6527 try {
6528 Bundle newb = new Bundle(other.mExtras);
6529 newb.putAll(mExtras);
6530 mExtras = newb;
6531 } catch (RuntimeException e) {
6532 // Modifying the extras can cause us to unparcel the contents
6533 // of the bundle, and if we do this in the system process that
6534 // may fail. We really should handle this (i.e., the Bundle
6535 // impl shouldn't be on top of a plain map), but for now just
6536 // ignore it and keep the original contents. :(
6537 Log.w("Intent", "Failure filling in extras", e);
6538 }
6539 }
6540 return changes;
6541 }
6542
6543 /**
6544 * Wrapper class holding an Intent and implementing comparisons on it for
6545 * the purpose of filtering. The class implements its
6546 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6547 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6548 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6549 * on the wrapped Intent.
6550 */
6551 public static final class FilterComparison {
6552 private final Intent mIntent;
6553 private final int mHashCode;
6554
6555 public FilterComparison(Intent intent) {
6556 mIntent = intent;
6557 mHashCode = intent.filterHashCode();
6558 }
6559
6560 /**
6561 * Return the Intent that this FilterComparison represents.
6562 * @return Returns the Intent held by the FilterComparison. Do
6563 * not modify!
6564 */
6565 public Intent getIntent() {
6566 return mIntent;
6567 }
6568
6569 @Override
6570 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006571 if (obj instanceof FilterComparison) {
6572 Intent other = ((FilterComparison)obj).mIntent;
6573 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006574 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006575 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006576 }
6577
6578 @Override
6579 public int hashCode() {
6580 return mHashCode;
6581 }
6582 }
6583
6584 /**
6585 * Determine if two intents are the same for the purposes of intent
6586 * resolution (filtering). That is, if their action, data, type,
6587 * class, and categories are the same. This does <em>not</em> compare
6588 * any extra data included in the intents.
6589 *
6590 * @param other The other Intent to compare against.
6591 *
6592 * @return Returns true if action, data, type, class, and categories
6593 * are the same.
6594 */
6595 public boolean filterEquals(Intent other) {
6596 if (other == null) {
6597 return false;
6598 }
6599 if (mAction != other.mAction) {
6600 if (mAction != null) {
6601 if (!mAction.equals(other.mAction)) {
6602 return false;
6603 }
6604 } else {
6605 if (!other.mAction.equals(mAction)) {
6606 return false;
6607 }
6608 }
6609 }
6610 if (mData != other.mData) {
6611 if (mData != null) {
6612 if (!mData.equals(other.mData)) {
6613 return false;
6614 }
6615 } else {
6616 if (!other.mData.equals(mData)) {
6617 return false;
6618 }
6619 }
6620 }
6621 if (mType != other.mType) {
6622 if (mType != null) {
6623 if (!mType.equals(other.mType)) {
6624 return false;
6625 }
6626 } else {
6627 if (!other.mType.equals(mType)) {
6628 return false;
6629 }
6630 }
6631 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006632 if (mPackage != other.mPackage) {
6633 if (mPackage != null) {
6634 if (!mPackage.equals(other.mPackage)) {
6635 return false;
6636 }
6637 } else {
6638 if (!other.mPackage.equals(mPackage)) {
6639 return false;
6640 }
6641 }
6642 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006643 if (mComponent != other.mComponent) {
6644 if (mComponent != null) {
6645 if (!mComponent.equals(other.mComponent)) {
6646 return false;
6647 }
6648 } else {
6649 if (!other.mComponent.equals(mComponent)) {
6650 return false;
6651 }
6652 }
6653 }
6654 if (mCategories != other.mCategories) {
6655 if (mCategories != null) {
6656 if (!mCategories.equals(other.mCategories)) {
6657 return false;
6658 }
6659 } else {
6660 if (!other.mCategories.equals(mCategories)) {
6661 return false;
6662 }
6663 }
6664 }
6665
6666 return true;
6667 }
6668
6669 /**
6670 * Generate hash code that matches semantics of filterEquals().
6671 *
6672 * @return Returns the hash value of the action, data, type, class, and
6673 * categories.
6674 *
6675 * @see #filterEquals
6676 */
6677 public int filterHashCode() {
6678 int code = 0;
6679 if (mAction != null) {
6680 code += mAction.hashCode();
6681 }
6682 if (mData != null) {
6683 code += mData.hashCode();
6684 }
6685 if (mType != null) {
6686 code += mType.hashCode();
6687 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006688 if (mPackage != null) {
6689 code += mPackage.hashCode();
6690 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006691 if (mComponent != null) {
6692 code += mComponent.hashCode();
6693 }
6694 if (mCategories != null) {
6695 code += mCategories.hashCode();
6696 }
6697 return code;
6698 }
6699
6700 @Override
6701 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006702 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006703
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006704 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006705 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006706 b.append(" }");
6707
6708 return b.toString();
6709 }
6710
6711 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006712 public String toInsecureString() {
6713 StringBuilder b = new StringBuilder(128);
6714
6715 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006716 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006717 b.append(" }");
6718
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006719 return b.toString();
6720 }
Romain Guy4969af72009-06-17 10:53:19 -07006721
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006722 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006723 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006724 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006725
6726 b.append("Intent { ");
6727 toShortString(b, false, true, true, true);
6728 b.append(" }");
6729
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006730 return b.toString();
6731 }
6732
6733 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006734 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6735 StringBuilder b = new StringBuilder(128);
6736 toShortString(b, secure, comp, extras, clip);
6737 return b.toString();
6738 }
6739
6740 /** @hide */
6741 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6742 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006743 boolean first = true;
6744 if (mAction != null) {
6745 b.append("act=").append(mAction);
6746 first = false;
6747 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006748 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006749 if (!first) {
6750 b.append(' ');
6751 }
6752 first = false;
6753 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006754 for (int i=0; i<mCategories.size(); i++) {
6755 if (i > 0) b.append(',');
6756 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006757 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006758 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006759 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006760 if (mData != null) {
6761 if (!first) {
6762 b.append(' ');
6763 }
6764 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006765 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006766 if (secure) {
6767 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006768 } else {
6769 b.append(mData);
6770 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006771 }
6772 if (mType != null) {
6773 if (!first) {
6774 b.append(' ');
6775 }
6776 first = false;
6777 b.append("typ=").append(mType);
6778 }
6779 if (mFlags != 0) {
6780 if (!first) {
6781 b.append(' ');
6782 }
6783 first = false;
6784 b.append("flg=0x").append(Integer.toHexString(mFlags));
6785 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006786 if (mPackage != null) {
6787 if (!first) {
6788 b.append(' ');
6789 }
6790 first = false;
6791 b.append("pkg=").append(mPackage);
6792 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006793 if (comp && mComponent != null) {
6794 if (!first) {
6795 b.append(' ');
6796 }
6797 first = false;
6798 b.append("cmp=").append(mComponent.flattenToShortString());
6799 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006800 if (mSourceBounds != null) {
6801 if (!first) {
6802 b.append(' ');
6803 }
6804 first = false;
6805 b.append("bnds=").append(mSourceBounds.toShortString());
6806 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006807 if (mClipData != null) {
6808 if (!first) {
6809 b.append(' ');
6810 }
6811 first = false;
6812 if (clip) {
6813 b.append("clip={");
6814 mClipData.toShortString(b);
6815 b.append('}');
6816 } else {
6817 b.append("(has clip)");
6818 }
6819 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006820 if (extras && mExtras != null) {
6821 if (!first) {
6822 b.append(' ');
6823 }
6824 first = false;
6825 b.append("(has extras)");
6826 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006827 if (mSelector != null) {
6828 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006829 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006830 b.append("}");
6831 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006832 }
6833
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006834 /**
6835 * Call {@link #toUri} with 0 flags.
6836 * @deprecated Use {@link #toUri} instead.
6837 */
6838 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006839 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006840 return toUri(0);
6841 }
6842
6843 /**
6844 * Convert this Intent into a String holding a URI representation of it.
6845 * The returned URI string has been properly URI encoded, so it can be
6846 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6847 * Intent's data as the base URI, with an additional fragment describing
6848 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006849 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006850 * <p>You can convert the returned string back to an Intent with
6851 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006852 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006853 * @param flags Additional operating flags. Either 0 or
6854 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006855 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006856 * @return Returns a URI encoding URI string describing the entire contents
6857 * of the Intent.
6858 */
6859 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006860 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006861 String scheme = null;
6862 if (mData != null) {
6863 String data = mData.toString();
6864 if ((flags&URI_INTENT_SCHEME) != 0) {
6865 final int N = data.length();
6866 for (int i=0; i<N; i++) {
6867 char c = data.charAt(i);
6868 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6869 || c == '.' || c == '-') {
6870 continue;
6871 }
6872 if (c == ':' && i > 0) {
6873 // Valid scheme.
6874 scheme = data.substring(0, i);
6875 uri.append("intent:");
6876 data = data.substring(i+1);
6877 break;
6878 }
Tom Taylord4a47292009-12-21 13:59:18 -08006879
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006880 // No scheme.
6881 break;
6882 }
6883 }
6884 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006885
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006886 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6887 uri.append("intent:");
6888 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006889
6890 uri.append("#Intent;");
6891
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006892 toUriInner(uri, scheme, flags);
6893 if (mSelector != null) {
6894 uri.append("SEL;");
6895 // Note that for now we are not going to try to handle the
6896 // data part; not clear how to represent this as a URI, and
6897 // not much utility in it.
6898 mSelector.toUriInner(uri, null, flags);
6899 }
6900
6901 uri.append("end");
6902
6903 return uri.toString();
6904 }
6905
6906 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006907 if (scheme != null) {
6908 uri.append("scheme=").append(scheme).append(';');
6909 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006910 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006911 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006912 }
6913 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006914 for (int i=0; i<mCategories.size(); i++) {
6915 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006916 }
6917 }
6918 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006919 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006920 }
6921 if (mFlags != 0) {
6922 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6923 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006924 if (mPackage != null) {
6925 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6926 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006927 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006928 uri.append("component=").append(Uri.encode(
6929 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006930 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006931 if (mSourceBounds != null) {
6932 uri.append("sourceBounds=")
6933 .append(Uri.encode(mSourceBounds.flattenToString()))
6934 .append(';');
6935 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006936 if (mExtras != null) {
6937 for (String key : mExtras.keySet()) {
6938 final Object value = mExtras.get(key);
6939 char entryType =
6940 value instanceof String ? 'S' :
6941 value instanceof Boolean ? 'B' :
6942 value instanceof Byte ? 'b' :
6943 value instanceof Character ? 'c' :
6944 value instanceof Double ? 'd' :
6945 value instanceof Float ? 'f' :
6946 value instanceof Integer ? 'i' :
6947 value instanceof Long ? 'l' :
6948 value instanceof Short ? 's' :
6949 '\0';
6950
6951 if (entryType != '\0') {
6952 uri.append(entryType);
6953 uri.append('.');
6954 uri.append(Uri.encode(key));
6955 uri.append('=');
6956 uri.append(Uri.encode(value.toString()));
6957 uri.append(';');
6958 }
6959 }
6960 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006961 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006962
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006963 public int describeContents() {
6964 return (mExtras != null) ? mExtras.describeContents() : 0;
6965 }
6966
6967 public void writeToParcel(Parcel out, int flags) {
6968 out.writeString(mAction);
6969 Uri.writeToParcel(out, mData);
6970 out.writeString(mType);
6971 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006972 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006973 ComponentName.writeToParcel(mComponent, out);
6974
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006975 if (mSourceBounds != null) {
6976 out.writeInt(1);
6977 mSourceBounds.writeToParcel(out, flags);
6978 } else {
6979 out.writeInt(0);
6980 }
6981
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006982 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006983 final int N = mCategories.size();
6984 out.writeInt(N);
6985 for (int i=0; i<N; i++) {
6986 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006987 }
6988 } else {
6989 out.writeInt(0);
6990 }
6991
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006992 if (mSelector != null) {
6993 out.writeInt(1);
6994 mSelector.writeToParcel(out, flags);
6995 } else {
6996 out.writeInt(0);
6997 }
6998
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006999 if (mClipData != null) {
7000 out.writeInt(1);
7001 mClipData.writeToParcel(out, flags);
7002 } else {
7003 out.writeInt(0);
7004 }
7005
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007006 out.writeBundle(mExtras);
7007 }
7008
7009 public static final Parcelable.Creator<Intent> CREATOR
7010 = new Parcelable.Creator<Intent>() {
7011 public Intent createFromParcel(Parcel in) {
7012 return new Intent(in);
7013 }
7014 public Intent[] newArray(int size) {
7015 return new Intent[size];
7016 }
7017 };
7018
Dianne Hackborneb034652009-09-07 00:49:58 -07007019 /** @hide */
7020 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007021 readFromParcel(in);
7022 }
7023
7024 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007025 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007026 mData = Uri.CREATOR.createFromParcel(in);
7027 mType = in.readString();
7028 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007029 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007030 mComponent = ComponentName.readFromParcel(in);
7031
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007032 if (in.readInt() != 0) {
7033 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7034 }
7035
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007036 int N = in.readInt();
7037 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007038 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007039 int i;
7040 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007041 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007042 }
7043 } else {
7044 mCategories = null;
7045 }
7046
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007047 if (in.readInt() != 0) {
7048 mSelector = new Intent(in);
7049 }
7050
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007051 if (in.readInt() != 0) {
7052 mClipData = new ClipData(in);
7053 }
7054
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007055 mExtras = in.readBundle();
7056 }
7057
7058 /**
7059 * Parses the "intent" element (and its children) from XML and instantiates
7060 * an Intent object. The given XML parser should be located at the tag
7061 * where parsing should start (often named "intent"), from which the
7062 * basic action, data, type, and package and class name will be
7063 * retrieved. The function will then parse in to any child elements,
7064 * looking for <category android:name="xxx"> tags to add categories and
7065 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7066 * to the intent.
7067 *
7068 * @param resources The Resources to use when inflating resources.
7069 * @param parser The XML parser pointing at an "intent" tag.
7070 * @param attrs The AttributeSet interface for retrieving extended
7071 * attribute data at the current <var>parser</var> location.
7072 * @return An Intent object matching the XML data.
7073 * @throws XmlPullParserException If there was an XML parsing error.
7074 * @throws IOException If there was an I/O error.
7075 */
7076 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7077 throws XmlPullParserException, IOException {
7078 Intent intent = new Intent();
7079
7080 TypedArray sa = resources.obtainAttributes(attrs,
7081 com.android.internal.R.styleable.Intent);
7082
7083 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7084
7085 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7086 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7087 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7088
7089 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7090 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7091 if (packageName != null && className != null) {
7092 intent.setComponent(new ComponentName(packageName, className));
7093 }
7094
7095 sa.recycle();
7096
7097 int outerDepth = parser.getDepth();
7098 int type;
7099 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7100 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7101 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7102 continue;
7103 }
7104
7105 String nodeName = parser.getName();
7106 if (nodeName.equals("category")) {
7107 sa = resources.obtainAttributes(attrs,
7108 com.android.internal.R.styleable.IntentCategory);
7109 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7110 sa.recycle();
7111
7112 if (cat != null) {
7113 intent.addCategory(cat);
7114 }
7115 XmlUtils.skipCurrentTag(parser);
7116
7117 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007118 if (intent.mExtras == null) {
7119 intent.mExtras = new Bundle();
7120 }
7121 resources.parseBundleExtra("extra", attrs, intent.mExtras);
7122 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007123
7124 } else {
7125 XmlUtils.skipCurrentTag(parser);
7126 }
7127 }
7128
7129 return intent;
7130 }
Nick Pellyccae4122012-01-09 14:12:58 -08007131
7132 /**
7133 * Normalize a MIME data type.
7134 *
7135 * <p>A normalized MIME type has white-space trimmed,
7136 * content-type parameters removed, and is lower-case.
7137 * This aligns the type with Android best practices for
7138 * intent filtering.
7139 *
7140 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7141 * "text/x-vCard" becomes "text/x-vcard".
7142 *
7143 * <p>All MIME types received from outside Android (such as user input,
7144 * or external sources like Bluetooth, NFC, or the Internet) should
7145 * be normalized before they are used to create an Intent.
7146 *
7147 * @param type MIME data type to normalize
7148 * @return normalized MIME data type, or null if the input was null
7149 * @see {@link #setType}
7150 * @see {@link #setTypeAndNormalize}
7151 */
7152 public static String normalizeMimeType(String type) {
7153 if (type == null) {
7154 return null;
7155 }
7156
Elliott Hughescb64d432013-08-02 10:00:44 -07007157 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007158
7159 final int semicolonIndex = type.indexOf(';');
7160 if (semicolonIndex != -1) {
7161 type = type.substring(0, semicolonIndex);
7162 }
7163 return type;
7164 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007165
7166 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007167 * Prepare this {@link Intent} to leave an app process.
7168 *
7169 * @hide
7170 */
7171 public void prepareToLeaveProcess() {
7172 setAllowFds(false);
7173
7174 if (mSelector != null) {
7175 mSelector.prepareToLeaveProcess();
7176 }
7177 if (mClipData != null) {
7178 mClipData.prepareToLeaveProcess();
7179 }
7180
7181 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7182 // There are several ACTION_MEDIA_* broadcasts that send file://
7183 // Uris, so only check common actions.
7184 if (ACTION_VIEW.equals(mAction) ||
7185 ACTION_EDIT.equals(mAction) ||
7186 ACTION_ATTACH_DATA.equals(mAction)) {
7187 mData.checkFileUriExposed("Intent.getData()");
7188 }
7189 }
7190 }
7191
7192 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007193 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007194 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7195 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007196 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007197 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007198 * @hide
7199 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007200 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007201 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007202 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007203
7204 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007205 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007206
7207 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007208 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007209 try {
7210 // Inspect target intent to see if we need to migrate
7211 final Intent target = getParcelableExtra(EXTRA_INTENT);
7212 if (target != null && target.migrateExtraStreamToClipData()) {
7213 // Since we migrated in child, we need to promote ClipData
7214 // and flags to ourselves to grant.
7215 setClipData(target.getClipData());
7216 addFlags(target.getFlags()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07007217 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION
7218 | FLAG_PERSIST_GRANT_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007219 return true;
7220 } else {
7221 return false;
7222 }
7223 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007224 }
7225
7226 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007227 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007228 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7229 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7230 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7231 if (stream != null || text != null || htmlText != null) {
7232 final ClipData clipData = new ClipData(
7233 null, new String[] { getType() },
7234 new ClipData.Item(text, htmlText, null, stream));
7235 setClipData(clipData);
7236 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007237 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007238 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007239 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007240 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007241
7242 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007243 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007244 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7245 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7246 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7247 int num = -1;
7248 if (streams != null) {
7249 num = streams.size();
7250 }
7251 if (texts != null) {
7252 if (num >= 0 && num != texts.size()) {
7253 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007254 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007255 }
7256 num = texts.size();
7257 }
7258 if (htmlTexts != null) {
7259 if (num >= 0 && num != htmlTexts.size()) {
7260 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007261 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007262 }
7263 num = htmlTexts.size();
7264 }
7265 if (num > 0) {
7266 final ClipData clipData = new ClipData(
7267 null, new String[] { getType() },
7268 makeClipItem(streams, texts, htmlTexts, 0));
7269
7270 for (int i = 1; i < num; i++) {
7271 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7272 }
7273
7274 setClipData(clipData);
7275 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007276 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007277 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007278 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007279 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007280 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007281
7282 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007283 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007284
7285 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7286 ArrayList<String> htmlTexts, int which) {
7287 Uri uri = streams != null ? streams.get(which) : null;
7288 CharSequence text = texts != null ? texts.get(which) : null;
7289 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7290 return new ClipData.Item(text, htmlText, null, uri);
7291 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007292}