blob: 9881428865c4e73b77b04df0248444eb9fa31d38 [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;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070040import android.provider.DocumentsProvider;
41import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070042import android.util.AttributeSet;
43import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080044
45import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070046
47import java.io.IOException;
48import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070049import java.lang.annotation.Retention;
50import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070051import java.net.URISyntaxException;
52import java.util.ArrayList;
Dianne Hackborn221ea892013-08-04 16:50:16 -070053import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080054import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070055import java.util.Set;
56
57/**
58 * An intent is an abstract description of an operation to be performed. It
59 * can be used with {@link Context#startActivity(Intent) startActivity} to
60 * launch an {@link android.app.Activity},
61 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
62 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
63 * and {@link android.content.Context#startService} or
64 * {@link android.content.Context#bindService} to communicate with a
65 * background {@link android.app.Service}.
66 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070067 * <p>An Intent provides a facility for performing late runtime binding between the code in
68 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070069 * can be thought of as the glue between activities. It is basically a passive data structure
70 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070071 *
72 * <div class="special reference">
73 * <h3>Developer Guides</h3>
74 * <p>For information about how to create and resolve intents, read the
75 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
76 * developer guide.</p>
77 * </div>
78 *
79 * <a name="IntentStructure"></a>
80 * <h3>Intent Structure</h3>
81 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070082 *
83 * <ul>
84 * <li> <p><b>action</b> -- The general action to be performed, such as
85 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
86 * etc.</p>
87 * </li>
88 * <li> <p><b>data</b> -- The data to operate on, such as a person record
89 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
90 * </li>
91 * </ul>
92 *
93 *
94 * <p>Some examples of action/data pairs are:</p>
95 *
96 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070097 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070098 * information about the person whose identifier is "1".</p>
99 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700100 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700101 * the phone dialer with the person filled in.</p>
102 * </li>
103 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
104 * the phone dialer with the given number filled in. Note how the
105 * VIEW action does what what is considered the most reasonable thing for
106 * a particular URI.</p>
107 * </li>
108 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
109 * the phone dialer with the given number filled in.</p>
110 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700111 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700112 * information about the person whose identifier is "1".</p>
113 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700114 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700115 * a list of people, which the user can browse through. This example is a
116 * typical top-level entry into the Contacts application, showing you the
117 * list of people. Selecting a particular person to view would result in a
118 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
119 * being used to start an activity to display that person.</p>
120 * </li>
121 * </ul>
122 *
123 * <p>In addition to these primary attributes, there are a number of secondary
124 * attributes that you can also include with an intent:</p>
125 *
126 * <ul>
127 * <li> <p><b>category</b> -- Gives additional information about the action
128 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
129 * appear in the Launcher as a top-level application, while
130 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
131 * of alternative actions the user can perform on a piece of data.</p>
132 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
133 * intent data. Normally the type is inferred from the data itself.
134 * By setting this attribute, you disable that evaluation and force
135 * an explicit type.</p>
136 * <li> <p><b>component</b> -- Specifies an explicit name of a component
137 * class to use for the intent. Normally this is determined by looking
138 * at the other information in the intent (the action, data/type, and
139 * categories) and matching that with a component that can handle it.
140 * If this attribute is set then none of the evaluation is performed,
141 * and this component is used exactly as is. By specifying this attribute,
142 * all of the other Intent attributes become optional.</p>
143 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
144 * This can be used to provide extended information to the component.
145 * For example, if we have a action to send an e-mail message, we could
146 * also include extra pieces of data here to supply a subject, body,
147 * etc.</p>
148 * </ul>
149 *
150 * <p>Here are some examples of other operations you can specify as intents
151 * using these additional parameters:</p>
152 *
153 * <ul>
154 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
155 * Launch the home screen.</p>
156 * </li>
157 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
158 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
159 * vnd.android.cursor.item/phone}</i></b>
160 * -- Display the list of people's phone numbers, allowing the user to
161 * browse through them and pick one and return it to the parent activity.</p>
162 * </li>
163 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
164 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
165 * -- Display all pickers for data that can be opened with
166 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
167 * allowing the user to pick one of them and then some data inside of it
168 * and returning the resulting URI to the caller. This can be used,
169 * for example, in an e-mail application to allow the user to pick some
170 * data to include as an attachment.</p>
171 * </li>
172 * </ul>
173 *
174 * <p>There are a variety of standard Intent action and category constants
175 * defined in the Intent class, but applications can also define their own.
176 * These strings use java style scoping, to ensure they are unique -- for
177 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700178 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700179 *
180 * <p>Put together, the set of actions, data types, categories, and extra data
181 * defines a language for the system allowing for the expression of phrases
182 * such as "call john smith's cell". As applications are added to the system,
183 * they can extend this language by adding new actions, types, and categories, or
184 * they can modify the behavior of existing phrases by supplying their own
185 * activities that handle them.</p>
186 *
187 * <a name="IntentResolution"></a>
188 * <h3>Intent Resolution</h3>
189 *
190 * <p>There are two primary forms of intents you will use.
191 *
192 * <ul>
193 * <li> <p><b>Explicit Intents</b> have specified a component (via
194 * {@link #setComponent} or {@link #setClass}), which provides the exact
195 * class to be run. Often these will not include any other information,
196 * simply being a way for an application to launch various internal
197 * activities it has as the user interacts with the application.
198 *
199 * <li> <p><b>Implicit Intents</b> have not specified a component;
200 * instead, they must include enough information for the system to
201 * determine which of the available components is best to run for that
202 * intent.
203 * </ul>
204 *
205 * <p>When using implicit intents, given such an arbitrary intent we need to
206 * know what to do with it. This is handled by the process of <em>Intent
207 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
208 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
209 * more activities/receivers) that can handle it.</p>
210 *
211 * <p>The intent resolution mechanism basically revolves around matching an
212 * Intent against all of the &lt;intent-filter&gt; descriptions in the
213 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
214 * objects explicitly registered with {@link Context#registerReceiver}.) More
215 * details on this can be found in the documentation on the {@link
216 * IntentFilter} class.</p>
217 *
218 * <p>There are three pieces of information in the Intent that are used for
219 * resolution: the action, type, and category. Using this information, a query
220 * is done on the {@link PackageManager} for a component that can handle the
221 * intent. The appropriate component is determined based on the intent
222 * information supplied in the <code>AndroidManifest.xml</code> file as
223 * follows:</p>
224 *
225 * <ul>
226 * <li> <p>The <b>action</b>, if given, must be listed by the component as
227 * one it handles.</p>
228 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
229 * already supplied in the Intent. Like the action, if a type is
230 * included in the intent (either explicitly or implicitly in its
231 * data), then this must be listed by the component as one it handles.</p>
232 * <li> For data that is not a <code>content:</code> URI and where no explicit
233 * type is included in the Intent, instead the <b>scheme</b> of the
234 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
235 * considered. Again like the action, if we are matching a scheme it
236 * must be listed by the component as one it can handle.
237 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
238 * by the activity as categories it handles. That is, if you include
239 * the categories {@link #CATEGORY_LAUNCHER} and
240 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
241 * with an intent that lists <em>both</em> of those categories.
242 * Activities will very often need to support the
243 * {@link #CATEGORY_DEFAULT} so that they can be found by
244 * {@link Context#startActivity Context.startActivity()}.</p>
245 * </ul>
246 *
247 * <p>For example, consider the Note Pad sample application that
248 * allows user to browse through a list of notes data and view details about
249 * individual items. Text in italics indicate places were you would replace a
250 * name with one specific to your own package.</p>
251 *
252 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
253 * package="<i>com.android.notepad</i>"&gt;
254 * &lt;application android:icon="@drawable/app_notes"
255 * android:label="@string/app_name"&gt;
256 *
257 * &lt;provider class=".NotePadProvider"
258 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
259 *
260 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
261 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700262 * &lt;action android:name="android.intent.action.MAIN" /&gt;
263 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700264 * &lt;/intent-filter&gt;
265 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700266 * &lt;action android:name="android.intent.action.VIEW" /&gt;
267 * &lt;action android:name="android.intent.action.EDIT" /&gt;
268 * &lt;action android:name="android.intent.action.PICK" /&gt;
269 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
270 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700271 * &lt;/intent-filter&gt;
272 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700273 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
274 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
275 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700276 * &lt;/intent-filter&gt;
277 * &lt;/activity&gt;
278 *
279 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
280 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700281 * &lt;action android:name="android.intent.action.VIEW" /&gt;
282 * &lt;action android:name="android.intent.action.EDIT" /&gt;
283 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
284 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700285 * &lt;/intent-filter&gt;
286 *
287 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700288 * &lt;action android:name="android.intent.action.INSERT" /&gt;
289 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
290 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700291 * &lt;/intent-filter&gt;
292 *
293 * &lt;/activity&gt;
294 *
295 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
296 * android:theme="@android:style/Theme.Dialog"&gt;
297 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700298 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
299 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
300 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
301 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
302 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700303 * &lt;/intent-filter&gt;
304 * &lt;/activity&gt;
305 *
306 * &lt;/application&gt;
307 * &lt;/manifest&gt;</pre>
308 *
309 * <p>The first activity,
310 * <code>com.android.notepad.NotesList</code>, serves as our main
311 * entry into the app. It can do three things as described by its three intent
312 * templates:
313 * <ol>
314 * <li><pre>
315 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700316 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
317 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700318 * &lt;/intent-filter&gt;</pre>
319 * <p>This provides a top-level entry into the NotePad application: the standard
320 * MAIN action is a main entry point (not requiring any other information in
321 * the Intent), and the LAUNCHER category says that this entry point should be
322 * listed in the application launcher.</p>
323 * <li><pre>
324 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700325 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
326 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
327 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
328 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
329 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700330 * &lt;/intent-filter&gt;</pre>
331 * <p>This declares the things that the activity can do on a directory of
332 * notes. The type being supported is given with the &lt;type&gt; tag, where
333 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
334 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
335 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
336 * The activity allows the user to view or edit the directory of data (via
337 * the VIEW and EDIT actions), or to pick a particular note and return it
338 * to the caller (via the PICK action). Note also the DEFAULT category
339 * supplied here: this is <em>required</em> for the
340 * {@link Context#startActivity Context.startActivity} method to resolve your
341 * activity when its component name is not explicitly specified.</p>
342 * <li><pre>
343 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700344 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
345 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
346 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700347 * &lt;/intent-filter&gt;</pre>
348 * <p>This filter describes the ability return to the caller a note selected by
349 * the user without needing to know where it came from. The data type
350 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
351 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
352 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
353 * The GET_CONTENT action is similar to the PICK action, where the activity
354 * will return to its caller a piece of data selected by the user. Here,
355 * however, the caller specifies the type of data they desire instead of
356 * the type of data the user will be picking from.</p>
357 * </ol>
358 *
359 * <p>Given these capabilities, the following intents will resolve to the
360 * NotesList activity:</p>
361 *
362 * <ul>
363 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
364 * activities that can be used as top-level entry points into an
365 * application.</p>
366 * <li> <p><b>{ action=android.app.action.MAIN,
367 * category=android.app.category.LAUNCHER }</b> is the actual intent
368 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700369 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700370 * data=content://com.google.provider.NotePad/notes }</b>
371 * displays a list of all the notes under
372 * "content://com.google.provider.NotePad/notes", which
373 * the user can browse through and see the details on.</p>
374 * <li> <p><b>{ action=android.app.action.PICK
375 * data=content://com.google.provider.NotePad/notes }</b>
376 * provides a list of the notes under
377 * "content://com.google.provider.NotePad/notes", from which
378 * the user can pick a note whose data URL is returned back to the caller.</p>
379 * <li> <p><b>{ action=android.app.action.GET_CONTENT
380 * type=vnd.android.cursor.item/vnd.google.note }</b>
381 * is similar to the pick action, but allows the caller to specify the
382 * kind of data they want back so that the system can find the appropriate
383 * activity to pick something of that data type.</p>
384 * </ul>
385 *
386 * <p>The second activity,
387 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
388 * note entry and allows them to edit it. It can do two things as described
389 * by its two intent templates:
390 * <ol>
391 * <li><pre>
392 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700393 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
394 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
395 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
396 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700397 * &lt;/intent-filter&gt;</pre>
398 * <p>The first, primary, purpose of this activity is to let the user interact
399 * with a single note, as decribed by the MIME type
400 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
401 * either VIEW a note or allow the user to EDIT it. Again we support the
402 * DEFAULT category to allow the activity to be launched without explicitly
403 * specifying its component.</p>
404 * <li><pre>
405 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700406 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
407 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
408 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700409 * &lt;/intent-filter&gt;</pre>
410 * <p>The secondary use of this activity is to insert a new note entry into
411 * an existing directory of notes. This is used when the user creates a new
412 * note: the INSERT action is executed on the directory of notes, causing
413 * this activity to run and have the user create the new note data which
414 * it then adds to the content provider.</p>
415 * </ol>
416 *
417 * <p>Given these capabilities, the following intents will resolve to the
418 * NoteEditor activity:</p>
419 *
420 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700421 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700422 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
423 * shows the user the content of note <var>{ID}</var>.</p>
424 * <li> <p><b>{ action=android.app.action.EDIT
425 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
426 * allows the user to edit the content of note <var>{ID}</var>.</p>
427 * <li> <p><b>{ action=android.app.action.INSERT
428 * data=content://com.google.provider.NotePad/notes }</b>
429 * creates a new, empty note in the notes list at
430 * "content://com.google.provider.NotePad/notes"
431 * and allows the user to edit it. If they keep their changes, the URI
432 * of the newly created note is returned to the caller.</p>
433 * </ul>
434 *
435 * <p>The last activity,
436 * <code>com.android.notepad.TitleEditor</code>, allows the user to
437 * edit the title of a note. This could be implemented as a class that the
438 * application directly invokes (by explicitly setting its component in
439 * the Intent), but here we show a way you can publish alternative
440 * operations on existing data:</p>
441 *
442 * <pre>
443 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700444 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
445 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
446 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
447 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
448 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700449 * &lt;/intent-filter&gt;</pre>
450 *
451 * <p>In the single intent template here, we
452 * have created our own private action called
453 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
454 * edit the title of a note. It must be invoked on a specific note
455 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
456 * view and edit actions, but here displays and edits the title contained
457 * in the note data.
458 *
459 * <p>In addition to supporting the default category as usual, our title editor
460 * also supports two other standard categories: ALTERNATIVE and
461 * SELECTED_ALTERNATIVE. Implementing
462 * these categories allows others to find the special action it provides
463 * without directly knowing about it, through the
464 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
465 * more often to build dynamic menu items with
466 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
467 * template here was also supply an explicit name for the template
468 * (via <code>android:label="@string/resolve_title"</code>) to better control
469 * what the user sees when presented with this activity as an alternative
470 * action to the data they are viewing.
471 *
472 * <p>Given these capabilities, the following intent will resolve to the
473 * TitleEditor activity:</p>
474 *
475 * <ul>
476 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
477 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
478 * displays and allows the user to edit the title associated
479 * with note <var>{ID}</var>.</p>
480 * </ul>
481 *
482 * <h3>Standard Activity Actions</h3>
483 *
484 * <p>These are the current standard actions that Intent defines for launching
485 * activities (usually through {@link Context#startActivity}. The most
486 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
487 * {@link #ACTION_EDIT}.
488 *
489 * <ul>
490 * <li> {@link #ACTION_MAIN}
491 * <li> {@link #ACTION_VIEW}
492 * <li> {@link #ACTION_ATTACH_DATA}
493 * <li> {@link #ACTION_EDIT}
494 * <li> {@link #ACTION_PICK}
495 * <li> {@link #ACTION_CHOOSER}
496 * <li> {@link #ACTION_GET_CONTENT}
497 * <li> {@link #ACTION_DIAL}
498 * <li> {@link #ACTION_CALL}
499 * <li> {@link #ACTION_SEND}
500 * <li> {@link #ACTION_SENDTO}
501 * <li> {@link #ACTION_ANSWER}
502 * <li> {@link #ACTION_INSERT}
503 * <li> {@link #ACTION_DELETE}
504 * <li> {@link #ACTION_RUN}
505 * <li> {@link #ACTION_SYNC}
506 * <li> {@link #ACTION_PICK_ACTIVITY}
507 * <li> {@link #ACTION_SEARCH}
508 * <li> {@link #ACTION_WEB_SEARCH}
509 * <li> {@link #ACTION_FACTORY_TEST}
510 * </ul>
511 *
512 * <h3>Standard Broadcast Actions</h3>
513 *
514 * <p>These are the current standard actions that Intent defines for receiving
515 * broadcasts (usually through {@link Context#registerReceiver} or a
516 * &lt;receiver&gt; tag in a manifest).
517 *
518 * <ul>
519 * <li> {@link #ACTION_TIME_TICK}
520 * <li> {@link #ACTION_TIME_CHANGED}
521 * <li> {@link #ACTION_TIMEZONE_CHANGED}
522 * <li> {@link #ACTION_BOOT_COMPLETED}
523 * <li> {@link #ACTION_PACKAGE_ADDED}
524 * <li> {@link #ACTION_PACKAGE_CHANGED}
525 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800526 * <li> {@link #ACTION_PACKAGE_RESTARTED}
527 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700528 * <li> {@link #ACTION_UID_REMOVED}
529 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700530 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700531 * <li> {@link #ACTION_POWER_DISCONNECTED}
532 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700533 * </ul>
534 *
535 * <h3>Standard Categories</h3>
536 *
537 * <p>These are the current standard categories that can be used to further
538 * clarify an Intent via {@link #addCategory}.
539 *
540 * <ul>
541 * <li> {@link #CATEGORY_DEFAULT}
542 * <li> {@link #CATEGORY_BROWSABLE}
543 * <li> {@link #CATEGORY_TAB}
544 * <li> {@link #CATEGORY_ALTERNATIVE}
545 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
546 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800547 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700548 * <li> {@link #CATEGORY_HOME}
549 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700550 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400551 * <li> {@link #CATEGORY_CAR_DOCK}
552 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500553 * <li> {@link #CATEGORY_LE_DESK_DOCK}
554 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200555 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700556 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700557 * </ul>
558 *
559 * <h3>Standard Extra Data</h3>
560 *
561 * <p>These are the current standard fields that can be used as extra data via
562 * {@link #putExtra}.
563 *
564 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800565 * <li> {@link #EXTRA_ALARM_COUNT}
566 * <li> {@link #EXTRA_BCC}
567 * <li> {@link #EXTRA_CC}
568 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
569 * <li> {@link #EXTRA_DATA_REMOVED}
570 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500571 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
572 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800573 * <li> {@link #EXTRA_DOCK_STATE_CAR}
574 * <li> {@link #EXTRA_DOCK_STATE_DESK}
575 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
576 * <li> {@link #EXTRA_DONT_KILL_APP}
577 * <li> {@link #EXTRA_EMAIL}
578 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700579 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800580 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700581 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800582 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700583 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800584 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
585 * <li> {@link #EXTRA_REPLACING}
586 * <li> {@link #EXTRA_SHORTCUT_ICON}
587 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
588 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700589 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800590 * <li> {@link #EXTRA_SHORTCUT_NAME}
591 * <li> {@link #EXTRA_SUBJECT}
592 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700593 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800594 * <li> {@link #EXTRA_TITLE}
595 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700596 * </ul>
597 *
598 * <h3>Flags</h3>
599 *
600 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800601 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
602 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700603 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800604public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700605 // ---------------------------------------------------------------------
606 // ---------------------------------------------------------------------
607 // Standard intent activity actions (see action variable).
608
609 /**
610 * Activity Action: Start as a main entry point, does not expect to
611 * receive data.
612 * <p>Input: nothing
613 * <p>Output: nothing
614 */
615 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
616 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800617
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 /**
619 * Activity Action: Display the data to the user. This is the most common
620 * action performed on data -- it is the generic action you can use on
621 * a piece of data to get the most reasonable thing to occur. For example,
622 * when used on a contacts entry it will view the entry; when used on a
623 * mailto: URI it will bring up a compose window filled with the information
624 * supplied by the URI; when used with a tel: URI it will invoke the
625 * dialer.
626 * <p>Input: {@link #getData} is URI from which to retrieve data.
627 * <p>Output: nothing.
628 */
629 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
630 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800631
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700632 /**
633 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
634 * performed on a piece of data.
635 */
636 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800637
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700638 /**
639 * Used to indicate that some piece of data should be attached to some other
640 * place. For example, image data could be attached to a contact. It is up
641 * to the recipient to decide where the data should be attached; the intent
642 * does not specify the ultimate destination.
643 * <p>Input: {@link #getData} is URI of data to be attached.
644 * <p>Output: nothing.
645 */
646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
647 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700649 /**
650 * Activity Action: Provide explicit editable access to the given data.
651 * <p>Input: {@link #getData} is URI of data to be edited.
652 * <p>Output: nothing.
653 */
654 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
655 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800656
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700657 /**
658 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
659 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
660 * The extras can contain type specific data to pass through to the editing/creating
661 * activity.
662 * <p>Output: The URI of the item that was picked. This must be a content:
663 * URI so that any receiver can access it.
664 */
665 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
666 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800667
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700668 /**
669 * Activity Action: Pick an item from the data, returning what was selected.
670 * <p>Input: {@link #getData} is URI containing a directory of data
671 * (vnd.android.cursor.dir/*) from which to pick an item.
672 * <p>Output: The URI of the item that was picked.
673 */
674 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
675 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800676
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 /**
678 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800679 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700680 * <p>Output: An Intent representing the shortcut. The intent must contain three
681 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
682 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800683 * (value: ShortcutIconResource).</p>
684 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700685 * @see #EXTRA_SHORTCUT_INTENT
686 * @see #EXTRA_SHORTCUT_NAME
687 * @see #EXTRA_SHORTCUT_ICON
688 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
689 * @see android.content.Intent.ShortcutIconResource
690 */
691 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
692 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
693
694 /**
695 * The name of the extra used to define the Intent of a shortcut.
696 *
697 * @see #ACTION_CREATE_SHORTCUT
698 */
699 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
700 /**
701 * The name of the extra used to define the name of a shortcut.
702 *
703 * @see #ACTION_CREATE_SHORTCUT
704 */
705 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
706 /**
707 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
708 *
709 * @see #ACTION_CREATE_SHORTCUT
710 */
711 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
712 /**
713 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
714 *
715 * @see #ACTION_CREATE_SHORTCUT
716 * @see android.content.Intent.ShortcutIconResource
717 */
718 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
719 "android.intent.extra.shortcut.ICON_RESOURCE";
720
721 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800722 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700723 *
724 * @see Intent#ACTION_CREATE_SHORTCUT
725 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800726 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
727 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700728 */
729 public static class ShortcutIconResource implements Parcelable {
730 /**
731 * The package name of the application containing the icon.
732 */
733 public String packageName;
734
735 /**
736 * The resource name of the icon, including package, name and type.
737 */
738 public String resourceName;
739
740 /**
741 * Creates a new ShortcutIconResource for the specified context and resource
742 * identifier.
743 *
744 * @param context The context of the application.
745 * @param resourceId The resource idenfitier for the icon.
746 * @return A new ShortcutIconResource with the specified's context package name
747 * and icon resource idenfitier.
748 */
749 public static ShortcutIconResource fromContext(Context context, int resourceId) {
750 ShortcutIconResource icon = new ShortcutIconResource();
751 icon.packageName = context.getPackageName();
752 icon.resourceName = context.getResources().getResourceName(resourceId);
753 return icon;
754 }
755
756 /**
757 * Used to read a ShortcutIconResource from a Parcel.
758 */
759 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
760 new Parcelable.Creator<ShortcutIconResource>() {
761
762 public ShortcutIconResource createFromParcel(Parcel source) {
763 ShortcutIconResource icon = new ShortcutIconResource();
764 icon.packageName = source.readString();
765 icon.resourceName = source.readString();
766 return icon;
767 }
768
769 public ShortcutIconResource[] newArray(int size) {
770 return new ShortcutIconResource[size];
771 }
772 };
773
774 /**
775 * No special parcel contents.
776 */
777 public int describeContents() {
778 return 0;
779 }
780
781 public void writeToParcel(Parcel dest, int flags) {
782 dest.writeString(packageName);
783 dest.writeString(resourceName);
784 }
785
786 @Override
787 public String toString() {
788 return resourceName;
789 }
790 }
791
792 /**
793 * Activity Action: Display an activity chooser, allowing the user to pick
794 * what they want to before proceeding. This can be used as an alternative
795 * to the standard activity picker that is displayed by the system when
796 * you try to start an activity with multiple possible matches, with these
797 * differences in behavior:
798 * <ul>
799 * <li>You can specify the title that will appear in the activity chooser.
800 * <li>The user does not have the option to make one of the matching
801 * activities a preferred activity, and all possible activities will
802 * always be shown even if one of them is currently marked as the
803 * preferred activity.
804 * </ul>
805 * <p>
806 * This action should be used when the user will naturally expect to
807 * select an activity in order to proceed. An example if when not to use
808 * it is when the user clicks on a "mailto:" link. They would naturally
809 * expect to go directly to their mail app, so startActivity() should be
810 * called directly: it will
811 * either launch the current preferred app, or put up a dialog allowing the
812 * user to pick an app to use and optionally marking that as preferred.
813 * <p>
814 * In contrast, if the user is selecting a menu item to send a picture
815 * they are viewing to someone else, there are many different things they
816 * may want to do at this point: send it through e-mail, upload it to a
817 * web service, etc. In this case the CHOOSER action should be used, to
818 * always present to the user a list of the things they can do, with a
819 * nice title given by the caller such as "Send this photo with:".
820 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700821 * If you need to grant URI permissions through a chooser, you must specify
822 * the permissions to be granted on the ACTION_CHOOSER Intent
823 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
824 * {@link #setClipData} to specify the URIs to be granted as well as
825 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
826 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
827 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700828 * As a convenience, an Intent of this form can be created with the
829 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700830 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700831 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700832 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
833 * and can optionally have a {@link #EXTRA_TITLE} field containing the
834 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700835 * <p>
836 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700837 */
838 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
839 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
840
841 /**
842 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
843 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700844 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
845 * target intent, also optionally supplying a title. If the target
846 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
847 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
848 * set in the returned chooser intent, with its ClipData set appropriately:
849 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500850 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700851 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700852 * @param target The Intent that the user will be selecting an activity
853 * to perform.
854 * @param title Optional title that will be displayed in the chooser.
855 * @return Return a new Intent object that you can hand to
856 * {@link Context#startActivity(Intent) Context.startActivity()} and
857 * related methods.
858 */
859 public static Intent createChooser(Intent target, CharSequence title) {
860 Intent intent = new Intent(ACTION_CHOOSER);
861 intent.putExtra(EXTRA_INTENT, target);
862 if (title != null) {
863 intent.putExtra(EXTRA_TITLE, title);
864 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700865
866 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700867 int permFlags = target.getFlags()
868 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
869 if (permFlags != 0) {
870 ClipData targetClipData = target.getClipData();
871 if (targetClipData == null && target.getData() != null) {
872 ClipData.Item item = new ClipData.Item(target.getData());
873 String[] mimeTypes;
874 if (target.getType() != null) {
875 mimeTypes = new String[] { target.getType() };
876 } else {
877 mimeTypes = new String[] { };
878 }
879 targetClipData = new ClipData(null, mimeTypes, item);
880 }
881 if (targetClipData != null) {
882 intent.setClipData(targetClipData);
883 intent.addFlags(permFlags);
884 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700885 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700886
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700887 return intent;
888 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700889
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700890 /**
891 * Activity Action: Allow the user to select a particular kind of data and
892 * return it. This is different than {@link #ACTION_PICK} in that here we
893 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800894 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700895 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900896 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700897 * etc.
898 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900899 * 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 -0700900 * of data, such as a person contact, you set the MIME type to the kind of
901 * data you want and launch it with {@link Context#startActivity(Intent)}.
902 * The system will then launch the best application to select that kind
903 * of data for you.
904 * <p>
905 * You may also be interested in any of a set of types of content the user
906 * can pick. For example, an e-mail application that wants to allow the
907 * user to add an attachment to an e-mail message can use this action to
908 * bring up a list of all of the types of content the user can attach.
909 * <p>
910 * In this case, you should wrap the GET_CONTENT intent with a chooser
911 * (through {@link #createChooser}), which will give the proper interface
912 * for the user to pick how to send your data and allow you to specify
913 * a prompt indicating what they are doing. You will usually specify a
914 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
915 * broad range of content types the user can select from.
916 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900917 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700918 * only pick from data that can be represented as a stream. This is
919 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
920 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800921 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900922 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800923 * is locally available on the device. For example, if this extra is set
924 * to true then an image picker should not show any pictures that are available
925 * from a remote server but not already on the local device (thus requiring
926 * they be downloaded when opened).
927 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800928 * If the caller can handle multiple returned items (the user performing
929 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
930 * to indicate this.
931 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700932 * Input: {@link #getType} is the desired MIME type to retrieve. Note
933 * that no URI is supplied in the intent, as there are no constraints on
934 * where the returned data originally comes from. You may also include the
935 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800936 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800937 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
938 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700939 * <p>
940 * Output: The URI of the item that was picked. This must be a content:
941 * URI so that any receiver can access it.
942 */
943 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
944 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
945 /**
946 * Activity Action: Dial a number as specified by the data. This shows a
947 * UI with the number being dialed, allowing the user to explicitly
948 * initiate the call.
949 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
950 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
951 * number.
952 * <p>Output: nothing.
953 */
954 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
955 public static final String ACTION_DIAL = "android.intent.action.DIAL";
956 /**
957 * Activity Action: Perform a call to someone specified by the data.
958 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
959 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
960 * number.
961 * <p>Output: nothing.
962 *
963 * <p>Note: there will be restrictions on which applications can initiate a
964 * call; most applications should use the {@link #ACTION_DIAL}.
965 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
966 * numbers. Applications can <strong>dial</strong> emergency numbers using
967 * {@link #ACTION_DIAL}, however.
968 */
969 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
970 public static final String ACTION_CALL = "android.intent.action.CALL";
971 /**
972 * Activity Action: Perform a call to an emergency number specified by the
973 * data.
974 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
975 * tel: URI of an explicit phone number.
976 * <p>Output: nothing.
977 * @hide
978 */
979 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
980 /**
981 * Activity action: Perform a call to any number (emergency or not)
982 * specified by the data.
983 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
984 * tel: URI of an explicit phone number.
985 * <p>Output: nothing.
986 * @hide
987 */
988 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
989 /**
990 * Activity Action: Send a message to someone specified by the data.
991 * <p>Input: {@link #getData} is URI describing the target.
992 * <p>Output: nothing.
993 */
994 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
995 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
996 /**
997 * Activity Action: Deliver some data to someone else. Who the data is
998 * being delivered to is not specified; it is up to the receiver of this
999 * action to ask the user where the data should be sent.
1000 * <p>
1001 * When launching a SEND intent, you should usually wrap it in a chooser
1002 * (through {@link #createChooser}), which will give the proper interface
1003 * for the user to pick how to send your data and allow you to specify
1004 * a prompt indicating what they are doing.
1005 * <p>
1006 * Input: {@link #getType} is the MIME type of the data being sent.
1007 * get*Extra can have either a {@link #EXTRA_TEXT}
1008 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1009 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1010 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1011 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001012 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1013 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1014 * your text with HTML formatting.
1015 * <p>
1016 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1017 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1018 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1019 * content: URIs and other advanced features of {@link ClipData}. If
1020 * using this approach, you still must supply the same data through the
1021 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1022 * for compatibility with old applications. If you don't set a ClipData,
1023 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001024 * <p>
1025 * Optional standard extras, which may be interpreted by some recipients as
1026 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1027 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1028 * <p>
1029 * Output: nothing.
1030 */
1031 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1032 public static final String ACTION_SEND = "android.intent.action.SEND";
1033 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001034 * Activity Action: Deliver multiple data to someone else.
1035 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001036 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001037 * <p>
1038 * Input: {@link #getType} is the MIME type of the data being sent.
1039 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001040 * #EXTRA_STREAM} field, containing the data to be sent. If using
1041 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1042 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001043 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001044 * Multiple types are supported, and receivers should handle mixed types
1045 * whenever possible. The right way for the receiver to check them is to
1046 * use the content resolver on each URI. The intent sender should try to
1047 * put the most concrete mime type in the intent type, but it can fall
1048 * back to {@literal <type>/*} or {@literal *}/* as needed.
1049 * <p>
1050 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1051 * be image/jpg, but if you are sending image/jpg and image/png, then the
1052 * intent's type should be image/*.
1053 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001054 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1055 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1056 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1057 * content: URIs and other advanced features of {@link ClipData}. If
1058 * using this approach, you still must supply the same data through the
1059 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1060 * for compatibility with old applications. If you don't set a ClipData,
1061 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1062 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001063 * Optional standard extras, which may be interpreted by some recipients as
1064 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1065 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1066 * <p>
1067 * Output: nothing.
1068 */
1069 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1070 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1071 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001072 * Activity Action: Handle an incoming phone call.
1073 * <p>Input: nothing.
1074 * <p>Output: nothing.
1075 */
1076 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1077 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1078 /**
1079 * Activity Action: Insert an empty item into the given container.
1080 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1081 * in which to place the data.
1082 * <p>Output: URI of the new data that was created.
1083 */
1084 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1085 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1086 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001087 * Activity Action: Create a new item in the given container, initializing it
1088 * from the current contents of the clipboard.
1089 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1090 * in which to place the data.
1091 * <p>Output: URI of the new data that was created.
1092 */
1093 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1094 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1095 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001096 * Activity Action: Delete the given data from its container.
1097 * <p>Input: {@link #getData} is URI of data to be deleted.
1098 * <p>Output: nothing.
1099 */
1100 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1101 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1102 /**
1103 * Activity Action: Run the data, whatever that means.
1104 * <p>Input: ? (Note: this is currently specific to the test harness.)
1105 * <p>Output: nothing.
1106 */
1107 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1108 public static final String ACTION_RUN = "android.intent.action.RUN";
1109 /**
1110 * Activity Action: Perform a data synchronization.
1111 * <p>Input: ?
1112 * <p>Output: ?
1113 */
1114 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1115 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1116 /**
1117 * Activity Action: Pick an activity given an intent, returning the class
1118 * selected.
1119 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1120 * used with {@link PackageManager#queryIntentActivities} to determine the
1121 * set of activities from which to pick.
1122 * <p>Output: Class name of the activity that was selected.
1123 */
1124 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1125 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1126 /**
1127 * Activity Action: Perform a search.
1128 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1129 * is the text to search for. If empty, simply
1130 * enter your search results Activity with the search UI activated.
1131 * <p>Output: nothing.
1132 */
1133 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1134 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1135 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001136 * Activity Action: Start the platform-defined tutorial
1137 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1138 * is the text to search for. If empty, simply
1139 * enter your search results Activity with the search UI activated.
1140 * <p>Output: nothing.
1141 */
1142 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1143 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1144 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001145 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001146 * <p>
1147 * Input: {@link android.app.SearchManager#QUERY
1148 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1149 * a url starts with http or https, the site will be opened. If it is plain
1150 * text, Google search will be applied.
1151 * <p>
1152 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001153 */
1154 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1155 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001156
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001157 /**
Jim Miller07994402012-05-02 14:22:27 -07001158 * Activity Action: Perform assist action.
1159 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001160 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1161 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001162 * 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 Skory7140a252013-09-11 12:04:58 +01001171 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1172 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001173 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001174 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001175 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001176 */
1177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1178 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1179
1180 /**
Adam Skory7140a252013-09-11 12:04:58 +01001181 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1182 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001183 */
1184 public static final String EXTRA_ASSIST_PACKAGE
1185 = "android.intent.extra.ASSIST_PACKAGE";
1186
1187 /**
Adam Skory7140a252013-09-11 12:04:58 +01001188 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1189 * information supplied by the current foreground app at the time of the assist request.
1190 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001191 */
1192 public static final String EXTRA_ASSIST_CONTEXT
1193 = "android.intent.extra.ASSIST_CONTEXT";
1194
Jim Miller07994402012-05-02 14:22:27 -07001195 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001196 * Activity Action: List all available applications
1197 * <p>Input: Nothing.
1198 * <p>Output: nothing.
1199 */
1200 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1201 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1202 /**
1203 * Activity Action: Show settings for choosing wallpaper
1204 * <p>Input: Nothing.
1205 * <p>Output: Nothing.
1206 */
1207 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1208 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1209
1210 /**
1211 * Activity Action: Show activity for reporting a bug.
1212 * <p>Input: Nothing.
1213 * <p>Output: Nothing.
1214 */
1215 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1216 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1217
1218 /**
1219 * Activity Action: Main entry point for factory tests. Only used when
1220 * the device is booting in factory test node. The implementing package
1221 * must be installed in the system image.
1222 * <p>Input: nothing
1223 * <p>Output: nothing
1224 */
1225 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1226
1227 /**
1228 * Activity Action: The user pressed the "call" button to go to the dialer
1229 * or other appropriate UI for placing a call.
1230 * <p>Input: Nothing.
1231 * <p>Output: Nothing.
1232 */
1233 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1234 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1235
1236 /**
1237 * Activity Action: Start Voice Command.
1238 * <p>Input: Nothing.
1239 * <p>Output: Nothing.
1240 */
1241 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1242 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001243
1244 /**
1245 * Activity Action: Start action associated with long pressing on the
1246 * search key.
1247 * <p>Input: Nothing.
1248 * <p>Output: Nothing.
1249 */
1250 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1251 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001252
Jacek Surazski86b6c532009-05-13 14:38:28 +02001253 /**
1254 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1255 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001256 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001257 * <p>Input: No data is specified. The bug report is passed in using
1258 * an {@link #EXTRA_BUG_REPORT} field.
1259 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001260 *
1261 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001262 */
1263 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1264 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001265
1266 /**
1267 * Activity Action: Show power usage information to the user.
1268 * <p>Input: Nothing.
1269 * <p>Output: Nothing.
1270 */
1271 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1272 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001273
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001274 /**
1275 * Activity Action: Setup wizard to launch after a platform update. This
1276 * activity should have a string meta-data field associated with it,
1277 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1278 * the platform for setup. The activity will be launched only if
1279 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1280 * same value.
1281 * <p>Input: Nothing.
1282 * <p>Output: Nothing.
1283 * @hide
1284 */
1285 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1286 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001287
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001288 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001289 * Activity Action: Show settings for managing network data usage of a
1290 * specific application. Applications should define an activity that offers
1291 * options to control data usage.
1292 */
1293 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1294 public static final String ACTION_MANAGE_NETWORK_USAGE =
1295 "android.intent.action.MANAGE_NETWORK_USAGE";
1296
1297 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001298 * Activity Action: Launch application installer.
1299 * <p>
1300 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001301 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1302 * you can also use "package:<package-name>" to install an application for the
1303 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001304 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1305 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1306 * <p>
1307 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1308 * succeeded.
1309 *
1310 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1311 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1312 * @see #EXTRA_RETURN_RESULT
1313 */
1314 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1315 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1316
1317 /**
1318 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1319 * package. Specifies the installer package name; this package will receive the
1320 * {@link #ACTION_APP_ERROR} intent.
1321 */
1322 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1323 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1324
1325 /**
1326 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1327 * package. Specifies that the application being installed should not be
1328 * treated as coming from an unknown source, but as coming from the app
1329 * invoking the Intent. For this to work you must start the installer with
1330 * startActivityForResult().
1331 */
1332 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1333 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1334
1335 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001336 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1337 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001338 * data field originated from.
1339 */
rich cannings706e8ba2012-08-20 13:20:14 -07001340 public static final String EXTRA_ORIGINATING_URI
1341 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001342
1343 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001344 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1345 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1346 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001347 */
1348 public static final String EXTRA_REFERRER
1349 = "android.intent.extra.REFERRER";
1350
1351 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001352 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1353 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1354 * @hide
1355 */
1356 public static final String EXTRA_ORIGINATING_UID
1357 = "android.intent.extra.ORIGINATING_UID";
1358
1359 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001360 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1361 * package. Tells the installer UI to skip the confirmation with the user
1362 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001363 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1364 * will no longer show an interstitial message about updating existing
1365 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001366 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001367 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001368 public static final String EXTRA_ALLOW_REPLACE
1369 = "android.intent.extra.ALLOW_REPLACE";
1370
1371 /**
1372 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1373 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1374 * return to the application the result code of the install/uninstall. The returned result
1375 * code will be {@link android.app.Activity#RESULT_OK} on success or
1376 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1377 */
1378 public static final String EXTRA_RETURN_RESULT
1379 = "android.intent.extra.RETURN_RESULT";
1380
1381 /**
1382 * Package manager install result code. @hide because result codes are not
1383 * yet ready to be exposed.
1384 */
1385 public static final String EXTRA_INSTALL_RESULT
1386 = "android.intent.extra.INSTALL_RESULT";
1387
1388 /**
1389 * Activity Action: Launch application uninstaller.
1390 * <p>
1391 * Input: The data must be a package: URI whose scheme specific part is
1392 * the package name of the current installed package to be uninstalled.
1393 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1394 * <p>
1395 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1396 * succeeded.
1397 */
1398 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1399 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1400
1401 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001402 * Specify whether the package should be uninstalled for all users.
1403 * @hide because these should not be part of normal application flow.
1404 */
1405 public static final String EXTRA_UNINSTALL_ALL_USERS
1406 = "android.intent.extra.UNINSTALL_ALL_USERS";
1407
1408 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001409 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1410 * describing the last run version of the platform that was setup.
1411 * @hide
1412 */
1413 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1414
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001415 // ---------------------------------------------------------------------
1416 // ---------------------------------------------------------------------
1417 // Standard intent broadcast actions (see action variable).
1418
1419 /**
1420 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001421 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001422 * <p class="note">This is a protected intent that can only be sent
1423 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001424 */
1425 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1426 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1427 /**
1428 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001429 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001430 * <p class="note">This is a protected intent that can only be sent
1431 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001432 */
1433 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1434 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001435
1436 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001437 * Broadcast Action: Sent after the system stops dreaming.
1438 *
1439 * <p class="note">This is a protected intent that can only be sent by the system.
1440 * It is only sent to registered receivers.</p>
1441 */
1442 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1443 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1444
1445 /**
1446 * Broadcast Action: Sent after the system starts dreaming.
1447 *
1448 * <p class="note">This is a protected intent that can only be sent by the system.
1449 * It is only sent to registered receivers.</p>
1450 */
1451 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1452 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1453
1454 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001455 * 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 -07001456 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001457 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001458 * <p class="note">This is a protected intent that can only be sent
1459 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001460 */
1461 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001462 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001463
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001464 /**
1465 * Broadcast Action: The current time has changed. Sent every
1466 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001467 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001468 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1469 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001470 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001471 * <p class="note">This is a protected intent that can only be sent
1472 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001473 */
1474 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1475 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1476 /**
1477 * Broadcast Action: The time was set.
1478 */
1479 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1480 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1481 /**
1482 * Broadcast Action: The date has changed.
1483 */
1484 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1485 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1486 /**
1487 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1488 * <ul>
1489 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1490 * </ul>
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_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1497 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001498 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1499 * DNS entries should be tossed.
1500 * @hide
1501 */
1502 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1503 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1504 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001505 * Alarm Changed Action: This is broadcast when the AlarmClock
1506 * application's alarm is set or unset. It is used by the
1507 * AlarmClock application and the StatusBar service.
1508 * @hide
1509 */
1510 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1511 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1512 /**
1513 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1514 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1515 * @hide
1516 */
1517 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1518 public static final String ACTION_SYNC_STATE_CHANGED
1519 = "android.intent.action.SYNC_STATE_CHANGED";
1520 /**
1521 * Broadcast Action: This is broadcast once, after the system has finished
1522 * booting. It can be used to perform application-specific initialization,
1523 * such as installing alarms. You must hold the
1524 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1525 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001526 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001527 * <p class="note">This is a protected intent that can only be sent
1528 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001529 */
1530 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1531 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1532 /**
1533 * Broadcast Action: This is broadcast when a user action should request a
1534 * temporary system dialog to dismiss. Some examples of temporary system
1535 * dialogs are the notification window-shade and the recent tasks dialog.
1536 */
1537 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1538 /**
1539 * Broadcast Action: Trigger the download and eventual installation
1540 * of a package.
1541 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001542 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001543 * <p class="note">This is a protected intent that can only be sent
1544 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001545 *
1546 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001547 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001548 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001549 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1550 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1551 /**
1552 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001553 * device. The data contains the name of the package. Note that the
1554 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001555 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001556 * <ul>
1557 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1558 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1559 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1560 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001561 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001562 * <p class="note">This is a protected intent that can only be sent
1563 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001564 */
1565 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1566 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1567 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001568 * Broadcast Action: A new version of an application package has been
1569 * installed, replacing an existing version that was previously installed.
1570 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001571 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001572 * <ul>
1573 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1574 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001575 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001576 * <p class="note">This is a protected intent that can only be sent
1577 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001578 */
1579 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1580 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1581 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001582 * Broadcast Action: A new version of your application has been installed
1583 * over an existing one. This is only sent to the application that was
1584 * replaced. It does not contain any additional data; to receive it, just
1585 * use an intent filter for this action.
1586 *
1587 * <p class="note">This is a protected intent that can only be sent
1588 * by the system.
1589 */
1590 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1591 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1592 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001593 * Broadcast Action: An existing application package has been removed from
1594 * the device. The data contains the name of the package. The package
1595 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001596 * <ul>
1597 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1598 * to the package.
1599 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1600 * application -- data and code -- is being removed.
1601 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1602 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1603 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001604 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001605 * <p class="note">This is a protected intent that can only be sent
1606 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001607 */
1608 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1609 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1610 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001611 * Broadcast Action: An existing application package has been completely
1612 * removed from the device. The data contains the name of the package.
1613 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1614 * {@link #EXTRA_DATA_REMOVED} is true and
1615 * {@link #EXTRA_REPLACING} is false of that broadcast.
1616 *
1617 * <ul>
1618 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1619 * to the package.
1620 * </ul>
1621 *
1622 * <p class="note">This is a protected intent that can only be sent
1623 * by the system.
1624 */
1625 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1626 public static final String ACTION_PACKAGE_FULLY_REMOVED
1627 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1628 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001629 * Broadcast Action: An existing application package has been changed (e.g.
1630 * a component has been enabled or disabled). The data contains the name of
1631 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001632 * <ul>
1633 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001634 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001635 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001636 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1637 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001638 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001639 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001640 * <p class="note">This is a protected intent that can only be sent
1641 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001642 */
1643 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1644 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1645 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001646 * @hide
1647 * Broadcast Action: Ask system services if there is any reason to
1648 * restart the given package. The data contains the name of the
1649 * package.
1650 * <ul>
1651 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1652 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1653 * </ul>
1654 *
1655 * <p class="note">This is a protected intent that can only be sent
1656 * by the system.
1657 */
1658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1659 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1660 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001661 * Broadcast Action: The user has restarted a package, and all of its
1662 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001663 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001664 * be removed. Note that the restarted package does <em>not</em>
1665 * receive this broadcast.
1666 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001667 * <ul>
1668 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1669 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001670 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001671 * <p class="note">This is a protected intent that can only be sent
1672 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001673 */
1674 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1675 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1676 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001677 * Broadcast Action: The user has cleared the data of a package. This should
1678 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001679 * its persistent data is erased and this broadcast sent.
1680 * Note that the cleared package does <em>not</em>
1681 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001682 * <ul>
1683 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1684 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001685 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001686 * <p class="note">This is a protected intent that can only be sent
1687 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001688 */
1689 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1690 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1691 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001692 * Broadcast Action: A user ID has been removed from the system. The user
1693 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001694 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001695 * <p class="note">This is a protected intent that can only be sent
1696 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001697 */
1698 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1699 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001700
1701 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001702 * Broadcast Action: Sent to the installer package of an application
1703 * when that application is first launched (that is the first time it
1704 * is moved out of the stopped state). The data contains the name of the package.
1705 *
1706 * <p class="note">This is a protected intent that can only be sent
1707 * by the system.
1708 */
1709 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1710 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1711
1712 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001713 * Broadcast Action: Sent to the system package verifier when a package
1714 * needs to be verified. The data contains the package URI.
1715 * <p class="note">
1716 * This is a protected intent that can only be sent by the system.
1717 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001718 */
1719 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1720 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1721
1722 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001723 * Broadcast Action: Sent to the system package verifier when a package is
1724 * verified. The data contains the package URI.
1725 * <p class="note">
1726 * This is a protected intent that can only be sent by the system.
1727 */
1728 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1729 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1730
1731 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001732 * Broadcast Action: Resources for a set of packages (which were
1733 * previously unavailable) are currently
1734 * available since the media on which they exist is available.
1735 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1736 * list of packages whose availability changed.
1737 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1738 * list of uids of packages whose availability changed.
1739 * Note that the
1740 * packages in this list do <em>not</em> receive this broadcast.
1741 * The specified set of packages are now available on the system.
1742 * <p>Includes the following extras:
1743 * <ul>
1744 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1745 * whose resources(were previously unavailable) are currently available.
1746 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1747 * packages whose resources(were previously unavailable)
1748 * are currently available.
1749 * </ul>
1750 *
1751 * <p class="note">This is a protected intent that can only be sent
1752 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001753 */
1754 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001755 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1756 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001757
1758 /**
1759 * Broadcast Action: Resources for a set of packages are currently
1760 * unavailable since the media on which they exist is unavailable.
1761 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1762 * list of packages whose availability changed.
1763 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1764 * list of uids of packages whose availability changed.
1765 * The specified set of packages can no longer be
1766 * launched and are practically unavailable on the system.
1767 * <p>Inclues the following extras:
1768 * <ul>
1769 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1770 * whose resources are no longer available.
1771 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1772 * whose resources are no longer available.
1773 * </ul>
1774 *
1775 * <p class="note">This is a protected intent that can only be sent
1776 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001777 */
1778 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001779 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001780 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001781
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001782 /**
1783 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001784 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001785 * This should <em>only</em> be used to determine when the wallpaper
1786 * has changed to show the new wallpaper to the user. You should certainly
1787 * never, in response to this, change the wallpaper or other attributes of
1788 * it such as the suggested size. That would be crazy, right? You'd cause
1789 * all kinds of loops, especially if other apps are doing similar things,
1790 * right? Of course. So please don't do this.
1791 *
1792 * @deprecated Modern applications should use
1793 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1794 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1795 * shown behind their UI, rather than watching for this broadcast and
1796 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001797 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001798 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001799 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1800 /**
1801 * Broadcast Action: The current device {@link android.content.res.Configuration}
1802 * (orientation, locale, etc) has changed. When such a change happens, the
1803 * UIs (view hierarchy) will need to be rebuilt based on this new
1804 * information; for the most part, applications don't need to worry about
1805 * this, because the system will take care of stopping and restarting the
1806 * application to make sure it sees the new changes. Some system code that
1807 * can not be restarted will need to watch for this action and handle it
1808 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001809 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001810 * <p class="note">
1811 * You can <em>not</em> receive this through components declared
1812 * in manifests, only by explicitly registering for it with
1813 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1814 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001815 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001816 * <p class="note">This is a protected intent that can only be sent
1817 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001818 *
1819 * @see android.content.res.Configuration
1820 */
1821 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1822 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1823 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001824 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001825 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001826 * <p class="note">This is a protected intent that can only be sent
1827 * by the system.
1828 */
1829 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1830 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1831 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001832 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1833 * charging state, level, and other information about the battery.
1834 * See {@link android.os.BatteryManager} for documentation on the
1835 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001836 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001837 * <p class="note">
1838 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001839 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001840 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001841 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1842 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1843 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1844 * broadcasts that are sent and can be received through manifest
1845 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001846 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001847 * <p class="note">This is a protected intent that can only be sent
1848 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001849 */
1850 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1851 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1852 /**
1853 * Broadcast Action: Indicates low battery condition on the device.
1854 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001855 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001856 * <p class="note">This is a protected intent that can only be sent
1857 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001858 */
1859 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1860 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1861 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001862 * Broadcast Action: Indicates the battery is now okay after being low.
1863 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1864 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001865 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001866 * <p class="note">This is a protected intent that can only be sent
1867 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001868 */
1869 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1870 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1871 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001872 * Broadcast Action: External power has been connected to the device.
1873 * This is intended for applications that wish to register specifically to this notification.
1874 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1875 * stay active to receive this notification. This action can be used to implement actions
1876 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001877 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001878 * <p class="note">This is a protected intent that can only be sent
1879 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001880 */
1881 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001882 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001883 /**
1884 * Broadcast Action: External power has been removed from the device.
1885 * This is intended for applications that wish to register specifically to this notification.
1886 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1887 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001888 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001889 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001890 * <p class="note">This is a protected intent that can only be sent
1891 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001892 */
1893 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001894 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001895 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001896 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001897 * Broadcast Action: Device is shutting down.
1898 * This is broadcast when the device is being shut down (completely turned
1899 * off, not sleeping). Once the broadcast is complete, the final shutdown
1900 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001901 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001902 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001903 * <p class="note">This is a protected intent that can only be sent
1904 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001905 * <p>May include the following extras:
1906 * <ul>
1907 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1908 * shutdown is only for userspace processes. If not set, assumed to be false.
1909 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001910 */
1911 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001912 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001913 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001914 * Activity Action: Start this activity to request system shutdown.
1915 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1916 * to request confirmation from the user before shutting down.
1917 *
1918 * <p class="note">This is a protected intent that can only be sent
1919 * by the system.
1920 *
1921 * {@hide}
1922 */
1923 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1924 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001925 * Broadcast Action: A sticky broadcast that indicates low memory
1926 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001927 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001928 * <p class="note">This is a protected intent that can only be sent
1929 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001930 */
1931 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1932 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1933 /**
1934 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001935 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001936 * <p class="note">This is a protected intent that can only be sent
1937 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001938 */
1939 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1940 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1941 /**
Jake Hambybb371632010-08-23 18:16:48 -07001942 * Broadcast Action: A sticky broadcast that indicates a memory full
1943 * condition on the device. This is intended for activities that want
1944 * to be able to fill the data partition completely, leaving only
1945 * enough free space to prevent system-wide SQLite failures.
1946 *
1947 * <p class="note">This is a protected intent that can only be sent
1948 * by the system.
1949 *
1950 * {@hide}
1951 */
1952 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1953 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1954 /**
1955 * Broadcast Action: Indicates memory full condition on the device
1956 * no longer exists.
1957 *
1958 * <p class="note">This is a protected intent that can only be sent
1959 * by the system.
1960 *
1961 * {@hide}
1962 */
1963 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1964 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1965 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001966 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1967 * and package management should be started.
1968 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1969 * notification.
1970 */
1971 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1972 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1973 /**
1974 * Broadcast Action: The device has entered USB Mass Storage mode.
1975 * This is used mainly for the USB Settings panel.
1976 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1977 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001978 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001979 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001980 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001981 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1982
1983 /**
1984 * Broadcast Action: The device has exited USB Mass Storage mode.
1985 * This is used mainly for the USB Settings panel.
1986 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1987 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001988 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001989 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001990 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001991 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1992
1993 /**
1994 * Broadcast Action: External media has been removed.
1995 * The path to the mount point for the removed media is contained in the Intent.mData field.
1996 */
1997 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1998 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1999
2000 /**
2001 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002002 * 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 -07002003 */
2004 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2005 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2006
2007 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002008 * Broadcast Action: External media is present, and being disk-checked
2009 * 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 -08002010 */
2011 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2012 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2013
2014 /**
2015 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2016 * 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 -08002017 */
2018 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2019 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2020
2021 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002022 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002023 * 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 -07002024 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2025 * media was mounted read only.
2026 */
2027 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2028 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2029
2030 /**
2031 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002032 * 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 -07002033 */
2034 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2035 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2036
2037 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002038 * Broadcast Action: External media is no longer being shared via USB mass storage.
2039 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2040 *
2041 * @hide
2042 */
2043 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2044
2045 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002046 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2047 * The path to the mount point for the removed media is contained in the Intent.mData field.
2048 */
2049 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2050 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2051
2052 /**
2053 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002054 * 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 -07002055 */
2056 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2057 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2058
2059 /**
2060 * Broadcast Action: User has expressed the desire to remove the external storage media.
2061 * Applications should close all files they have open within the mount point when they receive this intent.
2062 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2063 */
2064 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2065 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2066
2067 /**
2068 * Broadcast Action: The media scanner has started scanning a directory.
2069 * The path to the directory being scanned is contained in the Intent.mData field.
2070 */
2071 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2072 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2073
2074 /**
2075 * Broadcast Action: The media scanner has finished scanning a directory.
2076 * The path to the scanned directory is contained in the Intent.mData field.
2077 */
2078 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2079 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2080
2081 /**
2082 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2083 * The path to the file is contained in the Intent.mData field.
2084 */
2085 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2086 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2087
2088 /**
2089 * Broadcast Action: The "Media Button" was pressed. Includes a single
2090 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2091 * caused the broadcast.
2092 */
2093 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2094 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2095
2096 /**
2097 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2098 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2099 * caused the broadcast.
2100 */
2101 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2102 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2103
2104 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2105 // location; they are not general-purpose actions.
2106
2107 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002108 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002109 */
2110 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2111 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2112 "android.intent.action.GTALK_CONNECTED";
2113
2114 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002115 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002116 */
2117 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2118 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2119 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002120
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002121 /**
2122 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002123 */
2124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2125 public static final String ACTION_INPUT_METHOD_CHANGED =
2126 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002127
2128 /**
2129 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2130 * more radios have been turned off or on. The intent will have the following extra value:</p>
2131 * <ul>
2132 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2133 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2134 * turned off</li>
2135 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002136 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002137 * <p class="note">This is a protected intent that can only be sent
2138 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002139 */
2140 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2141 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2142
2143 /**
2144 * Broadcast Action: Some content providers have parts of their namespace
2145 * where they publish new events or items that the user may be especially
2146 * interested in. For these things, they may broadcast this action when the
2147 * set of interesting items change.
2148 *
2149 * For example, GmailProvider sends this notification when the set of unread
2150 * mail in the inbox changes.
2151 *
2152 * <p>The data of the intent identifies which part of which provider
2153 * changed. When queried through the content resolver, the data URI will
2154 * return the data set in question.
2155 *
2156 * <p>The intent will have the following extra values:
2157 * <ul>
2158 * <li><em>count</em> - The number of items in the data set. This is the
2159 * same as the number of items in the cursor returned by querying the
2160 * data URI. </li>
2161 * </ul>
2162 *
2163 * This intent will be sent at boot (if the count is non-zero) and when the
2164 * data set changes. It is possible for the data set to change without the
2165 * count changing (for example, if a new unread message arrives in the same
2166 * sync operation in which a message is archived). The phone should still
2167 * ring/vibrate/etc as normal in this case.
2168 */
2169 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2170 public static final String ACTION_PROVIDER_CHANGED =
2171 "android.intent.action.PROVIDER_CHANGED";
2172
2173 /**
2174 * Broadcast Action: Wired Headset plugged in or unplugged.
2175 *
Matt Casey79867f52014-03-26 15:20:25 -07002176 * You <em>cannot</em> receive this through components declared
2177 * in manifests, only by explicitly registering for it with
2178 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2179 * Context.registerReceiver()}.
2180 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002181 * <p>The intent will have the following extra values:
2182 * <ul>
2183 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2184 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002185 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002186 * </ul>
2187 * </ul>
2188 */
2189 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2190 public static final String ACTION_HEADSET_PLUG =
2191 "android.intent.action.HEADSET_PLUG";
2192
2193 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002194 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2195 *
2196 * <p>The intent will have the following extra values:
2197 * <ul>
2198 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2199 * <li><em>name</em> - Headset type, human readable string </li>
2200 * </ul>
2201 * </ul>
2202 * @hide
2203 */
2204 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002205 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2206 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002207
2208 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002209 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002210 *
2211 * <p>The intent will have the following extra values:
2212 * <ul>
2213 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2214 * <li><em>name</em> - Headset type, human readable string </li>
2215 * </ul>
2216 * </ul>
2217 * @hide
2218 */
2219 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002220 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2221 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002222
2223 /**
2224 * Broadcast Action: A HMDI cable was plugged or unplugged
2225 *
2226 * <p>The intent will have the following extra values:
2227 * <ul>
2228 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2229 * <li><em>name</em> - HDMI cable, human readable string </li>
2230 * </ul>
2231 * </ul>
2232 * @hide
2233 */
2234 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2235 public static final String ACTION_HDMI_AUDIO_PLUG =
2236 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002237
2238 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002239 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2240 *
2241 * <p>The intent will have the following extra values:
2242 * <ul>
2243 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2244 * <li><em>card</em> - ALSA card number (integer) </li>
2245 * <li><em>device</em> - ALSA device number (integer) </li>
2246 * </ul>
2247 * </ul>
2248 * @hide
2249 */
2250 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2251 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2252 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2253
2254 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002255 * Broadcast Action: A USB audio device 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_DEVICE_PLUG =
2268 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2269
2270 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002271 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2272 * <ul>
2273 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2274 * </ul>
2275 *
2276 * <p class="note">This is a protected intent that can only be sent
2277 * by the system.
2278 *
2279 * @hide
2280 */
2281 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2282 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2283 = "android.intent.action.ADVANCED_SETTINGS";
2284
2285 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002286 * Broadcast Action: An outgoing call is about to be placed.
2287 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002288 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002289 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002290 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002291 * the phone number originally intended to be dialed.</li>
2292 * </ul>
2293 * <p>Once the broadcast is finished, the resultData is used as the actual
2294 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002295 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002296 * outgoing call in turn: for example, a parental control application
2297 * might verify that the user is authorized to place the call at that
2298 * time, then a number-rewriting application might add an area code if
2299 * one was not specified.</p>
2300 * <p>For consistency, any receiver whose purpose is to prohibit phone
2301 * calls should have a priority of 0, to ensure it will see the final
2302 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002303 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002304 * should have a positive priority.
2305 * Negative priorities are reserved for the system for this broadcast;
2306 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002307 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2308 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002309 * <p>Emergency calls cannot be intercepted using this mechanism, and
2310 * other calls cannot be modified to call emergency numbers using this
2311 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002312 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2313 * call to use their own service instead. Those apps should first prevent
2314 * the call from being placed by setting resultData to <code>null</code>
2315 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002316 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002317 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2318 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002319 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002320 * <p class="note">This is a protected intent that can only be sent
2321 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002322 */
2323 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2324 public static final String ACTION_NEW_OUTGOING_CALL =
2325 "android.intent.action.NEW_OUTGOING_CALL";
2326
2327 /**
2328 * Broadcast Action: Have the device reboot. This is only for use by
2329 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002330 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002331 * <p class="note">This is a protected intent that can only be sent
2332 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002333 */
2334 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2335 public static final String ACTION_REBOOT =
2336 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002337
Wei Huang97ecc9c2009-05-11 17:44:20 -07002338 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002339 * Broadcast Action: A sticky broadcast for changes in the physical
2340 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002341 *
2342 * <p>The intent will have the following extra values:
2343 * <ul>
2344 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002345 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002346 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002347 * <p>This is intended for monitoring the current physical dock state.
2348 * See {@link android.app.UiModeManager} for the normal API dealing with
2349 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002350 */
2351 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2352 public static final String ACTION_DOCK_EVENT =
2353 "android.intent.action.DOCK_EVENT";
2354
2355 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002356 * Broadcast Action: A broadcast when idle maintenance can be started.
2357 * This means that the user is not interacting with the device and is
2358 * not expected to do so soon. Typical use of the idle maintenance is
2359 * to perform somehow expensive tasks that can be postponed at a moment
2360 * when they will not degrade user experience.
2361 * <p>
2362 * <p class="note">In order to keep the device responsive in case of an
2363 * unexpected user interaction, implementations of a maintenance task
2364 * should be interruptible. In such a scenario a broadcast with action
2365 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2366 * should not do the maintenance work in
2367 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2368 * maintenance service by {@link Context#startService(Intent)}. Also
2369 * you should hold a wake lock while your maintenance service is running
2370 * to prevent the device going to sleep.
2371 * </p>
2372 * <p>
2373 * <p class="note">This is a protected intent that can only be sent by
2374 * the system.
2375 * </p>
2376 *
2377 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002378 *
2379 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002380 */
2381 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2382 public static final String ACTION_IDLE_MAINTENANCE_START =
2383 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2384
2385 /**
2386 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2387 * This means that the user was not interacting with the device as a result
2388 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2389 * was sent and now the user started interacting with the device. Typical
2390 * use of the idle maintenance is to perform somehow expensive tasks that
2391 * can be postponed at a moment when they will not degrade user experience.
2392 * <p>
2393 * <p class="note">In order to keep the device responsive in case of an
2394 * unexpected user interaction, implementations of a maintenance task
2395 * should be interruptible. Hence, on receiving a broadcast with this
2396 * action, the maintenance task should be interrupted as soon as possible.
2397 * In other words, you should not do the maintenance work in
2398 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2399 * maintenance service that was started on receiving of
2400 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2401 * lock you acquired when your maintenance service started.
2402 * </p>
2403 * <p class="note">This is a protected intent that can only be sent
2404 * by the system.
2405 *
2406 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002407 *
2408 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002409 */
2410 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2411 public static final String ACTION_IDLE_MAINTENANCE_END =
2412 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2413
2414 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002415 * Broadcast Action: a remote intent is to be broadcasted.
2416 *
2417 * A remote intent is used for remote RPC between devices. The remote intent
2418 * is serialized and sent from one device to another device. The receiving
2419 * device parses the remote intent and broadcasts it. Note that anyone can
2420 * broadcast a remote intent. However, if the intent receiver of the remote intent
2421 * does not trust intent broadcasts from arbitrary intent senders, it should require
2422 * the sender to hold certain permissions so only trusted sender's broadcast will be
2423 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002424 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002425 */
2426 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002427 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002428
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002429 /**
2430 * Broadcast Action: hook for permforming cleanup after a system update.
2431 *
2432 * The broadcast is sent when the system is booting, before the
2433 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2434 * image. A receiver for this should do its work and then disable itself
2435 * so that it does not get run again at the next boot.
2436 * @hide
2437 */
2438 public static final String ACTION_PRE_BOOT_COMPLETED =
2439 "android.intent.action.PRE_BOOT_COMPLETED";
2440
Amith Yamasani13593602012-03-22 16:16:17 -07002441 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002442 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002443 * on restricted users. The broadcast intent contains an extra
2444 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2445 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2446 * String[] depending on the restriction type.<p/>
2447 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002448 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2449 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2450 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002451 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2452 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002453 * @see RestrictionEntry
2454 */
2455 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2456 "android.intent.action.GET_RESTRICTION_ENTRIES";
2457
2458 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002459 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002460 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002461 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2462 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2463 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002464 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2465 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2466 * challenge.<p/>
2467 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002468 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002469 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002470 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2471 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002472
2473 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002474 * Sent the first time a user is starting, to allow system apps to
2475 * perform one time initialization. (This will not be seen by third
2476 * party applications because a newly initialized user does not have any
2477 * third party applications installed for it.) This is sent early in
2478 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002479 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2480 * broadcast, since it is part of a visible user interaction; be as quick
2481 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002482 */
2483 public static final String ACTION_USER_INITIALIZE =
2484 "android.intent.action.USER_INITIALIZE";
2485
2486 /**
2487 * Sent when a user switch is happening, causing the process's user to be
2488 * brought to the foreground. This is only sent to receivers registered
2489 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2490 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002491 * foreground. This is sent as a foreground
2492 * broadcast, since it is part of a visible user interaction; be as quick
2493 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002494 */
2495 public static final String ACTION_USER_FOREGROUND =
2496 "android.intent.action.USER_FOREGROUND";
2497
2498 /**
2499 * Sent when a user switch is happening, causing the process's user to be
2500 * sent to the background. This is only sent to receivers registered
2501 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2502 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002503 * background. This is sent as a foreground
2504 * broadcast, since it is part of a visible user interaction; be as quick
2505 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002506 */
2507 public static final String ACTION_USER_BACKGROUND =
2508 "android.intent.action.USER_BACKGROUND";
2509
2510 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002511 * Broadcast sent to the system when a user is added. Carries an extra
2512 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2513 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002514 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002515 * @hide
2516 */
2517 public static final String ACTION_USER_ADDED =
2518 "android.intent.action.USER_ADDED";
2519
2520 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002521 * Broadcast sent by the system when a user is started. Carries an extra
2522 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002523 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002524 * that has been started. This is sent as a foreground
2525 * broadcast, since it is part of a visible user interaction; be as quick
2526 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002527 * @hide
2528 */
2529 public static final String ACTION_USER_STARTED =
2530 "android.intent.action.USER_STARTED";
2531
2532 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002533 * Broadcast sent when a user is in the process of starting. Carries an extra
2534 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2535 * sent to registered receivers, not manifest receivers. It is sent to all
2536 * users (including the one that is being started). You must hold
2537 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2538 * this broadcast. This is sent as a background broadcast, since
2539 * its result is not part of the primary UX flow; to safely keep track of
2540 * started/stopped state of a user you can use this in conjunction with
2541 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2542 * other user state broadcasts since those are foreground broadcasts so can
2543 * execute in a different order.
2544 * @hide
2545 */
2546 public static final String ACTION_USER_STARTING =
2547 "android.intent.action.USER_STARTING";
2548
2549 /**
2550 * Broadcast sent when a user is going to be stopped. Carries an extra
2551 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2552 * sent to registered receivers, not manifest receivers. It is sent to all
2553 * users (including the one that is being stopped). You must hold
2554 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2555 * this broadcast. The user will not stop until all receivers have
2556 * handled the broadcast. This is sent as a background broadcast, since
2557 * its result is not part of the primary UX flow; to safely keep track of
2558 * started/stopped state of a user you can use this in conjunction with
2559 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2560 * other user state broadcasts since those are foreground broadcasts so can
2561 * execute in a different order.
2562 * @hide
2563 */
2564 public static final String ACTION_USER_STOPPING =
2565 "android.intent.action.USER_STOPPING";
2566
2567 /**
2568 * Broadcast sent to the system when a user is stopped. Carries an extra
2569 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2570 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2571 * specific package. This is only sent to registered receivers, not manifest
2572 * receivers. It is sent to all running users <em>except</em> the one that
2573 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002574 * @hide
2575 */
2576 public static final String ACTION_USER_STOPPED =
2577 "android.intent.action.USER_STOPPED";
2578
2579 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002580 * 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 -07002581 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002582 * one that has been removed. The user will not be completely removed until all receivers have
2583 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002584 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002585 * @hide
2586 */
2587 public static final String ACTION_USER_REMOVED =
2588 "android.intent.action.USER_REMOVED";
2589
2590 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002591 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002592 * the userHandle of the user to become the current one. This is only sent to
2593 * registered receivers, not manifest receivers. It is sent to all running users.
2594 * You must hold
2595 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002596 * @hide
2597 */
2598 public static final String ACTION_USER_SWITCHED =
2599 "android.intent.action.USER_SWITCHED";
2600
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002601 /**
2602 * Broadcast sent to the system when a user's information changes. Carries an extra
2603 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002604 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002605 * @hide
2606 */
2607 public static final String ACTION_USER_INFO_CHANGED =
2608 "android.intent.action.USER_INFO_CHANGED";
2609
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002610 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002611 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2612 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
2613 * the UserHandle of the profile that was added. This is only sent to registered receivers,
2614 * not manifest receivers.
2615 */
2616 public static final String ACTION_MANAGED_PROFILE_ADDED =
2617 "android.intent.action.MANAGED_PROFILE_ADDED";
2618
2619 /**
2620 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
2621 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed. This
2622 * is only sent to registered receivers, not manifest receivers.
2623 */
2624 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2625 "android.intent.action.MANAGED_PROFILE_REMOVED";
2626
2627 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002628 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2629 */
2630 public static final String ACTION_QUICK_CLOCK =
2631 "android.intent.action.QUICK_CLOCK";
2632
Michael Wright0087a142013-02-05 16:29:39 -08002633 /**
2634 * Broadcast Action: This is broadcast when a user action should request the
2635 * brightness setting dialog.
2636 * @hide
2637 */
2638 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2639 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2640
Justin Kohd378ad72013-04-01 12:18:26 -07002641 /**
2642 * Broadcast Action: A global button was pressed. Includes a single
2643 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2644 * caused the broadcast.
2645 * @hide
2646 */
2647 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2648
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002649 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002650 * Activity Action: Allow the user to select and return one or more existing
2651 * documents. When invoked, the system will display the various
2652 * {@link DocumentsProvider} instances installed on the device, letting the
2653 * user interactively navigate through them. These documents include local
2654 * media, such as photos and video, and documents provided by installed
2655 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002656 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002657 * Each document is represented as a {@code content://} URI backed by a
2658 * {@link DocumentsProvider}, which can be opened as a stream with
2659 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2660 * {@link android.provider.DocumentsContract.Document} metadata.
2661 * <p>
2662 * All selected documents are returned to the calling application with
2663 * persistable read and write permission grants. If you want to maintain
2664 * access to the documents across device reboots, you need to explicitly
2665 * take the persistable permissions using
2666 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2667 * <p>
2668 * Callers can restrict document selection to a specific kind of data, such
2669 * as photos, by setting one or more MIME types in
2670 * {@link #EXTRA_MIME_TYPES}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002671 * <p>
2672 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002673 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2674 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002675 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002676 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2677 * returned URIs can be opened with
2678 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002679 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002680 * Output: The URI of the item that was picked. This must be a
2681 * {@code content://} URI so that any receiver can access it. If multiple
2682 * documents were selected, they are returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002683 *
2684 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002685 * @see #ACTION_CREATE_DOCUMENT
2686 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002687 */
2688 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2689 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2690
2691 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002692 * Activity Action: Allow the user to create a new document. When invoked,
2693 * the system will display the various {@link DocumentsProvider} instances
2694 * installed on the device, letting the user navigate through them. The
2695 * returned document may be a newly created document with no content, or it
2696 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002697 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002698 * Each document is represented as a {@code content://} URI backed by a
2699 * {@link DocumentsProvider}, which can be opened as a stream with
2700 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2701 * {@link android.provider.DocumentsContract.Document} metadata.
2702 * <p>
2703 * Callers must indicate the concrete MIME type of the document being
2704 * created by setting {@link #setType(String)}. This MIME type cannot be
2705 * changed after the document is created.
2706 * <p>
2707 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2708 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002709 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002710 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2711 * returned URIs can be opened with
2712 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002713 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002714 * Output: The URI of the item that was created. This must be a
2715 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002716 *
2717 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002718 * @see #ACTION_OPEN_DOCUMENT
2719 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002720 */
2721 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2722 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2723
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002724 // ---------------------------------------------------------------------
2725 // ---------------------------------------------------------------------
2726 // Standard intent categories (see addCategory()).
2727
2728 /**
2729 * Set if the activity should be an option for the default action
2730 * (center press) to perform on a piece of data. Setting this will
2731 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002732 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002733 * Intent when initiating an action -- it is for use in intent filters
2734 * specified in packages.
2735 */
2736 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2737 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2738 /**
2739 * Activities that can be safely invoked from a browser must support this
2740 * category. For example, if the user is viewing a web page or an e-mail
2741 * and clicks on a link in the text, the Intent generated execute that
2742 * link will require the BROWSABLE category, so that only activities
2743 * supporting this category will be considered as possible actions. By
2744 * supporting this category, you are promising that there is nothing
2745 * damaging (without user intervention) that can happen by invoking any
2746 * matching Intent.
2747 */
2748 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2749 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2750 /**
2751 * Set if the activity should be considered as an alternative action to
2752 * the data the user is currently viewing. See also
2753 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2754 * applies to the selection in a list of items.
2755 *
2756 * <p>Supporting this category means that you would like your activity to be
2757 * displayed in the set of alternative things the user can do, usually as
2758 * part of the current activity's options menu. You will usually want to
2759 * include a specific label in the &lt;intent-filter&gt; of this action
2760 * describing to the user what it does.
2761 *
2762 * <p>The action of IntentFilter with this category is important in that it
2763 * describes the specific action the target will perform. This generally
2764 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2765 * a specific name such as "com.android.camera.action.CROP. Only one
2766 * alternative of any particular action will be shown to the user, so using
2767 * a specific action like this makes sure that your alternative will be
2768 * displayed while also allowing other applications to provide their own
2769 * overrides of that particular action.
2770 */
2771 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2772 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2773 /**
2774 * Set if the activity should be considered as an alternative selection
2775 * action to the data the user has currently selected. This is like
2776 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2777 * of items from which the user can select, giving them alternatives to the
2778 * default action that will be performed on it.
2779 */
2780 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2781 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2782 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002783 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002784 */
2785 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2786 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2787 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002788 * Should be displayed in the top-level launcher.
2789 */
2790 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2791 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2792 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002793 * Indicates an activity optimized for Leanback mode, and that should
2794 * be displayed in the Leanback launcher.
2795 */
2796 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2797 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2798 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002799 * Provides information about the package it is in; typically used if
2800 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2801 * a front-door to the user without having to be shown in the all apps list.
2802 */
2803 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2804 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2805 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002806 * This is the home activity, that is the first activity that is displayed
2807 * when the device boots.
2808 */
2809 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2810 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2811 /**
2812 * This activity is a preference panel.
2813 */
2814 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2815 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2816 /**
2817 * This activity is a development preference panel.
2818 */
2819 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2820 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2821 /**
2822 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002823 */
2824 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2825 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2826 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002827 * This activity allows the user to browse and download new applications.
2828 */
2829 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2830 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2831 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002832 * This activity may be exercised by the monkey or other automated test tools.
2833 */
2834 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2835 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2836 /**
2837 * To be used as a test (not part of the normal user experience).
2838 */
2839 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2840 /**
2841 * To be used as a unit test (run through the Test Harness).
2842 */
2843 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2844 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002845 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002846 * experience).
2847 */
2848 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002849
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002850 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002851 * Used to indicate that an intent only wants URIs that can be opened with
2852 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2853 * must support at least the columns defined in {@link OpenableColumns} when
2854 * queried.
2855 *
2856 * @see #ACTION_GET_CONTENT
2857 * @see #ACTION_OPEN_DOCUMENT
2858 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002859 */
2860 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2861 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2862
2863 /**
2864 * To be used as code under test for framework instrumentation tests.
2865 */
2866 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2867 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002868 /**
2869 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002870 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2871 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002872 */
2873 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2874 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2875 /**
2876 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002877 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2878 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002879 */
2880 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2881 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002882 /**
2883 * An activity to run when device is inserted into a analog (low end) dock.
2884 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2885 * information, see {@link android.app.UiModeManager}.
2886 */
2887 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2888 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2889
2890 /**
2891 * An activity to run when device is inserted into a digital (high end) dock.
2892 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2893 * information, see {@link android.app.UiModeManager}.
2894 */
2895 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2896 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002897
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002898 /**
2899 * Used to indicate that the activity can be used in a car environment.
2900 */
2901 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2902 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2903
Dan Sandlera55734a2014-03-26 18:41:11 -04002904 /**
2905 * An activity that provides a user interface for adjusting notification preferences for its
2906 * containing application. Optional but recommended for apps that post
2907 * {@link android.app.Notification Notifications}.
2908 */
2909 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2910 public static final String CATEGORY_NOTIFICATION_PREFERENCES = "android.intent.category.NOTIFICATION_PREFERENCES";
2911
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002912 // ---------------------------------------------------------------------
2913 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002914 // Application launch intent categories (see addCategory()).
2915
2916 /**
2917 * Used with {@link #ACTION_MAIN} to launch the browser application.
2918 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002919 * <p>NOTE: This should not be used as the primary key of an Intent,
2920 * since it will not result in the app launching with the correct
2921 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002922 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002923 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002924 */
2925 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2926 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2927
2928 /**
2929 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2930 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002931 * <p>NOTE: This should not be used as the primary key of an Intent,
2932 * since it will not result in the app launching with the correct
2933 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002934 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002935 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002936 */
2937 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2938 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2939
2940 /**
2941 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2942 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002943 * <p>NOTE: This should not be used as the primary key of an Intent,
2944 * since it will not result in the app launching with the correct
2945 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002946 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002947 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002948 */
2949 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2950 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2951
2952 /**
2953 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2954 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002955 * <p>NOTE: This should not be used as the primary key of an Intent,
2956 * since it will not result in the app launching with the correct
2957 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002958 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002959 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002960 */
2961 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2962 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2963
2964 /**
2965 * Used with {@link #ACTION_MAIN} to launch the email application.
2966 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002967 * <p>NOTE: This should not be used as the primary key of an Intent,
2968 * since it will not result in the app launching with the correct
2969 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002970 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002971 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002972 */
2973 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2974 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2975
2976 /**
2977 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2978 * The activity should be able to view and manipulate image and video files
2979 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002980 * <p>NOTE: This should not be used as the primary key of an Intent,
2981 * since it will not result in the app launching with the correct
2982 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002983 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002984 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002985 */
2986 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2987 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2988
2989 /**
2990 * Used with {@link #ACTION_MAIN} to launch the maps application.
2991 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002992 * <p>NOTE: This should not be used as the primary key of an Intent,
2993 * since it will not result in the app launching with the correct
2994 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002995 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002996 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002997 */
2998 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2999 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3000
3001 /**
3002 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3003 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003004 * <p>NOTE: This should not be used as the primary key of an Intent,
3005 * since it will not result in the app launching with the correct
3006 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003007 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003008 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003009 */
3010 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3011 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3012
3013 /**
3014 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003015 * The activity should be able to play, browse, or manipulate music files
3016 * stored on the device.
3017 * <p>NOTE: This should not be used as the primary key of an Intent,
3018 * since it will not result in the app launching with the correct
3019 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003020 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003021 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003022 */
3023 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3024 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3025
3026 // ---------------------------------------------------------------------
3027 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003028 // Standard extra data keys.
3029
3030 /**
3031 * The initial data to place in a newly created record. Use with
3032 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3033 * fields as would be given to the underlying ContentProvider.insert()
3034 * call.
3035 */
3036 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3037
3038 /**
3039 * A constant CharSequence that is associated with the Intent, used with
3040 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3041 * this may be a styled CharSequence, so you must use
3042 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3043 * retrieve it.
3044 */
3045 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3046
3047 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003048 * A constant String that is associated with the Intent, used with
3049 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3050 * as HTML formatted text. Note that you <em>must</em> also supply
3051 * {@link #EXTRA_TEXT}.
3052 */
3053 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3054
3055 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003056 * A content: URI holding a stream of data associated with the Intent,
3057 * used with {@link #ACTION_SEND} to supply the data being sent.
3058 */
3059 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3060
3061 /**
3062 * A String[] holding e-mail addresses that should be delivered to.
3063 */
3064 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3065
3066 /**
3067 * A String[] holding e-mail addresses that should be carbon copied.
3068 */
3069 public static final String EXTRA_CC = "android.intent.extra.CC";
3070
3071 /**
3072 * A String[] holding e-mail addresses that should be blind carbon copied.
3073 */
3074 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3075
3076 /**
3077 * A constant string holding the desired subject line of a message.
3078 */
3079 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3080
3081 /**
3082 * An Intent describing the choices you would like shown with
3083 * {@link #ACTION_PICK_ACTIVITY}.
3084 */
3085 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3086
3087 /**
3088 * A CharSequence dialog title to provide to the user when used with a
3089 * {@link #ACTION_CHOOSER}.
3090 */
3091 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3092
3093 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003094 * A Parcelable[] of {@link Intent} or
3095 * {@link android.content.pm.LabeledIntent} objects as set with
3096 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3097 * a the front of the list of choices, when shown to the user with a
3098 * {@link #ACTION_CHOOSER}.
3099 */
3100 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3101
3102 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003103 * A {@link android.view.KeyEvent} object containing the event that
3104 * triggered the creation of the Intent it is in.
3105 */
3106 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3107
3108 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003109 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3110 * before shutting down.
3111 *
3112 * {@hide}
3113 */
3114 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3115
3116 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003117 * 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 -07003118 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3119 * of restarting the application.
3120 */
3121 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3122
3123 /**
3124 * A String holding the phone number originally entered in
3125 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3126 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3127 */
3128 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003129
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003130 /**
3131 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3132 * intents to supply the uid the package had been assigned. Also an optional
3133 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3134 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3135 * purpose.
3136 */
3137 public static final String EXTRA_UID = "android.intent.extra.UID";
3138
3139 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003140 * @hide String array of package names.
3141 */
3142 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3143
3144 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003145 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3146 * intents to indicate whether this represents a full uninstall (removing
3147 * both the code and its data) or a partial uninstall (leaving its data,
3148 * implying that this is an update).
3149 */
3150 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003151
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003152 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003153 * @hide
3154 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3155 * intents to indicate that at this point the package has been removed for
3156 * all users on the device.
3157 */
3158 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3159 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3160
3161 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003162 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3163 * intents to indicate that this is a replacement of the package, so this
3164 * broadcast will immediately be followed by an add broadcast for a
3165 * different version of the same package.
3166 */
3167 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003168
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003169 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003170 * Used as an int extra field in {@link android.app.AlarmManager} intents
3171 * to tell the application being invoked how many pending alarms are being
3172 * delievered with the intent. For one-shot alarms this will always be 1.
3173 * For recurring alarms, this might be greater than 1 if the device was
3174 * asleep or powered off at the time an earlier alarm would have been
3175 * delivered.
3176 */
3177 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003178
Jacek Surazski86b6c532009-05-13 14:38:28 +02003179 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003180 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3181 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003182 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3183 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003184 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3185 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3186 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003187 */
3188 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3189
3190 /**
3191 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3192 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003193 */
3194 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3195
3196 /**
3197 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3198 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003199 */
3200 public static final int EXTRA_DOCK_STATE_DESK = 1;
3201
3202 /**
3203 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3204 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003205 */
3206 public static final int EXTRA_DOCK_STATE_CAR = 2;
3207
3208 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003209 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3210 * to represent that the phone is in a analog (low end) dock.
3211 */
3212 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3213
3214 /**
3215 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3216 * to represent that the phone is in a digital (high end) dock.
3217 */
3218 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3219
3220 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003221 * Boolean that can be supplied as meta-data with a dock activity, to
3222 * indicate that the dock should take over the home key when it is active.
3223 */
3224 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003225
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003226 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003227 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3228 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003229 */
3230 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3231
3232 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003233 * Used in the extra field in the remote intent. It's astring token passed with the
3234 * remote intent.
3235 */
3236 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3237 "android.intent.extra.remote_intent_token";
3238
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003239 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003240 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003241 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003242 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003243 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003244 "android.intent.extra.changed_component_name";
3245
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003246 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003247 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003248 * and contains a string array of all of the components that have changed. If
3249 * the state of the overall package has changed, then it will contain an entry
3250 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003251 */
3252 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3253 "android.intent.extra.changed_component_name_list";
3254
3255 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003256 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003257 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3258 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003259 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003260 */
3261 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3262 "android.intent.extra.changed_package_list";
3263
3264 /**
3265 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003266 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3267 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003268 * and contains an integer array of uids of all of the components
3269 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003270 */
3271 public static final String EXTRA_CHANGED_UID_LIST =
3272 "android.intent.extra.changed_uid_list";
3273
3274 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003275 * @hide
3276 * Magic extra system code can use when binding, to give a label for
3277 * who it is that has bound to a service. This is an integer giving
3278 * a framework string resource that can be displayed to the user.
3279 */
3280 public static final String EXTRA_CLIENT_LABEL =
3281 "android.intent.extra.client_label";
3282
3283 /**
3284 * @hide
3285 * Magic extra system code can use when binding, to give a PendingIntent object
3286 * that can be launched for the user to disable the system's use of this
3287 * service.
3288 */
3289 public static final String EXTRA_CLIENT_INTENT =
3290 "android.intent.extra.client_intent";
3291
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003292 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003293 * Extra used to indicate that an intent should only return data that is on
3294 * the local device. This is a boolean extra; the default is false. If true,
3295 * an implementation should only allow the user to select data that is
3296 * already on the device, not requiring it be downloaded from a remote
3297 * service when opened.
3298 *
3299 * @see #ACTION_GET_CONTENT
3300 * @see #ACTION_OPEN_DOCUMENT
3301 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003302 */
3303 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003304 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003305
Amith Yamasani13593602012-03-22 16:16:17 -07003306 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003307 * Extra used to indicate that an intent can allow the user to select and
3308 * return multiple items. This is a boolean extra; the default is false. If
3309 * true, an implementation is allowed to present the user with a UI where
3310 * they can pick multiple items that are all returned to the caller. When
3311 * this happens, they should be returned as the {@link #getClipData()} part
3312 * of the result Intent.
3313 *
3314 * @see #ACTION_GET_CONTENT
3315 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003316 */
3317 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003318 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003319
3320 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003321 * The integer userHandle carried with broadcast intents related to addition, removal and
3322 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3323 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3324 *
Amith Yamasani13593602012-03-22 16:16:17 -07003325 * @hide
3326 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003327 public static final String EXTRA_USER_HANDLE =
3328 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003329
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003330 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003331 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3332 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3333 */
3334 public static final String EXTRA_USER =
3335 "android.intent.extra.user";
3336
3337 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003338 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003339 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3340 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003341 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003342 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3343
3344 /**
3345 * Extra sent in the intent to the BroadcastReceiver that handles
3346 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3347 * the restrictions as key/value pairs.
3348 */
3349 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3350 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003351
Amith Yamasani86118ba2013-03-28 14:33:16 -07003352 /**
3353 * Extra used in the response from a BroadcastReceiver that handles
3354 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3355 */
3356 public static final String EXTRA_RESTRICTIONS_INTENT =
3357 "android.intent.extra.restrictions_intent";
3358
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003359 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003360 * Extra used to communicate a set of acceptable MIME types. The type of the
3361 * extra is {@code String[]}. Values may be a combination of concrete MIME
3362 * types (such as "image/png") and/or partial MIME types (such as
3363 * "audio/*").
3364 *
3365 * @see #ACTION_GET_CONTENT
3366 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003367 */
3368 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3369
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003370 /**
3371 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3372 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003373 * When this is true, hardware devices can use this information to determine that
3374 * they shouldn't do a complete shutdown of their device since this is not a
3375 * complete shutdown down to the kernel, but only user space restarting.
3376 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003377 */
3378 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3379 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3380
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003381 /**
3382 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3383 * user has set their time format preferences to the 24 hour format.
3384 *
3385 * @hide for internal use only.
3386 */
3387 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3388 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3389
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003390 // ---------------------------------------------------------------------
3391 // ---------------------------------------------------------------------
3392 // Intent flags (see mFlags variable).
3393
Tor Norbyed9273d62013-05-30 15:59:53 -07003394 /** @hide */
3395 @IntDef(flag = true,
3396 value = {FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION})
3397 @Retention(RetentionPolicy.SOURCE)
3398 public @interface GrantUriMode {}
3399
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003400 /**
3401 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003402 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003403 * specified in its ClipData. When applying to an Intent's ClipData,
3404 * all URIs as well as recursive traversals through data or other ClipData
3405 * in Intent items will be granted; only the grant flags of the top-level
3406 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003407 */
3408 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3409 /**
3410 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003411 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003412 * specified in its ClipData. When applying to an Intent's ClipData,
3413 * all URIs as well as recursive traversals through data or other ClipData
3414 * in Intent items will be granted; only the grant flags of the top-level
3415 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003416 */
3417 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3418 /**
3419 * Can be set by the caller to indicate that this Intent is coming from
3420 * a background operation, not from direct user interaction.
3421 */
3422 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3423 /**
3424 * A flag you can enable for debugging: when set, log messages will be
3425 * printed during the resolution of this intent to show you what has
3426 * been found to create the final resolved list.
3427 */
3428 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003429 /**
3430 * If set, this intent will not match any components in packages that
3431 * are currently stopped. If this is not set, then the default behavior
3432 * is to include such applications in the result.
3433 */
3434 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3435 /**
3436 * If set, this intent will always match any components in packages that
3437 * are currently stopped. This is the default behavior when
3438 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3439 * flags are set, this one wins (it allows overriding of exclude for
3440 * places where the framework may automatically set the exclude flag).
3441 */
3442 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003443
3444 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003445 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003446 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003447 * persisted across device reboots until explicitly revoked with
3448 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3449 * grant for possible persisting; the receiving application must call
3450 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3451 * actually persist.
3452 *
3453 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3454 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3455 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003456 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003457 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003458 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003459
3460 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003461 * If set, the new activity is not kept in the history stack. As soon as
3462 * the user navigates away from it, the activity is finished. This may also
3463 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3464 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003465 */
3466 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3467 /**
3468 * If set, the activity will not be launched if it is already running
3469 * at the top of the history stack.
3470 */
3471 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3472 /**
3473 * If set, this activity will become the start of a new task on this
3474 * history stack. A task (from the activity that started it to the
3475 * next task activity) defines an atomic group of activities that the
3476 * user can move to. Tasks can be moved to the foreground and background;
3477 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003478 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003479 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3480 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003481 *
3482 * <p>This flag is generally used by activities that want
3483 * to present a "launcher" style behavior: they give the user a list of
3484 * separate things that can be done, which otherwise run completely
3485 * independently of the activity launching them.
3486 *
3487 * <p>When using this flag, if a task is already running for the activity
3488 * you are now starting, then a new activity will not be started; instead,
3489 * the current task will simply be brought to the front of the screen with
3490 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3491 * to disable this behavior.
3492 *
3493 * <p>This flag can not be used when the caller is requesting a result from
3494 * the activity being launched.
3495 */
3496 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3497 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003498 * This flag is used to create a new task and launch an activity into it.
3499 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3500 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3501 * search through existing tasks for ones matching this Intent. Only if no such
3502 * task is found would a new task be created. When paired with
3503 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3504 * the search for a matching task and unconditionally start a new task.
3505 *
3506 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3507 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003508 * top-level application launcher.</strong> Used in conjunction with
3509 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3510 * behavior of bringing an existing task to the foreground. When set,
3511 * a new task is <em>always</em> started to host the Activity for the
3512 * Intent, regardless of whether there is already an existing task running
3513 * the same thing.
3514 *
3515 * <p><strong>Because the default system does not include graphical task management,
3516 * you should not use this flag unless you provide some way for a user to
3517 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003518 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003519 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3520 * creating new document tasks.
3521 *
3522 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
3523 * {@link #FLAG_ACTIVITY_NEW_TASK} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003524 *
Scott Main7aee61f2011-02-08 11:25:01 -08003525 * <p>See
3526 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3527 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003528 *
3529 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3530 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003531 */
3532 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3533 /**
3534 * If set, and the activity being launched is already running in the
3535 * current task, then instead of launching a new instance of that activity,
3536 * all of the other activities on top of it will be closed and this Intent
3537 * will be delivered to the (now on top) old activity as a new Intent.
3538 *
3539 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3540 * If D calls startActivity() with an Intent that resolves to the component
3541 * of activity B, then C and D will be finished and B receive the given
3542 * Intent, resulting in the stack now being: A, B.
3543 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003544 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003545 * either receive the new intent you are starting here in its
3546 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003547 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003548 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3549 * the same intent, then it will be finished and re-created; for all other
3550 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3551 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003552 *
3553 * <p>This launch mode can also be used to good effect in conjunction with
3554 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3555 * of a task, it will bring any currently running instance of that task
3556 * to the foreground, and then clear it to its root state. This is
3557 * especially useful, for example, when launching an activity from the
3558 * notification manager.
3559 *
Scott Main7aee61f2011-02-08 11:25:01 -08003560 * <p>See
3561 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3562 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003563 */
3564 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3565 /**
3566 * If set and this intent is being used to launch a new activity from an
3567 * existing one, then the reply target of the existing activity will be
3568 * transfered to the new activity. This way the new activity can call
3569 * {@link android.app.Activity#setResult} and have that result sent back to
3570 * the reply target of the original activity.
3571 */
3572 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3573 /**
3574 * If set and this intent is being used to launch a new activity from an
3575 * existing one, the current activity will not be counted as the top
3576 * activity for deciding whether the new intent should be delivered to
3577 * the top instead of starting a new one. The previous activity will
3578 * be used as the top, with the assumption being that the current activity
3579 * will finish itself immediately.
3580 */
3581 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3582 /**
3583 * If set, the new activity is not kept in the list of recently launched
3584 * activities.
3585 */
3586 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3587 /**
3588 * This flag is not normally set by application code, but set for you by
3589 * the system as described in the
3590 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3591 * launchMode} documentation for the singleTask mode.
3592 */
3593 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3594 /**
3595 * If set, and this activity is either being started in a new task or
3596 * bringing to the top an existing task, then it will be launched as
3597 * the front door of the task. This will result in the application of
3598 * any affinities needed to have that task in the proper state (either
3599 * moving activities to or from it), or simply resetting that task to
3600 * its initial state if needed.
3601 */
3602 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3603 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003604 * This flag is not normally set by application code, but set for you by
3605 * the system if this activity is being launched from history
3606 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003607 */
3608 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003609 /**
3610 * If set, this marks a point in the task's activity stack that should
3611 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003612 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003613 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3614 * the user re-launching it from home), this activity and all on top of
3615 * it will be finished so that the user does not return to them, but
3616 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003617 *
Craig Mautnere1f3fa22014-01-24 18:02:10 -08003618 * <p>When this flag is assigned to the root activity all activities up
3619 * to, but not including the root activity, will be cleared. This prevents
3620 * this flag from being used to finish all activities in a task and thereby
3621 * ending the task.
3622 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003623 * <p>This is useful for cases where you have a logical break in your
3624 * application. For example, an e-mail application may have a command
3625 * to view an attachment, which launches an image view activity to
3626 * display it. This activity should be part of the e-mail application's
3627 * task, since it is a part of the task the user is involved in. However,
3628 * if the user leaves that task, and later selects the e-mail app from
3629 * home, we may like them to return to the conversation they were
3630 * viewing, not the picture attachment, since that is confusing. By
3631 * setting this flag when launching the image viewer, that viewer and
3632 * any activities it starts will be removed the next time the user returns
3633 * to mail.
3634 */
3635 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003636 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003637 * This flag is used to break out "documents" into separate tasks that can
3638 * be reached via the Recents mechanism. Such a document is any kind of
3639 * item for which an application may want to maintain multiple simultaneous
3640 * instances. Examples might be text files, web pages, spreadsheets, or
3641 * emails. Each such document will be in a separate task in the Recents list.
3642 *
3643 * <p>When set, the activity specified by this Intent will launch into a
3644 * separate task rooted at that activity. The activity launched must be
3645 * defined with {@link android.R.attr#launchMode} "standard" or "singleTop".
3646 *
3647 * <p>If FLAG_ACTIVITY_NEW_DOCUMENT is used without
3648 * {@link #FLAG_ACTIVITY_MULTIPLE_TASK} then the activity manager will
3649 * search for an existing task with a matching target activity and Intent
3650 * data URI and relaunch that task, first finishing all activities down to
3651 * the root activity and then calling the root activity's
3652 * {@link android.app.Activity#onNewIntent(Intent)} method. If no existing
3653 * task's root activity matches the Intent's data URI then a new task will
3654 * be launched with the target activity as root.
3655 *
3656 * <p>When paired with {@link #FLAG_ACTIVITY_MULTIPLE_TASK} this will
3657 * always create a new task. Thus the same document may be made to appear
3658 * more than one time in Recents.
3659 *
3660 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3661 */
3662 public static final int FLAG_ACTIVITY_NEW_DOCUMENT =
3663 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET | FLAG_ACTIVITY_NEW_TASK;
3664 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003665 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003666 * callback from occurring on the current frontmost activity before it is
3667 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003668 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003669 * <p>Typically, an activity can rely on that callback to indicate that an
3670 * explicit user action has caused their activity to be moved out of the
3671 * foreground. The callback marks an appropriate point in the activity's
3672 * lifecycle for it to dismiss any notifications that it intends to display
3673 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003674 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003675 * <p>If an activity is ever started via any non-user-driven events such as
3676 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3677 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003678 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003679 */
3680 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003681 /**
3682 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3683 * this flag will cause the launched activity to be brought to the front of its
3684 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003685 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003686 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3687 * If D calls startActivity() with an Intent that resolves to the component
3688 * of activity B, then B will be brought to the front of the history stack,
3689 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003690 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003691 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003692 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003693 */
3694 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003695 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003696 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3697 * this flag will prevent the system from applying an activity transition
3698 * animation to go to the next activity state. This doesn't mean an
3699 * animation will never run -- if another activity change happens that doesn't
3700 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003701 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003702 * when you are going to do a series of activity operations but the
3703 * animation seen by the user shouldn't be driven by the first activity
3704 * change but rather a later one.
3705 */
3706 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3707 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003708 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3709 * this flag will cause any existing task that would be associated with the
3710 * activity to be cleared before the activity is started. That is, the activity
3711 * becomes the new root of an otherwise empty task, and any old activities
3712 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3713 */
3714 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3715 /**
3716 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3717 * this flag will cause a newly launching task to be placed on top of the current
3718 * home activity task (if there is one). That is, pressing back from the task
3719 * will always return the user to home even if that was not the last activity they
3720 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3721 */
3722 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3723 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003724 * If set, when sending a broadcast only registered receivers will be
3725 * called -- no BroadcastReceiver components will be launched.
3726 */
3727 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003728 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003729 * If set, when sending a broadcast the new broadcast will replace
3730 * any existing pending broadcast that matches it. Matching is defined
3731 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3732 * true for the intents of the two broadcasts. When a match is found,
3733 * the new broadcast (and receivers associated with it) will replace the
3734 * existing one in the pending broadcast list, remaining at the same
3735 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003736 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003737 * <p>This flag is most typically used with sticky broadcasts, which
3738 * only care about delivering the most recent values of the broadcast
3739 * to their receivers.
3740 */
3741 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3742 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003743 * If set, when sending a broadcast the recipient is allowed to run at
3744 * foreground priority, with a shorter timeout interval. During normal
3745 * broadcasts the receivers are not automatically hoisted out of the
3746 * background priority class.
3747 */
3748 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3749 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003750 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3751 * They can still propagate results through to later receivers, but they can not prevent
3752 * later receivers from seeing the broadcast.
3753 */
3754 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3755 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003756 * If set, when sending a broadcast <i>before boot has completed</i> only
3757 * registered receivers will be called -- no BroadcastReceiver components
3758 * will be launched. Sticky intent state will be recorded properly even
3759 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3760 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003761 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003762 * <p>This flag is only for use by system sevices as a convenience to
3763 * avoid having to implement a more complex mechanism around detection
3764 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003765 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003766 * @hide
3767 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003768 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003769 /**
3770 * Set when this broadcast is for a boot upgrade, a special mode that
3771 * allows the broadcast to be sent before the system is ready and launches
3772 * the app process with no providers running in it.
3773 * @hide
3774 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003775 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003776
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003777 /**
3778 * @hide Flags that can't be changed with PendingIntent.
3779 */
3780 public static final int IMMUTABLE_FLAGS =
3781 FLAG_GRANT_READ_URI_PERMISSION
3782 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003783
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003784 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003785 // ---------------------------------------------------------------------
3786 // toUri() and parseUri() options.
3787
3788 /**
3789 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3790 * always has the "intent:" scheme. This syntax can be used when you want
3791 * to later disambiguate between URIs that are intended to describe an
3792 * Intent vs. all others that should be treated as raw URIs. When used
3793 * with {@link #parseUri}, any other scheme will result in a generic
3794 * VIEW action for that raw URI.
3795 */
3796 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003797
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003798 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003799
3800 private String mAction;
3801 private Uri mData;
3802 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003803 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003804 private ComponentName mComponent;
3805 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003806 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003807 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003808 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003809 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003810 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003811
3812 // ---------------------------------------------------------------------
3813
3814 /**
3815 * Create an empty intent.
3816 */
3817 public Intent() {
3818 }
3819
3820 /**
3821 * Copy constructor.
3822 */
3823 public Intent(Intent o) {
3824 this.mAction = o.mAction;
3825 this.mData = o.mData;
3826 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003827 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003828 this.mComponent = o.mComponent;
3829 this.mFlags = o.mFlags;
3830 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003831 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003832 }
3833 if (o.mExtras != null) {
3834 this.mExtras = new Bundle(o.mExtras);
3835 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003836 if (o.mSourceBounds != null) {
3837 this.mSourceBounds = new Rect(o.mSourceBounds);
3838 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003839 if (o.mSelector != null) {
3840 this.mSelector = new Intent(o.mSelector);
3841 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003842 if (o.mClipData != null) {
3843 this.mClipData = new ClipData(o.mClipData);
3844 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003845 }
3846
3847 @Override
3848 public Object clone() {
3849 return new Intent(this);
3850 }
3851
3852 private Intent(Intent o, boolean all) {
3853 this.mAction = o.mAction;
3854 this.mData = o.mData;
3855 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003856 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003857 this.mComponent = o.mComponent;
3858 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003859 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003860 }
3861 }
3862
3863 /**
3864 * Make a clone of only the parts of the Intent that are relevant for
3865 * filter matching: the action, data, type, component, and categories.
3866 */
3867 public Intent cloneFilter() {
3868 return new Intent(this, false);
3869 }
3870
3871 /**
3872 * Create an intent with a given action. All other fields (data, type,
3873 * class) are null. Note that the action <em>must</em> be in a
3874 * namespace because Intents are used globally in the system -- for
3875 * example the system VIEW action is android.intent.action.VIEW; an
3876 * application's custom action would be something like
3877 * com.google.app.myapp.CUSTOM_ACTION.
3878 *
3879 * @param action The Intent action, such as ACTION_VIEW.
3880 */
3881 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003882 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003883 }
3884
3885 /**
3886 * Create an intent with a given action and for a given data url. Note
3887 * that the action <em>must</em> be in a namespace because Intents are
3888 * used globally in the system -- for example the system VIEW action is
3889 * android.intent.action.VIEW; an application's custom action would be
3890 * something like com.google.app.myapp.CUSTOM_ACTION.
3891 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003892 * <p><em>Note: scheme and host name matching in the Android framework is
3893 * case-sensitive, unlike the formal RFC. As a result,
3894 * you should always ensure that you write your Uri with these elements
3895 * using lower case letters, and normalize any Uris you receive from
3896 * outside of Android to ensure the scheme and host is lower case.</em></p>
3897 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003898 * @param action The Intent action, such as ACTION_VIEW.
3899 * @param uri The Intent data URI.
3900 */
3901 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003902 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003903 mData = uri;
3904 }
3905
3906 /**
3907 * Create an intent for a specific component. All other fields (action, data,
3908 * type, class) are null, though they can be modified later with explicit
3909 * calls. This provides a convenient way to create an intent that is
3910 * intended to execute a hard-coded class name, rather than relying on the
3911 * system to find an appropriate class for you; see {@link #setComponent}
3912 * for more information on the repercussions of this.
3913 *
3914 * @param packageContext A Context of the application package implementing
3915 * this class.
3916 * @param cls The component class that is to be used for the intent.
3917 *
3918 * @see #setClass
3919 * @see #setComponent
3920 * @see #Intent(String, android.net.Uri , Context, Class)
3921 */
3922 public Intent(Context packageContext, Class<?> cls) {
3923 mComponent = new ComponentName(packageContext, cls);
3924 }
3925
3926 /**
3927 * Create an intent for a specific component with a specified action and data.
3928 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3929 * construct the Intent and then calling {@link #setClass} to set its
3930 * class.
3931 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003932 * <p><em>Note: scheme and host name matching in the Android framework is
3933 * case-sensitive, unlike the formal RFC. As a result,
3934 * you should always ensure that you write your Uri with these elements
3935 * using lower case letters, and normalize any Uris you receive from
3936 * outside of Android to ensure the scheme and host is lower case.</em></p>
3937 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003938 * @param action The Intent action, such as ACTION_VIEW.
3939 * @param uri The Intent data URI.
3940 * @param packageContext A Context of the application package implementing
3941 * this class.
3942 * @param cls The component class that is to be used for the intent.
3943 *
3944 * @see #Intent(String, android.net.Uri)
3945 * @see #Intent(Context, Class)
3946 * @see #setClass
3947 * @see #setComponent
3948 */
3949 public Intent(String action, Uri uri,
3950 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003951 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003952 mData = uri;
3953 mComponent = new ComponentName(packageContext, cls);
3954 }
3955
3956 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003957 * Create an intent to launch the main (root) activity of a task. This
3958 * is the Intent that is started when the application's is launched from
3959 * Home. For anything else that wants to launch an application in the
3960 * same way, it is important that they use an Intent structured the same
3961 * way, and can use this function to ensure this is the case.
3962 *
3963 * <p>The returned Intent has the given Activity component as its explicit
3964 * component, {@link #ACTION_MAIN} as its action, and includes the
3965 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3966 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3967 * to do that through {@link #addFlags(int)} on the returned Intent.
3968 *
3969 * @param mainActivity The main activity component that this Intent will
3970 * launch.
3971 * @return Returns a newly created Intent that can be used to launch the
3972 * activity as a main application entry.
3973 *
3974 * @see #setClass
3975 * @see #setComponent
3976 */
3977 public static Intent makeMainActivity(ComponentName mainActivity) {
3978 Intent intent = new Intent(ACTION_MAIN);
3979 intent.setComponent(mainActivity);
3980 intent.addCategory(CATEGORY_LAUNCHER);
3981 return intent;
3982 }
3983
3984 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003985 * Make an Intent for the main activity of an application, without
3986 * specifying a specific activity to run but giving a selector to find
3987 * the activity. This results in a final Intent that is structured
3988 * the same as when the application is launched from
3989 * Home. For anything else that wants to launch an application in the
3990 * same way, it is important that they use an Intent structured the same
3991 * way, and can use this function to ensure this is the case.
3992 *
3993 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3994 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3995 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3996 * to do that through {@link #addFlags(int)} on the returned Intent.
3997 *
3998 * @param selectorAction The action name of the Intent's selector.
3999 * @param selectorCategory The name of a category to add to the Intent's
4000 * selector.
4001 * @return Returns a newly created Intent that can be used to launch the
4002 * activity as a main application entry.
4003 *
4004 * @see #setSelector(Intent)
4005 */
4006 public static Intent makeMainSelectorActivity(String selectorAction,
4007 String selectorCategory) {
4008 Intent intent = new Intent(ACTION_MAIN);
4009 intent.addCategory(CATEGORY_LAUNCHER);
4010 Intent selector = new Intent();
4011 selector.setAction(selectorAction);
4012 selector.addCategory(selectorCategory);
4013 intent.setSelector(selector);
4014 return intent;
4015 }
4016
4017 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004018 * Make an Intent that can be used to re-launch an application's task
4019 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4020 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4021 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4022 *
4023 * @param mainActivity The activity component that is the root of the
4024 * task; this is the activity that has been published in the application's
4025 * manifest as the main launcher icon.
4026 *
4027 * @return Returns a newly created Intent that can be used to relaunch the
4028 * activity's task in its root state.
4029 */
4030 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4031 Intent intent = makeMainActivity(mainActivity);
4032 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4033 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4034 return intent;
4035 }
4036
4037 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004038 * Call {@link #parseUri} with 0 flags.
4039 * @deprecated Use {@link #parseUri} instead.
4040 */
4041 @Deprecated
4042 public static Intent getIntent(String uri) throws URISyntaxException {
4043 return parseUri(uri, 0);
4044 }
Tom Taylord4a47292009-12-21 13:59:18 -08004045
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004046 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004047 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004048 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004049 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004050 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004051 *
4052 * <p>The URI given here must not be relative -- that is, it must include
4053 * the scheme and full path.
4054 *
4055 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004056 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004057 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004058 *
4059 * @return Intent The newly created Intent object.
4060 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004061 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4062 * it bad (as parsed by the Uri class) or the Intent data within the
4063 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004064 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004065 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004066 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004067 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004068 int i = 0;
4069 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004070 // Validate intent scheme for if requested.
4071 if ((flags&URI_INTENT_SCHEME) != 0) {
4072 if (!uri.startsWith("intent:")) {
4073 Intent intent = new Intent(ACTION_VIEW);
4074 try {
4075 intent.setData(Uri.parse(uri));
4076 } catch (IllegalArgumentException e) {
4077 throw new URISyntaxException(uri, e.getMessage());
4078 }
4079 return intent;
4080 }
4081 }
Tom Taylord4a47292009-12-21 13:59:18 -08004082
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004083 // simple case
4084 i = uri.lastIndexOf("#");
4085 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4086
4087 // old format Intent URI
4088 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07004089
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004090 // new format
4091 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004092 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004093
4094 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004095 String data = i >= 0 ? uri.substring(0, i) : null;
4096 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004097 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07004098
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004099 // loop over contents of Intent, all name=value;
4100 while (!uri.startsWith("end", i)) {
4101 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004102 if (eq < 0) eq = i-1;
4103 int semi = uri.indexOf(';', i);
4104 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004105
4106 // action
4107 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004108 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004109 }
4110
4111 // categories
4112 else if (uri.startsWith("category=", i)) {
4113 intent.addCategory(value);
4114 }
4115
4116 // type
4117 else if (uri.startsWith("type=", i)) {
4118 intent.mType = value;
4119 }
4120
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004121 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004122 else if (uri.startsWith("launchFlags=", i)) {
4123 intent.mFlags = Integer.decode(value).intValue();
4124 }
4125
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004126 // package
4127 else if (uri.startsWith("package=", i)) {
4128 intent.mPackage = value;
4129 }
4130
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004131 // component
4132 else if (uri.startsWith("component=", i)) {
4133 intent.mComponent = ComponentName.unflattenFromString(value);
4134 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004135
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004136 // scheme
4137 else if (uri.startsWith("scheme=", i)) {
4138 scheme = value;
4139 }
4140
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004141 // source bounds
4142 else if (uri.startsWith("sourceBounds=", i)) {
4143 intent.mSourceBounds = Rect.unflattenFromString(value);
4144 }
4145
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004146 // selector
4147 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4148 intent = new Intent();
4149 }
4150
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004151 // extra
4152 else {
4153 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004154 // create Bundle if it doesn't already exist
4155 if (intent.mExtras == null) intent.mExtras = new Bundle();
4156 Bundle b = intent.mExtras;
4157 // add EXTRA
4158 if (uri.startsWith("S.", i)) b.putString(key, value);
4159 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4160 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4161 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4162 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4163 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4164 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4165 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4166 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4167 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4168 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004169
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004170 // move to the next item
4171 i = semi + 1;
4172 }
4173
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004174 if (intent != baseIntent) {
4175 // The Intent had a selector; fix it up.
4176 baseIntent.setSelector(intent);
4177 intent = baseIntent;
4178 }
4179
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004180 if (data != null) {
4181 if (data.startsWith("intent:")) {
4182 data = data.substring(7);
4183 if (scheme != null) {
4184 data = scheme + ':' + data;
4185 }
4186 }
Tom Taylord4a47292009-12-21 13:59:18 -08004187
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004188 if (data.length() > 0) {
4189 try {
4190 intent.mData = Uri.parse(data);
4191 } catch (IllegalArgumentException e) {
4192 throw new URISyntaxException(uri, e.getMessage());
4193 }
4194 }
4195 }
Tom Taylord4a47292009-12-21 13:59:18 -08004196
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004197 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004198
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004199 } catch (IndexOutOfBoundsException e) {
4200 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4201 }
4202 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004203
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004204 public static Intent getIntentOld(String uri) throws URISyntaxException {
4205 Intent intent;
4206
4207 int i = uri.lastIndexOf('#');
4208 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004209 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004210 final int intentFragmentStart = i;
4211 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004212
4213 i++;
4214
4215 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004216 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004217 i += 7;
4218 int j = uri.indexOf(')', i);
4219 action = uri.substring(i, j);
4220 i = j + 1;
4221 }
4222
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004223 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004224
4225 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004226 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004227 i += 11;
4228 int j = uri.indexOf(')', i);
4229 while (i < j) {
4230 int sep = uri.indexOf('!', i);
4231 if (sep < 0) sep = j;
4232 if (i < sep) {
4233 intent.addCategory(uri.substring(i, sep));
4234 }
4235 i = sep + 1;
4236 }
4237 i = j + 1;
4238 }
4239
4240 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004241 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004242 i += 5;
4243 int j = uri.indexOf(')', i);
4244 intent.mType = uri.substring(i, j);
4245 i = j + 1;
4246 }
4247
4248 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004249 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004250 i += 12;
4251 int j = uri.indexOf(')', i);
4252 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4253 i = j + 1;
4254 }
4255
4256 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004257 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004258 i += 10;
4259 int j = uri.indexOf(')', i);
4260 int sep = uri.indexOf('!', i);
4261 if (sep >= 0 && sep < j) {
4262 String pkg = uri.substring(i, sep);
4263 String cls = uri.substring(sep + 1, j);
4264 intent.mComponent = new ComponentName(pkg, cls);
4265 }
4266 i = j + 1;
4267 }
4268
4269 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004270 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004271 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004272
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004273 final int closeParen = uri.indexOf(')', i);
4274 if (closeParen == -1) throw new URISyntaxException(uri,
4275 "EXTRA missing trailing ')'", i);
4276
4277 while (i < closeParen) {
4278 // fetch the key value
4279 int j = uri.indexOf('=', i);
4280 if (j <= i + 1 || i >= closeParen) {
4281 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4282 }
4283 char type = uri.charAt(i);
4284 i++;
4285 String key = uri.substring(i, j);
4286 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004287
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004288 // get type-value
4289 j = uri.indexOf('!', i);
4290 if (j == -1 || j >= closeParen) j = closeParen;
4291 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4292 String value = uri.substring(i, j);
4293 i = j;
4294
4295 // create Bundle if it doesn't already exist
4296 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004297
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004298 // add item to bundle
4299 try {
4300 switch (type) {
4301 case 'S':
4302 intent.mExtras.putString(key, Uri.decode(value));
4303 break;
4304 case 'B':
4305 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4306 break;
4307 case 'b':
4308 intent.mExtras.putByte(key, Byte.parseByte(value));
4309 break;
4310 case 'c':
4311 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4312 break;
4313 case 'd':
4314 intent.mExtras.putDouble(key, Double.parseDouble(value));
4315 break;
4316 case 'f':
4317 intent.mExtras.putFloat(key, Float.parseFloat(value));
4318 break;
4319 case 'i':
4320 intent.mExtras.putInt(key, Integer.parseInt(value));
4321 break;
4322 case 'l':
4323 intent.mExtras.putLong(key, Long.parseLong(value));
4324 break;
4325 case 's':
4326 intent.mExtras.putShort(key, Short.parseShort(value));
4327 break;
4328 default:
4329 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4330 }
4331 } catch (NumberFormatException e) {
4332 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4333 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004334
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004335 char ch = uri.charAt(i);
4336 if (ch == ')') break;
4337 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4338 i++;
4339 }
4340 }
4341
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004342 if (isIntentFragment) {
4343 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4344 } else {
4345 intent.mData = Uri.parse(uri);
4346 }
Tom Taylord4a47292009-12-21 13:59:18 -08004347
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004348 if (intent.mAction == null) {
4349 // By default, if no action is specified, then use VIEW.
4350 intent.mAction = ACTION_VIEW;
4351 }
4352
4353 } else {
4354 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4355 }
4356
4357 return intent;
4358 }
4359
4360 /**
4361 * Retrieve the general action to be performed, such as
4362 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4363 * the information in the intent should be interpreted -- most importantly,
4364 * what to do with the data returned by {@link #getData}.
4365 *
4366 * @return The action of this intent or null if none is specified.
4367 *
4368 * @see #setAction
4369 */
4370 public String getAction() {
4371 return mAction;
4372 }
4373
4374 /**
4375 * Retrieve data this intent is operating on. This URI specifies the name
4376 * of the data; often it uses the content: scheme, specifying data in a
4377 * content provider. Other schemes may be handled by specific activities,
4378 * such as http: by the web browser.
4379 *
4380 * @return The URI of the data this intent is targeting or null.
4381 *
4382 * @see #getScheme
4383 * @see #setData
4384 */
4385 public Uri getData() {
4386 return mData;
4387 }
4388
4389 /**
4390 * The same as {@link #getData()}, but returns the URI as an encoded
4391 * String.
4392 */
4393 public String getDataString() {
4394 return mData != null ? mData.toString() : null;
4395 }
4396
4397 /**
4398 * Return the scheme portion of the intent's data. If the data is null or
4399 * does not include a scheme, null is returned. Otherwise, the scheme
4400 * prefix without the final ':' is returned, i.e. "http".
4401 *
4402 * <p>This is the same as calling getData().getScheme() (and checking for
4403 * null data).
4404 *
4405 * @return The scheme of this intent.
4406 *
4407 * @see #getData
4408 */
4409 public String getScheme() {
4410 return mData != null ? mData.getScheme() : null;
4411 }
4412
4413 /**
4414 * Retrieve any explicit MIME type included in the intent. This is usually
4415 * null, as the type is determined by the intent data.
4416 *
4417 * @return If a type was manually set, it is returned; else null is
4418 * returned.
4419 *
4420 * @see #resolveType(ContentResolver)
4421 * @see #setType
4422 */
4423 public String getType() {
4424 return mType;
4425 }
4426
4427 /**
4428 * Return the MIME data type of this intent. If the type field is
4429 * explicitly set, that is simply returned. Otherwise, if the data is set,
4430 * the type of that data is returned. If neither fields are set, a null is
4431 * returned.
4432 *
4433 * @return The MIME type of this intent.
4434 *
4435 * @see #getType
4436 * @see #resolveType(ContentResolver)
4437 */
4438 public String resolveType(Context context) {
4439 return resolveType(context.getContentResolver());
4440 }
4441
4442 /**
4443 * Return the MIME data type of this intent. If the type field is
4444 * explicitly set, that is simply returned. Otherwise, if the data is set,
4445 * the type of that data is returned. If neither fields are set, a null is
4446 * returned.
4447 *
4448 * @param resolver A ContentResolver that can be used to determine the MIME
4449 * type of the intent's data.
4450 *
4451 * @return The MIME type of this intent.
4452 *
4453 * @see #getType
4454 * @see #resolveType(Context)
4455 */
4456 public String resolveType(ContentResolver resolver) {
4457 if (mType != null) {
4458 return mType;
4459 }
4460 if (mData != null) {
4461 if ("content".equals(mData.getScheme())) {
4462 return resolver.getType(mData);
4463 }
4464 }
4465 return null;
4466 }
4467
4468 /**
4469 * Return the MIME data type of this intent, only if it will be needed for
4470 * intent resolution. This is not generally useful for application code;
4471 * it is used by the frameworks for communicating with back-end system
4472 * services.
4473 *
4474 * @param resolver A ContentResolver that can be used to determine the MIME
4475 * type of the intent's data.
4476 *
4477 * @return The MIME type of this intent, or null if it is unknown or not
4478 * needed.
4479 */
4480 public String resolveTypeIfNeeded(ContentResolver resolver) {
4481 if (mComponent != null) {
4482 return mType;
4483 }
4484 return resolveType(resolver);
4485 }
4486
4487 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004488 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004489 *
4490 * @param category The category to check.
4491 *
4492 * @return boolean True if the intent contains the category, else false.
4493 *
4494 * @see #getCategories
4495 * @see #addCategory
4496 */
4497 public boolean hasCategory(String category) {
4498 return mCategories != null && mCategories.contains(category);
4499 }
4500
4501 /**
4502 * Return the set of all categories in the intent. If there are no categories,
4503 * returns NULL.
4504 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004505 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004506 *
4507 * @see #hasCategory
4508 * @see #addCategory
4509 */
4510 public Set<String> getCategories() {
4511 return mCategories;
4512 }
4513
4514 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004515 * Return the specific selector associated with this Intent. If there is
4516 * none, returns null. See {@link #setSelector} for more information.
4517 *
4518 * @see #setSelector
4519 */
4520 public Intent getSelector() {
4521 return mSelector;
4522 }
4523
4524 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004525 * Return the {@link ClipData} associated with this Intent. If there is
4526 * none, returns null. See {@link #setClipData} for more information.
4527 *
John Spurlock125d1332013-11-25 11:58:37 -05004528 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004529 */
4530 public ClipData getClipData() {
4531 return mClipData;
4532 }
4533
4534 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004535 * Sets the ClassLoader that will be used when unmarshalling
4536 * any Parcelable values from the extras of this Intent.
4537 *
4538 * @param loader a ClassLoader, or null to use the default loader
4539 * at the time of unmarshalling.
4540 */
4541 public void setExtrasClassLoader(ClassLoader loader) {
4542 if (mExtras != null) {
4543 mExtras.setClassLoader(loader);
4544 }
4545 }
4546
4547 /**
4548 * Returns true if an extra value is associated with the given name.
4549 * @param name the extra's name
4550 * @return true if the given extra is present.
4551 */
4552 public boolean hasExtra(String name) {
4553 return mExtras != null && mExtras.containsKey(name);
4554 }
4555
4556 /**
4557 * Returns true if the Intent's extras contain a parcelled file descriptor.
4558 * @return true if the Intent contains a parcelled file descriptor.
4559 */
4560 public boolean hasFileDescriptors() {
4561 return mExtras != null && mExtras.hasFileDescriptors();
4562 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004563
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004564 /** @hide */
4565 public void setAllowFds(boolean allowFds) {
4566 if (mExtras != null) {
4567 mExtras.setAllowFds(allowFds);
4568 }
4569 }
4570
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004571 /**
4572 * Retrieve extended data from the intent.
4573 *
4574 * @param name The name of the desired item.
4575 *
4576 * @return the value of an item that previously added with putExtra()
4577 * or null if none was found.
4578 *
4579 * @deprecated
4580 * @hide
4581 */
4582 @Deprecated
4583 public Object getExtra(String name) {
4584 return getExtra(name, null);
4585 }
4586
4587 /**
4588 * Retrieve extended data from the intent.
4589 *
4590 * @param name The name of the desired item.
4591 * @param defaultValue the value to be returned if no value of the desired
4592 * type is stored with the given name.
4593 *
4594 * @return the value of an item that previously added with putExtra()
4595 * or the default value if none was found.
4596 *
4597 * @see #putExtra(String, boolean)
4598 */
4599 public boolean getBooleanExtra(String name, boolean defaultValue) {
4600 return mExtras == null ? defaultValue :
4601 mExtras.getBoolean(name, defaultValue);
4602 }
4603
4604 /**
4605 * Retrieve extended data from the intent.
4606 *
4607 * @param name The name of the desired item.
4608 * @param defaultValue the value to be returned if no value of the desired
4609 * type is stored with the given name.
4610 *
4611 * @return the value of an item that previously added with putExtra()
4612 * or the default value if none was found.
4613 *
4614 * @see #putExtra(String, byte)
4615 */
4616 public byte getByteExtra(String name, byte defaultValue) {
4617 return mExtras == null ? defaultValue :
4618 mExtras.getByte(name, defaultValue);
4619 }
4620
4621 /**
4622 * Retrieve extended data from the intent.
4623 *
4624 * @param name The name of the desired item.
4625 * @param defaultValue the value to be returned if no value of the desired
4626 * type is stored with the given name.
4627 *
4628 * @return the value of an item that previously added with putExtra()
4629 * or the default value if none was found.
4630 *
4631 * @see #putExtra(String, short)
4632 */
4633 public short getShortExtra(String name, short defaultValue) {
4634 return mExtras == null ? defaultValue :
4635 mExtras.getShort(name, defaultValue);
4636 }
4637
4638 /**
4639 * Retrieve extended data from the intent.
4640 *
4641 * @param name The name of the desired item.
4642 * @param defaultValue the value to be returned if no value of the desired
4643 * type is stored with the given name.
4644 *
4645 * @return the value of an item that previously added with putExtra()
4646 * or the default value if none was found.
4647 *
4648 * @see #putExtra(String, char)
4649 */
4650 public char getCharExtra(String name, char defaultValue) {
4651 return mExtras == null ? defaultValue :
4652 mExtras.getChar(name, defaultValue);
4653 }
4654
4655 /**
4656 * Retrieve extended data from the intent.
4657 *
4658 * @param name The name of the desired item.
4659 * @param defaultValue the value to be returned if no value of the desired
4660 * type is stored with the given name.
4661 *
4662 * @return the value of an item that previously added with putExtra()
4663 * or the default value if none was found.
4664 *
4665 * @see #putExtra(String, int)
4666 */
4667 public int getIntExtra(String name, int defaultValue) {
4668 return mExtras == null ? defaultValue :
4669 mExtras.getInt(name, defaultValue);
4670 }
4671
4672 /**
4673 * Retrieve extended data from the intent.
4674 *
4675 * @param name The name of the desired item.
4676 * @param defaultValue the value to be returned if no value of the desired
4677 * type is stored with the given name.
4678 *
4679 * @return the value of an item that previously added with putExtra()
4680 * or the default value if none was found.
4681 *
4682 * @see #putExtra(String, long)
4683 */
4684 public long getLongExtra(String name, long defaultValue) {
4685 return mExtras == null ? defaultValue :
4686 mExtras.getLong(name, defaultValue);
4687 }
4688
4689 /**
4690 * Retrieve extended data from the intent.
4691 *
4692 * @param name The name of the desired item.
4693 * @param defaultValue the value to be returned if no value of the desired
4694 * type is stored with the given name.
4695 *
4696 * @return the value of an item that previously added with putExtra(),
4697 * or the default value if no such item is present
4698 *
4699 * @see #putExtra(String, float)
4700 */
4701 public float getFloatExtra(String name, float defaultValue) {
4702 return mExtras == null ? defaultValue :
4703 mExtras.getFloat(name, defaultValue);
4704 }
4705
4706 /**
4707 * Retrieve extended data from the intent.
4708 *
4709 * @param name The name of the desired item.
4710 * @param defaultValue the value to be returned if no value of the desired
4711 * type is stored with the given name.
4712 *
4713 * @return the value of an item that previously added with putExtra()
4714 * or the default value if none was found.
4715 *
4716 * @see #putExtra(String, double)
4717 */
4718 public double getDoubleExtra(String name, double defaultValue) {
4719 return mExtras == null ? defaultValue :
4720 mExtras.getDouble(name, defaultValue);
4721 }
4722
4723 /**
4724 * Retrieve extended data from the intent.
4725 *
4726 * @param name The name of the desired item.
4727 *
4728 * @return the value of an item that previously added with putExtra()
4729 * or null if no String value was found.
4730 *
4731 * @see #putExtra(String, String)
4732 */
4733 public String getStringExtra(String name) {
4734 return mExtras == null ? null : mExtras.getString(name);
4735 }
4736
4737 /**
4738 * Retrieve extended data from the intent.
4739 *
4740 * @param name The name of the desired item.
4741 *
4742 * @return the value of an item that previously added with putExtra()
4743 * or null if no CharSequence value was found.
4744 *
4745 * @see #putExtra(String, CharSequence)
4746 */
4747 public CharSequence getCharSequenceExtra(String name) {
4748 return mExtras == null ? null : mExtras.getCharSequence(name);
4749 }
4750
4751 /**
4752 * Retrieve extended data from the intent.
4753 *
4754 * @param name The name of the desired item.
4755 *
4756 * @return the value of an item that previously added with putExtra()
4757 * or null if no Parcelable value was found.
4758 *
4759 * @see #putExtra(String, Parcelable)
4760 */
4761 public <T extends Parcelable> T getParcelableExtra(String name) {
4762 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4763 }
4764
4765 /**
4766 * Retrieve extended data from the intent.
4767 *
4768 * @param name The name of the desired item.
4769 *
4770 * @return the value of an item that previously added with putExtra()
4771 * or null if no Parcelable[] value was found.
4772 *
4773 * @see #putExtra(String, Parcelable[])
4774 */
4775 public Parcelable[] getParcelableArrayExtra(String name) {
4776 return mExtras == null ? null : mExtras.getParcelableArray(name);
4777 }
4778
4779 /**
4780 * Retrieve extended data from the intent.
4781 *
4782 * @param name The name of the desired item.
4783 *
4784 * @return the value of an item that previously added with putExtra()
4785 * or null if no ArrayList<Parcelable> value was found.
4786 *
4787 * @see #putParcelableArrayListExtra(String, ArrayList)
4788 */
4789 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4790 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4791 }
4792
4793 /**
4794 * Retrieve extended data from the intent.
4795 *
4796 * @param name The name of the desired item.
4797 *
4798 * @return the value of an item that previously added with putExtra()
4799 * or null if no Serializable value was found.
4800 *
4801 * @see #putExtra(String, Serializable)
4802 */
4803 public Serializable getSerializableExtra(String name) {
4804 return mExtras == null ? null : mExtras.getSerializable(name);
4805 }
4806
4807 /**
4808 * Retrieve extended data from the intent.
4809 *
4810 * @param name The name of the desired item.
4811 *
4812 * @return the value of an item that previously added with putExtra()
4813 * or null if no ArrayList<Integer> value was found.
4814 *
4815 * @see #putIntegerArrayListExtra(String, ArrayList)
4816 */
4817 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4818 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4819 }
4820
4821 /**
4822 * Retrieve extended data from the intent.
4823 *
4824 * @param name The name of the desired item.
4825 *
4826 * @return the value of an item that previously added with putExtra()
4827 * or null if no ArrayList<String> value was found.
4828 *
4829 * @see #putStringArrayListExtra(String, ArrayList)
4830 */
4831 public ArrayList<String> getStringArrayListExtra(String name) {
4832 return mExtras == null ? null : mExtras.getStringArrayList(name);
4833 }
4834
4835 /**
4836 * Retrieve extended data from the intent.
4837 *
4838 * @param name The name of the desired item.
4839 *
4840 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004841 * or null if no ArrayList<CharSequence> value was found.
4842 *
4843 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4844 */
4845 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4846 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4847 }
4848
4849 /**
4850 * Retrieve extended data from the intent.
4851 *
4852 * @param name The name of the desired item.
4853 *
4854 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004855 * or null if no boolean array value was found.
4856 *
4857 * @see #putExtra(String, boolean[])
4858 */
4859 public boolean[] getBooleanArrayExtra(String name) {
4860 return mExtras == null ? null : mExtras.getBooleanArray(name);
4861 }
4862
4863 /**
4864 * Retrieve extended data from the intent.
4865 *
4866 * @param name The name of the desired item.
4867 *
4868 * @return the value of an item that previously added with putExtra()
4869 * or null if no byte array value was found.
4870 *
4871 * @see #putExtra(String, byte[])
4872 */
4873 public byte[] getByteArrayExtra(String name) {
4874 return mExtras == null ? null : mExtras.getByteArray(name);
4875 }
4876
4877 /**
4878 * Retrieve extended data from the intent.
4879 *
4880 * @param name The name of the desired item.
4881 *
4882 * @return the value of an item that previously added with putExtra()
4883 * or null if no short array value was found.
4884 *
4885 * @see #putExtra(String, short[])
4886 */
4887 public short[] getShortArrayExtra(String name) {
4888 return mExtras == null ? null : mExtras.getShortArray(name);
4889 }
4890
4891 /**
4892 * Retrieve extended data from the intent.
4893 *
4894 * @param name The name of the desired item.
4895 *
4896 * @return the value of an item that previously added with putExtra()
4897 * or null if no char array value was found.
4898 *
4899 * @see #putExtra(String, char[])
4900 */
4901 public char[] getCharArrayExtra(String name) {
4902 return mExtras == null ? null : mExtras.getCharArray(name);
4903 }
4904
4905 /**
4906 * Retrieve extended data from the intent.
4907 *
4908 * @param name The name of the desired item.
4909 *
4910 * @return the value of an item that previously added with putExtra()
4911 * or null if no int array value was found.
4912 *
4913 * @see #putExtra(String, int[])
4914 */
4915 public int[] getIntArrayExtra(String name) {
4916 return mExtras == null ? null : mExtras.getIntArray(name);
4917 }
4918
4919 /**
4920 * Retrieve extended data from the intent.
4921 *
4922 * @param name The name of the desired item.
4923 *
4924 * @return the value of an item that previously added with putExtra()
4925 * or null if no long array value was found.
4926 *
4927 * @see #putExtra(String, long[])
4928 */
4929 public long[] getLongArrayExtra(String name) {
4930 return mExtras == null ? null : mExtras.getLongArray(name);
4931 }
4932
4933 /**
4934 * Retrieve extended data from the intent.
4935 *
4936 * @param name The name of the desired item.
4937 *
4938 * @return the value of an item that previously added with putExtra()
4939 * or null if no float array value was found.
4940 *
4941 * @see #putExtra(String, float[])
4942 */
4943 public float[] getFloatArrayExtra(String name) {
4944 return mExtras == null ? null : mExtras.getFloatArray(name);
4945 }
4946
4947 /**
4948 * Retrieve extended data from the intent.
4949 *
4950 * @param name The name of the desired item.
4951 *
4952 * @return the value of an item that previously added with putExtra()
4953 * or null if no double array value was found.
4954 *
4955 * @see #putExtra(String, double[])
4956 */
4957 public double[] getDoubleArrayExtra(String name) {
4958 return mExtras == null ? null : mExtras.getDoubleArray(name);
4959 }
4960
4961 /**
4962 * Retrieve extended data from the intent.
4963 *
4964 * @param name The name of the desired item.
4965 *
4966 * @return the value of an item that previously added with putExtra()
4967 * or null if no String array value was found.
4968 *
4969 * @see #putExtra(String, String[])
4970 */
4971 public String[] getStringArrayExtra(String name) {
4972 return mExtras == null ? null : mExtras.getStringArray(name);
4973 }
4974
4975 /**
4976 * Retrieve extended data from the intent.
4977 *
4978 * @param name The name of the desired item.
4979 *
4980 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004981 * or null if no CharSequence array value was found.
4982 *
4983 * @see #putExtra(String, CharSequence[])
4984 */
4985 public CharSequence[] getCharSequenceArrayExtra(String name) {
4986 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4987 }
4988
4989 /**
4990 * Retrieve extended data from the intent.
4991 *
4992 * @param name The name of the desired item.
4993 *
4994 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004995 * or null if no Bundle value was found.
4996 *
4997 * @see #putExtra(String, Bundle)
4998 */
4999 public Bundle getBundleExtra(String name) {
5000 return mExtras == null ? null : mExtras.getBundle(name);
5001 }
5002
5003 /**
5004 * Retrieve extended data from the intent.
5005 *
5006 * @param name The name of the desired item.
5007 *
5008 * @return the value of an item that previously added with putExtra()
5009 * or null if no IBinder value was found.
5010 *
5011 * @see #putExtra(String, IBinder)
5012 *
5013 * @deprecated
5014 * @hide
5015 */
5016 @Deprecated
5017 public IBinder getIBinderExtra(String name) {
5018 return mExtras == null ? null : mExtras.getIBinder(name);
5019 }
5020
5021 /**
5022 * Retrieve extended data from the intent.
5023 *
5024 * @param name The name of the desired item.
5025 * @param defaultValue The default value to return in case no item is
5026 * associated with the key 'name'
5027 *
5028 * @return the value of an item that previously added with putExtra()
5029 * or defaultValue if none was found.
5030 *
5031 * @see #putExtra
5032 *
5033 * @deprecated
5034 * @hide
5035 */
5036 @Deprecated
5037 public Object getExtra(String name, Object defaultValue) {
5038 Object result = defaultValue;
5039 if (mExtras != null) {
5040 Object result2 = mExtras.get(name);
5041 if (result2 != null) {
5042 result = result2;
5043 }
5044 }
5045
5046 return result;
5047 }
5048
5049 /**
5050 * Retrieves a map of extended data from the intent.
5051 *
5052 * @return the map of all extras previously added with putExtra(),
5053 * or null if none have been added.
5054 */
5055 public Bundle getExtras() {
5056 return (mExtras != null)
5057 ? new Bundle(mExtras)
5058 : null;
5059 }
5060
5061 /**
5062 * Retrieve any special flags associated with this intent. You will
5063 * normally just set them with {@link #setFlags} and let the system
5064 * take the appropriate action with them.
5065 *
5066 * @return int The currently set flags.
5067 *
5068 * @see #setFlags
5069 */
5070 public int getFlags() {
5071 return mFlags;
5072 }
5073
Dianne Hackborne7f97212011-02-24 14:40:20 -08005074 /** @hide */
5075 public boolean isExcludingStopped() {
5076 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5077 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5078 }
5079
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005080 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005081 * Retrieve the application package name this Intent is limited to. When
5082 * resolving an Intent, if non-null this limits the resolution to only
5083 * components in the given application package.
5084 *
5085 * @return The name of the application package for the Intent.
5086 *
5087 * @see #resolveActivity
5088 * @see #setPackage
5089 */
5090 public String getPackage() {
5091 return mPackage;
5092 }
5093
5094 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005095 * Retrieve the concrete component associated with the intent. When receiving
5096 * an intent, this is the component that was found to best handle it (that is,
5097 * yourself) and will always be non-null; in all other cases it will be
5098 * null unless explicitly set.
5099 *
5100 * @return The name of the application component to handle the intent.
5101 *
5102 * @see #resolveActivity
5103 * @see #setComponent
5104 */
5105 public ComponentName getComponent() {
5106 return mComponent;
5107 }
5108
5109 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005110 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5111 * used as a hint to the receiver for animations and the like. Null means that there
5112 * is no source bounds.
5113 */
5114 public Rect getSourceBounds() {
5115 return mSourceBounds;
5116 }
5117
5118 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005119 * Return the Activity component that should be used to handle this intent.
5120 * The appropriate component is determined based on the information in the
5121 * intent, evaluated as follows:
5122 *
5123 * <p>If {@link #getComponent} returns an explicit class, that is returned
5124 * without any further consideration.
5125 *
5126 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5127 * category to be considered.
5128 *
5129 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5130 * action.
5131 *
5132 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5133 * this type.
5134 *
5135 * <p>If {@link #addCategory} has added any categories, the activity must
5136 * handle ALL of the categories specified.
5137 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005138 * <p>If {@link #getPackage} is non-NULL, only activity components in
5139 * that application package will be considered.
5140 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005141 * <p>If there are no activities that satisfy all of these conditions, a
5142 * null string is returned.
5143 *
5144 * <p>If multiple activities are found to satisfy the intent, the one with
5145 * the highest priority will be used. If there are multiple activities
5146 * with the same priority, the system will either pick the best activity
5147 * based on user preference, or resolve to a system class that will allow
5148 * the user to pick an activity and forward from there.
5149 *
5150 * <p>This method is implemented simply by calling
5151 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5152 * true.</p>
5153 * <p> This API is called for you as part of starting an activity from an
5154 * intent. You do not normally need to call it yourself.</p>
5155 *
5156 * @param pm The package manager with which to resolve the Intent.
5157 *
5158 * @return Name of the component implementing an activity that can
5159 * display the intent.
5160 *
5161 * @see #setComponent
5162 * @see #getComponent
5163 * @see #resolveActivityInfo
5164 */
5165 public ComponentName resolveActivity(PackageManager pm) {
5166 if (mComponent != null) {
5167 return mComponent;
5168 }
5169
5170 ResolveInfo info = pm.resolveActivity(
5171 this, PackageManager.MATCH_DEFAULT_ONLY);
5172 if (info != null) {
5173 return new ComponentName(
5174 info.activityInfo.applicationInfo.packageName,
5175 info.activityInfo.name);
5176 }
5177
5178 return null;
5179 }
5180
5181 /**
5182 * Resolve the Intent into an {@link ActivityInfo}
5183 * describing the activity that should execute the intent. Resolution
5184 * follows the same rules as described for {@link #resolveActivity}, but
5185 * you get back the completely information about the resolved activity
5186 * instead of just its class name.
5187 *
5188 * @param pm The package manager with which to resolve the Intent.
5189 * @param flags Addition information to retrieve as per
5190 * {@link PackageManager#getActivityInfo(ComponentName, int)
5191 * PackageManager.getActivityInfo()}.
5192 *
5193 * @return PackageManager.ActivityInfo
5194 *
5195 * @see #resolveActivity
5196 */
5197 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5198 ActivityInfo ai = null;
5199 if (mComponent != null) {
5200 try {
5201 ai = pm.getActivityInfo(mComponent, flags);
5202 } catch (PackageManager.NameNotFoundException e) {
5203 // ignore
5204 }
5205 } else {
5206 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005207 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005208 if (info != null) {
5209 ai = info.activityInfo;
5210 }
5211 }
5212
5213 return ai;
5214 }
5215
5216 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005217 * Special function for use by the system to resolve service
5218 * intents to system apps. Throws an exception if there are
5219 * multiple potential matches to the Intent. Returns null if
5220 * there are no matches.
5221 * @hide
5222 */
5223 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5224 if (mComponent != null) {
5225 return mComponent;
5226 }
5227
5228 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5229 if (results == null) {
5230 return null;
5231 }
5232 ComponentName comp = null;
5233 for (int i=0; i<results.size(); i++) {
5234 ResolveInfo ri = results.get(i);
5235 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5236 continue;
5237 }
5238 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5239 ri.serviceInfo.name);
5240 if (comp != null) {
5241 throw new IllegalStateException("Multiple system services handle " + this
5242 + ": " + comp + ", " + foundComp);
5243 }
5244 comp = foundComp;
5245 }
5246 return comp;
5247 }
5248
5249 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005250 * Set the general action to be performed.
5251 *
5252 * @param action An action name, such as ACTION_VIEW. Application-specific
5253 * actions should be prefixed with the vendor's package name.
5254 *
5255 * @return Returns the same Intent object, for chaining multiple calls
5256 * into a single statement.
5257 *
5258 * @see #getAction
5259 */
5260 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005261 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005262 return this;
5263 }
5264
5265 /**
5266 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005267 * clears any type that was previously set by {@link #setType} or
5268 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005269 *
Nick Pellyccae4122012-01-09 14:12:58 -08005270 * <p><em>Note: scheme matching in the Android framework is
5271 * case-sensitive, unlike the formal RFC. As a result,
5272 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005273 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005274 * {@link #setDataAndNormalize}
5275 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005276 *
Nick Pellyccae4122012-01-09 14:12:58 -08005277 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005278 *
5279 * @return Returns the same Intent object, for chaining multiple calls
5280 * into a single statement.
5281 *
5282 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005283 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005284 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005285 */
5286 public Intent setData(Uri data) {
5287 mData = data;
5288 mType = null;
5289 return this;
5290 }
5291
5292 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005293 * Normalize and set the data this intent is operating on.
5294 *
5295 * <p>This method automatically clears any type that was
5296 * previously set (for example, by {@link #setType}).
5297 *
5298 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005299 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005300 * so really this is just a convenience method for
5301 * <pre>
5302 * setData(data.normalize())
5303 * </pre>
5304 *
5305 * @param data The Uri of the data this intent is now targeting.
5306 *
5307 * @return Returns the same Intent object, for chaining multiple calls
5308 * into a single statement.
5309 *
5310 * @see #getData
5311 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005312 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005313 */
5314 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005315 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005316 }
5317
5318 /**
5319 * Set an explicit MIME data type.
5320 *
5321 * <p>This is used to create intents that only specify a type and not data,
5322 * for example to indicate the type of data to return.
5323 *
5324 * <p>This method automatically clears any data that was
5325 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005326 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005327 * <p><em>Note: MIME type matching in the Android framework is
5328 * case-sensitive, unlike formal RFC MIME types. As a result,
5329 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005330 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5331 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005332 *
5333 * @param type The MIME type of the data being handled by this intent.
5334 *
5335 * @return Returns the same Intent object, for chaining multiple calls
5336 * into a single statement.
5337 *
5338 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005339 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005340 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005341 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005342 */
5343 public Intent setType(String type) {
5344 mData = null;
5345 mType = type;
5346 return this;
5347 }
5348
5349 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005350 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005351 *
Nick Pellyccae4122012-01-09 14:12:58 -08005352 * <p>This is used to create intents that only specify a type and not data,
5353 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005354 *
Nick Pellyccae4122012-01-09 14:12:58 -08005355 * <p>This method automatically clears any data that was
5356 * previously set (for example by {@link #setData}).
5357 *
5358 * <p>The MIME type is normalized using
5359 * {@link #normalizeMimeType} before it is set,
5360 * so really this is just a convenience method for
5361 * <pre>
5362 * setType(Intent.normalizeMimeType(type))
5363 * </pre>
5364 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005365 * @param type The MIME type of the data being handled by this intent.
5366 *
5367 * @return Returns the same Intent object, for chaining multiple calls
5368 * into a single statement.
5369 *
Nick Pellyccae4122012-01-09 14:12:58 -08005370 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005371 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005372 * @see #normalizeMimeType
5373 */
5374 public Intent setTypeAndNormalize(String type) {
5375 return setType(normalizeMimeType(type));
5376 }
5377
5378 /**
5379 * (Usually optional) Set the data for the intent along with an explicit
5380 * MIME data type. This method should very rarely be used -- it allows you
5381 * to override the MIME type that would ordinarily be inferred from the
5382 * data with your own type given here.
5383 *
5384 * <p><em>Note: MIME type and Uri scheme matching in the
5385 * Android framework is case-sensitive, unlike the formal RFC definitions.
5386 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005387 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005388 * {@link #setDataAndTypeAndNormalize}
5389 * to ensure that they are converted to lower case.</em>
5390 *
5391 * @param data The Uri of the data this intent is now targeting.
5392 * @param type The MIME type of the data being handled by this intent.
5393 *
5394 * @return Returns the same Intent object, for chaining multiple calls
5395 * into a single statement.
5396 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005397 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005398 * @see #setData
5399 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005400 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005401 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005402 */
5403 public Intent setDataAndType(Uri data, String type) {
5404 mData = data;
5405 mType = type;
5406 return this;
5407 }
5408
5409 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005410 * (Usually optional) Normalize and set both the data Uri and an explicit
5411 * MIME data type. This method should very rarely be used -- it allows you
5412 * to override the MIME type that would ordinarily be inferred from the
5413 * data with your own type given here.
5414 *
5415 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005416 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005417 * before they are set, so really this is just a convenience method for
5418 * <pre>
5419 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5420 * </pre>
5421 *
5422 * @param data The Uri of the data this intent is now targeting.
5423 * @param type The MIME type of the data being handled by this intent.
5424 *
5425 * @return Returns the same Intent object, for chaining multiple calls
5426 * into a single statement.
5427 *
5428 * @see #setType
5429 * @see #setData
5430 * @see #setDataAndType
5431 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005432 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005433 */
5434 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005435 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005436 }
5437
5438 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005439 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005440 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005441 * activities that provide <em>all</em> of the requested categories will be
5442 * used.
5443 *
5444 * @param category The desired category. This can be either one of the
5445 * predefined Intent categories, or a custom category in your own
5446 * namespace.
5447 *
5448 * @return Returns the same Intent object, for chaining multiple calls
5449 * into a single statement.
5450 *
5451 * @see #hasCategory
5452 * @see #removeCategory
5453 */
5454 public Intent addCategory(String category) {
5455 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005456 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005457 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005458 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005459 return this;
5460 }
5461
5462 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005463 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005464 *
5465 * @param category The category to remove.
5466 *
5467 * @see #addCategory
5468 */
5469 public void removeCategory(String category) {
5470 if (mCategories != null) {
5471 mCategories.remove(category);
5472 if (mCategories.size() == 0) {
5473 mCategories = null;
5474 }
5475 }
5476 }
5477
5478 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005479 * Set a selector for this Intent. This is a modification to the kinds of
5480 * things the Intent will match. If the selector is set, it will be used
5481 * when trying to find entities that can handle the Intent, instead of the
5482 * main contents of the Intent. This allows you build an Intent containing
5483 * a generic protocol while targeting it more specifically.
5484 *
5485 * <p>An example of where this may be used is with things like
5486 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5487 * Intent that will launch the Browser application. However, the correct
5488 * main entry point of an application is actually {@link #ACTION_MAIN}
5489 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5490 * used to specify the actual Activity to launch. If you launch the browser
5491 * with something different, undesired behavior may happen if the user has
5492 * previously or later launches it the normal way, since they do not match.
5493 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5494 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5495 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5496 *
5497 * <p>Setting a selector does not impact the behavior of
5498 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5499 * desired behavior of a selector -- it does not impact the base meaning
5500 * of the Intent, just what kinds of things will be matched against it
5501 * when determining who can handle it.</p>
5502 *
5503 * <p>You can not use both a selector and {@link #setPackage(String)} on
5504 * the same base Intent.</p>
5505 *
5506 * @param selector The desired selector Intent; set to null to not use
5507 * a special selector.
5508 */
5509 public void setSelector(Intent selector) {
5510 if (selector == this) {
5511 throw new IllegalArgumentException(
5512 "Intent being set as a selector of itself");
5513 }
5514 if (selector != null && mPackage != null) {
5515 throw new IllegalArgumentException(
5516 "Can't set selector when package name is already set");
5517 }
5518 mSelector = selector;
5519 }
5520
5521 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005522 * Set a {@link ClipData} associated with this Intent. This replaces any
5523 * previously set ClipData.
5524 *
5525 * <p>The ClipData in an intent is not used for Intent matching or other
5526 * such operations. Semantically it is like extras, used to transmit
5527 * additional data with the Intent. The main feature of using this over
5528 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5529 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5530 * items included in the clip data. This is useful, in particular, if
5531 * you want to transmit an Intent containing multiple <code>content:</code>
5532 * URIs for which the recipient may not have global permission to access the
5533 * content provider.
5534 *
5535 * <p>If the ClipData contains items that are themselves Intents, any
5536 * grant flags in those Intents will be ignored. Only the top-level flags
5537 * of the main Intent are respected, and will be applied to all Uri or
5538 * Intent items in the clip (or sub-items of the clip).
5539 *
5540 * <p>The MIME type, label, and icon in the ClipData object are not
5541 * directly used by Intent. Applications should generally rely on the
5542 * MIME type of the Intent itself, not what it may find in the ClipData.
5543 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005544 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005545 *
5546 * @param clip The new clip to set. May be null to clear the current clip.
5547 */
5548 public void setClipData(ClipData clip) {
5549 mClipData = clip;
5550 }
5551
5552 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005553 * Add extended data to the intent. The name must include a package
5554 * prefix, for example the app com.android.contacts would use names
5555 * like "com.android.contacts.ShowAll".
5556 *
5557 * @param name The name of the extra data, with package prefix.
5558 * @param value The boolean data value.
5559 *
5560 * @return Returns the same Intent object, for chaining multiple calls
5561 * into a single statement.
5562 *
5563 * @see #putExtras
5564 * @see #removeExtra
5565 * @see #getBooleanExtra(String, boolean)
5566 */
5567 public Intent putExtra(String name, boolean value) {
5568 if (mExtras == null) {
5569 mExtras = new Bundle();
5570 }
5571 mExtras.putBoolean(name, value);
5572 return this;
5573 }
5574
5575 /**
5576 * Add extended data to the intent. The name must include a package
5577 * prefix, for example the app com.android.contacts would use names
5578 * like "com.android.contacts.ShowAll".
5579 *
5580 * @param name The name of the extra data, with package prefix.
5581 * @param value The byte data value.
5582 *
5583 * @return Returns the same Intent object, for chaining multiple calls
5584 * into a single statement.
5585 *
5586 * @see #putExtras
5587 * @see #removeExtra
5588 * @see #getByteExtra(String, byte)
5589 */
5590 public Intent putExtra(String name, byte value) {
5591 if (mExtras == null) {
5592 mExtras = new Bundle();
5593 }
5594 mExtras.putByte(name, value);
5595 return this;
5596 }
5597
5598 /**
5599 * Add extended data to the intent. The name must include a package
5600 * prefix, for example the app com.android.contacts would use names
5601 * like "com.android.contacts.ShowAll".
5602 *
5603 * @param name The name of the extra data, with package prefix.
5604 * @param value The char data value.
5605 *
5606 * @return Returns the same Intent object, for chaining multiple calls
5607 * into a single statement.
5608 *
5609 * @see #putExtras
5610 * @see #removeExtra
5611 * @see #getCharExtra(String, char)
5612 */
5613 public Intent putExtra(String name, char value) {
5614 if (mExtras == null) {
5615 mExtras = new Bundle();
5616 }
5617 mExtras.putChar(name, value);
5618 return this;
5619 }
5620
5621 /**
5622 * Add extended data to the intent. The name must include a package
5623 * prefix, for example the app com.android.contacts would use names
5624 * like "com.android.contacts.ShowAll".
5625 *
5626 * @param name The name of the extra data, with package prefix.
5627 * @param value The short data value.
5628 *
5629 * @return Returns the same Intent object, for chaining multiple calls
5630 * into a single statement.
5631 *
5632 * @see #putExtras
5633 * @see #removeExtra
5634 * @see #getShortExtra(String, short)
5635 */
5636 public Intent putExtra(String name, short value) {
5637 if (mExtras == null) {
5638 mExtras = new Bundle();
5639 }
5640 mExtras.putShort(name, value);
5641 return this;
5642 }
5643
5644 /**
5645 * Add extended data to the intent. The name must include a package
5646 * prefix, for example the app com.android.contacts would use names
5647 * like "com.android.contacts.ShowAll".
5648 *
5649 * @param name The name of the extra data, with package prefix.
5650 * @param value The integer data value.
5651 *
5652 * @return Returns the same Intent object, for chaining multiple calls
5653 * into a single statement.
5654 *
5655 * @see #putExtras
5656 * @see #removeExtra
5657 * @see #getIntExtra(String, int)
5658 */
5659 public Intent putExtra(String name, int value) {
5660 if (mExtras == null) {
5661 mExtras = new Bundle();
5662 }
5663 mExtras.putInt(name, value);
5664 return this;
5665 }
5666
5667 /**
5668 * Add extended data to the intent. The name must include a package
5669 * prefix, for example the app com.android.contacts would use names
5670 * like "com.android.contacts.ShowAll".
5671 *
5672 * @param name The name of the extra data, with package prefix.
5673 * @param value The long data value.
5674 *
5675 * @return Returns the same Intent object, for chaining multiple calls
5676 * into a single statement.
5677 *
5678 * @see #putExtras
5679 * @see #removeExtra
5680 * @see #getLongExtra(String, long)
5681 */
5682 public Intent putExtra(String name, long value) {
5683 if (mExtras == null) {
5684 mExtras = new Bundle();
5685 }
5686 mExtras.putLong(name, value);
5687 return this;
5688 }
5689
5690 /**
5691 * Add extended data to the intent. The name must include a package
5692 * prefix, for example the app com.android.contacts would use names
5693 * like "com.android.contacts.ShowAll".
5694 *
5695 * @param name The name of the extra data, with package prefix.
5696 * @param value The float data value.
5697 *
5698 * @return Returns the same Intent object, for chaining multiple calls
5699 * into a single statement.
5700 *
5701 * @see #putExtras
5702 * @see #removeExtra
5703 * @see #getFloatExtra(String, float)
5704 */
5705 public Intent putExtra(String name, float value) {
5706 if (mExtras == null) {
5707 mExtras = new Bundle();
5708 }
5709 mExtras.putFloat(name, value);
5710 return this;
5711 }
5712
5713 /**
5714 * Add extended data to the intent. The name must include a package
5715 * prefix, for example the app com.android.contacts would use names
5716 * like "com.android.contacts.ShowAll".
5717 *
5718 * @param name The name of the extra data, with package prefix.
5719 * @param value The double data value.
5720 *
5721 * @return Returns the same Intent object, for chaining multiple calls
5722 * into a single statement.
5723 *
5724 * @see #putExtras
5725 * @see #removeExtra
5726 * @see #getDoubleExtra(String, double)
5727 */
5728 public Intent putExtra(String name, double value) {
5729 if (mExtras == null) {
5730 mExtras = new Bundle();
5731 }
5732 mExtras.putDouble(name, value);
5733 return this;
5734 }
5735
5736 /**
5737 * Add extended data to the intent. The name must include a package
5738 * prefix, for example the app com.android.contacts would use names
5739 * like "com.android.contacts.ShowAll".
5740 *
5741 * @param name The name of the extra data, with package prefix.
5742 * @param value The String data value.
5743 *
5744 * @return Returns the same Intent object, for chaining multiple calls
5745 * into a single statement.
5746 *
5747 * @see #putExtras
5748 * @see #removeExtra
5749 * @see #getStringExtra(String)
5750 */
5751 public Intent putExtra(String name, String value) {
5752 if (mExtras == null) {
5753 mExtras = new Bundle();
5754 }
5755 mExtras.putString(name, value);
5756 return this;
5757 }
5758
5759 /**
5760 * Add extended data to the intent. The name must include a package
5761 * prefix, for example the app com.android.contacts would use names
5762 * like "com.android.contacts.ShowAll".
5763 *
5764 * @param name The name of the extra data, with package prefix.
5765 * @param value The CharSequence data value.
5766 *
5767 * @return Returns the same Intent object, for chaining multiple calls
5768 * into a single statement.
5769 *
5770 * @see #putExtras
5771 * @see #removeExtra
5772 * @see #getCharSequenceExtra(String)
5773 */
5774 public Intent putExtra(String name, CharSequence value) {
5775 if (mExtras == null) {
5776 mExtras = new Bundle();
5777 }
5778 mExtras.putCharSequence(name, value);
5779 return this;
5780 }
5781
5782 /**
5783 * Add extended data to the intent. The name must include a package
5784 * prefix, for example the app com.android.contacts would use names
5785 * like "com.android.contacts.ShowAll".
5786 *
5787 * @param name The name of the extra data, with package prefix.
5788 * @param value The Parcelable data value.
5789 *
5790 * @return Returns the same Intent object, for chaining multiple calls
5791 * into a single statement.
5792 *
5793 * @see #putExtras
5794 * @see #removeExtra
5795 * @see #getParcelableExtra(String)
5796 */
5797 public Intent putExtra(String name, Parcelable value) {
5798 if (mExtras == null) {
5799 mExtras = new Bundle();
5800 }
5801 mExtras.putParcelable(name, value);
5802 return this;
5803 }
5804
5805 /**
5806 * Add extended data to the intent. The name must include a package
5807 * prefix, for example the app com.android.contacts would use names
5808 * like "com.android.contacts.ShowAll".
5809 *
5810 * @param name The name of the extra data, with package prefix.
5811 * @param value The Parcelable[] data value.
5812 *
5813 * @return Returns the same Intent object, for chaining multiple calls
5814 * into a single statement.
5815 *
5816 * @see #putExtras
5817 * @see #removeExtra
5818 * @see #getParcelableArrayExtra(String)
5819 */
5820 public Intent putExtra(String name, Parcelable[] value) {
5821 if (mExtras == null) {
5822 mExtras = new Bundle();
5823 }
5824 mExtras.putParcelableArray(name, value);
5825 return this;
5826 }
5827
5828 /**
5829 * Add extended data to the intent. The name must include a package
5830 * prefix, for example the app com.android.contacts would use names
5831 * like "com.android.contacts.ShowAll".
5832 *
5833 * @param name The name of the extra data, with package prefix.
5834 * @param value The ArrayList<Parcelable> data value.
5835 *
5836 * @return Returns the same Intent object, for chaining multiple calls
5837 * into a single statement.
5838 *
5839 * @see #putExtras
5840 * @see #removeExtra
5841 * @see #getParcelableArrayListExtra(String)
5842 */
5843 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5844 if (mExtras == null) {
5845 mExtras = new Bundle();
5846 }
5847 mExtras.putParcelableArrayList(name, value);
5848 return this;
5849 }
5850
5851 /**
5852 * Add extended data to the intent. The name must include a package
5853 * prefix, for example the app com.android.contacts would use names
5854 * like "com.android.contacts.ShowAll".
5855 *
5856 * @param name The name of the extra data, with package prefix.
5857 * @param value The ArrayList<Integer> data value.
5858 *
5859 * @return Returns the same Intent object, for chaining multiple calls
5860 * into a single statement.
5861 *
5862 * @see #putExtras
5863 * @see #removeExtra
5864 * @see #getIntegerArrayListExtra(String)
5865 */
5866 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5867 if (mExtras == null) {
5868 mExtras = new Bundle();
5869 }
5870 mExtras.putIntegerArrayList(name, value);
5871 return this;
5872 }
5873
5874 /**
5875 * Add extended data to the intent. The name must include a package
5876 * prefix, for example the app com.android.contacts would use names
5877 * like "com.android.contacts.ShowAll".
5878 *
5879 * @param name The name of the extra data, with package prefix.
5880 * @param value The ArrayList<String> data value.
5881 *
5882 * @return Returns the same Intent object, for chaining multiple calls
5883 * into a single statement.
5884 *
5885 * @see #putExtras
5886 * @see #removeExtra
5887 * @see #getStringArrayListExtra(String)
5888 */
5889 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5890 if (mExtras == null) {
5891 mExtras = new Bundle();
5892 }
5893 mExtras.putStringArrayList(name, value);
5894 return this;
5895 }
5896
5897 /**
5898 * Add extended data to the intent. The name must include a package
5899 * prefix, for example the app com.android.contacts would use names
5900 * like "com.android.contacts.ShowAll".
5901 *
5902 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005903 * @param value The ArrayList<CharSequence> data value.
5904 *
5905 * @return Returns the same Intent object, for chaining multiple calls
5906 * into a single statement.
5907 *
5908 * @see #putExtras
5909 * @see #removeExtra
5910 * @see #getCharSequenceArrayListExtra(String)
5911 */
5912 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5913 if (mExtras == null) {
5914 mExtras = new Bundle();
5915 }
5916 mExtras.putCharSequenceArrayList(name, value);
5917 return this;
5918 }
5919
5920 /**
5921 * Add extended data to the intent. The name must include a package
5922 * prefix, for example the app com.android.contacts would use names
5923 * like "com.android.contacts.ShowAll".
5924 *
5925 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005926 * @param value The Serializable data value.
5927 *
5928 * @return Returns the same Intent object, for chaining multiple calls
5929 * into a single statement.
5930 *
5931 * @see #putExtras
5932 * @see #removeExtra
5933 * @see #getSerializableExtra(String)
5934 */
5935 public Intent putExtra(String name, Serializable value) {
5936 if (mExtras == null) {
5937 mExtras = new Bundle();
5938 }
5939 mExtras.putSerializable(name, value);
5940 return this;
5941 }
5942
5943 /**
5944 * Add extended data to the intent. The name must include a package
5945 * prefix, for example the app com.android.contacts would use names
5946 * like "com.android.contacts.ShowAll".
5947 *
5948 * @param name The name of the extra data, with package prefix.
5949 * @param value The boolean array data value.
5950 *
5951 * @return Returns the same Intent object, for chaining multiple calls
5952 * into a single statement.
5953 *
5954 * @see #putExtras
5955 * @see #removeExtra
5956 * @see #getBooleanArrayExtra(String)
5957 */
5958 public Intent putExtra(String name, boolean[] value) {
5959 if (mExtras == null) {
5960 mExtras = new Bundle();
5961 }
5962 mExtras.putBooleanArray(name, value);
5963 return this;
5964 }
5965
5966 /**
5967 * Add extended data to the intent. The name must include a package
5968 * prefix, for example the app com.android.contacts would use names
5969 * like "com.android.contacts.ShowAll".
5970 *
5971 * @param name The name of the extra data, with package prefix.
5972 * @param value The byte array data value.
5973 *
5974 * @return Returns the same Intent object, for chaining multiple calls
5975 * into a single statement.
5976 *
5977 * @see #putExtras
5978 * @see #removeExtra
5979 * @see #getByteArrayExtra(String)
5980 */
5981 public Intent putExtra(String name, byte[] value) {
5982 if (mExtras == null) {
5983 mExtras = new Bundle();
5984 }
5985 mExtras.putByteArray(name, value);
5986 return this;
5987 }
5988
5989 /**
5990 * Add extended data to the intent. The name must include a package
5991 * prefix, for example the app com.android.contacts would use names
5992 * like "com.android.contacts.ShowAll".
5993 *
5994 * @param name The name of the extra data, with package prefix.
5995 * @param value The short array data value.
5996 *
5997 * @return Returns the same Intent object, for chaining multiple calls
5998 * into a single statement.
5999 *
6000 * @see #putExtras
6001 * @see #removeExtra
6002 * @see #getShortArrayExtra(String)
6003 */
6004 public Intent putExtra(String name, short[] value) {
6005 if (mExtras == null) {
6006 mExtras = new Bundle();
6007 }
6008 mExtras.putShortArray(name, value);
6009 return this;
6010 }
6011
6012 /**
6013 * Add extended data to the intent. The name must include a package
6014 * prefix, for example the app com.android.contacts would use names
6015 * like "com.android.contacts.ShowAll".
6016 *
6017 * @param name The name of the extra data, with package prefix.
6018 * @param value The char array data value.
6019 *
6020 * @return Returns the same Intent object, for chaining multiple calls
6021 * into a single statement.
6022 *
6023 * @see #putExtras
6024 * @see #removeExtra
6025 * @see #getCharArrayExtra(String)
6026 */
6027 public Intent putExtra(String name, char[] value) {
6028 if (mExtras == null) {
6029 mExtras = new Bundle();
6030 }
6031 mExtras.putCharArray(name, value);
6032 return this;
6033 }
6034
6035 /**
6036 * Add extended data to the intent. The name must include a package
6037 * prefix, for example the app com.android.contacts would use names
6038 * like "com.android.contacts.ShowAll".
6039 *
6040 * @param name The name of the extra data, with package prefix.
6041 * @param value The int array data value.
6042 *
6043 * @return Returns the same Intent object, for chaining multiple calls
6044 * into a single statement.
6045 *
6046 * @see #putExtras
6047 * @see #removeExtra
6048 * @see #getIntArrayExtra(String)
6049 */
6050 public Intent putExtra(String name, int[] value) {
6051 if (mExtras == null) {
6052 mExtras = new Bundle();
6053 }
6054 mExtras.putIntArray(name, value);
6055 return this;
6056 }
6057
6058 /**
6059 * Add extended data to the intent. The name must include a package
6060 * prefix, for example the app com.android.contacts would use names
6061 * like "com.android.contacts.ShowAll".
6062 *
6063 * @param name The name of the extra data, with package prefix.
6064 * @param value The byte array data value.
6065 *
6066 * @return Returns the same Intent object, for chaining multiple calls
6067 * into a single statement.
6068 *
6069 * @see #putExtras
6070 * @see #removeExtra
6071 * @see #getLongArrayExtra(String)
6072 */
6073 public Intent putExtra(String name, long[] value) {
6074 if (mExtras == null) {
6075 mExtras = new Bundle();
6076 }
6077 mExtras.putLongArray(name, value);
6078 return this;
6079 }
6080
6081 /**
6082 * Add extended data to the intent. The name must include a package
6083 * prefix, for example the app com.android.contacts would use names
6084 * like "com.android.contacts.ShowAll".
6085 *
6086 * @param name The name of the extra data, with package prefix.
6087 * @param value The float array data value.
6088 *
6089 * @return Returns the same Intent object, for chaining multiple calls
6090 * into a single statement.
6091 *
6092 * @see #putExtras
6093 * @see #removeExtra
6094 * @see #getFloatArrayExtra(String)
6095 */
6096 public Intent putExtra(String name, float[] value) {
6097 if (mExtras == null) {
6098 mExtras = new Bundle();
6099 }
6100 mExtras.putFloatArray(name, value);
6101 return this;
6102 }
6103
6104 /**
6105 * Add extended data to the intent. The name must include a package
6106 * prefix, for example the app com.android.contacts would use names
6107 * like "com.android.contacts.ShowAll".
6108 *
6109 * @param name The name of the extra data, with package prefix.
6110 * @param value The double array data value.
6111 *
6112 * @return Returns the same Intent object, for chaining multiple calls
6113 * into a single statement.
6114 *
6115 * @see #putExtras
6116 * @see #removeExtra
6117 * @see #getDoubleArrayExtra(String)
6118 */
6119 public Intent putExtra(String name, double[] value) {
6120 if (mExtras == null) {
6121 mExtras = new Bundle();
6122 }
6123 mExtras.putDoubleArray(name, value);
6124 return this;
6125 }
6126
6127 /**
6128 * Add extended data to the intent. The name must include a package
6129 * prefix, for example the app com.android.contacts would use names
6130 * like "com.android.contacts.ShowAll".
6131 *
6132 * @param name The name of the extra data, with package prefix.
6133 * @param value The String array data value.
6134 *
6135 * @return Returns the same Intent object, for chaining multiple calls
6136 * into a single statement.
6137 *
6138 * @see #putExtras
6139 * @see #removeExtra
6140 * @see #getStringArrayExtra(String)
6141 */
6142 public Intent putExtra(String name, String[] value) {
6143 if (mExtras == null) {
6144 mExtras = new Bundle();
6145 }
6146 mExtras.putStringArray(name, value);
6147 return this;
6148 }
6149
6150 /**
6151 * Add extended data to the intent. The name must include a package
6152 * prefix, for example the app com.android.contacts would use names
6153 * like "com.android.contacts.ShowAll".
6154 *
6155 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006156 * @param value The CharSequence array data value.
6157 *
6158 * @return Returns the same Intent object, for chaining multiple calls
6159 * into a single statement.
6160 *
6161 * @see #putExtras
6162 * @see #removeExtra
6163 * @see #getCharSequenceArrayExtra(String)
6164 */
6165 public Intent putExtra(String name, CharSequence[] value) {
6166 if (mExtras == null) {
6167 mExtras = new Bundle();
6168 }
6169 mExtras.putCharSequenceArray(name, value);
6170 return this;
6171 }
6172
6173 /**
6174 * Add extended data to the intent. The name must include a package
6175 * prefix, for example the app com.android.contacts would use names
6176 * like "com.android.contacts.ShowAll".
6177 *
6178 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006179 * @param value The Bundle data value.
6180 *
6181 * @return Returns the same Intent object, for chaining multiple calls
6182 * into a single statement.
6183 *
6184 * @see #putExtras
6185 * @see #removeExtra
6186 * @see #getBundleExtra(String)
6187 */
6188 public Intent putExtra(String name, Bundle value) {
6189 if (mExtras == null) {
6190 mExtras = new Bundle();
6191 }
6192 mExtras.putBundle(name, value);
6193 return this;
6194 }
6195
6196 /**
6197 * Add extended data to the intent. The name must include a package
6198 * prefix, for example the app com.android.contacts would use names
6199 * like "com.android.contacts.ShowAll".
6200 *
6201 * @param name The name of the extra data, with package prefix.
6202 * @param value The IBinder data value.
6203 *
6204 * @return Returns the same Intent object, for chaining multiple calls
6205 * into a single statement.
6206 *
6207 * @see #putExtras
6208 * @see #removeExtra
6209 * @see #getIBinderExtra(String)
6210 *
6211 * @deprecated
6212 * @hide
6213 */
6214 @Deprecated
6215 public Intent putExtra(String name, IBinder value) {
6216 if (mExtras == null) {
6217 mExtras = new Bundle();
6218 }
6219 mExtras.putIBinder(name, value);
6220 return this;
6221 }
6222
6223 /**
6224 * Copy all extras in 'src' in to this intent.
6225 *
6226 * @param src Contains the extras to copy.
6227 *
6228 * @see #putExtra
6229 */
6230 public Intent putExtras(Intent src) {
6231 if (src.mExtras != null) {
6232 if (mExtras == null) {
6233 mExtras = new Bundle(src.mExtras);
6234 } else {
6235 mExtras.putAll(src.mExtras);
6236 }
6237 }
6238 return this;
6239 }
6240
6241 /**
6242 * Add a set of extended data to the intent. The keys must include a package
6243 * prefix, for example the app com.android.contacts would use names
6244 * like "com.android.contacts.ShowAll".
6245 *
6246 * @param extras The Bundle of extras to add to this intent.
6247 *
6248 * @see #putExtra
6249 * @see #removeExtra
6250 */
6251 public Intent putExtras(Bundle extras) {
6252 if (mExtras == null) {
6253 mExtras = new Bundle();
6254 }
6255 mExtras.putAll(extras);
6256 return this;
6257 }
6258
6259 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006260 * Completely replace the extras in the Intent with the extras in the
6261 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006262 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006263 * @param src The exact extras contained in this Intent are copied
6264 * into the target intent, replacing any that were previously there.
6265 */
6266 public Intent replaceExtras(Intent src) {
6267 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6268 return this;
6269 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006270
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006271 /**
6272 * Completely replace the extras in the Intent with the given Bundle of
6273 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006274 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006275 * @param extras The new set of extras in the Intent, or null to erase
6276 * all extras.
6277 */
6278 public Intent replaceExtras(Bundle extras) {
6279 mExtras = extras != null ? new Bundle(extras) : null;
6280 return this;
6281 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006282
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006283 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006284 * Remove extended data from the intent.
6285 *
6286 * @see #putExtra
6287 */
6288 public void removeExtra(String name) {
6289 if (mExtras != null) {
6290 mExtras.remove(name);
6291 if (mExtras.size() == 0) {
6292 mExtras = null;
6293 }
6294 }
6295 }
6296
6297 /**
6298 * Set special flags controlling how this intent is handled. Most values
6299 * here depend on the type of component being executed by the Intent,
6300 * specifically the FLAG_ACTIVITY_* flags are all for use with
6301 * {@link Context#startActivity Context.startActivity()} and the
6302 * FLAG_RECEIVER_* flags are all for use with
6303 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6304 *
Scott Main7aee61f2011-02-08 11:25:01 -08006305 * <p>See the
6306 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6307 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006308 * the behavior of your application.
6309 *
6310 * @param flags The desired flags.
6311 *
6312 * @return Returns the same Intent object, for chaining multiple calls
6313 * into a single statement.
6314 *
6315 * @see #getFlags
6316 * @see #addFlags
6317 *
6318 * @see #FLAG_GRANT_READ_URI_PERMISSION
6319 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6320 * @see #FLAG_DEBUG_LOG_RESOLUTION
6321 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006322 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006323 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006324 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006325 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006326 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6327 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006328 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006329 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006330 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006331 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006332 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006333 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006334 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006335 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6336 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006337 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006338 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006339 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006340 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6341 */
6342 public Intent setFlags(int flags) {
6343 mFlags = flags;
6344 return this;
6345 }
6346
6347 /**
6348 * Add additional flags to the intent (or with existing flags
6349 * value).
6350 *
6351 * @param flags The new flags to set.
6352 *
6353 * @return Returns the same Intent object, for chaining multiple calls
6354 * into a single statement.
6355 *
6356 * @see #setFlags
6357 */
6358 public Intent addFlags(int flags) {
6359 mFlags |= flags;
6360 return this;
6361 }
6362
6363 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006364 * (Usually optional) Set an explicit application package name that limits
6365 * the components this Intent will resolve to. If left to the default
6366 * value of null, all components in all applications will considered.
6367 * If non-null, the Intent can only match the components in the given
6368 * application package.
6369 *
6370 * @param packageName The name of the application package to handle the
6371 * intent, or null to allow any application package.
6372 *
6373 * @return Returns the same Intent object, for chaining multiple calls
6374 * into a single statement.
6375 *
6376 * @see #getPackage
6377 * @see #resolveActivity
6378 */
6379 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006380 if (packageName != null && mSelector != null) {
6381 throw new IllegalArgumentException(
6382 "Can't set package name when selector is already set");
6383 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006384 mPackage = packageName;
6385 return this;
6386 }
6387
6388 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006389 * (Usually optional) Explicitly set the component to handle the intent.
6390 * If left with the default value of null, the system will determine the
6391 * appropriate class to use based on the other fields (action, data,
6392 * type, categories) in the Intent. If this class is defined, the
6393 * specified class will always be used regardless of the other fields. You
6394 * should only set this value when you know you absolutely want a specific
6395 * class to be used; otherwise it is better to let the system find the
6396 * appropriate class so that you will respect the installed applications
6397 * and user preferences.
6398 *
6399 * @param component The name of the application component to handle the
6400 * intent, or null to let the system find one for you.
6401 *
6402 * @return Returns the same Intent object, for chaining multiple calls
6403 * into a single statement.
6404 *
6405 * @see #setClass
6406 * @see #setClassName(Context, String)
6407 * @see #setClassName(String, String)
6408 * @see #getComponent
6409 * @see #resolveActivity
6410 */
6411 public Intent setComponent(ComponentName component) {
6412 mComponent = component;
6413 return this;
6414 }
6415
6416 /**
6417 * Convenience for calling {@link #setComponent} with an
6418 * explicit class name.
6419 *
6420 * @param packageContext A Context of the application package implementing
6421 * this class.
6422 * @param className The name of a class inside of the application package
6423 * that will be used as the component for this Intent.
6424 *
6425 * @return Returns the same Intent object, for chaining multiple calls
6426 * into a single statement.
6427 *
6428 * @see #setComponent
6429 * @see #setClass
6430 */
6431 public Intent setClassName(Context packageContext, String className) {
6432 mComponent = new ComponentName(packageContext, className);
6433 return this;
6434 }
6435
6436 /**
6437 * Convenience for calling {@link #setComponent} with an
6438 * explicit application package name and class name.
6439 *
6440 * @param packageName The name of the package implementing the desired
6441 * component.
6442 * @param className The name of a class inside of the application package
6443 * that will be used as the component for this Intent.
6444 *
6445 * @return Returns the same Intent object, for chaining multiple calls
6446 * into a single statement.
6447 *
6448 * @see #setComponent
6449 * @see #setClass
6450 */
6451 public Intent setClassName(String packageName, String className) {
6452 mComponent = new ComponentName(packageName, className);
6453 return this;
6454 }
6455
6456 /**
6457 * Convenience for calling {@link #setComponent(ComponentName)} with the
6458 * name returned by a {@link Class} object.
6459 *
6460 * @param packageContext A Context of the application package implementing
6461 * this class.
6462 * @param cls The class name to set, equivalent to
6463 * <code>setClassName(context, cls.getName())</code>.
6464 *
6465 * @return Returns the same Intent object, for chaining multiple calls
6466 * into a single statement.
6467 *
6468 * @see #setComponent
6469 */
6470 public Intent setClass(Context packageContext, Class<?> cls) {
6471 mComponent = new ComponentName(packageContext, cls);
6472 return this;
6473 }
6474
6475 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006476 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6477 * used as a hint to the receiver for animations and the like. Null means that there
6478 * is no source bounds.
6479 */
6480 public void setSourceBounds(Rect r) {
6481 if (r != null) {
6482 mSourceBounds = new Rect(r);
6483 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006484 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006485 }
6486 }
6487
Tor Norbyed9273d62013-05-30 15:59:53 -07006488 /** @hide */
6489 @IntDef(flag = true,
6490 value = {
6491 FILL_IN_ACTION,
6492 FILL_IN_DATA,
6493 FILL_IN_CATEGORIES,
6494 FILL_IN_COMPONENT,
6495 FILL_IN_PACKAGE,
6496 FILL_IN_SOURCE_BOUNDS,
6497 FILL_IN_SELECTOR,
6498 FILL_IN_CLIP_DATA
6499 })
6500 @Retention(RetentionPolicy.SOURCE)
6501 public @interface FillInFlags {}
6502
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006503 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006504 * Use with {@link #fillIn} to allow the current action value to be
6505 * overwritten, even if it is already set.
6506 */
6507 public static final int FILL_IN_ACTION = 1<<0;
6508
6509 /**
6510 * Use with {@link #fillIn} to allow the current data or type value
6511 * overwritten, even if it is already set.
6512 */
6513 public static final int FILL_IN_DATA = 1<<1;
6514
6515 /**
6516 * Use with {@link #fillIn} to allow the current categories to be
6517 * overwritten, even if they are already set.
6518 */
6519 public static final int FILL_IN_CATEGORIES = 1<<2;
6520
6521 /**
6522 * Use with {@link #fillIn} to allow the current component value to be
6523 * overwritten, even if it is already set.
6524 */
6525 public static final int FILL_IN_COMPONENT = 1<<3;
6526
6527 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006528 * Use with {@link #fillIn} to allow the current package value to be
6529 * overwritten, even if it is already set.
6530 */
6531 public static final int FILL_IN_PACKAGE = 1<<4;
6532
6533 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006534 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006535 * overwritten, even if it is already set.
6536 */
6537 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6538
6539 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006540 * Use with {@link #fillIn} to allow the current selector to be
6541 * overwritten, even if it is already set.
6542 */
6543 public static final int FILL_IN_SELECTOR = 1<<6;
6544
6545 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006546 * Use with {@link #fillIn} to allow the current ClipData to be
6547 * overwritten, even if it is already set.
6548 */
6549 public static final int FILL_IN_CLIP_DATA = 1<<7;
6550
6551 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006552 * Copy the contents of <var>other</var> in to this object, but only
6553 * where fields are not defined by this object. For purposes of a field
6554 * being defined, the following pieces of data in the Intent are
6555 * considered to be separate fields:
6556 *
6557 * <ul>
6558 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006559 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006560 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6561 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006562 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006563 * <li> component, as set by {@link #setComponent(ComponentName)} or
6564 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006565 * <li> source bounds, as set by {@link #setSourceBounds}.
6566 * <li> selector, as set by {@link #setSelector(Intent)}.
6567 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006568 * <li> each top-level name in the associated extras.
6569 * </ul>
6570 *
6571 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006572 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006573 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6574 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6575 * the restriction where the corresponding field will not be replaced if
6576 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006577 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006578 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6579 * is explicitly specified. The selector will only be copied if
6580 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006581 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006582 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6583 * and Intent B with {action="gotit", data-type="some/thing",
6584 * categories="one","two"}.
6585 *
6586 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6587 * containing: {action="gotit", data-type="some/thing",
6588 * categories="bar"}.
6589 *
6590 * @param other Another Intent whose values are to be used to fill in
6591 * the current one.
6592 * @param flags Options to control which fields can be filled in.
6593 *
6594 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006595 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006596 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6597 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6598 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006599 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006600 @FillInFlags
6601 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006602 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006603 if (other.mAction != null
6604 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006605 mAction = other.mAction;
6606 changes |= FILL_IN_ACTION;
6607 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006608 if ((other.mData != null || other.mType != null)
6609 && ((mData == null && mType == null)
6610 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006611 mData = other.mData;
6612 mType = other.mType;
6613 changes |= FILL_IN_DATA;
6614 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006615 if (other.mCategories != null
6616 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006617 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006618 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006619 }
6620 changes |= FILL_IN_CATEGORIES;
6621 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006622 if (other.mPackage != null
6623 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006624 // Only do this if mSelector is not set.
6625 if (mSelector == null) {
6626 mPackage = other.mPackage;
6627 changes |= FILL_IN_PACKAGE;
6628 }
6629 }
6630 // Selector is special: it can only be set if explicitly allowed,
6631 // for the same reason as the component name.
6632 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6633 if (mPackage == null) {
6634 mSelector = new Intent(other.mSelector);
6635 mPackage = null;
6636 changes |= FILL_IN_SELECTOR;
6637 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006638 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006639 if (other.mClipData != null
6640 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6641 mClipData = other.mClipData;
6642 changes |= FILL_IN_CLIP_DATA;
6643 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006644 // Component is special: it can -only- be set if explicitly allowed,
6645 // since otherwise the sender could force the intent somewhere the
6646 // originator didn't intend.
6647 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006648 mComponent = other.mComponent;
6649 changes |= FILL_IN_COMPONENT;
6650 }
6651 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006652 if (other.mSourceBounds != null
6653 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6654 mSourceBounds = new Rect(other.mSourceBounds);
6655 changes |= FILL_IN_SOURCE_BOUNDS;
6656 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006657 if (mExtras == null) {
6658 if (other.mExtras != null) {
6659 mExtras = new Bundle(other.mExtras);
6660 }
6661 } else if (other.mExtras != null) {
6662 try {
6663 Bundle newb = new Bundle(other.mExtras);
6664 newb.putAll(mExtras);
6665 mExtras = newb;
6666 } catch (RuntimeException e) {
6667 // Modifying the extras can cause us to unparcel the contents
6668 // of the bundle, and if we do this in the system process that
6669 // may fail. We really should handle this (i.e., the Bundle
6670 // impl shouldn't be on top of a plain map), but for now just
6671 // ignore it and keep the original contents. :(
6672 Log.w("Intent", "Failure filling in extras", e);
6673 }
6674 }
6675 return changes;
6676 }
6677
6678 /**
6679 * Wrapper class holding an Intent and implementing comparisons on it for
6680 * the purpose of filtering. The class implements its
6681 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6682 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6683 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6684 * on the wrapped Intent.
6685 */
6686 public static final class FilterComparison {
6687 private final Intent mIntent;
6688 private final int mHashCode;
6689
6690 public FilterComparison(Intent intent) {
6691 mIntent = intent;
6692 mHashCode = intent.filterHashCode();
6693 }
6694
6695 /**
6696 * Return the Intent that this FilterComparison represents.
6697 * @return Returns the Intent held by the FilterComparison. Do
6698 * not modify!
6699 */
6700 public Intent getIntent() {
6701 return mIntent;
6702 }
6703
6704 @Override
6705 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006706 if (obj instanceof FilterComparison) {
6707 Intent other = ((FilterComparison)obj).mIntent;
6708 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006709 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006710 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006711 }
6712
6713 @Override
6714 public int hashCode() {
6715 return mHashCode;
6716 }
6717 }
6718
6719 /**
6720 * Determine if two intents are the same for the purposes of intent
6721 * resolution (filtering). That is, if their action, data, type,
6722 * class, and categories are the same. This does <em>not</em> compare
6723 * any extra data included in the intents.
6724 *
6725 * @param other The other Intent to compare against.
6726 *
6727 * @return Returns true if action, data, type, class, and categories
6728 * are the same.
6729 */
6730 public boolean filterEquals(Intent other) {
6731 if (other == null) {
6732 return false;
6733 }
6734 if (mAction != other.mAction) {
6735 if (mAction != null) {
6736 if (!mAction.equals(other.mAction)) {
6737 return false;
6738 }
6739 } else {
6740 if (!other.mAction.equals(mAction)) {
6741 return false;
6742 }
6743 }
6744 }
6745 if (mData != other.mData) {
6746 if (mData != null) {
6747 if (!mData.equals(other.mData)) {
6748 return false;
6749 }
6750 } else {
6751 if (!other.mData.equals(mData)) {
6752 return false;
6753 }
6754 }
6755 }
6756 if (mType != other.mType) {
6757 if (mType != null) {
6758 if (!mType.equals(other.mType)) {
6759 return false;
6760 }
6761 } else {
6762 if (!other.mType.equals(mType)) {
6763 return false;
6764 }
6765 }
6766 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006767 if (mPackage != other.mPackage) {
6768 if (mPackage != null) {
6769 if (!mPackage.equals(other.mPackage)) {
6770 return false;
6771 }
6772 } else {
6773 if (!other.mPackage.equals(mPackage)) {
6774 return false;
6775 }
6776 }
6777 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006778 if (mComponent != other.mComponent) {
6779 if (mComponent != null) {
6780 if (!mComponent.equals(other.mComponent)) {
6781 return false;
6782 }
6783 } else {
6784 if (!other.mComponent.equals(mComponent)) {
6785 return false;
6786 }
6787 }
6788 }
6789 if (mCategories != other.mCategories) {
6790 if (mCategories != null) {
6791 if (!mCategories.equals(other.mCategories)) {
6792 return false;
6793 }
6794 } else {
6795 if (!other.mCategories.equals(mCategories)) {
6796 return false;
6797 }
6798 }
6799 }
6800
6801 return true;
6802 }
6803
6804 /**
6805 * Generate hash code that matches semantics of filterEquals().
6806 *
6807 * @return Returns the hash value of the action, data, type, class, and
6808 * categories.
6809 *
6810 * @see #filterEquals
6811 */
6812 public int filterHashCode() {
6813 int code = 0;
6814 if (mAction != null) {
6815 code += mAction.hashCode();
6816 }
6817 if (mData != null) {
6818 code += mData.hashCode();
6819 }
6820 if (mType != null) {
6821 code += mType.hashCode();
6822 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006823 if (mPackage != null) {
6824 code += mPackage.hashCode();
6825 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006826 if (mComponent != null) {
6827 code += mComponent.hashCode();
6828 }
6829 if (mCategories != null) {
6830 code += mCategories.hashCode();
6831 }
6832 return code;
6833 }
6834
6835 @Override
6836 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006837 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006838
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006839 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006840 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006841 b.append(" }");
6842
6843 return b.toString();
6844 }
6845
6846 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006847 public String toInsecureString() {
6848 StringBuilder b = new StringBuilder(128);
6849
6850 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006851 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006852 b.append(" }");
6853
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006854 return b.toString();
6855 }
Romain Guy4969af72009-06-17 10:53:19 -07006856
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006857 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006858 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006859 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006860
6861 b.append("Intent { ");
6862 toShortString(b, false, true, true, true);
6863 b.append(" }");
6864
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006865 return b.toString();
6866 }
6867
6868 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006869 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6870 StringBuilder b = new StringBuilder(128);
6871 toShortString(b, secure, comp, extras, clip);
6872 return b.toString();
6873 }
6874
6875 /** @hide */
6876 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6877 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006878 boolean first = true;
6879 if (mAction != null) {
6880 b.append("act=").append(mAction);
6881 first = false;
6882 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006883 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006884 if (!first) {
6885 b.append(' ');
6886 }
6887 first = false;
6888 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006889 for (int i=0; i<mCategories.size(); i++) {
6890 if (i > 0) b.append(',');
6891 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006892 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006893 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006894 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006895 if (mData != null) {
6896 if (!first) {
6897 b.append(' ');
6898 }
6899 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006900 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006901 if (secure) {
6902 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006903 } else {
6904 b.append(mData);
6905 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006906 }
6907 if (mType != null) {
6908 if (!first) {
6909 b.append(' ');
6910 }
6911 first = false;
6912 b.append("typ=").append(mType);
6913 }
6914 if (mFlags != 0) {
6915 if (!first) {
6916 b.append(' ');
6917 }
6918 first = false;
6919 b.append("flg=0x").append(Integer.toHexString(mFlags));
6920 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006921 if (mPackage != null) {
6922 if (!first) {
6923 b.append(' ');
6924 }
6925 first = false;
6926 b.append("pkg=").append(mPackage);
6927 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006928 if (comp && mComponent != null) {
6929 if (!first) {
6930 b.append(' ');
6931 }
6932 first = false;
6933 b.append("cmp=").append(mComponent.flattenToShortString());
6934 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006935 if (mSourceBounds != null) {
6936 if (!first) {
6937 b.append(' ');
6938 }
6939 first = false;
6940 b.append("bnds=").append(mSourceBounds.toShortString());
6941 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006942 if (mClipData != null) {
6943 if (!first) {
6944 b.append(' ');
6945 }
6946 first = false;
6947 if (clip) {
6948 b.append("clip={");
6949 mClipData.toShortString(b);
6950 b.append('}');
6951 } else {
6952 b.append("(has clip)");
6953 }
6954 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006955 if (extras && mExtras != null) {
6956 if (!first) {
6957 b.append(' ');
6958 }
6959 first = false;
6960 b.append("(has extras)");
6961 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006962 if (mSelector != null) {
6963 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006964 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006965 b.append("}");
6966 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006967 }
6968
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006969 /**
6970 * Call {@link #toUri} with 0 flags.
6971 * @deprecated Use {@link #toUri} instead.
6972 */
6973 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006974 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006975 return toUri(0);
6976 }
6977
6978 /**
6979 * Convert this Intent into a String holding a URI representation of it.
6980 * The returned URI string has been properly URI encoded, so it can be
6981 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6982 * Intent's data as the base URI, with an additional fragment describing
6983 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006984 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006985 * <p>You can convert the returned string back to an Intent with
6986 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006987 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006988 * @param flags Additional operating flags. Either 0 or
6989 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006990 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006991 * @return Returns a URI encoding URI string describing the entire contents
6992 * of the Intent.
6993 */
6994 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006995 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006996 String scheme = null;
6997 if (mData != null) {
6998 String data = mData.toString();
6999 if ((flags&URI_INTENT_SCHEME) != 0) {
7000 final int N = data.length();
7001 for (int i=0; i<N; i++) {
7002 char c = data.charAt(i);
7003 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7004 || c == '.' || c == '-') {
7005 continue;
7006 }
7007 if (c == ':' && i > 0) {
7008 // Valid scheme.
7009 scheme = data.substring(0, i);
7010 uri.append("intent:");
7011 data = data.substring(i+1);
7012 break;
7013 }
Tom Taylord4a47292009-12-21 13:59:18 -08007014
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007015 // No scheme.
7016 break;
7017 }
7018 }
7019 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007020
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007021 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7022 uri.append("intent:");
7023 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007024
7025 uri.append("#Intent;");
7026
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007027 toUriInner(uri, scheme, flags);
7028 if (mSelector != null) {
7029 uri.append("SEL;");
7030 // Note that for now we are not going to try to handle the
7031 // data part; not clear how to represent this as a URI, and
7032 // not much utility in it.
7033 mSelector.toUriInner(uri, null, flags);
7034 }
7035
7036 uri.append("end");
7037
7038 return uri.toString();
7039 }
7040
7041 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007042 if (scheme != null) {
7043 uri.append("scheme=").append(scheme).append(';');
7044 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007045 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007046 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007047 }
7048 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007049 for (int i=0; i<mCategories.size(); i++) {
7050 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007051 }
7052 }
7053 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007054 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007055 }
7056 if (mFlags != 0) {
7057 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7058 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007059 if (mPackage != null) {
7060 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7061 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007062 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007063 uri.append("component=").append(Uri.encode(
7064 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007065 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007066 if (mSourceBounds != null) {
7067 uri.append("sourceBounds=")
7068 .append(Uri.encode(mSourceBounds.flattenToString()))
7069 .append(';');
7070 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007071 if (mExtras != null) {
7072 for (String key : mExtras.keySet()) {
7073 final Object value = mExtras.get(key);
7074 char entryType =
7075 value instanceof String ? 'S' :
7076 value instanceof Boolean ? 'B' :
7077 value instanceof Byte ? 'b' :
7078 value instanceof Character ? 'c' :
7079 value instanceof Double ? 'd' :
7080 value instanceof Float ? 'f' :
7081 value instanceof Integer ? 'i' :
7082 value instanceof Long ? 'l' :
7083 value instanceof Short ? 's' :
7084 '\0';
7085
7086 if (entryType != '\0') {
7087 uri.append(entryType);
7088 uri.append('.');
7089 uri.append(Uri.encode(key));
7090 uri.append('=');
7091 uri.append(Uri.encode(value.toString()));
7092 uri.append(';');
7093 }
7094 }
7095 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007096 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007097
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007098 public int describeContents() {
7099 return (mExtras != null) ? mExtras.describeContents() : 0;
7100 }
7101
7102 public void writeToParcel(Parcel out, int flags) {
7103 out.writeString(mAction);
7104 Uri.writeToParcel(out, mData);
7105 out.writeString(mType);
7106 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007107 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007108 ComponentName.writeToParcel(mComponent, out);
7109
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007110 if (mSourceBounds != null) {
7111 out.writeInt(1);
7112 mSourceBounds.writeToParcel(out, flags);
7113 } else {
7114 out.writeInt(0);
7115 }
7116
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007117 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007118 final int N = mCategories.size();
7119 out.writeInt(N);
7120 for (int i=0; i<N; i++) {
7121 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007122 }
7123 } else {
7124 out.writeInt(0);
7125 }
7126
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007127 if (mSelector != null) {
7128 out.writeInt(1);
7129 mSelector.writeToParcel(out, flags);
7130 } else {
7131 out.writeInt(0);
7132 }
7133
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007134 if (mClipData != null) {
7135 out.writeInt(1);
7136 mClipData.writeToParcel(out, flags);
7137 } else {
7138 out.writeInt(0);
7139 }
7140
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007141 out.writeBundle(mExtras);
7142 }
7143
7144 public static final Parcelable.Creator<Intent> CREATOR
7145 = new Parcelable.Creator<Intent>() {
7146 public Intent createFromParcel(Parcel in) {
7147 return new Intent(in);
7148 }
7149 public Intent[] newArray(int size) {
7150 return new Intent[size];
7151 }
7152 };
7153
Dianne Hackborneb034652009-09-07 00:49:58 -07007154 /** @hide */
7155 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007156 readFromParcel(in);
7157 }
7158
7159 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007160 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007161 mData = Uri.CREATOR.createFromParcel(in);
7162 mType = in.readString();
7163 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007164 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007165 mComponent = ComponentName.readFromParcel(in);
7166
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007167 if (in.readInt() != 0) {
7168 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7169 }
7170
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007171 int N = in.readInt();
7172 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007173 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007174 int i;
7175 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007176 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007177 }
7178 } else {
7179 mCategories = null;
7180 }
7181
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007182 if (in.readInt() != 0) {
7183 mSelector = new Intent(in);
7184 }
7185
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007186 if (in.readInt() != 0) {
7187 mClipData = new ClipData(in);
7188 }
7189
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007190 mExtras = in.readBundle();
7191 }
7192
7193 /**
7194 * Parses the "intent" element (and its children) from XML and instantiates
7195 * an Intent object. The given XML parser should be located at the tag
7196 * where parsing should start (often named "intent"), from which the
7197 * basic action, data, type, and package and class name will be
7198 * retrieved. The function will then parse in to any child elements,
7199 * looking for <category android:name="xxx"> tags to add categories and
7200 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7201 * to the intent.
7202 *
7203 * @param resources The Resources to use when inflating resources.
7204 * @param parser The XML parser pointing at an "intent" tag.
7205 * @param attrs The AttributeSet interface for retrieving extended
7206 * attribute data at the current <var>parser</var> location.
7207 * @return An Intent object matching the XML data.
7208 * @throws XmlPullParserException If there was an XML parsing error.
7209 * @throws IOException If there was an I/O error.
7210 */
7211 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7212 throws XmlPullParserException, IOException {
7213 Intent intent = new Intent();
7214
7215 TypedArray sa = resources.obtainAttributes(attrs,
7216 com.android.internal.R.styleable.Intent);
7217
7218 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7219
7220 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7221 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7222 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7223
7224 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7225 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7226 if (packageName != null && className != null) {
7227 intent.setComponent(new ComponentName(packageName, className));
7228 }
7229
7230 sa.recycle();
7231
7232 int outerDepth = parser.getDepth();
7233 int type;
7234 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7235 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7236 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7237 continue;
7238 }
7239
7240 String nodeName = parser.getName();
7241 if (nodeName.equals("category")) {
7242 sa = resources.obtainAttributes(attrs,
7243 com.android.internal.R.styleable.IntentCategory);
7244 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7245 sa.recycle();
7246
7247 if (cat != null) {
7248 intent.addCategory(cat);
7249 }
7250 XmlUtils.skipCurrentTag(parser);
7251
7252 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007253 if (intent.mExtras == null) {
7254 intent.mExtras = new Bundle();
7255 }
7256 resources.parseBundleExtra("extra", attrs, intent.mExtras);
7257 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007258
7259 } else {
7260 XmlUtils.skipCurrentTag(parser);
7261 }
7262 }
7263
7264 return intent;
7265 }
Nick Pellyccae4122012-01-09 14:12:58 -08007266
7267 /**
7268 * Normalize a MIME data type.
7269 *
7270 * <p>A normalized MIME type has white-space trimmed,
7271 * content-type parameters removed, and is lower-case.
7272 * This aligns the type with Android best practices for
7273 * intent filtering.
7274 *
7275 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7276 * "text/x-vCard" becomes "text/x-vcard".
7277 *
7278 * <p>All MIME types received from outside Android (such as user input,
7279 * or external sources like Bluetooth, NFC, or the Internet) should
7280 * be normalized before they are used to create an Intent.
7281 *
7282 * @param type MIME data type to normalize
7283 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007284 * @see #setType
7285 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007286 */
7287 public static String normalizeMimeType(String type) {
7288 if (type == null) {
7289 return null;
7290 }
7291
Elliott Hughescb64d432013-08-02 10:00:44 -07007292 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007293
7294 final int semicolonIndex = type.indexOf(';');
7295 if (semicolonIndex != -1) {
7296 type = type.substring(0, semicolonIndex);
7297 }
7298 return type;
7299 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007300
7301 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007302 * Prepare this {@link Intent} to leave an app process.
7303 *
7304 * @hide
7305 */
7306 public void prepareToLeaveProcess() {
7307 setAllowFds(false);
7308
7309 if (mSelector != null) {
7310 mSelector.prepareToLeaveProcess();
7311 }
7312 if (mClipData != null) {
7313 mClipData.prepareToLeaveProcess();
7314 }
7315
7316 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7317 // There are several ACTION_MEDIA_* broadcasts that send file://
7318 // Uris, so only check common actions.
7319 if (ACTION_VIEW.equals(mAction) ||
7320 ACTION_EDIT.equals(mAction) ||
7321 ACTION_ATTACH_DATA.equals(mAction)) {
7322 mData.checkFileUriExposed("Intent.getData()");
7323 }
7324 }
7325 }
7326
7327 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007328 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007329 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7330 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007331 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007332 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007333 * @hide
7334 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007335 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007336 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007337 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007338
7339 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007340 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007341
7342 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007343 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007344 try {
7345 // Inspect target intent to see if we need to migrate
7346 final Intent target = getParcelableExtra(EXTRA_INTENT);
7347 if (target != null && target.migrateExtraStreamToClipData()) {
7348 // Since we migrated in child, we need to promote ClipData
7349 // and flags to ourselves to grant.
7350 setClipData(target.getClipData());
7351 addFlags(target.getFlags()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07007352 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkeye66c1772013-09-20 14:30:59 -07007353 | FLAG_GRANT_PERSISTABLE_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007354 return true;
7355 } else {
7356 return false;
7357 }
7358 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007359 }
7360
7361 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007362 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007363 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7364 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7365 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7366 if (stream != null || text != null || htmlText != null) {
7367 final ClipData clipData = new ClipData(
7368 null, new String[] { getType() },
7369 new ClipData.Item(text, htmlText, null, stream));
7370 setClipData(clipData);
7371 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007372 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007373 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007374 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007375 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007376
7377 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007378 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007379 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7380 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7381 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7382 int num = -1;
7383 if (streams != null) {
7384 num = streams.size();
7385 }
7386 if (texts != null) {
7387 if (num >= 0 && num != texts.size()) {
7388 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007389 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007390 }
7391 num = texts.size();
7392 }
7393 if (htmlTexts != null) {
7394 if (num >= 0 && num != htmlTexts.size()) {
7395 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007396 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007397 }
7398 num = htmlTexts.size();
7399 }
7400 if (num > 0) {
7401 final ClipData clipData = new ClipData(
7402 null, new String[] { getType() },
7403 makeClipItem(streams, texts, htmlTexts, 0));
7404
7405 for (int i = 1; i < num; i++) {
7406 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7407 }
7408
7409 setClipData(clipData);
7410 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007411 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007412 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007413 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007414 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007415 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007416
7417 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007418 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007419
7420 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7421 ArrayList<String> htmlTexts, int which) {
7422 Uri uri = streams != null ? streams.get(which) : null;
7423 CharSequence text = texts != null ? texts.get(which) : null;
7424 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7425 return new ClipData.Item(text, htmlText, null, uri);
7426 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007427
7428 /** @hide */
7429 public boolean isDocument() {
7430 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7431 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007432}