blob: 67b67373b711c3218bb883e48012112ca97b35b5 [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;
Jeff Sharkey846318a2014-04-04 12:12:41 -070021
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070022import org.xmlpull.v1.XmlPullParser;
23import org.xmlpull.v1.XmlPullParserException;
24
Tor Norbyed9273d62013-05-30 15:59:53 -070025import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070026import android.annotation.SdkConstant;
27import android.annotation.SdkConstant.SdkConstantType;
28import android.content.pm.ActivityInfo;
29import android.content.pm.PackageManager;
30import android.content.pm.ResolveInfo;
31import android.content.res.Resources;
32import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080033import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.net.Uri;
35import android.os.Bundle;
36import android.os.IBinder;
37import android.os.Parcel;
38import android.os.Parcelable;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070039import android.os.StrictMode;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070040import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070041import android.provider.DocumentsProvider;
42import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070043import android.util.AttributeSet;
44import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080045
46import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070047
48import java.io.IOException;
49import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070050import java.lang.annotation.Retention;
51import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070052import java.net.URISyntaxException;
53import java.util.ArrayList;
Dianne Hackborn221ea892013-08-04 16:50:16 -070054import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080055import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070056import java.util.Set;
57
58/**
59 * An intent is an abstract description of an operation to be performed. It
60 * can be used with {@link Context#startActivity(Intent) startActivity} to
61 * launch an {@link android.app.Activity},
62 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
63 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
64 * and {@link android.content.Context#startService} or
65 * {@link android.content.Context#bindService} to communicate with a
66 * background {@link android.app.Service}.
67 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070068 * <p>An Intent provides a facility for performing late runtime binding between the code in
69 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070070 * can be thought of as the glue between activities. It is basically a passive data structure
71 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070072 *
73 * <div class="special reference">
74 * <h3>Developer Guides</h3>
75 * <p>For information about how to create and resolve intents, read the
76 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
77 * developer guide.</p>
78 * </div>
79 *
80 * <a name="IntentStructure"></a>
81 * <h3>Intent Structure</h3>
82 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070083 *
84 * <ul>
85 * <li> <p><b>action</b> -- The general action to be performed, such as
86 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
87 * etc.</p>
88 * </li>
89 * <li> <p><b>data</b> -- The data to operate on, such as a person record
90 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
91 * </li>
92 * </ul>
93 *
94 *
95 * <p>Some examples of action/data pairs are:</p>
96 *
97 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070098 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070099 * information about the person whose identifier is "1".</p>
100 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700101 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700102 * the phone dialer with the person filled in.</p>
103 * </li>
104 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
105 * the phone dialer with the given number filled in. Note how the
106 * VIEW action does what what is considered the most reasonable thing for
107 * a particular URI.</p>
108 * </li>
109 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
110 * the phone dialer with the given number filled in.</p>
111 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700112 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700113 * information about the person whose identifier is "1".</p>
114 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700115 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700116 * a list of people, which the user can browse through. This example is a
117 * typical top-level entry into the Contacts application, showing you the
118 * list of people. Selecting a particular person to view would result in a
119 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
120 * being used to start an activity to display that person.</p>
121 * </li>
122 * </ul>
123 *
124 * <p>In addition to these primary attributes, there are a number of secondary
125 * attributes that you can also include with an intent:</p>
126 *
127 * <ul>
128 * <li> <p><b>category</b> -- Gives additional information about the action
129 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
130 * appear in the Launcher as a top-level application, while
131 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
132 * of alternative actions the user can perform on a piece of data.</p>
133 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
134 * intent data. Normally the type is inferred from the data itself.
135 * By setting this attribute, you disable that evaluation and force
136 * an explicit type.</p>
137 * <li> <p><b>component</b> -- Specifies an explicit name of a component
138 * class to use for the intent. Normally this is determined by looking
139 * at the other information in the intent (the action, data/type, and
140 * categories) and matching that with a component that can handle it.
141 * If this attribute is set then none of the evaluation is performed,
142 * and this component is used exactly as is. By specifying this attribute,
143 * all of the other Intent attributes become optional.</p>
144 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
145 * This can be used to provide extended information to the component.
146 * For example, if we have a action to send an e-mail message, we could
147 * also include extra pieces of data here to supply a subject, body,
148 * etc.</p>
149 * </ul>
150 *
151 * <p>Here are some examples of other operations you can specify as intents
152 * using these additional parameters:</p>
153 *
154 * <ul>
155 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
156 * Launch the home screen.</p>
157 * </li>
158 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
159 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
160 * vnd.android.cursor.item/phone}</i></b>
161 * -- Display the list of people's phone numbers, allowing the user to
162 * browse through them and pick one and return it to the parent activity.</p>
163 * </li>
164 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
165 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
166 * -- Display all pickers for data that can be opened with
167 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
168 * allowing the user to pick one of them and then some data inside of it
169 * and returning the resulting URI to the caller. This can be used,
170 * for example, in an e-mail application to allow the user to pick some
171 * data to include as an attachment.</p>
172 * </li>
173 * </ul>
174 *
175 * <p>There are a variety of standard Intent action and category constants
176 * defined in the Intent class, but applications can also define their own.
177 * These strings use java style scoping, to ensure they are unique -- for
178 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700179 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700180 *
181 * <p>Put together, the set of actions, data types, categories, and extra data
182 * defines a language for the system allowing for the expression of phrases
183 * such as "call john smith's cell". As applications are added to the system,
184 * they can extend this language by adding new actions, types, and categories, or
185 * they can modify the behavior of existing phrases by supplying their own
186 * activities that handle them.</p>
187 *
188 * <a name="IntentResolution"></a>
189 * <h3>Intent Resolution</h3>
190 *
191 * <p>There are two primary forms of intents you will use.
192 *
193 * <ul>
194 * <li> <p><b>Explicit Intents</b> have specified a component (via
195 * {@link #setComponent} or {@link #setClass}), which provides the exact
196 * class to be run. Often these will not include any other information,
197 * simply being a way for an application to launch various internal
198 * activities it has as the user interacts with the application.
199 *
200 * <li> <p><b>Implicit Intents</b> have not specified a component;
201 * instead, they must include enough information for the system to
202 * determine which of the available components is best to run for that
203 * intent.
204 * </ul>
205 *
206 * <p>When using implicit intents, given such an arbitrary intent we need to
207 * know what to do with it. This is handled by the process of <em>Intent
208 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
209 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
210 * more activities/receivers) that can handle it.</p>
211 *
212 * <p>The intent resolution mechanism basically revolves around matching an
213 * Intent against all of the &lt;intent-filter&gt; descriptions in the
214 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
215 * objects explicitly registered with {@link Context#registerReceiver}.) More
216 * details on this can be found in the documentation on the {@link
217 * IntentFilter} class.</p>
218 *
219 * <p>There are three pieces of information in the Intent that are used for
220 * resolution: the action, type, and category. Using this information, a query
221 * is done on the {@link PackageManager} for a component that can handle the
222 * intent. The appropriate component is determined based on the intent
223 * information supplied in the <code>AndroidManifest.xml</code> file as
224 * follows:</p>
225 *
226 * <ul>
227 * <li> <p>The <b>action</b>, if given, must be listed by the component as
228 * one it handles.</p>
229 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
230 * already supplied in the Intent. Like the action, if a type is
231 * included in the intent (either explicitly or implicitly in its
232 * data), then this must be listed by the component as one it handles.</p>
233 * <li> For data that is not a <code>content:</code> URI and where no explicit
234 * type is included in the Intent, instead the <b>scheme</b> of the
235 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
236 * considered. Again like the action, if we are matching a scheme it
237 * must be listed by the component as one it can handle.
238 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
239 * by the activity as categories it handles. That is, if you include
240 * the categories {@link #CATEGORY_LAUNCHER} and
241 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
242 * with an intent that lists <em>both</em> of those categories.
243 * Activities will very often need to support the
244 * {@link #CATEGORY_DEFAULT} so that they can be found by
245 * {@link Context#startActivity Context.startActivity()}.</p>
246 * </ul>
247 *
248 * <p>For example, consider the Note Pad sample application that
249 * allows user to browse through a list of notes data and view details about
250 * individual items. Text in italics indicate places were you would replace a
251 * name with one specific to your own package.</p>
252 *
253 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
254 * package="<i>com.android.notepad</i>"&gt;
255 * &lt;application android:icon="@drawable/app_notes"
256 * android:label="@string/app_name"&gt;
257 *
258 * &lt;provider class=".NotePadProvider"
259 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
260 *
261 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
262 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700263 * &lt;action android:name="android.intent.action.MAIN" /&gt;
264 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700265 * &lt;/intent-filter&gt;
266 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700267 * &lt;action android:name="android.intent.action.VIEW" /&gt;
268 * &lt;action android:name="android.intent.action.EDIT" /&gt;
269 * &lt;action android:name="android.intent.action.PICK" /&gt;
270 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
271 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700272 * &lt;/intent-filter&gt;
273 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700274 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
275 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
276 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 * &lt;/activity&gt;
279 *
280 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
281 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700282 * &lt;action android:name="android.intent.action.VIEW" /&gt;
283 * &lt;action android:name="android.intent.action.EDIT" /&gt;
284 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
285 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700286 * &lt;/intent-filter&gt;
287 *
288 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700289 * &lt;action android:name="android.intent.action.INSERT" /&gt;
290 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
291 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700292 * &lt;/intent-filter&gt;
293 *
294 * &lt;/activity&gt;
295 *
296 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
297 * android:theme="@android:style/Theme.Dialog"&gt;
298 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700299 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
300 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
301 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
302 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
303 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700304 * &lt;/intent-filter&gt;
305 * &lt;/activity&gt;
306 *
307 * &lt;/application&gt;
308 * &lt;/manifest&gt;</pre>
309 *
310 * <p>The first activity,
311 * <code>com.android.notepad.NotesList</code>, serves as our main
312 * entry into the app. It can do three things as described by its three intent
313 * templates:
314 * <ol>
315 * <li><pre>
316 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700317 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
318 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700319 * &lt;/intent-filter&gt;</pre>
320 * <p>This provides a top-level entry into the NotePad application: the standard
321 * MAIN action is a main entry point (not requiring any other information in
322 * the Intent), and the LAUNCHER category says that this entry point should be
323 * listed in the application launcher.</p>
324 * <li><pre>
325 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700326 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
327 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
328 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
329 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
330 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700331 * &lt;/intent-filter&gt;</pre>
332 * <p>This declares the things that the activity can do on a directory of
333 * notes. The type being supported is given with the &lt;type&gt; tag, where
334 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
335 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
336 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
337 * The activity allows the user to view or edit the directory of data (via
338 * the VIEW and EDIT actions), or to pick a particular note and return it
339 * to the caller (via the PICK action). Note also the DEFAULT category
340 * supplied here: this is <em>required</em> for the
341 * {@link Context#startActivity Context.startActivity} method to resolve your
342 * activity when its component name is not explicitly specified.</p>
343 * <li><pre>
344 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700345 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
346 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
347 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700348 * &lt;/intent-filter&gt;</pre>
349 * <p>This filter describes the ability return to the caller a note selected by
350 * the user without needing to know where it came from. The data type
351 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
352 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
353 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
354 * The GET_CONTENT action is similar to the PICK action, where the activity
355 * will return to its caller a piece of data selected by the user. Here,
356 * however, the caller specifies the type of data they desire instead of
357 * the type of data the user will be picking from.</p>
358 * </ol>
359 *
360 * <p>Given these capabilities, the following intents will resolve to the
361 * NotesList activity:</p>
362 *
363 * <ul>
364 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
365 * activities that can be used as top-level entry points into an
366 * application.</p>
367 * <li> <p><b>{ action=android.app.action.MAIN,
368 * category=android.app.category.LAUNCHER }</b> is the actual intent
369 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700370 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700371 * data=content://com.google.provider.NotePad/notes }</b>
372 * displays a list of all the notes under
373 * "content://com.google.provider.NotePad/notes", which
374 * the user can browse through and see the details on.</p>
375 * <li> <p><b>{ action=android.app.action.PICK
376 * data=content://com.google.provider.NotePad/notes }</b>
377 * provides a list of the notes under
378 * "content://com.google.provider.NotePad/notes", from which
379 * the user can pick a note whose data URL is returned back to the caller.</p>
380 * <li> <p><b>{ action=android.app.action.GET_CONTENT
381 * type=vnd.android.cursor.item/vnd.google.note }</b>
382 * is similar to the pick action, but allows the caller to specify the
383 * kind of data they want back so that the system can find the appropriate
384 * activity to pick something of that data type.</p>
385 * </ul>
386 *
387 * <p>The second activity,
388 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
389 * note entry and allows them to edit it. It can do two things as described
390 * by its two intent templates:
391 * <ol>
392 * <li><pre>
393 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700394 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
395 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
396 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
397 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700398 * &lt;/intent-filter&gt;</pre>
399 * <p>The first, primary, purpose of this activity is to let the user interact
400 * with a single note, as decribed by the MIME type
401 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
402 * either VIEW a note or allow the user to EDIT it. Again we support the
403 * DEFAULT category to allow the activity to be launched without explicitly
404 * specifying its component.</p>
405 * <li><pre>
406 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700407 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
408 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
409 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700410 * &lt;/intent-filter&gt;</pre>
411 * <p>The secondary use of this activity is to insert a new note entry into
412 * an existing directory of notes. This is used when the user creates a new
413 * note: the INSERT action is executed on the directory of notes, causing
414 * this activity to run and have the user create the new note data which
415 * it then adds to the content provider.</p>
416 * </ol>
417 *
418 * <p>Given these capabilities, the following intents will resolve to the
419 * NoteEditor activity:</p>
420 *
421 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700422 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700423 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
424 * shows the user the content of note <var>{ID}</var>.</p>
425 * <li> <p><b>{ action=android.app.action.EDIT
426 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
427 * allows the user to edit the content of note <var>{ID}</var>.</p>
428 * <li> <p><b>{ action=android.app.action.INSERT
429 * data=content://com.google.provider.NotePad/notes }</b>
430 * creates a new, empty note in the notes list at
431 * "content://com.google.provider.NotePad/notes"
432 * and allows the user to edit it. If they keep their changes, the URI
433 * of the newly created note is returned to the caller.</p>
434 * </ul>
435 *
436 * <p>The last activity,
437 * <code>com.android.notepad.TitleEditor</code>, allows the user to
438 * edit the title of a note. This could be implemented as a class that the
439 * application directly invokes (by explicitly setting its component in
440 * the Intent), but here we show a way you can publish alternative
441 * operations on existing data:</p>
442 *
443 * <pre>
444 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700445 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
446 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
447 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
448 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
449 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700450 * &lt;/intent-filter&gt;</pre>
451 *
452 * <p>In the single intent template here, we
453 * have created our own private action called
454 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
455 * edit the title of a note. It must be invoked on a specific note
456 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
457 * view and edit actions, but here displays and edits the title contained
458 * in the note data.
459 *
460 * <p>In addition to supporting the default category as usual, our title editor
461 * also supports two other standard categories: ALTERNATIVE and
462 * SELECTED_ALTERNATIVE. Implementing
463 * these categories allows others to find the special action it provides
464 * without directly knowing about it, through the
465 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
466 * more often to build dynamic menu items with
467 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
468 * template here was also supply an explicit name for the template
469 * (via <code>android:label="@string/resolve_title"</code>) to better control
470 * what the user sees when presented with this activity as an alternative
471 * action to the data they are viewing.
472 *
473 * <p>Given these capabilities, the following intent will resolve to the
474 * TitleEditor activity:</p>
475 *
476 * <ul>
477 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
478 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
479 * displays and allows the user to edit the title associated
480 * with note <var>{ID}</var>.</p>
481 * </ul>
482 *
483 * <h3>Standard Activity Actions</h3>
484 *
485 * <p>These are the current standard actions that Intent defines for launching
486 * activities (usually through {@link Context#startActivity}. The most
487 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
488 * {@link #ACTION_EDIT}.
489 *
490 * <ul>
491 * <li> {@link #ACTION_MAIN}
492 * <li> {@link #ACTION_VIEW}
493 * <li> {@link #ACTION_ATTACH_DATA}
494 * <li> {@link #ACTION_EDIT}
495 * <li> {@link #ACTION_PICK}
496 * <li> {@link #ACTION_CHOOSER}
497 * <li> {@link #ACTION_GET_CONTENT}
498 * <li> {@link #ACTION_DIAL}
499 * <li> {@link #ACTION_CALL}
500 * <li> {@link #ACTION_SEND}
501 * <li> {@link #ACTION_SENDTO}
502 * <li> {@link #ACTION_ANSWER}
503 * <li> {@link #ACTION_INSERT}
504 * <li> {@link #ACTION_DELETE}
505 * <li> {@link #ACTION_RUN}
506 * <li> {@link #ACTION_SYNC}
507 * <li> {@link #ACTION_PICK_ACTIVITY}
508 * <li> {@link #ACTION_SEARCH}
509 * <li> {@link #ACTION_WEB_SEARCH}
510 * <li> {@link #ACTION_FACTORY_TEST}
511 * </ul>
512 *
513 * <h3>Standard Broadcast Actions</h3>
514 *
515 * <p>These are the current standard actions that Intent defines for receiving
516 * broadcasts (usually through {@link Context#registerReceiver} or a
517 * &lt;receiver&gt; tag in a manifest).
518 *
519 * <ul>
520 * <li> {@link #ACTION_TIME_TICK}
521 * <li> {@link #ACTION_TIME_CHANGED}
522 * <li> {@link #ACTION_TIMEZONE_CHANGED}
523 * <li> {@link #ACTION_BOOT_COMPLETED}
524 * <li> {@link #ACTION_PACKAGE_ADDED}
525 * <li> {@link #ACTION_PACKAGE_CHANGED}
526 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800527 * <li> {@link #ACTION_PACKAGE_RESTARTED}
528 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700529 * <li> {@link #ACTION_UID_REMOVED}
530 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700531 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700532 * <li> {@link #ACTION_POWER_DISCONNECTED}
533 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700534 * </ul>
535 *
536 * <h3>Standard Categories</h3>
537 *
538 * <p>These are the current standard categories that can be used to further
539 * clarify an Intent via {@link #addCategory}.
540 *
541 * <ul>
542 * <li> {@link #CATEGORY_DEFAULT}
543 * <li> {@link #CATEGORY_BROWSABLE}
544 * <li> {@link #CATEGORY_TAB}
545 * <li> {@link #CATEGORY_ALTERNATIVE}
546 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
547 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800548 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * <li> {@link #CATEGORY_HOME}
550 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700551 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400552 * <li> {@link #CATEGORY_CAR_DOCK}
553 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500554 * <li> {@link #CATEGORY_LE_DESK_DOCK}
555 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200556 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700557 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700558 * </ul>
559 *
560 * <h3>Standard Extra Data</h3>
561 *
562 * <p>These are the current standard fields that can be used as extra data via
563 * {@link #putExtra}.
564 *
565 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800566 * <li> {@link #EXTRA_ALARM_COUNT}
567 * <li> {@link #EXTRA_BCC}
568 * <li> {@link #EXTRA_CC}
569 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
570 * <li> {@link #EXTRA_DATA_REMOVED}
571 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500572 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
573 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800574 * <li> {@link #EXTRA_DOCK_STATE_CAR}
575 * <li> {@link #EXTRA_DOCK_STATE_DESK}
576 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
577 * <li> {@link #EXTRA_DONT_KILL_APP}
578 * <li> {@link #EXTRA_EMAIL}
579 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700580 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800581 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700582 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800583 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700584 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800585 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
586 * <li> {@link #EXTRA_REPLACING}
587 * <li> {@link #EXTRA_SHORTCUT_ICON}
588 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
589 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700590 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800591 * <li> {@link #EXTRA_SHORTCUT_NAME}
592 * <li> {@link #EXTRA_SUBJECT}
593 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700594 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_TITLE}
596 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700597 * </ul>
598 *
599 * <h3>Flags</h3>
600 *
601 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800602 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
603 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700604 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800605public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700606 // ---------------------------------------------------------------------
607 // ---------------------------------------------------------------------
608 // Standard intent activity actions (see action variable).
609
610 /**
611 * Activity Action: Start as a main entry point, does not expect to
612 * receive data.
613 * <p>Input: nothing
614 * <p>Output: nothing
615 */
616 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
617 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800618
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700619 /**
620 * Activity Action: Display the data to the user. This is the most common
621 * action performed on data -- it is the generic action you can use on
622 * a piece of data to get the most reasonable thing to occur. For example,
623 * when used on a contacts entry it will view the entry; when used on a
624 * mailto: URI it will bring up a compose window filled with the information
625 * supplied by the URI; when used with a tel: URI it will invoke the
626 * dialer.
627 * <p>Input: {@link #getData} is URI from which to retrieve data.
628 * <p>Output: nothing.
629 */
630 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
631 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800632
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700633 /**
634 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
635 * performed on a piece of data.
636 */
637 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800638
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700639 /**
640 * Used to indicate that some piece of data should be attached to some other
641 * place. For example, image data could be attached to a contact. It is up
642 * to the recipient to decide where the data should be attached; the intent
643 * does not specify the ultimate destination.
644 * <p>Input: {@link #getData} is URI of data to be attached.
645 * <p>Output: nothing.
646 */
647 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
648 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700650 /**
651 * Activity Action: Provide explicit editable access to the given data.
652 * <p>Input: {@link #getData} is URI of data to be edited.
653 * <p>Output: nothing.
654 */
655 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
656 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800657
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700658 /**
659 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
660 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
661 * The extras can contain type specific data to pass through to the editing/creating
662 * activity.
663 * <p>Output: The URI of the item that was picked. This must be a content:
664 * URI so that any receiver can access it.
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700669 /**
670 * Activity Action: Pick an item from the data, returning what was selected.
671 * <p>Input: {@link #getData} is URI containing a directory of data
672 * (vnd.android.cursor.dir/*) from which to pick an item.
673 * <p>Output: The URI of the item that was picked.
674 */
675 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
676 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800677
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700678 /**
679 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800680 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700681 * <p>Output: An Intent representing the shortcut. The intent must contain three
682 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
683 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800684 * (value: ShortcutIconResource).</p>
685 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700686 * @see #EXTRA_SHORTCUT_INTENT
687 * @see #EXTRA_SHORTCUT_NAME
688 * @see #EXTRA_SHORTCUT_ICON
689 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
690 * @see android.content.Intent.ShortcutIconResource
691 */
692 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
693 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
694
695 /**
696 * The name of the extra used to define the Intent of a shortcut.
697 *
698 * @see #ACTION_CREATE_SHORTCUT
699 */
700 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
701 /**
702 * The name of the extra used to define the name of a shortcut.
703 *
704 * @see #ACTION_CREATE_SHORTCUT
705 */
706 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
707 /**
708 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
709 *
710 * @see #ACTION_CREATE_SHORTCUT
711 */
712 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
713 /**
714 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
715 *
716 * @see #ACTION_CREATE_SHORTCUT
717 * @see android.content.Intent.ShortcutIconResource
718 */
719 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
720 "android.intent.extra.shortcut.ICON_RESOURCE";
721
722 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800723 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700724 *
725 * @see Intent#ACTION_CREATE_SHORTCUT
726 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800727 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
728 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700729 */
730 public static class ShortcutIconResource implements Parcelable {
731 /**
732 * The package name of the application containing the icon.
733 */
734 public String packageName;
735
736 /**
737 * The resource name of the icon, including package, name and type.
738 */
739 public String resourceName;
740
741 /**
742 * Creates a new ShortcutIconResource for the specified context and resource
743 * identifier.
744 *
745 * @param context The context of the application.
746 * @param resourceId The resource idenfitier for the icon.
747 * @return A new ShortcutIconResource with the specified's context package name
748 * and icon resource idenfitier.
749 */
750 public static ShortcutIconResource fromContext(Context context, int resourceId) {
751 ShortcutIconResource icon = new ShortcutIconResource();
752 icon.packageName = context.getPackageName();
753 icon.resourceName = context.getResources().getResourceName(resourceId);
754 return icon;
755 }
756
757 /**
758 * Used to read a ShortcutIconResource from a Parcel.
759 */
760 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
761 new Parcelable.Creator<ShortcutIconResource>() {
762
763 public ShortcutIconResource createFromParcel(Parcel source) {
764 ShortcutIconResource icon = new ShortcutIconResource();
765 icon.packageName = source.readString();
766 icon.resourceName = source.readString();
767 return icon;
768 }
769
770 public ShortcutIconResource[] newArray(int size) {
771 return new ShortcutIconResource[size];
772 }
773 };
774
775 /**
776 * No special parcel contents.
777 */
778 public int describeContents() {
779 return 0;
780 }
781
782 public void writeToParcel(Parcel dest, int flags) {
783 dest.writeString(packageName);
784 dest.writeString(resourceName);
785 }
786
787 @Override
788 public String toString() {
789 return resourceName;
790 }
791 }
792
793 /**
794 * Activity Action: Display an activity chooser, allowing the user to pick
795 * what they want to before proceeding. This can be used as an alternative
796 * to the standard activity picker that is displayed by the system when
797 * you try to start an activity with multiple possible matches, with these
798 * differences in behavior:
799 * <ul>
800 * <li>You can specify the title that will appear in the activity chooser.
801 * <li>The user does not have the option to make one of the matching
802 * activities a preferred activity, and all possible activities will
803 * always be shown even if one of them is currently marked as the
804 * preferred activity.
805 * </ul>
806 * <p>
807 * This action should be used when the user will naturally expect to
808 * select an activity in order to proceed. An example if when not to use
809 * it is when the user clicks on a "mailto:" link. They would naturally
810 * expect to go directly to their mail app, so startActivity() should be
811 * called directly: it will
812 * either launch the current preferred app, or put up a dialog allowing the
813 * user to pick an app to use and optionally marking that as preferred.
814 * <p>
815 * In contrast, if the user is selecting a menu item to send a picture
816 * they are viewing to someone else, there are many different things they
817 * may want to do at this point: send it through e-mail, upload it to a
818 * web service, etc. In this case the CHOOSER action should be used, to
819 * always present to the user a list of the things they can do, with a
820 * nice title given by the caller such as "Send this photo with:".
821 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700822 * If you need to grant URI permissions through a chooser, you must specify
823 * the permissions to be granted on the ACTION_CHOOSER Intent
824 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
825 * {@link #setClipData} to specify the URIs to be granted as well as
826 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
827 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
828 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700829 * As a convenience, an Intent of this form can be created with the
830 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700831 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700832 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700833 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
834 * and can optionally have a {@link #EXTRA_TITLE} field containing the
835 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700836 * <p>
837 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700838 */
839 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
840 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
841
842 /**
843 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
844 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700845 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
846 * target intent, also optionally supplying a title. If the target
847 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
848 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
849 * set in the returned chooser intent, with its ClipData set appropriately:
850 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500851 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700852 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700853 * @param target The Intent that the user will be selecting an activity
854 * to perform.
855 * @param title Optional title that will be displayed in the chooser.
856 * @return Return a new Intent object that you can hand to
857 * {@link Context#startActivity(Intent) Context.startActivity()} and
858 * related methods.
859 */
860 public static Intent createChooser(Intent target, CharSequence title) {
861 Intent intent = new Intent(ACTION_CHOOSER);
862 intent.putExtra(EXTRA_INTENT, target);
863 if (title != null) {
864 intent.putExtra(EXTRA_TITLE, title);
865 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700866
867 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700868 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
869 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
870 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700871 if (permFlags != 0) {
872 ClipData targetClipData = target.getClipData();
873 if (targetClipData == null && target.getData() != null) {
874 ClipData.Item item = new ClipData.Item(target.getData());
875 String[] mimeTypes;
876 if (target.getType() != null) {
877 mimeTypes = new String[] { target.getType() };
878 } else {
879 mimeTypes = new String[] { };
880 }
881 targetClipData = new ClipData(null, mimeTypes, item);
882 }
883 if (targetClipData != null) {
884 intent.setClipData(targetClipData);
885 intent.addFlags(permFlags);
886 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700887 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700888
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700889 return intent;
890 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700891
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700892 /**
893 * Activity Action: Allow the user to select a particular kind of data and
894 * return it. This is different than {@link #ACTION_PICK} in that here we
895 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800896 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700897 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900898 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700899 * etc.
900 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900901 * 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 -0700902 * of data, such as a person contact, you set the MIME type to the kind of
903 * data you want and launch it with {@link Context#startActivity(Intent)}.
904 * The system will then launch the best application to select that kind
905 * of data for you.
906 * <p>
907 * You may also be interested in any of a set of types of content the user
908 * can pick. For example, an e-mail application that wants to allow the
909 * user to add an attachment to an e-mail message can use this action to
910 * bring up a list of all of the types of content the user can attach.
911 * <p>
912 * In this case, you should wrap the GET_CONTENT intent with a chooser
913 * (through {@link #createChooser}), which will give the proper interface
914 * for the user to pick how to send your data and allow you to specify
915 * a prompt indicating what they are doing. You will usually specify a
916 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
917 * broad range of content types the user can select from.
918 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900919 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700920 * only pick from data that can be represented as a stream. This is
921 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
922 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800923 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900924 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800925 * is locally available on the device. For example, if this extra is set
926 * to true then an image picker should not show any pictures that are available
927 * from a remote server but not already on the local device (thus requiring
928 * they be downloaded when opened).
929 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800930 * If the caller can handle multiple returned items (the user performing
931 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
932 * to indicate this.
933 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700934 * Input: {@link #getType} is the desired MIME type to retrieve. Note
935 * that no URI is supplied in the intent, as there are no constraints on
936 * where the returned data originally comes from. You may also include the
937 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800938 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800939 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
940 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700941 * <p>
942 * Output: The URI of the item that was picked. This must be a content:
943 * URI so that any receiver can access it.
944 */
945 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
946 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
947 /**
948 * Activity Action: Dial a number as specified by the data. This shows a
949 * UI with the number being dialed, allowing the user to explicitly
950 * initiate the call.
951 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
952 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
953 * number.
954 * <p>Output: nothing.
955 */
956 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
957 public static final String ACTION_DIAL = "android.intent.action.DIAL";
958 /**
959 * Activity Action: Perform a call to someone specified by the data.
960 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
961 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
962 * number.
963 * <p>Output: nothing.
964 *
965 * <p>Note: there will be restrictions on which applications can initiate a
966 * call; most applications should use the {@link #ACTION_DIAL}.
967 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
968 * numbers. Applications can <strong>dial</strong> emergency numbers using
969 * {@link #ACTION_DIAL}, however.
970 */
971 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
972 public static final String ACTION_CALL = "android.intent.action.CALL";
973 /**
974 * Activity Action: Perform a call to an emergency number specified by the
975 * data.
976 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
977 * tel: URI of an explicit phone number.
978 * <p>Output: nothing.
979 * @hide
980 */
981 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
982 /**
983 * Activity action: Perform a call to any number (emergency or not)
984 * specified by the data.
985 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
986 * tel: URI of an explicit phone number.
987 * <p>Output: nothing.
988 * @hide
989 */
990 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
991 /**
992 * Activity Action: Send a message to someone specified by the data.
993 * <p>Input: {@link #getData} is URI describing the target.
994 * <p>Output: nothing.
995 */
996 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
997 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
998 /**
999 * Activity Action: Deliver some data to someone else. Who the data is
1000 * being delivered to is not specified; it is up to the receiver of this
1001 * action to ask the user where the data should be sent.
1002 * <p>
1003 * When launching a SEND intent, you should usually wrap it in a chooser
1004 * (through {@link #createChooser}), which will give the proper interface
1005 * for the user to pick how to send your data and allow you to specify
1006 * a prompt indicating what they are doing.
1007 * <p>
1008 * Input: {@link #getType} is the MIME type of the data being sent.
1009 * get*Extra can have either a {@link #EXTRA_TEXT}
1010 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1011 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1012 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1013 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001014 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1015 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1016 * your text with HTML formatting.
1017 * <p>
1018 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1019 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1020 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1021 * content: URIs and other advanced features of {@link ClipData}. If
1022 * using this approach, you still must supply the same data through the
1023 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1024 * for compatibility with old applications. If you don't set a ClipData,
1025 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001026 * <p>
1027 * Optional standard extras, which may be interpreted by some recipients as
1028 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1029 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1030 * <p>
1031 * Output: nothing.
1032 */
1033 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1034 public static final String ACTION_SEND = "android.intent.action.SEND";
1035 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001036 * Activity Action: Deliver multiple data to someone else.
1037 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001038 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001039 * <p>
1040 * Input: {@link #getType} is the MIME type of the data being sent.
1041 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001042 * #EXTRA_STREAM} field, containing the data to be sent. If using
1043 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1044 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001045 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001046 * Multiple types are supported, and receivers should handle mixed types
1047 * whenever possible. The right way for the receiver to check them is to
1048 * use the content resolver on each URI. The intent sender should try to
1049 * put the most concrete mime type in the intent type, but it can fall
1050 * back to {@literal <type>/*} or {@literal *}/* as needed.
1051 * <p>
1052 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1053 * be image/jpg, but if you are sending image/jpg and image/png, then the
1054 * intent's type should be image/*.
1055 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001056 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1057 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1058 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1059 * content: URIs and other advanced features of {@link ClipData}. If
1060 * using this approach, you still must supply the same data through the
1061 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1062 * for compatibility with old applications. If you don't set a ClipData,
1063 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1064 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001065 * Optional standard extras, which may be interpreted by some recipients as
1066 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1067 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1068 * <p>
1069 * Output: nothing.
1070 */
1071 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1072 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1073 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001074 * Activity Action: Handle an incoming phone call.
1075 * <p>Input: nothing.
1076 * <p>Output: nothing.
1077 */
1078 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1079 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1080 /**
1081 * Activity Action: Insert an empty item into the given container.
1082 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1083 * in which to place the data.
1084 * <p>Output: URI of the new data that was created.
1085 */
1086 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1087 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1088 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001089 * Activity Action: Create a new item in the given container, initializing it
1090 * from the current contents of the clipboard.
1091 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1092 * in which to place the data.
1093 * <p>Output: URI of the new data that was created.
1094 */
1095 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1096 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1097 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001098 * Activity Action: Delete the given data from its container.
1099 * <p>Input: {@link #getData} is URI of data to be deleted.
1100 * <p>Output: nothing.
1101 */
1102 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1103 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1104 /**
1105 * Activity Action: Run the data, whatever that means.
1106 * <p>Input: ? (Note: this is currently specific to the test harness.)
1107 * <p>Output: nothing.
1108 */
1109 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1110 public static final String ACTION_RUN = "android.intent.action.RUN";
1111 /**
1112 * Activity Action: Perform a data synchronization.
1113 * <p>Input: ?
1114 * <p>Output: ?
1115 */
1116 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1117 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1118 /**
1119 * Activity Action: Pick an activity given an intent, returning the class
1120 * selected.
1121 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1122 * used with {@link PackageManager#queryIntentActivities} to determine the
1123 * set of activities from which to pick.
1124 * <p>Output: Class name of the activity that was selected.
1125 */
1126 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1127 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1128 /**
1129 * Activity Action: Perform a search.
1130 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1131 * is the text to search for. If empty, simply
1132 * enter your search results Activity with the search UI activated.
1133 * <p>Output: nothing.
1134 */
1135 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1136 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1137 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001138 * Activity Action: Start the platform-defined tutorial
1139 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1140 * is the text to search for. If empty, simply
1141 * enter your search results Activity with the search UI activated.
1142 * <p>Output: nothing.
1143 */
1144 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1145 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1146 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001147 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001148 * <p>
1149 * Input: {@link android.app.SearchManager#QUERY
1150 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1151 * a url starts with http or https, the site will be opened. If it is plain
1152 * text, Google search will be applied.
1153 * <p>
1154 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001155 */
1156 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1157 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001158
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001159 /**
Jim Miller07994402012-05-02 14:22:27 -07001160 * Activity Action: Perform assist action.
1161 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001162 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1163 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001164 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001165 * Output: nothing.
1166 */
1167 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1168 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001169
1170 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001171 * Activity Action: Perform voice assist action.
1172 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001173 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1174 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001175 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001176 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001177 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001178 */
1179 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1180 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1181
1182 /**
Adam Skory7140a252013-09-11 12:04:58 +01001183 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1184 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001185 */
1186 public static final String EXTRA_ASSIST_PACKAGE
1187 = "android.intent.extra.ASSIST_PACKAGE";
1188
1189 /**
Adam Skory7140a252013-09-11 12:04:58 +01001190 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1191 * information supplied by the current foreground app at the time of the assist request.
1192 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001193 */
1194 public static final String EXTRA_ASSIST_CONTEXT
1195 = "android.intent.extra.ASSIST_CONTEXT";
1196
Jim Miller07994402012-05-02 14:22:27 -07001197 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001198 * Activity Action: List all available applications
1199 * <p>Input: Nothing.
1200 * <p>Output: nothing.
1201 */
1202 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1203 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1204 /**
1205 * Activity Action: Show settings for choosing wallpaper
1206 * <p>Input: Nothing.
1207 * <p>Output: Nothing.
1208 */
1209 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1210 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1211
1212 /**
1213 * Activity Action: Show activity for reporting a bug.
1214 * <p>Input: Nothing.
1215 * <p>Output: Nothing.
1216 */
1217 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1218 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1219
1220 /**
1221 * Activity Action: Main entry point for factory tests. Only used when
1222 * the device is booting in factory test node. The implementing package
1223 * must be installed in the system image.
1224 * <p>Input: nothing
1225 * <p>Output: nothing
1226 */
1227 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1228
1229 /**
1230 * Activity Action: The user pressed the "call" button to go to the dialer
1231 * or other appropriate UI for placing a call.
1232 * <p>Input: Nothing.
1233 * <p>Output: Nothing.
1234 */
1235 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1236 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1237
1238 /**
1239 * Activity Action: Start Voice Command.
1240 * <p>Input: Nothing.
1241 * <p>Output: Nothing.
1242 */
1243 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1244 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001245
1246 /**
1247 * Activity Action: Start action associated with long pressing on the
1248 * search key.
1249 * <p>Input: Nothing.
1250 * <p>Output: Nothing.
1251 */
1252 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1253 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001254
Jacek Surazski86b6c532009-05-13 14:38:28 +02001255 /**
1256 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1257 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001258 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001259 * <p>Input: No data is specified. The bug report is passed in using
1260 * an {@link #EXTRA_BUG_REPORT} field.
1261 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001262 *
1263 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001264 */
1265 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1266 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001267
1268 /**
1269 * Activity Action: Show power usage information to the user.
1270 * <p>Input: Nothing.
1271 * <p>Output: Nothing.
1272 */
1273 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1274 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001275
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001276 /**
1277 * Activity Action: Setup wizard to launch after a platform update. This
1278 * activity should have a string meta-data field associated with it,
1279 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1280 * the platform for setup. The activity will be launched only if
1281 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1282 * same value.
1283 * <p>Input: Nothing.
1284 * <p>Output: Nothing.
1285 * @hide
1286 */
1287 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1288 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001289
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001290 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001291 * Activity Action: Show settings for managing network data usage of a
1292 * specific application. Applications should define an activity that offers
1293 * options to control data usage.
1294 */
1295 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1296 public static final String ACTION_MANAGE_NETWORK_USAGE =
1297 "android.intent.action.MANAGE_NETWORK_USAGE";
1298
1299 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001300 * Activity Action: Launch application installer.
1301 * <p>
1302 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001303 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1304 * you can also use "package:<package-name>" to install an application for the
1305 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001306 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1307 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1308 * <p>
1309 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1310 * succeeded.
1311 *
1312 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1313 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1314 * @see #EXTRA_RETURN_RESULT
1315 */
1316 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1317 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1318
1319 /**
1320 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1321 * package. Specifies the installer package name; this package will receive the
1322 * {@link #ACTION_APP_ERROR} intent.
1323 */
1324 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1325 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1326
1327 /**
1328 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1329 * package. Specifies that the application being installed should not be
1330 * treated as coming from an unknown source, but as coming from the app
1331 * invoking the Intent. For this to work you must start the installer with
1332 * startActivityForResult().
1333 */
1334 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1335 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1336
1337 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001338 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1339 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001340 * data field originated from.
1341 */
rich cannings706e8ba2012-08-20 13:20:14 -07001342 public static final String EXTRA_ORIGINATING_URI
1343 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001344
1345 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001346 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1347 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1348 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001349 */
1350 public static final String EXTRA_REFERRER
1351 = "android.intent.extra.REFERRER";
1352
1353 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001354 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1355 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1356 * @hide
1357 */
1358 public static final String EXTRA_ORIGINATING_UID
1359 = "android.intent.extra.ORIGINATING_UID";
1360
1361 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001362 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1363 * package. Tells the installer UI to skip the confirmation with the user
1364 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001365 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1366 * will no longer show an interstitial message about updating existing
1367 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001368 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001369 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001370 public static final String EXTRA_ALLOW_REPLACE
1371 = "android.intent.extra.ALLOW_REPLACE";
1372
1373 /**
1374 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1375 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1376 * return to the application the result code of the install/uninstall. The returned result
1377 * code will be {@link android.app.Activity#RESULT_OK} on success or
1378 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1379 */
1380 public static final String EXTRA_RETURN_RESULT
1381 = "android.intent.extra.RETURN_RESULT";
1382
1383 /**
1384 * Package manager install result code. @hide because result codes are not
1385 * yet ready to be exposed.
1386 */
1387 public static final String EXTRA_INSTALL_RESULT
1388 = "android.intent.extra.INSTALL_RESULT";
1389
1390 /**
1391 * Activity Action: Launch application uninstaller.
1392 * <p>
1393 * Input: The data must be a package: URI whose scheme specific part is
1394 * the package name of the current installed package to be uninstalled.
1395 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1396 * <p>
1397 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1398 * succeeded.
1399 */
1400 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1401 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1402
1403 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001404 * Specify whether the package should be uninstalled for all users.
1405 * @hide because these should not be part of normal application flow.
1406 */
1407 public static final String EXTRA_UNINSTALL_ALL_USERS
1408 = "android.intent.extra.UNINSTALL_ALL_USERS";
1409
1410 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001411 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1412 * describing the last run version of the platform that was setup.
1413 * @hide
1414 */
1415 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1416
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001417 // ---------------------------------------------------------------------
1418 // ---------------------------------------------------------------------
1419 // Standard intent broadcast actions (see action variable).
1420
1421 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001422 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1423 * <p>
1424 * For historical reasons, the name of this broadcast action refers to the power
1425 * state of the screen but it is actually sent in response to changes in the
1426 * overall interactive state of the device.
1427 * </p><p>
1428 * This broadcast is sent when the device becomes non-interactive which may have
1429 * nothing to do with the screen turning off. To determine the
1430 * actual state of the screen, use {@link android.view.Display#getState}.
1431 * </p><p>
1432 * See {@link android.os.PowerManager#isInteractive} for details.
1433 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001434 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001435 * <p class="note">This is a protected intent that can only be sent
1436 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001437 */
1438 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1439 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001440
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001441 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001442 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1443 * <p>
1444 * For historical reasons, the name of this broadcast action refers to the power
1445 * state of the screen but it is actually sent in response to changes in the
1446 * overall interactive state of the device.
1447 * </p><p>
1448 * This broadcast is sent when the device becomes interactive which may have
1449 * nothing to do with the screen turning on. To determine the
1450 * actual state of the screen, use {@link android.view.Display#getState}.
1451 * </p><p>
1452 * See {@link android.os.PowerManager#isInteractive} for details.
1453 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001454 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001455 * <p class="note">This is a protected intent that can only be sent
1456 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001457 */
1458 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1459 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001460
1461 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001462 * Broadcast Action: Sent after the system stops dreaming.
1463 *
1464 * <p class="note">This is a protected intent that can only be sent by the system.
1465 * It is only sent to registered receivers.</p>
1466 */
1467 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1468 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1469
1470 /**
1471 * Broadcast Action: Sent after the system starts dreaming.
1472 *
1473 * <p class="note">This is a protected intent that can only be sent by the system.
1474 * It is only sent to registered receivers.</p>
1475 */
1476 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1477 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1478
1479 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001480 * 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 -07001481 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001482 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001483 * <p class="note">This is a protected intent that can only be sent
1484 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001485 */
1486 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001487 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001488
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001489 /**
1490 * Broadcast Action: The current time has changed. Sent every
1491 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001492 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001493 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1494 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001495 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001496 * <p class="note">This is a protected intent that can only be sent
1497 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001498 */
1499 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1500 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1501 /**
1502 * Broadcast Action: The time was set.
1503 */
1504 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1505 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1506 /**
1507 * Broadcast Action: The date has changed.
1508 */
1509 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1510 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1511 /**
1512 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1513 * <ul>
1514 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1515 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001516 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001517 * <p class="note">This is a protected intent that can only be sent
1518 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001519 */
1520 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1521 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1522 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001523 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1524 * DNS entries should be tossed.
1525 * @hide
1526 */
1527 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1528 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1529 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001530 * Alarm Changed Action: This is broadcast when the AlarmClock
1531 * application's alarm is set or unset. It is used by the
1532 * AlarmClock application and the StatusBar service.
1533 * @hide
1534 */
1535 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1536 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1537 /**
1538 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1539 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1540 * @hide
1541 */
1542 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1543 public static final String ACTION_SYNC_STATE_CHANGED
1544 = "android.intent.action.SYNC_STATE_CHANGED";
1545 /**
1546 * Broadcast Action: This is broadcast once, after the system has finished
1547 * booting. It can be used to perform application-specific initialization,
1548 * such as installing alarms. You must hold the
1549 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1550 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001551 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001552 * <p class="note">This is a protected intent that can only be sent
1553 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001554 */
1555 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1556 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1557 /**
1558 * Broadcast Action: This is broadcast when a user action should request a
1559 * temporary system dialog to dismiss. Some examples of temporary system
1560 * dialogs are the notification window-shade and the recent tasks dialog.
1561 */
1562 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1563 /**
1564 * Broadcast Action: Trigger the download and eventual installation
1565 * of a package.
1566 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001567 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001568 * <p class="note">This is a protected intent that can only be sent
1569 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001570 *
1571 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001572 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001573 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001574 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1575 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1576 /**
1577 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001578 * device. The data contains the name of the package. Note that the
1579 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001580 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001581 * <ul>
1582 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1583 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1584 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1585 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001586 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001587 * <p class="note">This is a protected intent that can only be sent
1588 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001589 */
1590 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1591 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1592 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001593 * Broadcast Action: A new version of an application package has been
1594 * installed, replacing an existing version that was previously installed.
1595 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001596 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001597 * <ul>
1598 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1599 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001600 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001601 * <p class="note">This is a protected intent that can only be sent
1602 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001603 */
1604 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1605 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1606 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001607 * Broadcast Action: A new version of your application has been installed
1608 * over an existing one. This is only sent to the application that was
1609 * replaced. It does not contain any additional data; to receive it, just
1610 * use an intent filter for this action.
1611 *
1612 * <p class="note">This is a protected intent that can only be sent
1613 * by the system.
1614 */
1615 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1616 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1617 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001618 * Broadcast Action: An existing application package has been removed from
1619 * the device. The data contains the name of the package. The package
1620 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001621 * <ul>
1622 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1623 * to the package.
1624 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1625 * application -- data and code -- is being removed.
1626 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1627 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1628 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001629 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001630 * <p class="note">This is a protected intent that can only be sent
1631 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001632 */
1633 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1634 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1635 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001636 * Broadcast Action: An existing application package has been completely
1637 * removed from the device. The data contains the name of the package.
1638 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1639 * {@link #EXTRA_DATA_REMOVED} is true and
1640 * {@link #EXTRA_REPLACING} is false of that broadcast.
1641 *
1642 * <ul>
1643 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1644 * to the package.
1645 * </ul>
1646 *
1647 * <p class="note">This is a protected intent that can only be sent
1648 * by the system.
1649 */
1650 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1651 public static final String ACTION_PACKAGE_FULLY_REMOVED
1652 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1653 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001654 * Broadcast Action: An existing application package has been changed (e.g.
1655 * a component has been enabled or disabled). The data contains the name of
1656 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001657 * <ul>
1658 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001659 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001660 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001661 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1662 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001663 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001664 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001665 * <p class="note">This is a protected intent that can only be sent
1666 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001667 */
1668 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1669 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1670 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001671 * @hide
1672 * Broadcast Action: Ask system services if there is any reason to
1673 * restart the given package. The data contains the name of the
1674 * package.
1675 * <ul>
1676 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1677 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1678 * </ul>
1679 *
1680 * <p class="note">This is a protected intent that can only be sent
1681 * by the system.
1682 */
1683 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1684 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1685 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001686 * Broadcast Action: The user has restarted a package, and all of its
1687 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001688 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001689 * be removed. Note that the restarted package does <em>not</em>
1690 * receive this broadcast.
1691 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001692 * <ul>
1693 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1694 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001695 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001696 * <p class="note">This is a protected intent that can only be sent
1697 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001698 */
1699 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1700 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1701 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001702 * Broadcast Action: The user has cleared the data of a package. This should
1703 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001704 * its persistent data is erased and this broadcast sent.
1705 * Note that the cleared package does <em>not</em>
1706 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001707 * <ul>
1708 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1709 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001710 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001711 * <p class="note">This is a protected intent that can only be sent
1712 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001713 */
1714 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1715 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1716 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001717 * Broadcast Action: A user ID has been removed from the system. The user
1718 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001719 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001720 * <p class="note">This is a protected intent that can only be sent
1721 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001722 */
1723 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1724 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001725
1726 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001727 * Broadcast Action: Sent to the installer package of an application
1728 * when that application is first launched (that is the first time it
1729 * is moved out of the stopped state). The data contains the name of the package.
1730 *
1731 * <p class="note">This is a protected intent that can only be sent
1732 * by the system.
1733 */
1734 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1735 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1736
1737 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001738 * Broadcast Action: Sent to the system package verifier when a package
1739 * needs to be verified. The data contains the package URI.
1740 * <p class="note">
1741 * This is a protected intent that can only be sent by the system.
1742 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001743 */
1744 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1745 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1746
1747 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001748 * Broadcast Action: Sent to the system package verifier when a package is
1749 * verified. The data contains the package URI.
1750 * <p class="note">
1751 * This is a protected intent that can only be sent by the system.
1752 */
1753 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1754 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1755
1756 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001757 * Broadcast Action: Resources for a set of packages (which were
1758 * previously unavailable) are currently
1759 * available since the media on which they exist is available.
1760 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1761 * list of packages whose availability changed.
1762 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1763 * list of uids of packages whose availability changed.
1764 * Note that the
1765 * packages in this list do <em>not</em> receive this broadcast.
1766 * The specified set of packages are now available on the system.
1767 * <p>Includes the following extras:
1768 * <ul>
1769 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1770 * whose resources(were previously unavailable) are currently available.
1771 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1772 * packages whose resources(were previously unavailable)
1773 * are currently available.
1774 * </ul>
1775 *
1776 * <p class="note">This is a protected intent that can only be sent
1777 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001778 */
1779 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001780 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1781 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001782
1783 /**
1784 * Broadcast Action: Resources for a set of packages are currently
1785 * unavailable since the media on which they exist is unavailable.
1786 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1787 * list of packages whose availability changed.
1788 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1789 * list of uids of packages whose availability changed.
1790 * The specified set of packages can no longer be
1791 * launched and are practically unavailable on the system.
1792 * <p>Inclues the following extras:
1793 * <ul>
1794 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1795 * whose resources are no longer available.
1796 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1797 * whose resources are no longer available.
1798 * </ul>
1799 *
1800 * <p class="note">This is a protected intent that can only be sent
1801 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001802 */
1803 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001804 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001805 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001806
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001807 /**
1808 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001809 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001810 * This should <em>only</em> be used to determine when the wallpaper
1811 * has changed to show the new wallpaper to the user. You should certainly
1812 * never, in response to this, change the wallpaper or other attributes of
1813 * it such as the suggested size. That would be crazy, right? You'd cause
1814 * all kinds of loops, especially if other apps are doing similar things,
1815 * right? Of course. So please don't do this.
1816 *
1817 * @deprecated Modern applications should use
1818 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1819 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1820 * shown behind their UI, rather than watching for this broadcast and
1821 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001822 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001823 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001824 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1825 /**
1826 * Broadcast Action: The current device {@link android.content.res.Configuration}
1827 * (orientation, locale, etc) has changed. When such a change happens, the
1828 * UIs (view hierarchy) will need to be rebuilt based on this new
1829 * information; for the most part, applications don't need to worry about
1830 * this, because the system will take care of stopping and restarting the
1831 * application to make sure it sees the new changes. Some system code that
1832 * can not be restarted will need to watch for this action and handle it
1833 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001834 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001835 * <p class="note">
1836 * You can <em>not</em> receive this through components declared
1837 * in manifests, only by explicitly registering for it with
1838 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1839 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001840 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001841 * <p class="note">This is a protected intent that can only be sent
1842 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001843 *
1844 * @see android.content.res.Configuration
1845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1848 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001849 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001850 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001851 * <p class="note">This is a protected intent that can only be sent
1852 * by the system.
1853 */
1854 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1855 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1856 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001857 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1858 * charging state, level, and other information about the battery.
1859 * See {@link android.os.BatteryManager} for documentation on the
1860 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001861 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001862 * <p class="note">
1863 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001864 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001865 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001866 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1867 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1868 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1869 * broadcasts that are sent and can be received through manifest
1870 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001871 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001872 * <p class="note">This is a protected intent that can only be sent
1873 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001874 */
1875 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1876 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1877 /**
1878 * Broadcast Action: Indicates low battery condition on the device.
1879 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001880 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001881 * <p class="note">This is a protected intent that can only be sent
1882 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001883 */
1884 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1885 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1886 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001887 * Broadcast Action: Indicates the battery is now okay after being low.
1888 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1889 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001890 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001891 * <p class="note">This is a protected intent that can only be sent
1892 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001893 */
1894 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1895 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1896 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001897 * Broadcast Action: External power has been connected to the device.
1898 * This is intended for applications that wish to register specifically to this notification.
1899 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1900 * stay active to receive this notification. This action can be used to implement actions
1901 * that wait until power is available to trigger.
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.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001905 */
1906 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001907 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001908 /**
1909 * Broadcast Action: External power has been removed from the device.
1910 * This is intended for applications that wish to register specifically to this notification.
1911 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1912 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001913 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001914 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001915 * <p class="note">This is a protected intent that can only be sent
1916 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001917 */
1918 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001919 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001920 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001921 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001922 * Broadcast Action: Device is shutting down.
1923 * This is broadcast when the device is being shut down (completely turned
1924 * off, not sleeping). Once the broadcast is complete, the final shutdown
1925 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001926 * to handle this, since the foreground activity will be paused as well.
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.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001930 * <p>May include the following extras:
1931 * <ul>
1932 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1933 * shutdown is only for userspace processes. If not set, assumed to be false.
1934 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001935 */
1936 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001937 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001938 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001939 * Activity Action: Start this activity to request system shutdown.
1940 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1941 * to request confirmation from the user before shutting down.
1942 *
1943 * <p class="note">This is a protected intent that can only be sent
1944 * by the system.
1945 *
1946 * {@hide}
1947 */
1948 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1949 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001950 * Broadcast Action: A sticky broadcast that indicates low memory
1951 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001952 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001953 * <p class="note">This is a protected intent that can only be sent
1954 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001955 */
1956 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1957 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1958 /**
1959 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001960 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001961 * <p class="note">This is a protected intent that can only be sent
1962 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001963 */
1964 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1965 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1966 /**
Jake Hambybb371632010-08-23 18:16:48 -07001967 * Broadcast Action: A sticky broadcast that indicates a memory full
1968 * condition on the device. This is intended for activities that want
1969 * to be able to fill the data partition completely, leaving only
1970 * enough free space to prevent system-wide SQLite failures.
1971 *
1972 * <p class="note">This is a protected intent that can only be sent
1973 * by the system.
1974 *
1975 * {@hide}
1976 */
1977 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1978 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1979 /**
1980 * Broadcast Action: Indicates memory full condition on the device
1981 * no longer exists.
1982 *
1983 * <p class="note">This is a protected intent that can only be sent
1984 * by the system.
1985 *
1986 * {@hide}
1987 */
1988 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1989 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1990 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001991 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1992 * and package management should be started.
1993 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1994 * notification.
1995 */
1996 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1997 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1998 /**
1999 * Broadcast Action: The device has entered USB Mass Storage mode.
2000 * This is used mainly for the USB Settings panel.
2001 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2002 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002003 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002004 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002005 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002006 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2007
2008 /**
2009 * Broadcast Action: The device has exited USB Mass Storage mode.
2010 * This is used mainly for the USB Settings panel.
2011 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2012 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002013 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002014 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002015 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002016 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2017
2018 /**
2019 * Broadcast Action: External media has been removed.
2020 * The path to the mount point for the removed media is contained in the Intent.mData field.
2021 */
2022 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2023 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2024
2025 /**
2026 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002027 * 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 -07002028 */
2029 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2030 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2031
2032 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002033 * Broadcast Action: External media is present, and being disk-checked
2034 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002035 */
2036 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2037 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2038
2039 /**
2040 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2041 * 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 -08002042 */
2043 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2044 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2045
2046 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002047 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002048 * 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 -07002049 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2050 * media was mounted read only.
2051 */
2052 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2053 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2054
2055 /**
2056 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002057 * 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 -07002058 */
2059 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2060 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2061
2062 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002063 * Broadcast Action: External media is no longer being shared via USB mass storage.
2064 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2065 *
2066 * @hide
2067 */
2068 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2069
2070 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002071 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2072 * The path to the mount point for the removed media is contained in the Intent.mData field.
2073 */
2074 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2075 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2076
2077 /**
2078 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002079 * 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 -07002080 */
2081 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2082 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2083
2084 /**
2085 * Broadcast Action: User has expressed the desire to remove the external storage media.
2086 * Applications should close all files they have open within the mount point when they receive this intent.
2087 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2088 */
2089 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2090 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2091
2092 /**
2093 * Broadcast Action: The media scanner has started scanning a directory.
2094 * The path to the directory being scanned is contained in the Intent.mData field.
2095 */
2096 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2097 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2098
2099 /**
2100 * Broadcast Action: The media scanner has finished scanning a directory.
2101 * The path to the scanned directory is contained in the Intent.mData field.
2102 */
2103 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2104 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2105
2106 /**
2107 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2108 * The path to the file is contained in the Intent.mData field.
2109 */
2110 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2111 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2112
2113 /**
2114 * Broadcast Action: The "Media Button" was pressed. Includes a single
2115 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2116 * caused the broadcast.
2117 */
2118 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2119 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2120
2121 /**
2122 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2123 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2124 * caused the broadcast.
2125 */
2126 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2127 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2128
2129 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2130 // location; they are not general-purpose actions.
2131
2132 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002133 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002134 */
2135 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2136 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2137 "android.intent.action.GTALK_CONNECTED";
2138
2139 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002140 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002141 */
2142 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2143 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2144 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002145
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002146 /**
2147 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002148 */
2149 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2150 public static final String ACTION_INPUT_METHOD_CHANGED =
2151 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002152
2153 /**
2154 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2155 * more radios have been turned off or on. The intent will have the following extra value:</p>
2156 * <ul>
2157 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2158 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2159 * turned off</li>
2160 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002161 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002162 * <p class="note">This is a protected intent that can only be sent
2163 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002164 */
2165 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2166 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2167
2168 /**
2169 * Broadcast Action: Some content providers have parts of their namespace
2170 * where they publish new events or items that the user may be especially
2171 * interested in. For these things, they may broadcast this action when the
2172 * set of interesting items change.
2173 *
2174 * For example, GmailProvider sends this notification when the set of unread
2175 * mail in the inbox changes.
2176 *
2177 * <p>The data of the intent identifies which part of which provider
2178 * changed. When queried through the content resolver, the data URI will
2179 * return the data set in question.
2180 *
2181 * <p>The intent will have the following extra values:
2182 * <ul>
2183 * <li><em>count</em> - The number of items in the data set. This is the
2184 * same as the number of items in the cursor returned by querying the
2185 * data URI. </li>
2186 * </ul>
2187 *
2188 * This intent will be sent at boot (if the count is non-zero) and when the
2189 * data set changes. It is possible for the data set to change without the
2190 * count changing (for example, if a new unread message arrives in the same
2191 * sync operation in which a message is archived). The phone should still
2192 * ring/vibrate/etc as normal in this case.
2193 */
2194 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2195 public static final String ACTION_PROVIDER_CHANGED =
2196 "android.intent.action.PROVIDER_CHANGED";
2197
2198 /**
2199 * Broadcast Action: Wired Headset plugged in or unplugged.
2200 *
Matt Casey79867f52014-03-26 15:20:25 -07002201 * You <em>cannot</em> receive this through components declared
2202 * in manifests, only by explicitly registering for it with
2203 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2204 * Context.registerReceiver()}.
2205 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002206 * <p>The intent will have the following extra values:
2207 * <ul>
2208 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2209 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002210 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002211 * </ul>
2212 * </ul>
2213 */
2214 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2215 public static final String ACTION_HEADSET_PLUG =
2216 "android.intent.action.HEADSET_PLUG";
2217
2218 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002219 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2220 *
2221 * <p>The intent will have the following extra values:
2222 * <ul>
2223 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2224 * <li><em>name</em> - Headset type, human readable string </li>
2225 * </ul>
2226 * </ul>
2227 * @hide
2228 */
2229 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002230 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2231 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002232
2233 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002234 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002235 *
2236 * <p>The intent will have the following extra values:
2237 * <ul>
2238 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2239 * <li><em>name</em> - Headset type, human readable string </li>
2240 * </ul>
2241 * </ul>
2242 * @hide
2243 */
2244 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002245 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2246 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002247
2248 /**
2249 * Broadcast Action: A HMDI cable was plugged or unplugged
2250 *
2251 * <p>The intent will have the following extra values:
2252 * <ul>
2253 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2254 * <li><em>name</em> - HDMI cable, human readable string </li>
2255 * </ul>
2256 * </ul>
2257 * @hide
2258 */
2259 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2260 public static final String ACTION_HDMI_AUDIO_PLUG =
2261 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002262
2263 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002264 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2265 *
2266 * <p>The intent will have the following extra values:
2267 * <ul>
2268 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2269 * <li><em>card</em> - ALSA card number (integer) </li>
2270 * <li><em>device</em> - ALSA device number (integer) </li>
2271 * </ul>
2272 * </ul>
2273 * @hide
2274 */
2275 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2276 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2277 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2278
2279 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002280 * Broadcast Action: A USB audio device was plugged in or unplugged.
2281 *
2282 * <p>The intent will have the following extra values:
2283 * <ul>
2284 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2285 * <li><em>card</em> - ALSA card number (integer) </li>
2286 * <li><em>device</em> - ALSA device number (integer) </li>
2287 * </ul>
2288 * </ul>
2289 * @hide
2290 */
2291 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2292 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2293 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2294
2295 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002296 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2297 * <ul>
2298 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2299 * </ul>
2300 *
2301 * <p class="note">This is a protected intent that can only be sent
2302 * by the system.
2303 *
2304 * @hide
2305 */
2306 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2307 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2308 = "android.intent.action.ADVANCED_SETTINGS";
2309
2310 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002311 * Broadcast Action: Sent after application restrictions are changed.
2312 *
2313 * <p class="note">This is a protected intent that can only be sent
2314 * by the system.</p>
2315 */
2316 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2317 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2318 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2319
2320 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002321 * Broadcast Action: An outgoing call is about to be placed.
2322 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002323 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002324 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002325 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002326 * the phone number originally intended to be dialed.</li>
2327 * </ul>
2328 * <p>Once the broadcast is finished, the resultData is used as the actual
2329 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002330 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002331 * outgoing call in turn: for example, a parental control application
2332 * might verify that the user is authorized to place the call at that
2333 * time, then a number-rewriting application might add an area code if
2334 * one was not specified.</p>
2335 * <p>For consistency, any receiver whose purpose is to prohibit phone
2336 * calls should have a priority of 0, to ensure it will see the final
2337 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002338 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002339 * should have a positive priority.
2340 * Negative priorities are reserved for the system for this broadcast;
2341 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002342 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2343 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002344 * <p>Emergency calls cannot be intercepted using this mechanism, and
2345 * other calls cannot be modified to call emergency numbers using this
2346 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002347 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2348 * call to use their own service instead. Those apps should first prevent
2349 * the call from being placed by setting resultData to <code>null</code>
2350 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002351 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002352 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2353 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002354 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002355 * <p class="note">This is a protected intent that can only be sent
2356 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002357 */
2358 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2359 public static final String ACTION_NEW_OUTGOING_CALL =
2360 "android.intent.action.NEW_OUTGOING_CALL";
2361
2362 /**
2363 * Broadcast Action: Have the device reboot. This is only for use by
2364 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002365 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002366 * <p class="note">This is a protected intent that can only be sent
2367 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002368 */
2369 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2370 public static final String ACTION_REBOOT =
2371 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002372
Wei Huang97ecc9c2009-05-11 17:44:20 -07002373 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002374 * Broadcast Action: A sticky broadcast for changes in the physical
2375 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002376 *
2377 * <p>The intent will have the following extra values:
2378 * <ul>
2379 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002380 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002381 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002382 * <p>This is intended for monitoring the current physical dock state.
2383 * See {@link android.app.UiModeManager} for the normal API dealing with
2384 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002385 */
2386 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2387 public static final String ACTION_DOCK_EVENT =
2388 "android.intent.action.DOCK_EVENT";
2389
2390 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002391 * Broadcast Action: A broadcast when idle maintenance can be started.
2392 * This means that the user is not interacting with the device and is
2393 * not expected to do so soon. Typical use of the idle maintenance is
2394 * to perform somehow expensive tasks that can be postponed at a moment
2395 * when they will not degrade user experience.
2396 * <p>
2397 * <p class="note">In order to keep the device responsive in case of an
2398 * unexpected user interaction, implementations of a maintenance task
2399 * should be interruptible. In such a scenario a broadcast with action
2400 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2401 * should not do the maintenance work in
2402 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2403 * maintenance service by {@link Context#startService(Intent)}. Also
2404 * you should hold a wake lock while your maintenance service is running
2405 * to prevent the device going to sleep.
2406 * </p>
2407 * <p>
2408 * <p class="note">This is a protected intent that can only be sent by
2409 * the system.
2410 * </p>
2411 *
2412 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002413 *
2414 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002415 */
2416 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2417 public static final String ACTION_IDLE_MAINTENANCE_START =
2418 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2419
2420 /**
2421 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2422 * This means that the user was not interacting with the device as a result
2423 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2424 * was sent and now the user started interacting with the device. Typical
2425 * use of the idle maintenance is to perform somehow expensive tasks that
2426 * can be postponed at a moment when they will not degrade user experience.
2427 * <p>
2428 * <p class="note">In order to keep the device responsive in case of an
2429 * unexpected user interaction, implementations of a maintenance task
2430 * should be interruptible. Hence, on receiving a broadcast with this
2431 * action, the maintenance task should be interrupted as soon as possible.
2432 * In other words, you should not do the maintenance work in
2433 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2434 * maintenance service that was started on receiving of
2435 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2436 * lock you acquired when your maintenance service started.
2437 * </p>
2438 * <p class="note">This is a protected intent that can only be sent
2439 * by the system.
2440 *
2441 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002442 *
2443 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002444 */
2445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2446 public static final String ACTION_IDLE_MAINTENANCE_END =
2447 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2448
2449 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002450 * Broadcast Action: a remote intent is to be broadcasted.
2451 *
2452 * A remote intent is used for remote RPC between devices. The remote intent
2453 * is serialized and sent from one device to another device. The receiving
2454 * device parses the remote intent and broadcasts it. Note that anyone can
2455 * broadcast a remote intent. However, if the intent receiver of the remote intent
2456 * does not trust intent broadcasts from arbitrary intent senders, it should require
2457 * the sender to hold certain permissions so only trusted sender's broadcast will be
2458 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002459 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002460 */
2461 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002462 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002463
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002464 /**
2465 * Broadcast Action: hook for permforming cleanup after a system update.
2466 *
2467 * The broadcast is sent when the system is booting, before the
2468 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2469 * image. A receiver for this should do its work and then disable itself
2470 * so that it does not get run again at the next boot.
2471 * @hide
2472 */
2473 public static final String ACTION_PRE_BOOT_COMPLETED =
2474 "android.intent.action.PRE_BOOT_COMPLETED";
2475
Amith Yamasani13593602012-03-22 16:16:17 -07002476 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002477 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002478 * on restricted users. The broadcast intent contains an extra
2479 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2480 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2481 * String[] depending on the restriction type.<p/>
2482 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002483 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2484 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2485 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002486 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2487 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002488 * @see RestrictionEntry
2489 */
2490 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2491 "android.intent.action.GET_RESTRICTION_ENTRIES";
2492
2493 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002494 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002495 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002496 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2497 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2498 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002499 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2500 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2501 * challenge.<p/>
2502 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002503 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002504 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002505 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2506 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002507
2508 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002509 * Sent the first time a user is starting, to allow system apps to
2510 * perform one time initialization. (This will not be seen by third
2511 * party applications because a newly initialized user does not have any
2512 * third party applications installed for it.) This is sent early in
2513 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002514 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2515 * broadcast, since it is part of a visible user interaction; be as quick
2516 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002517 */
2518 public static final String ACTION_USER_INITIALIZE =
2519 "android.intent.action.USER_INITIALIZE";
2520
2521 /**
2522 * Sent when a user switch is happening, causing the process's user to be
2523 * brought to the foreground. This is only sent to receivers registered
2524 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2525 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002526 * foreground. This is sent as a foreground
2527 * broadcast, since it is part of a visible user interaction; be as quick
2528 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002529 */
2530 public static final String ACTION_USER_FOREGROUND =
2531 "android.intent.action.USER_FOREGROUND";
2532
2533 /**
2534 * Sent when a user switch is happening, causing the process's user to be
2535 * sent to the background. This is only sent to receivers registered
2536 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2537 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002538 * background. This is sent as a foreground
2539 * broadcast, since it is part of a visible user interaction; be as quick
2540 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002541 */
2542 public static final String ACTION_USER_BACKGROUND =
2543 "android.intent.action.USER_BACKGROUND";
2544
2545 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002546 * Broadcast sent to the system when a user is added. Carries an extra
2547 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2548 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002549 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002550 * @hide
2551 */
2552 public static final String ACTION_USER_ADDED =
2553 "android.intent.action.USER_ADDED";
2554
2555 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002556 * Broadcast sent by the system when a user is started. Carries an extra
2557 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002558 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002559 * that has been started. This is sent as a foreground
2560 * broadcast, since it is part of a visible user interaction; be as quick
2561 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002562 * @hide
2563 */
2564 public static final String ACTION_USER_STARTED =
2565 "android.intent.action.USER_STARTED";
2566
2567 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002568 * Broadcast sent when a user is in the process of starting. Carries an extra
2569 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2570 * sent to registered receivers, not manifest receivers. It is sent to all
2571 * users (including the one that is being started). You must hold
2572 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2573 * this broadcast. This is sent as a background broadcast, since
2574 * its result is not part of the primary UX flow; to safely keep track of
2575 * started/stopped state of a user you can use this in conjunction with
2576 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2577 * other user state broadcasts since those are foreground broadcasts so can
2578 * execute in a different order.
2579 * @hide
2580 */
2581 public static final String ACTION_USER_STARTING =
2582 "android.intent.action.USER_STARTING";
2583
2584 /**
2585 * Broadcast sent when a user is going to be stopped. Carries an extra
2586 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2587 * sent to registered receivers, not manifest receivers. It is sent to all
2588 * users (including the one that is being stopped). You must hold
2589 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2590 * this broadcast. The user will not stop until all receivers have
2591 * handled the broadcast. This is sent as a background broadcast, since
2592 * its result is not part of the primary UX flow; to safely keep track of
2593 * started/stopped state of a user you can use this in conjunction with
2594 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2595 * other user state broadcasts since those are foreground broadcasts so can
2596 * execute in a different order.
2597 * @hide
2598 */
2599 public static final String ACTION_USER_STOPPING =
2600 "android.intent.action.USER_STOPPING";
2601
2602 /**
2603 * Broadcast sent to the system when a user is stopped. Carries an extra
2604 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2605 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2606 * specific package. This is only sent to registered receivers, not manifest
2607 * receivers. It is sent to all running users <em>except</em> the one that
2608 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002609 * @hide
2610 */
2611 public static final String ACTION_USER_STOPPED =
2612 "android.intent.action.USER_STOPPED";
2613
2614 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002615 * 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 -07002616 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002617 * one that has been removed. The user will not be completely removed until all receivers have
2618 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002619 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002620 * @hide
2621 */
2622 public static final String ACTION_USER_REMOVED =
2623 "android.intent.action.USER_REMOVED";
2624
2625 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002626 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002627 * the userHandle of the user to become the current one. This is only sent to
2628 * registered receivers, not manifest receivers. It is sent to all running users.
2629 * You must hold
2630 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002631 * @hide
2632 */
2633 public static final String ACTION_USER_SWITCHED =
2634 "android.intent.action.USER_SWITCHED";
2635
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002636 /**
2637 * Broadcast sent to the system when a user's information changes. Carries an extra
2638 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002639 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002640 * @hide
2641 */
2642 public static final String ACTION_USER_INFO_CHANGED =
2643 "android.intent.action.USER_INFO_CHANGED";
2644
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002645 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002646 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2647 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
2648 * the UserHandle of the profile that was added. This is only sent to registered receivers,
2649 * not manifest receivers.
2650 */
2651 public static final String ACTION_MANAGED_PROFILE_ADDED =
2652 "android.intent.action.MANAGED_PROFILE_ADDED";
2653
2654 /**
2655 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
2656 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed. This
2657 * is only sent to registered receivers, not manifest receivers.
2658 */
2659 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2660 "android.intent.action.MANAGED_PROFILE_REMOVED";
2661
2662 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002663 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2664 */
2665 public static final String ACTION_QUICK_CLOCK =
2666 "android.intent.action.QUICK_CLOCK";
2667
Michael Wright0087a142013-02-05 16:29:39 -08002668 /**
2669 * Broadcast Action: This is broadcast when a user action should request the
2670 * brightness setting dialog.
2671 * @hide
2672 */
2673 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2674 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2675
Justin Kohd378ad72013-04-01 12:18:26 -07002676 /**
2677 * Broadcast Action: A global button was pressed. Includes a single
2678 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2679 * caused the broadcast.
2680 * @hide
2681 */
2682 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2683
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002684 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002685 * Activity Action: Allow the user to select and return one or more existing
2686 * documents. When invoked, the system will display the various
2687 * {@link DocumentsProvider} instances installed on the device, letting the
2688 * user interactively navigate through them. These documents include local
2689 * media, such as photos and video, and documents provided by installed
2690 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002691 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002692 * Each document is represented as a {@code content://} URI backed by a
2693 * {@link DocumentsProvider}, which can be opened as a stream with
2694 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2695 * {@link android.provider.DocumentsContract.Document} metadata.
2696 * <p>
2697 * All selected documents are returned to the calling application with
2698 * persistable read and write permission grants. If you want to maintain
2699 * access to the documents across device reboots, you need to explicitly
2700 * take the persistable permissions using
2701 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2702 * <p>
2703 * Callers can restrict document selection to a specific kind of data, such
2704 * as photos, by setting one or more MIME types in
2705 * {@link #EXTRA_MIME_TYPES}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002706 * <p>
2707 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002708 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2709 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002710 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002711 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2712 * returned URIs can be opened with
2713 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002714 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002715 * Output: The URI of the item that was picked. This must be a
2716 * {@code content://} URI so that any receiver can access it. If multiple
2717 * documents were selected, they are returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002718 *
2719 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002720 * @see #ACTION_CREATE_DOCUMENT
2721 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002722 */
2723 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2724 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2725
2726 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002727 * Activity Action: Allow the user to create a new document. When invoked,
2728 * the system will display the various {@link DocumentsProvider} instances
2729 * installed on the device, letting the user navigate through them. The
2730 * returned document may be a newly created document with no content, or it
2731 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002732 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002733 * Each document is represented as a {@code content://} URI backed by a
2734 * {@link DocumentsProvider}, which can be opened as a stream with
2735 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2736 * {@link android.provider.DocumentsContract.Document} metadata.
2737 * <p>
2738 * Callers must indicate the concrete MIME type of the document being
2739 * created by setting {@link #setType(String)}. This MIME type cannot be
2740 * changed after the document is created.
2741 * <p>
2742 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2743 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002744 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002745 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2746 * returned URIs can be opened with
2747 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002748 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002749 * Output: The URI of the item that was created. This must be a
2750 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002751 *
2752 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002753 * @see #ACTION_OPEN_DOCUMENT
2754 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002755 */
2756 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2757 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2758
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002759 // ---------------------------------------------------------------------
2760 // ---------------------------------------------------------------------
2761 // Standard intent categories (see addCategory()).
2762
2763 /**
2764 * Set if the activity should be an option for the default action
2765 * (center press) to perform on a piece of data. Setting this will
2766 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002767 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002768 * Intent when initiating an action -- it is for use in intent filters
2769 * specified in packages.
2770 */
2771 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2772 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2773 /**
2774 * Activities that can be safely invoked from a browser must support this
2775 * category. For example, if the user is viewing a web page or an e-mail
2776 * and clicks on a link in the text, the Intent generated execute that
2777 * link will require the BROWSABLE category, so that only activities
2778 * supporting this category will be considered as possible actions. By
2779 * supporting this category, you are promising that there is nothing
2780 * damaging (without user intervention) that can happen by invoking any
2781 * matching Intent.
2782 */
2783 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2784 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2785 /**
2786 * Set if the activity should be considered as an alternative action to
2787 * the data the user is currently viewing. See also
2788 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2789 * applies to the selection in a list of items.
2790 *
2791 * <p>Supporting this category means that you would like your activity to be
2792 * displayed in the set of alternative things the user can do, usually as
2793 * part of the current activity's options menu. You will usually want to
2794 * include a specific label in the &lt;intent-filter&gt; of this action
2795 * describing to the user what it does.
2796 *
2797 * <p>The action of IntentFilter with this category is important in that it
2798 * describes the specific action the target will perform. This generally
2799 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2800 * a specific name such as "com.android.camera.action.CROP. Only one
2801 * alternative of any particular action will be shown to the user, so using
2802 * a specific action like this makes sure that your alternative will be
2803 * displayed while also allowing other applications to provide their own
2804 * overrides of that particular action.
2805 */
2806 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2807 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2808 /**
2809 * Set if the activity should be considered as an alternative selection
2810 * action to the data the user has currently selected. This is like
2811 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2812 * of items from which the user can select, giving them alternatives to the
2813 * default action that will be performed on it.
2814 */
2815 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2816 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2817 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002818 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002819 */
2820 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2821 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2822 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002823 * Should be displayed in the top-level launcher.
2824 */
2825 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2826 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2827 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002828 * Indicates an activity optimized for Leanback mode, and that should
2829 * be displayed in the Leanback launcher.
2830 */
2831 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2832 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2833 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002834 * Provides information about the package it is in; typically used if
2835 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2836 * a front-door to the user without having to be shown in the all apps list.
2837 */
2838 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2839 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2840 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002841 * This is the home activity, that is the first activity that is displayed
2842 * when the device boots.
2843 */
2844 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2845 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2846 /**
2847 * This activity is a preference panel.
2848 */
2849 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2850 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2851 /**
2852 * This activity is a development preference panel.
2853 */
2854 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2855 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2856 /**
2857 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002858 */
2859 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2860 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2861 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002862 * This activity allows the user to browse and download new applications.
2863 */
2864 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2865 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2866 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002867 * This activity may be exercised by the monkey or other automated test tools.
2868 */
2869 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2870 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2871 /**
2872 * To be used as a test (not part of the normal user experience).
2873 */
2874 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2875 /**
2876 * To be used as a unit test (run through the Test Harness).
2877 */
2878 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2879 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002880 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002881 * experience).
2882 */
2883 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002884
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002885 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002886 * Used to indicate that an intent only wants URIs that can be opened with
2887 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2888 * must support at least the columns defined in {@link OpenableColumns} when
2889 * queried.
2890 *
2891 * @see #ACTION_GET_CONTENT
2892 * @see #ACTION_OPEN_DOCUMENT
2893 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002894 */
2895 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2896 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2897
2898 /**
2899 * To be used as code under test for framework instrumentation tests.
2900 */
2901 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2902 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002903 /**
2904 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002905 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2906 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002907 */
2908 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2909 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2910 /**
2911 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002912 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2913 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002914 */
2915 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2916 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002917 /**
2918 * An activity to run when device is inserted into a analog (low end) dock.
2919 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2920 * information, see {@link android.app.UiModeManager}.
2921 */
2922 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2923 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2924
2925 /**
2926 * An activity to run when device is inserted into a digital (high end) dock.
2927 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2928 * information, see {@link android.app.UiModeManager}.
2929 */
2930 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2931 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002932
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002933 /**
2934 * Used to indicate that the activity can be used in a car environment.
2935 */
2936 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2937 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2938
Dan Sandlera55734a2014-03-26 18:41:11 -04002939 /**
2940 * An activity that provides a user interface for adjusting notification preferences for its
2941 * containing application. Optional but recommended for apps that post
2942 * {@link android.app.Notification Notifications}.
2943 */
2944 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2945 public static final String CATEGORY_NOTIFICATION_PREFERENCES = "android.intent.category.NOTIFICATION_PREFERENCES";
2946
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002947 // ---------------------------------------------------------------------
2948 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002949 // Application launch intent categories (see addCategory()).
2950
2951 /**
2952 * Used with {@link #ACTION_MAIN} to launch the browser application.
2953 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002954 * <p>NOTE: This should not be used as the primary key of an Intent,
2955 * since it will not result in the app launching with the correct
2956 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002957 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002958 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002959 */
2960 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2961 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2962
2963 /**
2964 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2965 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002966 * <p>NOTE: This should not be used as the primary key of an Intent,
2967 * since it will not result in the app launching with the correct
2968 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002969 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002970 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002971 */
2972 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2973 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2974
2975 /**
2976 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2977 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002978 * <p>NOTE: This should not be used as the primary key of an Intent,
2979 * since it will not result in the app launching with the correct
2980 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002981 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002982 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002983 */
2984 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2985 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2986
2987 /**
2988 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2989 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002990 * <p>NOTE: This should not be used as the primary key of an Intent,
2991 * since it will not result in the app launching with the correct
2992 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002993 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002994 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002995 */
2996 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2997 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2998
2999 /**
3000 * Used with {@link #ACTION_MAIN} to launch the email application.
3001 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003002 * <p>NOTE: This should not be used as the primary key of an Intent,
3003 * since it will not result in the app launching with the correct
3004 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003005 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003006 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003007 */
3008 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3009 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3010
3011 /**
3012 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3013 * The activity should be able to view and manipulate image and video files
3014 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003015 * <p>NOTE: This should not be used as the primary key of an Intent,
3016 * since it will not result in the app launching with the correct
3017 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003018 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003019 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003020 */
3021 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3022 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3023
3024 /**
3025 * Used with {@link #ACTION_MAIN} to launch the maps application.
3026 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003027 * <p>NOTE: This should not be used as the primary key of an Intent,
3028 * since it will not result in the app launching with the correct
3029 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003030 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003031 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003032 */
3033 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3034 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3035
3036 /**
3037 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3038 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003039 * <p>NOTE: This should not be used as the primary key of an Intent,
3040 * since it will not result in the app launching with the correct
3041 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003042 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003043 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003044 */
3045 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3046 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3047
3048 /**
3049 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003050 * The activity should be able to play, browse, or manipulate music files
3051 * stored on the device.
3052 * <p>NOTE: This should not be used as the primary key of an Intent,
3053 * since it will not result in the app launching with the correct
3054 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003055 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003056 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003057 */
3058 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3059 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3060
3061 // ---------------------------------------------------------------------
3062 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003063 // Standard extra data keys.
3064
3065 /**
3066 * The initial data to place in a newly created record. Use with
3067 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3068 * fields as would be given to the underlying ContentProvider.insert()
3069 * call.
3070 */
3071 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3072
3073 /**
3074 * A constant CharSequence that is associated with the Intent, used with
3075 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3076 * this may be a styled CharSequence, so you must use
3077 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3078 * retrieve it.
3079 */
3080 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3081
3082 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003083 * A constant String that is associated with the Intent, used with
3084 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3085 * as HTML formatted text. Note that you <em>must</em> also supply
3086 * {@link #EXTRA_TEXT}.
3087 */
3088 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3089
3090 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003091 * A content: URI holding a stream of data associated with the Intent,
3092 * used with {@link #ACTION_SEND} to supply the data being sent.
3093 */
3094 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3095
3096 /**
3097 * A String[] holding e-mail addresses that should be delivered to.
3098 */
3099 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3100
3101 /**
3102 * A String[] holding e-mail addresses that should be carbon copied.
3103 */
3104 public static final String EXTRA_CC = "android.intent.extra.CC";
3105
3106 /**
3107 * A String[] holding e-mail addresses that should be blind carbon copied.
3108 */
3109 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3110
3111 /**
3112 * A constant string holding the desired subject line of a message.
3113 */
3114 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3115
3116 /**
3117 * An Intent describing the choices you would like shown with
3118 * {@link #ACTION_PICK_ACTIVITY}.
3119 */
3120 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3121
3122 /**
3123 * A CharSequence dialog title to provide to the user when used with a
3124 * {@link #ACTION_CHOOSER}.
3125 */
3126 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3127
3128 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003129 * A Parcelable[] of {@link Intent} or
3130 * {@link android.content.pm.LabeledIntent} objects as set with
3131 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3132 * a the front of the list of choices, when shown to the user with a
3133 * {@link #ACTION_CHOOSER}.
3134 */
3135 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3136
3137 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003138 * A {@link android.view.KeyEvent} object containing the event that
3139 * triggered the creation of the Intent it is in.
3140 */
3141 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3142
3143 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003144 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3145 * before shutting down.
3146 *
3147 * {@hide}
3148 */
3149 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3150
3151 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003152 * 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 -07003153 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3154 * of restarting the application.
3155 */
3156 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3157
3158 /**
3159 * A String holding the phone number originally entered in
3160 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3161 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3162 */
3163 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003164
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003165 /**
3166 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3167 * intents to supply the uid the package had been assigned. Also an optional
3168 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3169 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3170 * purpose.
3171 */
3172 public static final String EXTRA_UID = "android.intent.extra.UID";
3173
3174 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003175 * @hide String array of package names.
3176 */
3177 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3178
3179 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003180 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3181 * intents to indicate whether this represents a full uninstall (removing
3182 * both the code and its data) or a partial uninstall (leaving its data,
3183 * implying that this is an update).
3184 */
3185 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003186
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003187 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003188 * @hide
3189 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3190 * intents to indicate that at this point the package has been removed for
3191 * all users on the device.
3192 */
3193 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3194 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3195
3196 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003197 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3198 * intents to indicate that this is a replacement of the package, so this
3199 * broadcast will immediately be followed by an add broadcast for a
3200 * different version of the same package.
3201 */
3202 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003203
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003204 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003205 * Used as an int extra field in {@link android.app.AlarmManager} intents
3206 * to tell the application being invoked how many pending alarms are being
3207 * delievered with the intent. For one-shot alarms this will always be 1.
3208 * For recurring alarms, this might be greater than 1 if the device was
3209 * asleep or powered off at the time an earlier alarm would have been
3210 * delivered.
3211 */
3212 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003213
Jacek Surazski86b6c532009-05-13 14:38:28 +02003214 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003215 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3216 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003217 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3218 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003219 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3220 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3221 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003222 */
3223 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3224
3225 /**
3226 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3227 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003228 */
3229 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3230
3231 /**
3232 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3233 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003234 */
3235 public static final int EXTRA_DOCK_STATE_DESK = 1;
3236
3237 /**
3238 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3239 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003240 */
3241 public static final int EXTRA_DOCK_STATE_CAR = 2;
3242
3243 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003244 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3245 * to represent that the phone is in a analog (low end) dock.
3246 */
3247 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3248
3249 /**
3250 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3251 * to represent that the phone is in a digital (high end) dock.
3252 */
3253 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3254
3255 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003256 * Boolean that can be supplied as meta-data with a dock activity, to
3257 * indicate that the dock should take over the home key when it is active.
3258 */
3259 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003260
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003261 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003262 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3263 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003264 */
3265 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3266
3267 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003268 * Used in the extra field in the remote intent. It's astring token passed with the
3269 * remote intent.
3270 */
3271 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3272 "android.intent.extra.remote_intent_token";
3273
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003274 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003275 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003276 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003277 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003278 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003279 "android.intent.extra.changed_component_name";
3280
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003281 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003282 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003283 * and contains a string array of all of the components that have changed. If
3284 * the state of the overall package has changed, then it will contain an entry
3285 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003286 */
3287 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3288 "android.intent.extra.changed_component_name_list";
3289
3290 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003291 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003292 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3293 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003294 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003295 */
3296 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3297 "android.intent.extra.changed_package_list";
3298
3299 /**
3300 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003301 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3302 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003303 * and contains an integer array of uids of all of the components
3304 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003305 */
3306 public static final String EXTRA_CHANGED_UID_LIST =
3307 "android.intent.extra.changed_uid_list";
3308
3309 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003310 * @hide
3311 * Magic extra system code can use when binding, to give a label for
3312 * who it is that has bound to a service. This is an integer giving
3313 * a framework string resource that can be displayed to the user.
3314 */
3315 public static final String EXTRA_CLIENT_LABEL =
3316 "android.intent.extra.client_label";
3317
3318 /**
3319 * @hide
3320 * Magic extra system code can use when binding, to give a PendingIntent object
3321 * that can be launched for the user to disable the system's use of this
3322 * service.
3323 */
3324 public static final String EXTRA_CLIENT_INTENT =
3325 "android.intent.extra.client_intent";
3326
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003327 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003328 * Extra used to indicate that an intent should only return data that is on
3329 * the local device. This is a boolean extra; the default is false. If true,
3330 * an implementation should only allow the user to select data that is
3331 * already on the device, not requiring it be downloaded from a remote
3332 * service when opened.
3333 *
3334 * @see #ACTION_GET_CONTENT
3335 * @see #ACTION_OPEN_DOCUMENT
3336 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003337 */
3338 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003339 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003340
Amith Yamasani13593602012-03-22 16:16:17 -07003341 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003342 * Extra used to indicate that an intent can allow the user to select and
3343 * return multiple items. This is a boolean extra; the default is false. If
3344 * true, an implementation is allowed to present the user with a UI where
3345 * they can pick multiple items that are all returned to the caller. When
3346 * this happens, they should be returned as the {@link #getClipData()} part
3347 * of the result Intent.
3348 *
3349 * @see #ACTION_GET_CONTENT
3350 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003351 */
3352 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003353 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003354
3355 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003356 * The integer userHandle carried with broadcast intents related to addition, removal and
3357 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3358 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3359 *
Amith Yamasani13593602012-03-22 16:16:17 -07003360 * @hide
3361 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003362 public static final String EXTRA_USER_HANDLE =
3363 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003364
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003365 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003366 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3367 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3368 */
3369 public static final String EXTRA_USER =
3370 "android.intent.extra.user";
3371
3372 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003373 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003374 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3375 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003376 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003377 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3378
3379 /**
3380 * Extra sent in the intent to the BroadcastReceiver that handles
3381 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3382 * the restrictions as key/value pairs.
3383 */
3384 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3385 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003386
Amith Yamasani86118ba2013-03-28 14:33:16 -07003387 /**
3388 * Extra used in the response from a BroadcastReceiver that handles
3389 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3390 */
3391 public static final String EXTRA_RESTRICTIONS_INTENT =
3392 "android.intent.extra.restrictions_intent";
3393
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003394 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003395 * Extra used to communicate a set of acceptable MIME types. The type of the
3396 * extra is {@code String[]}. Values may be a combination of concrete MIME
3397 * types (such as "image/png") and/or partial MIME types (such as
3398 * "audio/*").
3399 *
3400 * @see #ACTION_GET_CONTENT
3401 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003402 */
3403 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3404
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003405 /**
3406 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3407 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003408 * When this is true, hardware devices can use this information to determine that
3409 * they shouldn't do a complete shutdown of their device since this is not a
3410 * complete shutdown down to the kernel, but only user space restarting.
3411 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003412 */
3413 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3414 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3415
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003416 /**
3417 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3418 * user has set their time format preferences to the 24 hour format.
3419 *
3420 * @hide for internal use only.
3421 */
3422 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3423 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3424
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003425 // ---------------------------------------------------------------------
3426 // ---------------------------------------------------------------------
3427 // Intent flags (see mFlags variable).
3428
Tor Norbyed9273d62013-05-30 15:59:53 -07003429 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003430 @IntDef(flag = true, value = {
3431 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3432 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003433 @Retention(RetentionPolicy.SOURCE)
3434 public @interface GrantUriMode {}
3435
Jeff Sharkey846318a2014-04-04 12:12:41 -07003436 /** @hide */
3437 @IntDef(flag = true, value = {
3438 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3439 @Retention(RetentionPolicy.SOURCE)
3440 public @interface AccessUriMode {}
3441
3442 /**
3443 * Test if given mode flags specify an access mode, which must be at least
3444 * read and/or write.
3445 *
3446 * @hide
3447 */
3448 public static boolean isAccessUriMode(int modeFlags) {
3449 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3450 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3451 }
3452
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003453 /**
3454 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003455 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003456 * specified in its ClipData. When applying to an Intent's ClipData,
3457 * all URIs as well as recursive traversals through data or other ClipData
3458 * in Intent items will be granted; only the grant flags of the top-level
3459 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003460 */
3461 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3462 /**
3463 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003464 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003465 * specified in its ClipData. When applying to an Intent's ClipData,
3466 * all URIs as well as recursive traversals through data or other ClipData
3467 * in Intent items will be granted; only the grant flags of the top-level
3468 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003469 */
3470 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3471 /**
3472 * Can be set by the caller to indicate that this Intent is coming from
3473 * a background operation, not from direct user interaction.
3474 */
3475 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3476 /**
3477 * A flag you can enable for debugging: when set, log messages will be
3478 * printed during the resolution of this intent to show you what has
3479 * been found to create the final resolved list.
3480 */
3481 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003482 /**
3483 * If set, this intent will not match any components in packages that
3484 * are currently stopped. If this is not set, then the default behavior
3485 * is to include such applications in the result.
3486 */
3487 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3488 /**
3489 * If set, this intent will always match any components in packages that
3490 * are currently stopped. This is the default behavior when
3491 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3492 * flags are set, this one wins (it allows overriding of exclude for
3493 * places where the framework may automatically set the exclude flag).
3494 */
3495 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003496
3497 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003498 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003499 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003500 * persisted across device reboots until explicitly revoked with
3501 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3502 * grant for possible persisting; the receiving application must call
3503 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3504 * actually persist.
3505 *
3506 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3507 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3508 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003509 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003510 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003511 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003512
3513 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003514 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3515 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3516 * applies to any URI that is a prefix match against the original granted
3517 * URI. (Without this flag, the URI must match exactly for access to be
3518 * granted.) Another URI is considered a prefix match only when scheme,
3519 * authority, and all path segments defined by the prefix are an exact
3520 * match.
3521 */
3522 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3523
3524 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003525 * If set, the new activity is not kept in the history stack. As soon as
3526 * the user navigates away from it, the activity is finished. This may also
3527 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3528 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003529 */
3530 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3531 /**
3532 * If set, the activity will not be launched if it is already running
3533 * at the top of the history stack.
3534 */
3535 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3536 /**
3537 * If set, this activity will become the start of a new task on this
3538 * history stack. A task (from the activity that started it to the
3539 * next task activity) defines an atomic group of activities that the
3540 * user can move to. Tasks can be moved to the foreground and background;
3541 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003542 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003543 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3544 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003545 *
3546 * <p>This flag is generally used by activities that want
3547 * to present a "launcher" style behavior: they give the user a list of
3548 * separate things that can be done, which otherwise run completely
3549 * independently of the activity launching them.
3550 *
3551 * <p>When using this flag, if a task is already running for the activity
3552 * you are now starting, then a new activity will not be started; instead,
3553 * the current task will simply be brought to the front of the screen with
3554 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3555 * to disable this behavior.
3556 *
3557 * <p>This flag can not be used when the caller is requesting a result from
3558 * the activity being launched.
3559 */
3560 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3561 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003562 * This flag is used to create a new task and launch an activity into it.
3563 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3564 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3565 * search through existing tasks for ones matching this Intent. Only if no such
3566 * task is found would a new task be created. When paired with
3567 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3568 * the search for a matching task and unconditionally start a new task.
3569 *
3570 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3571 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003572 * top-level application launcher.</strong> Used in conjunction with
3573 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3574 * behavior of bringing an existing task to the foreground. When set,
3575 * a new task is <em>always</em> started to host the Activity for the
3576 * Intent, regardless of whether there is already an existing task running
3577 * the same thing.
3578 *
3579 * <p><strong>Because the default system does not include graphical task management,
3580 * you should not use this flag unless you provide some way for a user to
3581 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003582 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003583 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3584 * creating new document tasks.
3585 *
3586 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
3587 * {@link #FLAG_ACTIVITY_NEW_TASK} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003588 *
Scott Main7aee61f2011-02-08 11:25:01 -08003589 * <p>See
3590 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3591 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003592 *
3593 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3594 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003595 */
3596 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3597 /**
3598 * If set, and the activity being launched is already running in the
3599 * current task, then instead of launching a new instance of that activity,
3600 * all of the other activities on top of it will be closed and this Intent
3601 * will be delivered to the (now on top) old activity as a new Intent.
3602 *
3603 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3604 * If D calls startActivity() with an Intent that resolves to the component
3605 * of activity B, then C and D will be finished and B receive the given
3606 * Intent, resulting in the stack now being: A, B.
3607 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003608 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003609 * either receive the new intent you are starting here in its
3610 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003611 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003612 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3613 * the same intent, then it will be finished and re-created; for all other
3614 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3615 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003616 *
3617 * <p>This launch mode can also be used to good effect in conjunction with
3618 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3619 * of a task, it will bring any currently running instance of that task
3620 * to the foreground, and then clear it to its root state. This is
3621 * especially useful, for example, when launching an activity from the
3622 * notification manager.
3623 *
Scott Main7aee61f2011-02-08 11:25:01 -08003624 * <p>See
3625 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3626 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003627 */
3628 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3629 /**
3630 * If set and this intent is being used to launch a new activity from an
3631 * existing one, then the reply target of the existing activity will be
3632 * transfered to the new activity. This way the new activity can call
3633 * {@link android.app.Activity#setResult} and have that result sent back to
3634 * the reply target of the original activity.
3635 */
3636 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3637 /**
3638 * If set and this intent is being used to launch a new activity from an
3639 * existing one, the current activity will not be counted as the top
3640 * activity for deciding whether the new intent should be delivered to
3641 * the top instead of starting a new one. The previous activity will
3642 * be used as the top, with the assumption being that the current activity
3643 * will finish itself immediately.
3644 */
3645 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3646 /**
3647 * If set, the new activity is not kept in the list of recently launched
3648 * activities.
3649 */
3650 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3651 /**
3652 * This flag is not normally set by application code, but set for you by
3653 * the system as described in the
3654 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3655 * launchMode} documentation for the singleTask mode.
3656 */
3657 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3658 /**
3659 * If set, and this activity is either being started in a new task or
3660 * bringing to the top an existing task, then it will be launched as
3661 * the front door of the task. This will result in the application of
3662 * any affinities needed to have that task in the proper state (either
3663 * moving activities to or from it), or simply resetting that task to
3664 * its initial state if needed.
3665 */
3666 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3667 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003668 * This flag is not normally set by application code, but set for you by
3669 * the system if this activity is being launched from history
3670 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003671 */
3672 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003673 /**
3674 * If set, this marks a point in the task's activity stack that should
3675 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003676 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003677 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3678 * the user re-launching it from home), this activity and all on top of
3679 * it will be finished so that the user does not return to them, but
3680 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003681 *
Craig Mautnere1f3fa22014-01-24 18:02:10 -08003682 * <p>When this flag is assigned to the root activity all activities up
3683 * to, but not including the root activity, will be cleared. This prevents
3684 * this flag from being used to finish all activities in a task and thereby
3685 * ending the task.
3686 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003687 * <p>This is useful for cases where you have a logical break in your
3688 * application. For example, an e-mail application may have a command
3689 * to view an attachment, which launches an image view activity to
3690 * display it. This activity should be part of the e-mail application's
3691 * task, since it is a part of the task the user is involved in. However,
3692 * if the user leaves that task, and later selects the e-mail app from
3693 * home, we may like them to return to the conversation they were
3694 * viewing, not the picture attachment, since that is confusing. By
3695 * setting this flag when launching the image viewer, that viewer and
3696 * any activities it starts will be removed the next time the user returns
3697 * to mail.
3698 */
3699 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003700 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003701 * This flag is used to break out "documents" into separate tasks that can
3702 * be reached via the Recents mechanism. Such a document is any kind of
3703 * item for which an application may want to maintain multiple simultaneous
3704 * instances. Examples might be text files, web pages, spreadsheets, or
3705 * emails. Each such document will be in a separate task in the Recents list.
3706 *
3707 * <p>When set, the activity specified by this Intent will launch into a
3708 * separate task rooted at that activity. The activity launched must be
3709 * defined with {@link android.R.attr#launchMode} "standard" or "singleTop".
3710 *
3711 * <p>If FLAG_ACTIVITY_NEW_DOCUMENT is used without
3712 * {@link #FLAG_ACTIVITY_MULTIPLE_TASK} then the activity manager will
3713 * search for an existing task with a matching target activity and Intent
3714 * data URI and relaunch that task, first finishing all activities down to
3715 * the root activity and then calling the root activity's
3716 * {@link android.app.Activity#onNewIntent(Intent)} method. If no existing
3717 * task's root activity matches the Intent's data URI then a new task will
3718 * be launched with the target activity as root.
3719 *
3720 * <p>When paired with {@link #FLAG_ACTIVITY_MULTIPLE_TASK} this will
3721 * always create a new task. Thus the same document may be made to appear
3722 * more than one time in Recents.
3723 *
3724 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3725 */
3726 public static final int FLAG_ACTIVITY_NEW_DOCUMENT =
3727 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET | FLAG_ACTIVITY_NEW_TASK;
3728 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003729 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003730 * callback from occurring on the current frontmost activity before it is
3731 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003732 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003733 * <p>Typically, an activity can rely on that callback to indicate that an
3734 * explicit user action has caused their activity to be moved out of the
3735 * foreground. The callback marks an appropriate point in the activity's
3736 * lifecycle for it to dismiss any notifications that it intends to display
3737 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003738 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003739 * <p>If an activity is ever started via any non-user-driven events such as
3740 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3741 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003742 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003743 */
3744 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003745 /**
3746 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3747 * this flag will cause the launched activity to be brought to the front of its
3748 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003749 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003750 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3751 * If D calls startActivity() with an Intent that resolves to the component
3752 * of activity B, then B will be brought to the front of the history stack,
3753 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003754 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003755 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003756 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003757 */
3758 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003759 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003760 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3761 * this flag will prevent the system from applying an activity transition
3762 * animation to go to the next activity state. This doesn't mean an
3763 * animation will never run -- if another activity change happens that doesn't
3764 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003765 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003766 * when you are going to do a series of activity operations but the
3767 * animation seen by the user shouldn't be driven by the first activity
3768 * change but rather a later one.
3769 */
3770 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3771 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003772 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3773 * this flag will cause any existing task that would be associated with the
3774 * activity to be cleared before the activity is started. That is, the activity
3775 * becomes the new root of an otherwise empty task, and any old activities
3776 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3777 */
3778 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3779 /**
3780 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3781 * this flag will cause a newly launching task to be placed on top of the current
3782 * home activity task (if there is one). That is, pressing back from the task
3783 * will always return the user to home even if that was not the last activity they
3784 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3785 */
3786 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3787 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003788 * If set, when sending a broadcast only registered receivers will be
3789 * called -- no BroadcastReceiver components will be launched.
3790 */
3791 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003792 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003793 * If set, when sending a broadcast the new broadcast will replace
3794 * any existing pending broadcast that matches it. Matching is defined
3795 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3796 * true for the intents of the two broadcasts. When a match is found,
3797 * the new broadcast (and receivers associated with it) will replace the
3798 * existing one in the pending broadcast list, remaining at the same
3799 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003800 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003801 * <p>This flag is most typically used with sticky broadcasts, which
3802 * only care about delivering the most recent values of the broadcast
3803 * to their receivers.
3804 */
3805 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3806 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003807 * If set, when sending a broadcast the recipient is allowed to run at
3808 * foreground priority, with a shorter timeout interval. During normal
3809 * broadcasts the receivers are not automatically hoisted out of the
3810 * background priority class.
3811 */
3812 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3813 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003814 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3815 * They can still propagate results through to later receivers, but they can not prevent
3816 * later receivers from seeing the broadcast.
3817 */
3818 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3819 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003820 * If set, when sending a broadcast <i>before boot has completed</i> only
3821 * registered receivers will be called -- no BroadcastReceiver components
3822 * will be launched. Sticky intent state will be recorded properly even
3823 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3824 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003825 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003826 * <p>This flag is only for use by system sevices as a convenience to
3827 * avoid having to implement a more complex mechanism around detection
3828 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003829 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003830 * @hide
3831 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003832 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003833 /**
3834 * Set when this broadcast is for a boot upgrade, a special mode that
3835 * allows the broadcast to be sent before the system is ready and launches
3836 * the app process with no providers running in it.
3837 * @hide
3838 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003839 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003840
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003841 /**
3842 * @hide Flags that can't be changed with PendingIntent.
3843 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003844 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
3845 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
3846 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003847
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003848 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003849 // ---------------------------------------------------------------------
3850 // toUri() and parseUri() options.
3851
3852 /**
3853 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3854 * always has the "intent:" scheme. This syntax can be used when you want
3855 * to later disambiguate between URIs that are intended to describe an
3856 * Intent vs. all others that should be treated as raw URIs. When used
3857 * with {@link #parseUri}, any other scheme will result in a generic
3858 * VIEW action for that raw URI.
3859 */
3860 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003861
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003862 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003863
3864 private String mAction;
3865 private Uri mData;
3866 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003867 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003868 private ComponentName mComponent;
3869 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003870 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003871 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003872 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003873 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003874 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003875
3876 // ---------------------------------------------------------------------
3877
3878 /**
3879 * Create an empty intent.
3880 */
3881 public Intent() {
3882 }
3883
3884 /**
3885 * Copy constructor.
3886 */
3887 public Intent(Intent o) {
3888 this.mAction = o.mAction;
3889 this.mData = o.mData;
3890 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003891 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003892 this.mComponent = o.mComponent;
3893 this.mFlags = o.mFlags;
3894 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003895 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003896 }
3897 if (o.mExtras != null) {
3898 this.mExtras = new Bundle(o.mExtras);
3899 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003900 if (o.mSourceBounds != null) {
3901 this.mSourceBounds = new Rect(o.mSourceBounds);
3902 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003903 if (o.mSelector != null) {
3904 this.mSelector = new Intent(o.mSelector);
3905 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003906 if (o.mClipData != null) {
3907 this.mClipData = new ClipData(o.mClipData);
3908 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003909 }
3910
3911 @Override
3912 public Object clone() {
3913 return new Intent(this);
3914 }
3915
3916 private Intent(Intent o, boolean all) {
3917 this.mAction = o.mAction;
3918 this.mData = o.mData;
3919 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003920 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003921 this.mComponent = o.mComponent;
3922 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003923 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003924 }
3925 }
3926
3927 /**
3928 * Make a clone of only the parts of the Intent that are relevant for
3929 * filter matching: the action, data, type, component, and categories.
3930 */
3931 public Intent cloneFilter() {
3932 return new Intent(this, false);
3933 }
3934
3935 /**
3936 * Create an intent with a given action. All other fields (data, type,
3937 * class) are null. Note that the action <em>must</em> be in a
3938 * namespace because Intents are used globally in the system -- for
3939 * example the system VIEW action is android.intent.action.VIEW; an
3940 * application's custom action would be something like
3941 * com.google.app.myapp.CUSTOM_ACTION.
3942 *
3943 * @param action The Intent action, such as ACTION_VIEW.
3944 */
3945 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003946 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003947 }
3948
3949 /**
3950 * Create an intent with a given action and for a given data url. Note
3951 * that the action <em>must</em> be in a namespace because Intents are
3952 * used globally in the system -- for example the system VIEW action is
3953 * android.intent.action.VIEW; an application's custom action would be
3954 * something like com.google.app.myapp.CUSTOM_ACTION.
3955 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003956 * <p><em>Note: scheme and host name matching in the Android framework is
3957 * case-sensitive, unlike the formal RFC. As a result,
3958 * you should always ensure that you write your Uri with these elements
3959 * using lower case letters, and normalize any Uris you receive from
3960 * outside of Android to ensure the scheme and host is lower case.</em></p>
3961 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003962 * @param action The Intent action, such as ACTION_VIEW.
3963 * @param uri The Intent data URI.
3964 */
3965 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003966 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003967 mData = uri;
3968 }
3969
3970 /**
3971 * Create an intent for a specific component. All other fields (action, data,
3972 * type, class) are null, though they can be modified later with explicit
3973 * calls. This provides a convenient way to create an intent that is
3974 * intended to execute a hard-coded class name, rather than relying on the
3975 * system to find an appropriate class for you; see {@link #setComponent}
3976 * for more information on the repercussions of this.
3977 *
3978 * @param packageContext A Context of the application package implementing
3979 * this class.
3980 * @param cls The component class that is to be used for the intent.
3981 *
3982 * @see #setClass
3983 * @see #setComponent
3984 * @see #Intent(String, android.net.Uri , Context, Class)
3985 */
3986 public Intent(Context packageContext, Class<?> cls) {
3987 mComponent = new ComponentName(packageContext, cls);
3988 }
3989
3990 /**
3991 * Create an intent for a specific component with a specified action and data.
3992 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3993 * construct the Intent and then calling {@link #setClass} to set its
3994 * class.
3995 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003996 * <p><em>Note: scheme and host name matching in the Android framework is
3997 * case-sensitive, unlike the formal RFC. As a result,
3998 * you should always ensure that you write your Uri with these elements
3999 * using lower case letters, and normalize any Uris you receive from
4000 * outside of Android to ensure the scheme and host is lower case.</em></p>
4001 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004002 * @param action The Intent action, such as ACTION_VIEW.
4003 * @param uri The Intent data URI.
4004 * @param packageContext A Context of the application package implementing
4005 * this class.
4006 * @param cls The component class that is to be used for the intent.
4007 *
4008 * @see #Intent(String, android.net.Uri)
4009 * @see #Intent(Context, Class)
4010 * @see #setClass
4011 * @see #setComponent
4012 */
4013 public Intent(String action, Uri uri,
4014 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004015 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004016 mData = uri;
4017 mComponent = new ComponentName(packageContext, cls);
4018 }
4019
4020 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004021 * Create an intent to launch the main (root) activity of a task. This
4022 * is the Intent that is started when the application's is launched from
4023 * Home. For anything else that wants to launch an application in the
4024 * same way, it is important that they use an Intent structured the same
4025 * way, and can use this function to ensure this is the case.
4026 *
4027 * <p>The returned Intent has the given Activity component as its explicit
4028 * component, {@link #ACTION_MAIN} as its action, and includes the
4029 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4030 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4031 * to do that through {@link #addFlags(int)} on the returned Intent.
4032 *
4033 * @param mainActivity The main activity component that this Intent will
4034 * launch.
4035 * @return Returns a newly created Intent that can be used to launch the
4036 * activity as a main application entry.
4037 *
4038 * @see #setClass
4039 * @see #setComponent
4040 */
4041 public static Intent makeMainActivity(ComponentName mainActivity) {
4042 Intent intent = new Intent(ACTION_MAIN);
4043 intent.setComponent(mainActivity);
4044 intent.addCategory(CATEGORY_LAUNCHER);
4045 return intent;
4046 }
4047
4048 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004049 * Make an Intent for the main activity of an application, without
4050 * specifying a specific activity to run but giving a selector to find
4051 * the activity. This results in a final Intent that is structured
4052 * the same as when the application is launched from
4053 * Home. For anything else that wants to launch an application in the
4054 * same way, it is important that they use an Intent structured the same
4055 * way, and can use this function to ensure this is the case.
4056 *
4057 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4058 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4059 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4060 * to do that through {@link #addFlags(int)} on the returned Intent.
4061 *
4062 * @param selectorAction The action name of the Intent's selector.
4063 * @param selectorCategory The name of a category to add to the Intent's
4064 * selector.
4065 * @return Returns a newly created Intent that can be used to launch the
4066 * activity as a main application entry.
4067 *
4068 * @see #setSelector(Intent)
4069 */
4070 public static Intent makeMainSelectorActivity(String selectorAction,
4071 String selectorCategory) {
4072 Intent intent = new Intent(ACTION_MAIN);
4073 intent.addCategory(CATEGORY_LAUNCHER);
4074 Intent selector = new Intent();
4075 selector.setAction(selectorAction);
4076 selector.addCategory(selectorCategory);
4077 intent.setSelector(selector);
4078 return intent;
4079 }
4080
4081 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004082 * Make an Intent that can be used to re-launch an application's task
4083 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4084 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4085 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4086 *
4087 * @param mainActivity The activity component that is the root of the
4088 * task; this is the activity that has been published in the application's
4089 * manifest as the main launcher icon.
4090 *
4091 * @return Returns a newly created Intent that can be used to relaunch the
4092 * activity's task in its root state.
4093 */
4094 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4095 Intent intent = makeMainActivity(mainActivity);
4096 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4097 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4098 return intent;
4099 }
4100
4101 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004102 * Call {@link #parseUri} with 0 flags.
4103 * @deprecated Use {@link #parseUri} instead.
4104 */
4105 @Deprecated
4106 public static Intent getIntent(String uri) throws URISyntaxException {
4107 return parseUri(uri, 0);
4108 }
Tom Taylord4a47292009-12-21 13:59:18 -08004109
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004110 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004111 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004112 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004113 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004114 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004115 *
4116 * <p>The URI given here must not be relative -- that is, it must include
4117 * the scheme and full path.
4118 *
4119 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004120 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004121 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004122 *
4123 * @return Intent The newly created Intent object.
4124 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004125 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4126 * it bad (as parsed by the Uri class) or the Intent data within the
4127 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004128 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004129 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004130 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004131 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004132 int i = 0;
4133 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004134 // Validate intent scheme for if requested.
4135 if ((flags&URI_INTENT_SCHEME) != 0) {
4136 if (!uri.startsWith("intent:")) {
4137 Intent intent = new Intent(ACTION_VIEW);
4138 try {
4139 intent.setData(Uri.parse(uri));
4140 } catch (IllegalArgumentException e) {
4141 throw new URISyntaxException(uri, e.getMessage());
4142 }
4143 return intent;
4144 }
4145 }
Tom Taylord4a47292009-12-21 13:59:18 -08004146
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004147 // simple case
4148 i = uri.lastIndexOf("#");
4149 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4150
4151 // old format Intent URI
4152 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07004153
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004154 // new format
4155 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004156 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004157
4158 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004159 String data = i >= 0 ? uri.substring(0, i) : null;
4160 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004161 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07004162
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004163 // loop over contents of Intent, all name=value;
4164 while (!uri.startsWith("end", i)) {
4165 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004166 if (eq < 0) eq = i-1;
4167 int semi = uri.indexOf(';', i);
4168 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004169
4170 // action
4171 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004172 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004173 }
4174
4175 // categories
4176 else if (uri.startsWith("category=", i)) {
4177 intent.addCategory(value);
4178 }
4179
4180 // type
4181 else if (uri.startsWith("type=", i)) {
4182 intent.mType = value;
4183 }
4184
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004185 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004186 else if (uri.startsWith("launchFlags=", i)) {
4187 intent.mFlags = Integer.decode(value).intValue();
4188 }
4189
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004190 // package
4191 else if (uri.startsWith("package=", i)) {
4192 intent.mPackage = value;
4193 }
4194
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004195 // component
4196 else if (uri.startsWith("component=", i)) {
4197 intent.mComponent = ComponentName.unflattenFromString(value);
4198 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004199
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004200 // scheme
4201 else if (uri.startsWith("scheme=", i)) {
4202 scheme = value;
4203 }
4204
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004205 // source bounds
4206 else if (uri.startsWith("sourceBounds=", i)) {
4207 intent.mSourceBounds = Rect.unflattenFromString(value);
4208 }
4209
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004210 // selector
4211 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4212 intent = new Intent();
4213 }
4214
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004215 // extra
4216 else {
4217 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004218 // create Bundle if it doesn't already exist
4219 if (intent.mExtras == null) intent.mExtras = new Bundle();
4220 Bundle b = intent.mExtras;
4221 // add EXTRA
4222 if (uri.startsWith("S.", i)) b.putString(key, value);
4223 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4224 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4225 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4226 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4227 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4228 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4229 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4230 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4231 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4232 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004233
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004234 // move to the next item
4235 i = semi + 1;
4236 }
4237
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004238 if (intent != baseIntent) {
4239 // The Intent had a selector; fix it up.
4240 baseIntent.setSelector(intent);
4241 intent = baseIntent;
4242 }
4243
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004244 if (data != null) {
4245 if (data.startsWith("intent:")) {
4246 data = data.substring(7);
4247 if (scheme != null) {
4248 data = scheme + ':' + data;
4249 }
4250 }
Tom Taylord4a47292009-12-21 13:59:18 -08004251
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004252 if (data.length() > 0) {
4253 try {
4254 intent.mData = Uri.parse(data);
4255 } catch (IllegalArgumentException e) {
4256 throw new URISyntaxException(uri, e.getMessage());
4257 }
4258 }
4259 }
Tom Taylord4a47292009-12-21 13:59:18 -08004260
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004261 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004262
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004263 } catch (IndexOutOfBoundsException e) {
4264 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4265 }
4266 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004267
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004268 public static Intent getIntentOld(String uri) throws URISyntaxException {
4269 Intent intent;
4270
4271 int i = uri.lastIndexOf('#');
4272 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004273 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004274 final int intentFragmentStart = i;
4275 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004276
4277 i++;
4278
4279 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004280 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004281 i += 7;
4282 int j = uri.indexOf(')', i);
4283 action = uri.substring(i, j);
4284 i = j + 1;
4285 }
4286
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004287 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004288
4289 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004290 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004291 i += 11;
4292 int j = uri.indexOf(')', i);
4293 while (i < j) {
4294 int sep = uri.indexOf('!', i);
4295 if (sep < 0) sep = j;
4296 if (i < sep) {
4297 intent.addCategory(uri.substring(i, sep));
4298 }
4299 i = sep + 1;
4300 }
4301 i = j + 1;
4302 }
4303
4304 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004305 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004306 i += 5;
4307 int j = uri.indexOf(')', i);
4308 intent.mType = uri.substring(i, j);
4309 i = j + 1;
4310 }
4311
4312 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004313 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004314 i += 12;
4315 int j = uri.indexOf(')', i);
4316 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4317 i = j + 1;
4318 }
4319
4320 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004321 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004322 i += 10;
4323 int j = uri.indexOf(')', i);
4324 int sep = uri.indexOf('!', i);
4325 if (sep >= 0 && sep < j) {
4326 String pkg = uri.substring(i, sep);
4327 String cls = uri.substring(sep + 1, j);
4328 intent.mComponent = new ComponentName(pkg, cls);
4329 }
4330 i = j + 1;
4331 }
4332
4333 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004334 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004335 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004336
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004337 final int closeParen = uri.indexOf(')', i);
4338 if (closeParen == -1) throw new URISyntaxException(uri,
4339 "EXTRA missing trailing ')'", i);
4340
4341 while (i < closeParen) {
4342 // fetch the key value
4343 int j = uri.indexOf('=', i);
4344 if (j <= i + 1 || i >= closeParen) {
4345 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4346 }
4347 char type = uri.charAt(i);
4348 i++;
4349 String key = uri.substring(i, j);
4350 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004351
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004352 // get type-value
4353 j = uri.indexOf('!', i);
4354 if (j == -1 || j >= closeParen) j = closeParen;
4355 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4356 String value = uri.substring(i, j);
4357 i = j;
4358
4359 // create Bundle if it doesn't already exist
4360 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004361
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004362 // add item to bundle
4363 try {
4364 switch (type) {
4365 case 'S':
4366 intent.mExtras.putString(key, Uri.decode(value));
4367 break;
4368 case 'B':
4369 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4370 break;
4371 case 'b':
4372 intent.mExtras.putByte(key, Byte.parseByte(value));
4373 break;
4374 case 'c':
4375 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4376 break;
4377 case 'd':
4378 intent.mExtras.putDouble(key, Double.parseDouble(value));
4379 break;
4380 case 'f':
4381 intent.mExtras.putFloat(key, Float.parseFloat(value));
4382 break;
4383 case 'i':
4384 intent.mExtras.putInt(key, Integer.parseInt(value));
4385 break;
4386 case 'l':
4387 intent.mExtras.putLong(key, Long.parseLong(value));
4388 break;
4389 case 's':
4390 intent.mExtras.putShort(key, Short.parseShort(value));
4391 break;
4392 default:
4393 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4394 }
4395 } catch (NumberFormatException e) {
4396 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4397 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004398
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004399 char ch = uri.charAt(i);
4400 if (ch == ')') break;
4401 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4402 i++;
4403 }
4404 }
4405
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004406 if (isIntentFragment) {
4407 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4408 } else {
4409 intent.mData = Uri.parse(uri);
4410 }
Tom Taylord4a47292009-12-21 13:59:18 -08004411
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004412 if (intent.mAction == null) {
4413 // By default, if no action is specified, then use VIEW.
4414 intent.mAction = ACTION_VIEW;
4415 }
4416
4417 } else {
4418 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4419 }
4420
4421 return intent;
4422 }
4423
4424 /**
4425 * Retrieve the general action to be performed, such as
4426 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4427 * the information in the intent should be interpreted -- most importantly,
4428 * what to do with the data returned by {@link #getData}.
4429 *
4430 * @return The action of this intent or null if none is specified.
4431 *
4432 * @see #setAction
4433 */
4434 public String getAction() {
4435 return mAction;
4436 }
4437
4438 /**
4439 * Retrieve data this intent is operating on. This URI specifies the name
4440 * of the data; often it uses the content: scheme, specifying data in a
4441 * content provider. Other schemes may be handled by specific activities,
4442 * such as http: by the web browser.
4443 *
4444 * @return The URI of the data this intent is targeting or null.
4445 *
4446 * @see #getScheme
4447 * @see #setData
4448 */
4449 public Uri getData() {
4450 return mData;
4451 }
4452
4453 /**
4454 * The same as {@link #getData()}, but returns the URI as an encoded
4455 * String.
4456 */
4457 public String getDataString() {
4458 return mData != null ? mData.toString() : null;
4459 }
4460
4461 /**
4462 * Return the scheme portion of the intent's data. If the data is null or
4463 * does not include a scheme, null is returned. Otherwise, the scheme
4464 * prefix without the final ':' is returned, i.e. "http".
4465 *
4466 * <p>This is the same as calling getData().getScheme() (and checking for
4467 * null data).
4468 *
4469 * @return The scheme of this intent.
4470 *
4471 * @see #getData
4472 */
4473 public String getScheme() {
4474 return mData != null ? mData.getScheme() : null;
4475 }
4476
4477 /**
4478 * Retrieve any explicit MIME type included in the intent. This is usually
4479 * null, as the type is determined by the intent data.
4480 *
4481 * @return If a type was manually set, it is returned; else null is
4482 * returned.
4483 *
4484 * @see #resolveType(ContentResolver)
4485 * @see #setType
4486 */
4487 public String getType() {
4488 return mType;
4489 }
4490
4491 /**
4492 * Return the MIME data type of this intent. If the type field is
4493 * explicitly set, that is simply returned. Otherwise, if the data is set,
4494 * the type of that data is returned. If neither fields are set, a null is
4495 * returned.
4496 *
4497 * @return The MIME type of this intent.
4498 *
4499 * @see #getType
4500 * @see #resolveType(ContentResolver)
4501 */
4502 public String resolveType(Context context) {
4503 return resolveType(context.getContentResolver());
4504 }
4505
4506 /**
4507 * Return the MIME data type of this intent. If the type field is
4508 * explicitly set, that is simply returned. Otherwise, if the data is set,
4509 * the type of that data is returned. If neither fields are set, a null is
4510 * returned.
4511 *
4512 * @param resolver A ContentResolver that can be used to determine the MIME
4513 * type of the intent's data.
4514 *
4515 * @return The MIME type of this intent.
4516 *
4517 * @see #getType
4518 * @see #resolveType(Context)
4519 */
4520 public String resolveType(ContentResolver resolver) {
4521 if (mType != null) {
4522 return mType;
4523 }
4524 if (mData != null) {
4525 if ("content".equals(mData.getScheme())) {
4526 return resolver.getType(mData);
4527 }
4528 }
4529 return null;
4530 }
4531
4532 /**
4533 * Return the MIME data type of this intent, only if it will be needed for
4534 * intent resolution. This is not generally useful for application code;
4535 * it is used by the frameworks for communicating with back-end system
4536 * services.
4537 *
4538 * @param resolver A ContentResolver that can be used to determine the MIME
4539 * type of the intent's data.
4540 *
4541 * @return The MIME type of this intent, or null if it is unknown or not
4542 * needed.
4543 */
4544 public String resolveTypeIfNeeded(ContentResolver resolver) {
4545 if (mComponent != null) {
4546 return mType;
4547 }
4548 return resolveType(resolver);
4549 }
4550
4551 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004552 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004553 *
4554 * @param category The category to check.
4555 *
4556 * @return boolean True if the intent contains the category, else false.
4557 *
4558 * @see #getCategories
4559 * @see #addCategory
4560 */
4561 public boolean hasCategory(String category) {
4562 return mCategories != null && mCategories.contains(category);
4563 }
4564
4565 /**
4566 * Return the set of all categories in the intent. If there are no categories,
4567 * returns NULL.
4568 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004569 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004570 *
4571 * @see #hasCategory
4572 * @see #addCategory
4573 */
4574 public Set<String> getCategories() {
4575 return mCategories;
4576 }
4577
4578 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004579 * Return the specific selector associated with this Intent. If there is
4580 * none, returns null. See {@link #setSelector} for more information.
4581 *
4582 * @see #setSelector
4583 */
4584 public Intent getSelector() {
4585 return mSelector;
4586 }
4587
4588 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004589 * Return the {@link ClipData} associated with this Intent. If there is
4590 * none, returns null. See {@link #setClipData} for more information.
4591 *
John Spurlock125d1332013-11-25 11:58:37 -05004592 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004593 */
4594 public ClipData getClipData() {
4595 return mClipData;
4596 }
4597
4598 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004599 * Sets the ClassLoader that will be used when unmarshalling
4600 * any Parcelable values from the extras of this Intent.
4601 *
4602 * @param loader a ClassLoader, or null to use the default loader
4603 * at the time of unmarshalling.
4604 */
4605 public void setExtrasClassLoader(ClassLoader loader) {
4606 if (mExtras != null) {
4607 mExtras.setClassLoader(loader);
4608 }
4609 }
4610
4611 /**
4612 * Returns true if an extra value is associated with the given name.
4613 * @param name the extra's name
4614 * @return true if the given extra is present.
4615 */
4616 public boolean hasExtra(String name) {
4617 return mExtras != null && mExtras.containsKey(name);
4618 }
4619
4620 /**
4621 * Returns true if the Intent's extras contain a parcelled file descriptor.
4622 * @return true if the Intent contains a parcelled file descriptor.
4623 */
4624 public boolean hasFileDescriptors() {
4625 return mExtras != null && mExtras.hasFileDescriptors();
4626 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004627
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004628 /** @hide */
4629 public void setAllowFds(boolean allowFds) {
4630 if (mExtras != null) {
4631 mExtras.setAllowFds(allowFds);
4632 }
4633 }
4634
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004635 /**
4636 * Retrieve extended data from the intent.
4637 *
4638 * @param name The name of the desired item.
4639 *
4640 * @return the value of an item that previously added with putExtra()
4641 * or null if none was found.
4642 *
4643 * @deprecated
4644 * @hide
4645 */
4646 @Deprecated
4647 public Object getExtra(String name) {
4648 return getExtra(name, null);
4649 }
4650
4651 /**
4652 * Retrieve extended data from the intent.
4653 *
4654 * @param name The name of the desired item.
4655 * @param defaultValue the value to be returned if no value of the desired
4656 * type is stored with the given name.
4657 *
4658 * @return the value of an item that previously added with putExtra()
4659 * or the default value if none was found.
4660 *
4661 * @see #putExtra(String, boolean)
4662 */
4663 public boolean getBooleanExtra(String name, boolean defaultValue) {
4664 return mExtras == null ? defaultValue :
4665 mExtras.getBoolean(name, defaultValue);
4666 }
4667
4668 /**
4669 * Retrieve extended data from the intent.
4670 *
4671 * @param name The name of the desired item.
4672 * @param defaultValue the value to be returned if no value of the desired
4673 * type is stored with the given name.
4674 *
4675 * @return the value of an item that previously added with putExtra()
4676 * or the default value if none was found.
4677 *
4678 * @see #putExtra(String, byte)
4679 */
4680 public byte getByteExtra(String name, byte defaultValue) {
4681 return mExtras == null ? defaultValue :
4682 mExtras.getByte(name, defaultValue);
4683 }
4684
4685 /**
4686 * Retrieve extended data from the intent.
4687 *
4688 * @param name The name of the desired item.
4689 * @param defaultValue the value to be returned if no value of the desired
4690 * type is stored with the given name.
4691 *
4692 * @return the value of an item that previously added with putExtra()
4693 * or the default value if none was found.
4694 *
4695 * @see #putExtra(String, short)
4696 */
4697 public short getShortExtra(String name, short defaultValue) {
4698 return mExtras == null ? defaultValue :
4699 mExtras.getShort(name, defaultValue);
4700 }
4701
4702 /**
4703 * Retrieve extended data from the intent.
4704 *
4705 * @param name The name of the desired item.
4706 * @param defaultValue the value to be returned if no value of the desired
4707 * type is stored with the given name.
4708 *
4709 * @return the value of an item that previously added with putExtra()
4710 * or the default value if none was found.
4711 *
4712 * @see #putExtra(String, char)
4713 */
4714 public char getCharExtra(String name, char defaultValue) {
4715 return mExtras == null ? defaultValue :
4716 mExtras.getChar(name, defaultValue);
4717 }
4718
4719 /**
4720 * Retrieve extended data from the intent.
4721 *
4722 * @param name The name of the desired item.
4723 * @param defaultValue the value to be returned if no value of the desired
4724 * type is stored with the given name.
4725 *
4726 * @return the value of an item that previously added with putExtra()
4727 * or the default value if none was found.
4728 *
4729 * @see #putExtra(String, int)
4730 */
4731 public int getIntExtra(String name, int defaultValue) {
4732 return mExtras == null ? defaultValue :
4733 mExtras.getInt(name, defaultValue);
4734 }
4735
4736 /**
4737 * Retrieve extended data from the intent.
4738 *
4739 * @param name The name of the desired item.
4740 * @param defaultValue the value to be returned if no value of the desired
4741 * type is stored with the given name.
4742 *
4743 * @return the value of an item that previously added with putExtra()
4744 * or the default value if none was found.
4745 *
4746 * @see #putExtra(String, long)
4747 */
4748 public long getLongExtra(String name, long defaultValue) {
4749 return mExtras == null ? defaultValue :
4750 mExtras.getLong(name, defaultValue);
4751 }
4752
4753 /**
4754 * Retrieve extended data from the intent.
4755 *
4756 * @param name The name of the desired item.
4757 * @param defaultValue the value to be returned if no value of the desired
4758 * type is stored with the given name.
4759 *
4760 * @return the value of an item that previously added with putExtra(),
4761 * or the default value if no such item is present
4762 *
4763 * @see #putExtra(String, float)
4764 */
4765 public float getFloatExtra(String name, float defaultValue) {
4766 return mExtras == null ? defaultValue :
4767 mExtras.getFloat(name, defaultValue);
4768 }
4769
4770 /**
4771 * Retrieve extended data from the intent.
4772 *
4773 * @param name The name of the desired item.
4774 * @param defaultValue the value to be returned if no value of the desired
4775 * type is stored with the given name.
4776 *
4777 * @return the value of an item that previously added with putExtra()
4778 * or the default value if none was found.
4779 *
4780 * @see #putExtra(String, double)
4781 */
4782 public double getDoubleExtra(String name, double defaultValue) {
4783 return mExtras == null ? defaultValue :
4784 mExtras.getDouble(name, defaultValue);
4785 }
4786
4787 /**
4788 * Retrieve extended data from the intent.
4789 *
4790 * @param name The name of the desired item.
4791 *
4792 * @return the value of an item that previously added with putExtra()
4793 * or null if no String value was found.
4794 *
4795 * @see #putExtra(String, String)
4796 */
4797 public String getStringExtra(String name) {
4798 return mExtras == null ? null : mExtras.getString(name);
4799 }
4800
4801 /**
4802 * Retrieve extended data from the intent.
4803 *
4804 * @param name The name of the desired item.
4805 *
4806 * @return the value of an item that previously added with putExtra()
4807 * or null if no CharSequence value was found.
4808 *
4809 * @see #putExtra(String, CharSequence)
4810 */
4811 public CharSequence getCharSequenceExtra(String name) {
4812 return mExtras == null ? null : mExtras.getCharSequence(name);
4813 }
4814
4815 /**
4816 * Retrieve extended data from the intent.
4817 *
4818 * @param name The name of the desired item.
4819 *
4820 * @return the value of an item that previously added with putExtra()
4821 * or null if no Parcelable value was found.
4822 *
4823 * @see #putExtra(String, Parcelable)
4824 */
4825 public <T extends Parcelable> T getParcelableExtra(String name) {
4826 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4827 }
4828
4829 /**
4830 * Retrieve extended data from the intent.
4831 *
4832 * @param name The name of the desired item.
4833 *
4834 * @return the value of an item that previously added with putExtra()
4835 * or null if no Parcelable[] value was found.
4836 *
4837 * @see #putExtra(String, Parcelable[])
4838 */
4839 public Parcelable[] getParcelableArrayExtra(String name) {
4840 return mExtras == null ? null : mExtras.getParcelableArray(name);
4841 }
4842
4843 /**
4844 * Retrieve extended data from the intent.
4845 *
4846 * @param name The name of the desired item.
4847 *
4848 * @return the value of an item that previously added with putExtra()
4849 * or null if no ArrayList<Parcelable> value was found.
4850 *
4851 * @see #putParcelableArrayListExtra(String, ArrayList)
4852 */
4853 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4854 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4855 }
4856
4857 /**
4858 * Retrieve extended data from the intent.
4859 *
4860 * @param name The name of the desired item.
4861 *
4862 * @return the value of an item that previously added with putExtra()
4863 * or null if no Serializable value was found.
4864 *
4865 * @see #putExtra(String, Serializable)
4866 */
4867 public Serializable getSerializableExtra(String name) {
4868 return mExtras == null ? null : mExtras.getSerializable(name);
4869 }
4870
4871 /**
4872 * Retrieve extended data from the intent.
4873 *
4874 * @param name The name of the desired item.
4875 *
4876 * @return the value of an item that previously added with putExtra()
4877 * or null if no ArrayList<Integer> value was found.
4878 *
4879 * @see #putIntegerArrayListExtra(String, ArrayList)
4880 */
4881 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4882 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4883 }
4884
4885 /**
4886 * Retrieve extended data from the intent.
4887 *
4888 * @param name The name of the desired item.
4889 *
4890 * @return the value of an item that previously added with putExtra()
4891 * or null if no ArrayList<String> value was found.
4892 *
4893 * @see #putStringArrayListExtra(String, ArrayList)
4894 */
4895 public ArrayList<String> getStringArrayListExtra(String name) {
4896 return mExtras == null ? null : mExtras.getStringArrayList(name);
4897 }
4898
4899 /**
4900 * Retrieve extended data from the intent.
4901 *
4902 * @param name The name of the desired item.
4903 *
4904 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004905 * or null if no ArrayList<CharSequence> value was found.
4906 *
4907 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4908 */
4909 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4910 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4911 }
4912
4913 /**
4914 * Retrieve extended data from the intent.
4915 *
4916 * @param name The name of the desired item.
4917 *
4918 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004919 * or null if no boolean array value was found.
4920 *
4921 * @see #putExtra(String, boolean[])
4922 */
4923 public boolean[] getBooleanArrayExtra(String name) {
4924 return mExtras == null ? null : mExtras.getBooleanArray(name);
4925 }
4926
4927 /**
4928 * Retrieve extended data from the intent.
4929 *
4930 * @param name The name of the desired item.
4931 *
4932 * @return the value of an item that previously added with putExtra()
4933 * or null if no byte array value was found.
4934 *
4935 * @see #putExtra(String, byte[])
4936 */
4937 public byte[] getByteArrayExtra(String name) {
4938 return mExtras == null ? null : mExtras.getByteArray(name);
4939 }
4940
4941 /**
4942 * Retrieve extended data from the intent.
4943 *
4944 * @param name The name of the desired item.
4945 *
4946 * @return the value of an item that previously added with putExtra()
4947 * or null if no short array value was found.
4948 *
4949 * @see #putExtra(String, short[])
4950 */
4951 public short[] getShortArrayExtra(String name) {
4952 return mExtras == null ? null : mExtras.getShortArray(name);
4953 }
4954
4955 /**
4956 * Retrieve extended data from the intent.
4957 *
4958 * @param name The name of the desired item.
4959 *
4960 * @return the value of an item that previously added with putExtra()
4961 * or null if no char array value was found.
4962 *
4963 * @see #putExtra(String, char[])
4964 */
4965 public char[] getCharArrayExtra(String name) {
4966 return mExtras == null ? null : mExtras.getCharArray(name);
4967 }
4968
4969 /**
4970 * Retrieve extended data from the intent.
4971 *
4972 * @param name The name of the desired item.
4973 *
4974 * @return the value of an item that previously added with putExtra()
4975 * or null if no int array value was found.
4976 *
4977 * @see #putExtra(String, int[])
4978 */
4979 public int[] getIntArrayExtra(String name) {
4980 return mExtras == null ? null : mExtras.getIntArray(name);
4981 }
4982
4983 /**
4984 * Retrieve extended data from the intent.
4985 *
4986 * @param name The name of the desired item.
4987 *
4988 * @return the value of an item that previously added with putExtra()
4989 * or null if no long array value was found.
4990 *
4991 * @see #putExtra(String, long[])
4992 */
4993 public long[] getLongArrayExtra(String name) {
4994 return mExtras == null ? null : mExtras.getLongArray(name);
4995 }
4996
4997 /**
4998 * Retrieve extended data from the intent.
4999 *
5000 * @param name The name of the desired item.
5001 *
5002 * @return the value of an item that previously added with putExtra()
5003 * or null if no float array value was found.
5004 *
5005 * @see #putExtra(String, float[])
5006 */
5007 public float[] getFloatArrayExtra(String name) {
5008 return mExtras == null ? null : mExtras.getFloatArray(name);
5009 }
5010
5011 /**
5012 * Retrieve extended data from the intent.
5013 *
5014 * @param name The name of the desired item.
5015 *
5016 * @return the value of an item that previously added with putExtra()
5017 * or null if no double array value was found.
5018 *
5019 * @see #putExtra(String, double[])
5020 */
5021 public double[] getDoubleArrayExtra(String name) {
5022 return mExtras == null ? null : mExtras.getDoubleArray(name);
5023 }
5024
5025 /**
5026 * Retrieve extended data from the intent.
5027 *
5028 * @param name The name of the desired item.
5029 *
5030 * @return the value of an item that previously added with putExtra()
5031 * or null if no String array value was found.
5032 *
5033 * @see #putExtra(String, String[])
5034 */
5035 public String[] getStringArrayExtra(String name) {
5036 return mExtras == null ? null : mExtras.getStringArray(name);
5037 }
5038
5039 /**
5040 * Retrieve extended data from the intent.
5041 *
5042 * @param name The name of the desired item.
5043 *
5044 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005045 * or null if no CharSequence array value was found.
5046 *
5047 * @see #putExtra(String, CharSequence[])
5048 */
5049 public CharSequence[] getCharSequenceArrayExtra(String name) {
5050 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5051 }
5052
5053 /**
5054 * Retrieve extended data from the intent.
5055 *
5056 * @param name The name of the desired item.
5057 *
5058 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005059 * or null if no Bundle value was found.
5060 *
5061 * @see #putExtra(String, Bundle)
5062 */
5063 public Bundle getBundleExtra(String name) {
5064 return mExtras == null ? null : mExtras.getBundle(name);
5065 }
5066
5067 /**
5068 * Retrieve extended data from the intent.
5069 *
5070 * @param name The name of the desired item.
5071 *
5072 * @return the value of an item that previously added with putExtra()
5073 * or null if no IBinder value was found.
5074 *
5075 * @see #putExtra(String, IBinder)
5076 *
5077 * @deprecated
5078 * @hide
5079 */
5080 @Deprecated
5081 public IBinder getIBinderExtra(String name) {
5082 return mExtras == null ? null : mExtras.getIBinder(name);
5083 }
5084
5085 /**
5086 * Retrieve extended data from the intent.
5087 *
5088 * @param name The name of the desired item.
5089 * @param defaultValue The default value to return in case no item is
5090 * associated with the key 'name'
5091 *
5092 * @return the value of an item that previously added with putExtra()
5093 * or defaultValue if none was found.
5094 *
5095 * @see #putExtra
5096 *
5097 * @deprecated
5098 * @hide
5099 */
5100 @Deprecated
5101 public Object getExtra(String name, Object defaultValue) {
5102 Object result = defaultValue;
5103 if (mExtras != null) {
5104 Object result2 = mExtras.get(name);
5105 if (result2 != null) {
5106 result = result2;
5107 }
5108 }
5109
5110 return result;
5111 }
5112
5113 /**
5114 * Retrieves a map of extended data from the intent.
5115 *
5116 * @return the map of all extras previously added with putExtra(),
5117 * or null if none have been added.
5118 */
5119 public Bundle getExtras() {
5120 return (mExtras != null)
5121 ? new Bundle(mExtras)
5122 : null;
5123 }
5124
5125 /**
5126 * Retrieve any special flags associated with this intent. You will
5127 * normally just set them with {@link #setFlags} and let the system
5128 * take the appropriate action with them.
5129 *
5130 * @return int The currently set flags.
5131 *
5132 * @see #setFlags
5133 */
5134 public int getFlags() {
5135 return mFlags;
5136 }
5137
Dianne Hackborne7f97212011-02-24 14:40:20 -08005138 /** @hide */
5139 public boolean isExcludingStopped() {
5140 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5141 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5142 }
5143
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005144 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005145 * Retrieve the application package name this Intent is limited to. When
5146 * resolving an Intent, if non-null this limits the resolution to only
5147 * components in the given application package.
5148 *
5149 * @return The name of the application package for the Intent.
5150 *
5151 * @see #resolveActivity
5152 * @see #setPackage
5153 */
5154 public String getPackage() {
5155 return mPackage;
5156 }
5157
5158 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005159 * Retrieve the concrete component associated with the intent. When receiving
5160 * an intent, this is the component that was found to best handle it (that is,
5161 * yourself) and will always be non-null; in all other cases it will be
5162 * null unless explicitly set.
5163 *
5164 * @return The name of the application component to handle the intent.
5165 *
5166 * @see #resolveActivity
5167 * @see #setComponent
5168 */
5169 public ComponentName getComponent() {
5170 return mComponent;
5171 }
5172
5173 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005174 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5175 * used as a hint to the receiver for animations and the like. Null means that there
5176 * is no source bounds.
5177 */
5178 public Rect getSourceBounds() {
5179 return mSourceBounds;
5180 }
5181
5182 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005183 * Return the Activity component that should be used to handle this intent.
5184 * The appropriate component is determined based on the information in the
5185 * intent, evaluated as follows:
5186 *
5187 * <p>If {@link #getComponent} returns an explicit class, that is returned
5188 * without any further consideration.
5189 *
5190 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5191 * category to be considered.
5192 *
5193 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5194 * action.
5195 *
5196 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5197 * this type.
5198 *
5199 * <p>If {@link #addCategory} has added any categories, the activity must
5200 * handle ALL of the categories specified.
5201 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005202 * <p>If {@link #getPackage} is non-NULL, only activity components in
5203 * that application package will be considered.
5204 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005205 * <p>If there are no activities that satisfy all of these conditions, a
5206 * null string is returned.
5207 *
5208 * <p>If multiple activities are found to satisfy the intent, the one with
5209 * the highest priority will be used. If there are multiple activities
5210 * with the same priority, the system will either pick the best activity
5211 * based on user preference, or resolve to a system class that will allow
5212 * the user to pick an activity and forward from there.
5213 *
5214 * <p>This method is implemented simply by calling
5215 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5216 * true.</p>
5217 * <p> This API is called for you as part of starting an activity from an
5218 * intent. You do not normally need to call it yourself.</p>
5219 *
5220 * @param pm The package manager with which to resolve the Intent.
5221 *
5222 * @return Name of the component implementing an activity that can
5223 * display the intent.
5224 *
5225 * @see #setComponent
5226 * @see #getComponent
5227 * @see #resolveActivityInfo
5228 */
5229 public ComponentName resolveActivity(PackageManager pm) {
5230 if (mComponent != null) {
5231 return mComponent;
5232 }
5233
5234 ResolveInfo info = pm.resolveActivity(
5235 this, PackageManager.MATCH_DEFAULT_ONLY);
5236 if (info != null) {
5237 return new ComponentName(
5238 info.activityInfo.applicationInfo.packageName,
5239 info.activityInfo.name);
5240 }
5241
5242 return null;
5243 }
5244
5245 /**
5246 * Resolve the Intent into an {@link ActivityInfo}
5247 * describing the activity that should execute the intent. Resolution
5248 * follows the same rules as described for {@link #resolveActivity}, but
5249 * you get back the completely information about the resolved activity
5250 * instead of just its class name.
5251 *
5252 * @param pm The package manager with which to resolve the Intent.
5253 * @param flags Addition information to retrieve as per
5254 * {@link PackageManager#getActivityInfo(ComponentName, int)
5255 * PackageManager.getActivityInfo()}.
5256 *
5257 * @return PackageManager.ActivityInfo
5258 *
5259 * @see #resolveActivity
5260 */
5261 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5262 ActivityInfo ai = null;
5263 if (mComponent != null) {
5264 try {
5265 ai = pm.getActivityInfo(mComponent, flags);
5266 } catch (PackageManager.NameNotFoundException e) {
5267 // ignore
5268 }
5269 } else {
5270 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005271 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005272 if (info != null) {
5273 ai = info.activityInfo;
5274 }
5275 }
5276
5277 return ai;
5278 }
5279
5280 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005281 * Special function for use by the system to resolve service
5282 * intents to system apps. Throws an exception if there are
5283 * multiple potential matches to the Intent. Returns null if
5284 * there are no matches.
5285 * @hide
5286 */
5287 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5288 if (mComponent != null) {
5289 return mComponent;
5290 }
5291
5292 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5293 if (results == null) {
5294 return null;
5295 }
5296 ComponentName comp = null;
5297 for (int i=0; i<results.size(); i++) {
5298 ResolveInfo ri = results.get(i);
5299 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5300 continue;
5301 }
5302 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5303 ri.serviceInfo.name);
5304 if (comp != null) {
5305 throw new IllegalStateException("Multiple system services handle " + this
5306 + ": " + comp + ", " + foundComp);
5307 }
5308 comp = foundComp;
5309 }
5310 return comp;
5311 }
5312
5313 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005314 * Set the general action to be performed.
5315 *
5316 * @param action An action name, such as ACTION_VIEW. Application-specific
5317 * actions should be prefixed with the vendor's package name.
5318 *
5319 * @return Returns the same Intent object, for chaining multiple calls
5320 * into a single statement.
5321 *
5322 * @see #getAction
5323 */
5324 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005325 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005326 return this;
5327 }
5328
5329 /**
5330 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005331 * clears any type that was previously set by {@link #setType} or
5332 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005333 *
Nick Pellyccae4122012-01-09 14:12:58 -08005334 * <p><em>Note: scheme matching in the Android framework is
5335 * case-sensitive, unlike the formal RFC. As a result,
5336 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005337 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005338 * {@link #setDataAndNormalize}
5339 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005340 *
Nick Pellyccae4122012-01-09 14:12:58 -08005341 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005342 *
5343 * @return Returns the same Intent object, for chaining multiple calls
5344 * into a single statement.
5345 *
5346 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005347 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005348 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005349 */
5350 public Intent setData(Uri data) {
5351 mData = data;
5352 mType = null;
5353 return this;
5354 }
5355
5356 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005357 * Normalize and set the data this intent is operating on.
5358 *
5359 * <p>This method automatically clears any type that was
5360 * previously set (for example, by {@link #setType}).
5361 *
5362 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005363 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005364 * so really this is just a convenience method for
5365 * <pre>
5366 * setData(data.normalize())
5367 * </pre>
5368 *
5369 * @param data The Uri of the data this intent is now targeting.
5370 *
5371 * @return Returns the same Intent object, for chaining multiple calls
5372 * into a single statement.
5373 *
5374 * @see #getData
5375 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005376 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005377 */
5378 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005379 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005380 }
5381
5382 /**
5383 * Set an explicit MIME data type.
5384 *
5385 * <p>This is used to create intents that only specify a type and not data,
5386 * for example to indicate the type of data to return.
5387 *
5388 * <p>This method automatically clears any data that was
5389 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005390 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005391 * <p><em>Note: MIME type matching in the Android framework is
5392 * case-sensitive, unlike formal RFC MIME types. As a result,
5393 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005394 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5395 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005396 *
5397 * @param type The MIME type of the data being handled by this intent.
5398 *
5399 * @return Returns the same Intent object, for chaining multiple calls
5400 * into a single statement.
5401 *
5402 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005403 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005404 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005405 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005406 */
5407 public Intent setType(String type) {
5408 mData = null;
5409 mType = type;
5410 return this;
5411 }
5412
5413 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005414 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005415 *
Nick Pellyccae4122012-01-09 14:12:58 -08005416 * <p>This is used to create intents that only specify a type and not data,
5417 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005418 *
Nick Pellyccae4122012-01-09 14:12:58 -08005419 * <p>This method automatically clears any data that was
5420 * previously set (for example by {@link #setData}).
5421 *
5422 * <p>The MIME type is normalized using
5423 * {@link #normalizeMimeType} before it is set,
5424 * so really this is just a convenience method for
5425 * <pre>
5426 * setType(Intent.normalizeMimeType(type))
5427 * </pre>
5428 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005429 * @param type The MIME type of the data being handled by this intent.
5430 *
5431 * @return Returns the same Intent object, for chaining multiple calls
5432 * into a single statement.
5433 *
Nick Pellyccae4122012-01-09 14:12:58 -08005434 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005435 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005436 * @see #normalizeMimeType
5437 */
5438 public Intent setTypeAndNormalize(String type) {
5439 return setType(normalizeMimeType(type));
5440 }
5441
5442 /**
5443 * (Usually optional) Set the data for the intent along with an explicit
5444 * MIME data type. This method should very rarely be used -- it allows you
5445 * to override the MIME type that would ordinarily be inferred from the
5446 * data with your own type given here.
5447 *
5448 * <p><em>Note: MIME type and Uri scheme matching in the
5449 * Android framework is case-sensitive, unlike the formal RFC definitions.
5450 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005451 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005452 * {@link #setDataAndTypeAndNormalize}
5453 * to ensure that they are converted to lower case.</em>
5454 *
5455 * @param data The Uri of the data this intent is now targeting.
5456 * @param type The MIME type of the data being handled by this intent.
5457 *
5458 * @return Returns the same Intent object, for chaining multiple calls
5459 * into a single statement.
5460 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005461 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005462 * @see #setData
5463 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005464 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005465 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005466 */
5467 public Intent setDataAndType(Uri data, String type) {
5468 mData = data;
5469 mType = type;
5470 return this;
5471 }
5472
5473 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005474 * (Usually optional) Normalize and set both the data Uri and an explicit
5475 * MIME data type. This method should very rarely be used -- it allows you
5476 * to override the MIME type that would ordinarily be inferred from the
5477 * data with your own type given here.
5478 *
5479 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005480 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005481 * before they are set, so really this is just a convenience method for
5482 * <pre>
5483 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5484 * </pre>
5485 *
5486 * @param data The Uri of the data this intent is now targeting.
5487 * @param type The MIME type of the data being handled by this intent.
5488 *
5489 * @return Returns the same Intent object, for chaining multiple calls
5490 * into a single statement.
5491 *
5492 * @see #setType
5493 * @see #setData
5494 * @see #setDataAndType
5495 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005496 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005497 */
5498 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005499 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005500 }
5501
5502 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005503 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005504 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005505 * activities that provide <em>all</em> of the requested categories will be
5506 * used.
5507 *
5508 * @param category The desired category. This can be either one of the
5509 * predefined Intent categories, or a custom category in your own
5510 * namespace.
5511 *
5512 * @return Returns the same Intent object, for chaining multiple calls
5513 * into a single statement.
5514 *
5515 * @see #hasCategory
5516 * @see #removeCategory
5517 */
5518 public Intent addCategory(String category) {
5519 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005520 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005521 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005522 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005523 return this;
5524 }
5525
5526 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005527 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005528 *
5529 * @param category The category to remove.
5530 *
5531 * @see #addCategory
5532 */
5533 public void removeCategory(String category) {
5534 if (mCategories != null) {
5535 mCategories.remove(category);
5536 if (mCategories.size() == 0) {
5537 mCategories = null;
5538 }
5539 }
5540 }
5541
5542 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005543 * Set a selector for this Intent. This is a modification to the kinds of
5544 * things the Intent will match. If the selector is set, it will be used
5545 * when trying to find entities that can handle the Intent, instead of the
5546 * main contents of the Intent. This allows you build an Intent containing
5547 * a generic protocol while targeting it more specifically.
5548 *
5549 * <p>An example of where this may be used is with things like
5550 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5551 * Intent that will launch the Browser application. However, the correct
5552 * main entry point of an application is actually {@link #ACTION_MAIN}
5553 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5554 * used to specify the actual Activity to launch. If you launch the browser
5555 * with something different, undesired behavior may happen if the user has
5556 * previously or later launches it the normal way, since they do not match.
5557 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5558 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5559 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5560 *
5561 * <p>Setting a selector does not impact the behavior of
5562 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5563 * desired behavior of a selector -- it does not impact the base meaning
5564 * of the Intent, just what kinds of things will be matched against it
5565 * when determining who can handle it.</p>
5566 *
5567 * <p>You can not use both a selector and {@link #setPackage(String)} on
5568 * the same base Intent.</p>
5569 *
5570 * @param selector The desired selector Intent; set to null to not use
5571 * a special selector.
5572 */
5573 public void setSelector(Intent selector) {
5574 if (selector == this) {
5575 throw new IllegalArgumentException(
5576 "Intent being set as a selector of itself");
5577 }
5578 if (selector != null && mPackage != null) {
5579 throw new IllegalArgumentException(
5580 "Can't set selector when package name is already set");
5581 }
5582 mSelector = selector;
5583 }
5584
5585 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005586 * Set a {@link ClipData} associated with this Intent. This replaces any
5587 * previously set ClipData.
5588 *
5589 * <p>The ClipData in an intent is not used for Intent matching or other
5590 * such operations. Semantically it is like extras, used to transmit
5591 * additional data with the Intent. The main feature of using this over
5592 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5593 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5594 * items included in the clip data. This is useful, in particular, if
5595 * you want to transmit an Intent containing multiple <code>content:</code>
5596 * URIs for which the recipient may not have global permission to access the
5597 * content provider.
5598 *
5599 * <p>If the ClipData contains items that are themselves Intents, any
5600 * grant flags in those Intents will be ignored. Only the top-level flags
5601 * of the main Intent are respected, and will be applied to all Uri or
5602 * Intent items in the clip (or sub-items of the clip).
5603 *
5604 * <p>The MIME type, label, and icon in the ClipData object are not
5605 * directly used by Intent. Applications should generally rely on the
5606 * MIME type of the Intent itself, not what it may find in the ClipData.
5607 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005608 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005609 *
5610 * @param clip The new clip to set. May be null to clear the current clip.
5611 */
5612 public void setClipData(ClipData clip) {
5613 mClipData = clip;
5614 }
5615
5616 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005617 * Add extended data to the intent. The name must include a package
5618 * prefix, for example the app com.android.contacts would use names
5619 * like "com.android.contacts.ShowAll".
5620 *
5621 * @param name The name of the extra data, with package prefix.
5622 * @param value The boolean data value.
5623 *
5624 * @return Returns the same Intent object, for chaining multiple calls
5625 * into a single statement.
5626 *
5627 * @see #putExtras
5628 * @see #removeExtra
5629 * @see #getBooleanExtra(String, boolean)
5630 */
5631 public Intent putExtra(String name, boolean value) {
5632 if (mExtras == null) {
5633 mExtras = new Bundle();
5634 }
5635 mExtras.putBoolean(name, value);
5636 return this;
5637 }
5638
5639 /**
5640 * Add extended data to the intent. The name must include a package
5641 * prefix, for example the app com.android.contacts would use names
5642 * like "com.android.contacts.ShowAll".
5643 *
5644 * @param name The name of the extra data, with package prefix.
5645 * @param value The byte data value.
5646 *
5647 * @return Returns the same Intent object, for chaining multiple calls
5648 * into a single statement.
5649 *
5650 * @see #putExtras
5651 * @see #removeExtra
5652 * @see #getByteExtra(String, byte)
5653 */
5654 public Intent putExtra(String name, byte value) {
5655 if (mExtras == null) {
5656 mExtras = new Bundle();
5657 }
5658 mExtras.putByte(name, value);
5659 return this;
5660 }
5661
5662 /**
5663 * Add extended data to the intent. The name must include a package
5664 * prefix, for example the app com.android.contacts would use names
5665 * like "com.android.contacts.ShowAll".
5666 *
5667 * @param name The name of the extra data, with package prefix.
5668 * @param value The char data value.
5669 *
5670 * @return Returns the same Intent object, for chaining multiple calls
5671 * into a single statement.
5672 *
5673 * @see #putExtras
5674 * @see #removeExtra
5675 * @see #getCharExtra(String, char)
5676 */
5677 public Intent putExtra(String name, char value) {
5678 if (mExtras == null) {
5679 mExtras = new Bundle();
5680 }
5681 mExtras.putChar(name, value);
5682 return this;
5683 }
5684
5685 /**
5686 * Add extended data to the intent. The name must include a package
5687 * prefix, for example the app com.android.contacts would use names
5688 * like "com.android.contacts.ShowAll".
5689 *
5690 * @param name The name of the extra data, with package prefix.
5691 * @param value The short data value.
5692 *
5693 * @return Returns the same Intent object, for chaining multiple calls
5694 * into a single statement.
5695 *
5696 * @see #putExtras
5697 * @see #removeExtra
5698 * @see #getShortExtra(String, short)
5699 */
5700 public Intent putExtra(String name, short value) {
5701 if (mExtras == null) {
5702 mExtras = new Bundle();
5703 }
5704 mExtras.putShort(name, value);
5705 return this;
5706 }
5707
5708 /**
5709 * Add extended data to the intent. The name must include a package
5710 * prefix, for example the app com.android.contacts would use names
5711 * like "com.android.contacts.ShowAll".
5712 *
5713 * @param name The name of the extra data, with package prefix.
5714 * @param value The integer data value.
5715 *
5716 * @return Returns the same Intent object, for chaining multiple calls
5717 * into a single statement.
5718 *
5719 * @see #putExtras
5720 * @see #removeExtra
5721 * @see #getIntExtra(String, int)
5722 */
5723 public Intent putExtra(String name, int value) {
5724 if (mExtras == null) {
5725 mExtras = new Bundle();
5726 }
5727 mExtras.putInt(name, value);
5728 return this;
5729 }
5730
5731 /**
5732 * Add extended data to the intent. The name must include a package
5733 * prefix, for example the app com.android.contacts would use names
5734 * like "com.android.contacts.ShowAll".
5735 *
5736 * @param name The name of the extra data, with package prefix.
5737 * @param value The long data value.
5738 *
5739 * @return Returns the same Intent object, for chaining multiple calls
5740 * into a single statement.
5741 *
5742 * @see #putExtras
5743 * @see #removeExtra
5744 * @see #getLongExtra(String, long)
5745 */
5746 public Intent putExtra(String name, long value) {
5747 if (mExtras == null) {
5748 mExtras = new Bundle();
5749 }
5750 mExtras.putLong(name, value);
5751 return this;
5752 }
5753
5754 /**
5755 * Add extended data to the intent. The name must include a package
5756 * prefix, for example the app com.android.contacts would use names
5757 * like "com.android.contacts.ShowAll".
5758 *
5759 * @param name The name of the extra data, with package prefix.
5760 * @param value The float data value.
5761 *
5762 * @return Returns the same Intent object, for chaining multiple calls
5763 * into a single statement.
5764 *
5765 * @see #putExtras
5766 * @see #removeExtra
5767 * @see #getFloatExtra(String, float)
5768 */
5769 public Intent putExtra(String name, float value) {
5770 if (mExtras == null) {
5771 mExtras = new Bundle();
5772 }
5773 mExtras.putFloat(name, value);
5774 return this;
5775 }
5776
5777 /**
5778 * Add extended data to the intent. The name must include a package
5779 * prefix, for example the app com.android.contacts would use names
5780 * like "com.android.contacts.ShowAll".
5781 *
5782 * @param name The name of the extra data, with package prefix.
5783 * @param value The double data value.
5784 *
5785 * @return Returns the same Intent object, for chaining multiple calls
5786 * into a single statement.
5787 *
5788 * @see #putExtras
5789 * @see #removeExtra
5790 * @see #getDoubleExtra(String, double)
5791 */
5792 public Intent putExtra(String name, double value) {
5793 if (mExtras == null) {
5794 mExtras = new Bundle();
5795 }
5796 mExtras.putDouble(name, value);
5797 return this;
5798 }
5799
5800 /**
5801 * Add extended data to the intent. The name must include a package
5802 * prefix, for example the app com.android.contacts would use names
5803 * like "com.android.contacts.ShowAll".
5804 *
5805 * @param name The name of the extra data, with package prefix.
5806 * @param value The String data value.
5807 *
5808 * @return Returns the same Intent object, for chaining multiple calls
5809 * into a single statement.
5810 *
5811 * @see #putExtras
5812 * @see #removeExtra
5813 * @see #getStringExtra(String)
5814 */
5815 public Intent putExtra(String name, String value) {
5816 if (mExtras == null) {
5817 mExtras = new Bundle();
5818 }
5819 mExtras.putString(name, value);
5820 return this;
5821 }
5822
5823 /**
5824 * Add extended data to the intent. The name must include a package
5825 * prefix, for example the app com.android.contacts would use names
5826 * like "com.android.contacts.ShowAll".
5827 *
5828 * @param name The name of the extra data, with package prefix.
5829 * @param value The CharSequence data value.
5830 *
5831 * @return Returns the same Intent object, for chaining multiple calls
5832 * into a single statement.
5833 *
5834 * @see #putExtras
5835 * @see #removeExtra
5836 * @see #getCharSequenceExtra(String)
5837 */
5838 public Intent putExtra(String name, CharSequence value) {
5839 if (mExtras == null) {
5840 mExtras = new Bundle();
5841 }
5842 mExtras.putCharSequence(name, value);
5843 return this;
5844 }
5845
5846 /**
5847 * Add extended data to the intent. The name must include a package
5848 * prefix, for example the app com.android.contacts would use names
5849 * like "com.android.contacts.ShowAll".
5850 *
5851 * @param name The name of the extra data, with package prefix.
5852 * @param value The Parcelable data value.
5853 *
5854 * @return Returns the same Intent object, for chaining multiple calls
5855 * into a single statement.
5856 *
5857 * @see #putExtras
5858 * @see #removeExtra
5859 * @see #getParcelableExtra(String)
5860 */
5861 public Intent putExtra(String name, Parcelable value) {
5862 if (mExtras == null) {
5863 mExtras = new Bundle();
5864 }
5865 mExtras.putParcelable(name, value);
5866 return this;
5867 }
5868
5869 /**
5870 * Add extended data to the intent. The name must include a package
5871 * prefix, for example the app com.android.contacts would use names
5872 * like "com.android.contacts.ShowAll".
5873 *
5874 * @param name The name of the extra data, with package prefix.
5875 * @param value The Parcelable[] data value.
5876 *
5877 * @return Returns the same Intent object, for chaining multiple calls
5878 * into a single statement.
5879 *
5880 * @see #putExtras
5881 * @see #removeExtra
5882 * @see #getParcelableArrayExtra(String)
5883 */
5884 public Intent putExtra(String name, Parcelable[] value) {
5885 if (mExtras == null) {
5886 mExtras = new Bundle();
5887 }
5888 mExtras.putParcelableArray(name, value);
5889 return this;
5890 }
5891
5892 /**
5893 * Add extended data to the intent. The name must include a package
5894 * prefix, for example the app com.android.contacts would use names
5895 * like "com.android.contacts.ShowAll".
5896 *
5897 * @param name The name of the extra data, with package prefix.
5898 * @param value The ArrayList<Parcelable> data value.
5899 *
5900 * @return Returns the same Intent object, for chaining multiple calls
5901 * into a single statement.
5902 *
5903 * @see #putExtras
5904 * @see #removeExtra
5905 * @see #getParcelableArrayListExtra(String)
5906 */
5907 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5908 if (mExtras == null) {
5909 mExtras = new Bundle();
5910 }
5911 mExtras.putParcelableArrayList(name, value);
5912 return this;
5913 }
5914
5915 /**
5916 * Add extended data to the intent. The name must include a package
5917 * prefix, for example the app com.android.contacts would use names
5918 * like "com.android.contacts.ShowAll".
5919 *
5920 * @param name The name of the extra data, with package prefix.
5921 * @param value The ArrayList<Integer> data value.
5922 *
5923 * @return Returns the same Intent object, for chaining multiple calls
5924 * into a single statement.
5925 *
5926 * @see #putExtras
5927 * @see #removeExtra
5928 * @see #getIntegerArrayListExtra(String)
5929 */
5930 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5931 if (mExtras == null) {
5932 mExtras = new Bundle();
5933 }
5934 mExtras.putIntegerArrayList(name, value);
5935 return this;
5936 }
5937
5938 /**
5939 * Add extended data to the intent. The name must include a package
5940 * prefix, for example the app com.android.contacts would use names
5941 * like "com.android.contacts.ShowAll".
5942 *
5943 * @param name The name of the extra data, with package prefix.
5944 * @param value The ArrayList<String> data value.
5945 *
5946 * @return Returns the same Intent object, for chaining multiple calls
5947 * into a single statement.
5948 *
5949 * @see #putExtras
5950 * @see #removeExtra
5951 * @see #getStringArrayListExtra(String)
5952 */
5953 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5954 if (mExtras == null) {
5955 mExtras = new Bundle();
5956 }
5957 mExtras.putStringArrayList(name, value);
5958 return this;
5959 }
5960
5961 /**
5962 * Add extended data to the intent. The name must include a package
5963 * prefix, for example the app com.android.contacts would use names
5964 * like "com.android.contacts.ShowAll".
5965 *
5966 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005967 * @param value The ArrayList<CharSequence> data value.
5968 *
5969 * @return Returns the same Intent object, for chaining multiple calls
5970 * into a single statement.
5971 *
5972 * @see #putExtras
5973 * @see #removeExtra
5974 * @see #getCharSequenceArrayListExtra(String)
5975 */
5976 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5977 if (mExtras == null) {
5978 mExtras = new Bundle();
5979 }
5980 mExtras.putCharSequenceArrayList(name, value);
5981 return this;
5982 }
5983
5984 /**
5985 * Add extended data to the intent. The name must include a package
5986 * prefix, for example the app com.android.contacts would use names
5987 * like "com.android.contacts.ShowAll".
5988 *
5989 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005990 * @param value The Serializable data value.
5991 *
5992 * @return Returns the same Intent object, for chaining multiple calls
5993 * into a single statement.
5994 *
5995 * @see #putExtras
5996 * @see #removeExtra
5997 * @see #getSerializableExtra(String)
5998 */
5999 public Intent putExtra(String name, Serializable value) {
6000 if (mExtras == null) {
6001 mExtras = new Bundle();
6002 }
6003 mExtras.putSerializable(name, value);
6004 return this;
6005 }
6006
6007 /**
6008 * Add extended data to the intent. The name must include a package
6009 * prefix, for example the app com.android.contacts would use names
6010 * like "com.android.contacts.ShowAll".
6011 *
6012 * @param name The name of the extra data, with package prefix.
6013 * @param value The boolean array data value.
6014 *
6015 * @return Returns the same Intent object, for chaining multiple calls
6016 * into a single statement.
6017 *
6018 * @see #putExtras
6019 * @see #removeExtra
6020 * @see #getBooleanArrayExtra(String)
6021 */
6022 public Intent putExtra(String name, boolean[] value) {
6023 if (mExtras == null) {
6024 mExtras = new Bundle();
6025 }
6026 mExtras.putBooleanArray(name, value);
6027 return this;
6028 }
6029
6030 /**
6031 * Add extended data to the intent. The name must include a package
6032 * prefix, for example the app com.android.contacts would use names
6033 * like "com.android.contacts.ShowAll".
6034 *
6035 * @param name The name of the extra data, with package prefix.
6036 * @param value The byte array data value.
6037 *
6038 * @return Returns the same Intent object, for chaining multiple calls
6039 * into a single statement.
6040 *
6041 * @see #putExtras
6042 * @see #removeExtra
6043 * @see #getByteArrayExtra(String)
6044 */
6045 public Intent putExtra(String name, byte[] value) {
6046 if (mExtras == null) {
6047 mExtras = new Bundle();
6048 }
6049 mExtras.putByteArray(name, value);
6050 return this;
6051 }
6052
6053 /**
6054 * Add extended data to the intent. The name must include a package
6055 * prefix, for example the app com.android.contacts would use names
6056 * like "com.android.contacts.ShowAll".
6057 *
6058 * @param name The name of the extra data, with package prefix.
6059 * @param value The short array data value.
6060 *
6061 * @return Returns the same Intent object, for chaining multiple calls
6062 * into a single statement.
6063 *
6064 * @see #putExtras
6065 * @see #removeExtra
6066 * @see #getShortArrayExtra(String)
6067 */
6068 public Intent putExtra(String name, short[] value) {
6069 if (mExtras == null) {
6070 mExtras = new Bundle();
6071 }
6072 mExtras.putShortArray(name, value);
6073 return this;
6074 }
6075
6076 /**
6077 * Add extended data to the intent. The name must include a package
6078 * prefix, for example the app com.android.contacts would use names
6079 * like "com.android.contacts.ShowAll".
6080 *
6081 * @param name The name of the extra data, with package prefix.
6082 * @param value The char array data value.
6083 *
6084 * @return Returns the same Intent object, for chaining multiple calls
6085 * into a single statement.
6086 *
6087 * @see #putExtras
6088 * @see #removeExtra
6089 * @see #getCharArrayExtra(String)
6090 */
6091 public Intent putExtra(String name, char[] value) {
6092 if (mExtras == null) {
6093 mExtras = new Bundle();
6094 }
6095 mExtras.putCharArray(name, value);
6096 return this;
6097 }
6098
6099 /**
6100 * Add extended data to the intent. The name must include a package
6101 * prefix, for example the app com.android.contacts would use names
6102 * like "com.android.contacts.ShowAll".
6103 *
6104 * @param name The name of the extra data, with package prefix.
6105 * @param value The int array data value.
6106 *
6107 * @return Returns the same Intent object, for chaining multiple calls
6108 * into a single statement.
6109 *
6110 * @see #putExtras
6111 * @see #removeExtra
6112 * @see #getIntArrayExtra(String)
6113 */
6114 public Intent putExtra(String name, int[] value) {
6115 if (mExtras == null) {
6116 mExtras = new Bundle();
6117 }
6118 mExtras.putIntArray(name, value);
6119 return this;
6120 }
6121
6122 /**
6123 * Add extended data to the intent. The name must include a package
6124 * prefix, for example the app com.android.contacts would use names
6125 * like "com.android.contacts.ShowAll".
6126 *
6127 * @param name The name of the extra data, with package prefix.
6128 * @param value The byte array data value.
6129 *
6130 * @return Returns the same Intent object, for chaining multiple calls
6131 * into a single statement.
6132 *
6133 * @see #putExtras
6134 * @see #removeExtra
6135 * @see #getLongArrayExtra(String)
6136 */
6137 public Intent putExtra(String name, long[] value) {
6138 if (mExtras == null) {
6139 mExtras = new Bundle();
6140 }
6141 mExtras.putLongArray(name, value);
6142 return this;
6143 }
6144
6145 /**
6146 * Add extended data to the intent. The name must include a package
6147 * prefix, for example the app com.android.contacts would use names
6148 * like "com.android.contacts.ShowAll".
6149 *
6150 * @param name The name of the extra data, with package prefix.
6151 * @param value The float array data value.
6152 *
6153 * @return Returns the same Intent object, for chaining multiple calls
6154 * into a single statement.
6155 *
6156 * @see #putExtras
6157 * @see #removeExtra
6158 * @see #getFloatArrayExtra(String)
6159 */
6160 public Intent putExtra(String name, float[] value) {
6161 if (mExtras == null) {
6162 mExtras = new Bundle();
6163 }
6164 mExtras.putFloatArray(name, value);
6165 return this;
6166 }
6167
6168 /**
6169 * Add extended data to the intent. The name must include a package
6170 * prefix, for example the app com.android.contacts would use names
6171 * like "com.android.contacts.ShowAll".
6172 *
6173 * @param name The name of the extra data, with package prefix.
6174 * @param value The double array data value.
6175 *
6176 * @return Returns the same Intent object, for chaining multiple calls
6177 * into a single statement.
6178 *
6179 * @see #putExtras
6180 * @see #removeExtra
6181 * @see #getDoubleArrayExtra(String)
6182 */
6183 public Intent putExtra(String name, double[] value) {
6184 if (mExtras == null) {
6185 mExtras = new Bundle();
6186 }
6187 mExtras.putDoubleArray(name, value);
6188 return this;
6189 }
6190
6191 /**
6192 * Add extended data to the intent. The name must include a package
6193 * prefix, for example the app com.android.contacts would use names
6194 * like "com.android.contacts.ShowAll".
6195 *
6196 * @param name The name of the extra data, with package prefix.
6197 * @param value The String array data value.
6198 *
6199 * @return Returns the same Intent object, for chaining multiple calls
6200 * into a single statement.
6201 *
6202 * @see #putExtras
6203 * @see #removeExtra
6204 * @see #getStringArrayExtra(String)
6205 */
6206 public Intent putExtra(String name, String[] value) {
6207 if (mExtras == null) {
6208 mExtras = new Bundle();
6209 }
6210 mExtras.putStringArray(name, value);
6211 return this;
6212 }
6213
6214 /**
6215 * Add extended data to the intent. The name must include a package
6216 * prefix, for example the app com.android.contacts would use names
6217 * like "com.android.contacts.ShowAll".
6218 *
6219 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006220 * @param value The CharSequence array data value.
6221 *
6222 * @return Returns the same Intent object, for chaining multiple calls
6223 * into a single statement.
6224 *
6225 * @see #putExtras
6226 * @see #removeExtra
6227 * @see #getCharSequenceArrayExtra(String)
6228 */
6229 public Intent putExtra(String name, CharSequence[] value) {
6230 if (mExtras == null) {
6231 mExtras = new Bundle();
6232 }
6233 mExtras.putCharSequenceArray(name, value);
6234 return this;
6235 }
6236
6237 /**
6238 * Add extended data to the intent. The name must include a package
6239 * prefix, for example the app com.android.contacts would use names
6240 * like "com.android.contacts.ShowAll".
6241 *
6242 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006243 * @param value The Bundle data value.
6244 *
6245 * @return Returns the same Intent object, for chaining multiple calls
6246 * into a single statement.
6247 *
6248 * @see #putExtras
6249 * @see #removeExtra
6250 * @see #getBundleExtra(String)
6251 */
6252 public Intent putExtra(String name, Bundle value) {
6253 if (mExtras == null) {
6254 mExtras = new Bundle();
6255 }
6256 mExtras.putBundle(name, value);
6257 return this;
6258 }
6259
6260 /**
6261 * Add extended data to the intent. The name must include a package
6262 * prefix, for example the app com.android.contacts would use names
6263 * like "com.android.contacts.ShowAll".
6264 *
6265 * @param name The name of the extra data, with package prefix.
6266 * @param value The IBinder data value.
6267 *
6268 * @return Returns the same Intent object, for chaining multiple calls
6269 * into a single statement.
6270 *
6271 * @see #putExtras
6272 * @see #removeExtra
6273 * @see #getIBinderExtra(String)
6274 *
6275 * @deprecated
6276 * @hide
6277 */
6278 @Deprecated
6279 public Intent putExtra(String name, IBinder value) {
6280 if (mExtras == null) {
6281 mExtras = new Bundle();
6282 }
6283 mExtras.putIBinder(name, value);
6284 return this;
6285 }
6286
6287 /**
6288 * Copy all extras in 'src' in to this intent.
6289 *
6290 * @param src Contains the extras to copy.
6291 *
6292 * @see #putExtra
6293 */
6294 public Intent putExtras(Intent src) {
6295 if (src.mExtras != null) {
6296 if (mExtras == null) {
6297 mExtras = new Bundle(src.mExtras);
6298 } else {
6299 mExtras.putAll(src.mExtras);
6300 }
6301 }
6302 return this;
6303 }
6304
6305 /**
6306 * Add a set of extended data to the intent. The keys must include a package
6307 * prefix, for example the app com.android.contacts would use names
6308 * like "com.android.contacts.ShowAll".
6309 *
6310 * @param extras The Bundle of extras to add to this intent.
6311 *
6312 * @see #putExtra
6313 * @see #removeExtra
6314 */
6315 public Intent putExtras(Bundle extras) {
6316 if (mExtras == null) {
6317 mExtras = new Bundle();
6318 }
6319 mExtras.putAll(extras);
6320 return this;
6321 }
6322
6323 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006324 * Completely replace the extras in the Intent with the extras in the
6325 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006326 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006327 * @param src The exact extras contained in this Intent are copied
6328 * into the target intent, replacing any that were previously there.
6329 */
6330 public Intent replaceExtras(Intent src) {
6331 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6332 return this;
6333 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006334
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006335 /**
6336 * Completely replace the extras in the Intent with the given Bundle of
6337 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006338 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006339 * @param extras The new set of extras in the Intent, or null to erase
6340 * all extras.
6341 */
6342 public Intent replaceExtras(Bundle extras) {
6343 mExtras = extras != null ? new Bundle(extras) : null;
6344 return this;
6345 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006346
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006347 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006348 * Remove extended data from the intent.
6349 *
6350 * @see #putExtra
6351 */
6352 public void removeExtra(String name) {
6353 if (mExtras != null) {
6354 mExtras.remove(name);
6355 if (mExtras.size() == 0) {
6356 mExtras = null;
6357 }
6358 }
6359 }
6360
6361 /**
6362 * Set special flags controlling how this intent is handled. Most values
6363 * here depend on the type of component being executed by the Intent,
6364 * specifically the FLAG_ACTIVITY_* flags are all for use with
6365 * {@link Context#startActivity Context.startActivity()} and the
6366 * FLAG_RECEIVER_* flags are all for use with
6367 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6368 *
Scott Main7aee61f2011-02-08 11:25:01 -08006369 * <p>See the
6370 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6371 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006372 * the behavior of your application.
6373 *
6374 * @param flags The desired flags.
6375 *
6376 * @return Returns the same Intent object, for chaining multiple calls
6377 * into a single statement.
6378 *
6379 * @see #getFlags
6380 * @see #addFlags
6381 *
6382 * @see #FLAG_GRANT_READ_URI_PERMISSION
6383 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006384 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6385 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006386 * @see #FLAG_DEBUG_LOG_RESOLUTION
6387 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006388 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006389 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006390 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006391 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006392 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6393 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006394 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006395 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006396 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006397 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006398 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006399 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006400 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006401 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6402 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006403 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006404 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006405 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006406 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6407 */
6408 public Intent setFlags(int flags) {
6409 mFlags = flags;
6410 return this;
6411 }
6412
6413 /**
6414 * Add additional flags to the intent (or with existing flags
6415 * value).
6416 *
6417 * @param flags The new flags to set.
6418 *
6419 * @return Returns the same Intent object, for chaining multiple calls
6420 * into a single statement.
6421 *
6422 * @see #setFlags
6423 */
6424 public Intent addFlags(int flags) {
6425 mFlags |= flags;
6426 return this;
6427 }
6428
6429 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006430 * (Usually optional) Set an explicit application package name that limits
6431 * the components this Intent will resolve to. If left to the default
6432 * value of null, all components in all applications will considered.
6433 * If non-null, the Intent can only match the components in the given
6434 * application package.
6435 *
6436 * @param packageName The name of the application package to handle the
6437 * intent, or null to allow any application package.
6438 *
6439 * @return Returns the same Intent object, for chaining multiple calls
6440 * into a single statement.
6441 *
6442 * @see #getPackage
6443 * @see #resolveActivity
6444 */
6445 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006446 if (packageName != null && mSelector != null) {
6447 throw new IllegalArgumentException(
6448 "Can't set package name when selector is already set");
6449 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006450 mPackage = packageName;
6451 return this;
6452 }
6453
6454 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006455 * (Usually optional) Explicitly set the component to handle the intent.
6456 * If left with the default value of null, the system will determine the
6457 * appropriate class to use based on the other fields (action, data,
6458 * type, categories) in the Intent. If this class is defined, the
6459 * specified class will always be used regardless of the other fields. You
6460 * should only set this value when you know you absolutely want a specific
6461 * class to be used; otherwise it is better to let the system find the
6462 * appropriate class so that you will respect the installed applications
6463 * and user preferences.
6464 *
6465 * @param component The name of the application component to handle the
6466 * intent, or null to let the system find one for you.
6467 *
6468 * @return Returns the same Intent object, for chaining multiple calls
6469 * into a single statement.
6470 *
6471 * @see #setClass
6472 * @see #setClassName(Context, String)
6473 * @see #setClassName(String, String)
6474 * @see #getComponent
6475 * @see #resolveActivity
6476 */
6477 public Intent setComponent(ComponentName component) {
6478 mComponent = component;
6479 return this;
6480 }
6481
6482 /**
6483 * Convenience for calling {@link #setComponent} with an
6484 * explicit class name.
6485 *
6486 * @param packageContext A Context of the application package implementing
6487 * this class.
6488 * @param className The name of a class inside of the application package
6489 * that will be used as the component for this Intent.
6490 *
6491 * @return Returns the same Intent object, for chaining multiple calls
6492 * into a single statement.
6493 *
6494 * @see #setComponent
6495 * @see #setClass
6496 */
6497 public Intent setClassName(Context packageContext, String className) {
6498 mComponent = new ComponentName(packageContext, className);
6499 return this;
6500 }
6501
6502 /**
6503 * Convenience for calling {@link #setComponent} with an
6504 * explicit application package name and class name.
6505 *
6506 * @param packageName The name of the package implementing the desired
6507 * component.
6508 * @param className The name of a class inside of the application package
6509 * that will be used as the component for this Intent.
6510 *
6511 * @return Returns the same Intent object, for chaining multiple calls
6512 * into a single statement.
6513 *
6514 * @see #setComponent
6515 * @see #setClass
6516 */
6517 public Intent setClassName(String packageName, String className) {
6518 mComponent = new ComponentName(packageName, className);
6519 return this;
6520 }
6521
6522 /**
6523 * Convenience for calling {@link #setComponent(ComponentName)} with the
6524 * name returned by a {@link Class} object.
6525 *
6526 * @param packageContext A Context of the application package implementing
6527 * this class.
6528 * @param cls The class name to set, equivalent to
6529 * <code>setClassName(context, cls.getName())</code>.
6530 *
6531 * @return Returns the same Intent object, for chaining multiple calls
6532 * into a single statement.
6533 *
6534 * @see #setComponent
6535 */
6536 public Intent setClass(Context packageContext, Class<?> cls) {
6537 mComponent = new ComponentName(packageContext, cls);
6538 return this;
6539 }
6540
6541 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006542 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6543 * used as a hint to the receiver for animations and the like. Null means that there
6544 * is no source bounds.
6545 */
6546 public void setSourceBounds(Rect r) {
6547 if (r != null) {
6548 mSourceBounds = new Rect(r);
6549 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006550 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006551 }
6552 }
6553
Tor Norbyed9273d62013-05-30 15:59:53 -07006554 /** @hide */
6555 @IntDef(flag = true,
6556 value = {
6557 FILL_IN_ACTION,
6558 FILL_IN_DATA,
6559 FILL_IN_CATEGORIES,
6560 FILL_IN_COMPONENT,
6561 FILL_IN_PACKAGE,
6562 FILL_IN_SOURCE_BOUNDS,
6563 FILL_IN_SELECTOR,
6564 FILL_IN_CLIP_DATA
6565 })
6566 @Retention(RetentionPolicy.SOURCE)
6567 public @interface FillInFlags {}
6568
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006569 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006570 * Use with {@link #fillIn} to allow the current action value to be
6571 * overwritten, even if it is already set.
6572 */
6573 public static final int FILL_IN_ACTION = 1<<0;
6574
6575 /**
6576 * Use with {@link #fillIn} to allow the current data or type value
6577 * overwritten, even if it is already set.
6578 */
6579 public static final int FILL_IN_DATA = 1<<1;
6580
6581 /**
6582 * Use with {@link #fillIn} to allow the current categories to be
6583 * overwritten, even if they are already set.
6584 */
6585 public static final int FILL_IN_CATEGORIES = 1<<2;
6586
6587 /**
6588 * Use with {@link #fillIn} to allow the current component value to be
6589 * overwritten, even if it is already set.
6590 */
6591 public static final int FILL_IN_COMPONENT = 1<<3;
6592
6593 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006594 * Use with {@link #fillIn} to allow the current package value to be
6595 * overwritten, even if it is already set.
6596 */
6597 public static final int FILL_IN_PACKAGE = 1<<4;
6598
6599 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006600 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006601 * overwritten, even if it is already set.
6602 */
6603 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6604
6605 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006606 * Use with {@link #fillIn} to allow the current selector to be
6607 * overwritten, even if it is already set.
6608 */
6609 public static final int FILL_IN_SELECTOR = 1<<6;
6610
6611 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006612 * Use with {@link #fillIn} to allow the current ClipData to be
6613 * overwritten, even if it is already set.
6614 */
6615 public static final int FILL_IN_CLIP_DATA = 1<<7;
6616
6617 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006618 * Copy the contents of <var>other</var> in to this object, but only
6619 * where fields are not defined by this object. For purposes of a field
6620 * being defined, the following pieces of data in the Intent are
6621 * considered to be separate fields:
6622 *
6623 * <ul>
6624 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006625 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006626 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6627 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006628 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006629 * <li> component, as set by {@link #setComponent(ComponentName)} or
6630 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006631 * <li> source bounds, as set by {@link #setSourceBounds}.
6632 * <li> selector, as set by {@link #setSelector(Intent)}.
6633 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006634 * <li> each top-level name in the associated extras.
6635 * </ul>
6636 *
6637 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006638 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006639 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6640 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6641 * the restriction where the corresponding field will not be replaced if
6642 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006643 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006644 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6645 * is explicitly specified. The selector will only be copied if
6646 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006647 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006648 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6649 * and Intent B with {action="gotit", data-type="some/thing",
6650 * categories="one","two"}.
6651 *
6652 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6653 * containing: {action="gotit", data-type="some/thing",
6654 * categories="bar"}.
6655 *
6656 * @param other Another Intent whose values are to be used to fill in
6657 * the current one.
6658 * @param flags Options to control which fields can be filled in.
6659 *
6660 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006661 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006662 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6663 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6664 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006665 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006666 @FillInFlags
6667 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006668 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006669 if (other.mAction != null
6670 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006671 mAction = other.mAction;
6672 changes |= FILL_IN_ACTION;
6673 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006674 if ((other.mData != null || other.mType != null)
6675 && ((mData == null && mType == null)
6676 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006677 mData = other.mData;
6678 mType = other.mType;
6679 changes |= FILL_IN_DATA;
6680 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006681 if (other.mCategories != null
6682 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006683 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006684 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006685 }
6686 changes |= FILL_IN_CATEGORIES;
6687 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006688 if (other.mPackage != null
6689 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006690 // Only do this if mSelector is not set.
6691 if (mSelector == null) {
6692 mPackage = other.mPackage;
6693 changes |= FILL_IN_PACKAGE;
6694 }
6695 }
6696 // Selector is special: it can only be set if explicitly allowed,
6697 // for the same reason as the component name.
6698 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6699 if (mPackage == null) {
6700 mSelector = new Intent(other.mSelector);
6701 mPackage = null;
6702 changes |= FILL_IN_SELECTOR;
6703 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006704 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006705 if (other.mClipData != null
6706 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6707 mClipData = other.mClipData;
6708 changes |= FILL_IN_CLIP_DATA;
6709 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006710 // Component is special: it can -only- be set if explicitly allowed,
6711 // since otherwise the sender could force the intent somewhere the
6712 // originator didn't intend.
6713 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006714 mComponent = other.mComponent;
6715 changes |= FILL_IN_COMPONENT;
6716 }
6717 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006718 if (other.mSourceBounds != null
6719 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6720 mSourceBounds = new Rect(other.mSourceBounds);
6721 changes |= FILL_IN_SOURCE_BOUNDS;
6722 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006723 if (mExtras == null) {
6724 if (other.mExtras != null) {
6725 mExtras = new Bundle(other.mExtras);
6726 }
6727 } else if (other.mExtras != null) {
6728 try {
6729 Bundle newb = new Bundle(other.mExtras);
6730 newb.putAll(mExtras);
6731 mExtras = newb;
6732 } catch (RuntimeException e) {
6733 // Modifying the extras can cause us to unparcel the contents
6734 // of the bundle, and if we do this in the system process that
6735 // may fail. We really should handle this (i.e., the Bundle
6736 // impl shouldn't be on top of a plain map), but for now just
6737 // ignore it and keep the original contents. :(
6738 Log.w("Intent", "Failure filling in extras", e);
6739 }
6740 }
6741 return changes;
6742 }
6743
6744 /**
6745 * Wrapper class holding an Intent and implementing comparisons on it for
6746 * the purpose of filtering. The class implements its
6747 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6748 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6749 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6750 * on the wrapped Intent.
6751 */
6752 public static final class FilterComparison {
6753 private final Intent mIntent;
6754 private final int mHashCode;
6755
6756 public FilterComparison(Intent intent) {
6757 mIntent = intent;
6758 mHashCode = intent.filterHashCode();
6759 }
6760
6761 /**
6762 * Return the Intent that this FilterComparison represents.
6763 * @return Returns the Intent held by the FilterComparison. Do
6764 * not modify!
6765 */
6766 public Intent getIntent() {
6767 return mIntent;
6768 }
6769
6770 @Override
6771 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006772 if (obj instanceof FilterComparison) {
6773 Intent other = ((FilterComparison)obj).mIntent;
6774 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006775 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006776 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006777 }
6778
6779 @Override
6780 public int hashCode() {
6781 return mHashCode;
6782 }
6783 }
6784
6785 /**
6786 * Determine if two intents are the same for the purposes of intent
6787 * resolution (filtering). That is, if their action, data, type,
6788 * class, and categories are the same. This does <em>not</em> compare
6789 * any extra data included in the intents.
6790 *
6791 * @param other The other Intent to compare against.
6792 *
6793 * @return Returns true if action, data, type, class, and categories
6794 * are the same.
6795 */
6796 public boolean filterEquals(Intent other) {
6797 if (other == null) {
6798 return false;
6799 }
6800 if (mAction != other.mAction) {
6801 if (mAction != null) {
6802 if (!mAction.equals(other.mAction)) {
6803 return false;
6804 }
6805 } else {
6806 if (!other.mAction.equals(mAction)) {
6807 return false;
6808 }
6809 }
6810 }
6811 if (mData != other.mData) {
6812 if (mData != null) {
6813 if (!mData.equals(other.mData)) {
6814 return false;
6815 }
6816 } else {
6817 if (!other.mData.equals(mData)) {
6818 return false;
6819 }
6820 }
6821 }
6822 if (mType != other.mType) {
6823 if (mType != null) {
6824 if (!mType.equals(other.mType)) {
6825 return false;
6826 }
6827 } else {
6828 if (!other.mType.equals(mType)) {
6829 return false;
6830 }
6831 }
6832 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006833 if (mPackage != other.mPackage) {
6834 if (mPackage != null) {
6835 if (!mPackage.equals(other.mPackage)) {
6836 return false;
6837 }
6838 } else {
6839 if (!other.mPackage.equals(mPackage)) {
6840 return false;
6841 }
6842 }
6843 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006844 if (mComponent != other.mComponent) {
6845 if (mComponent != null) {
6846 if (!mComponent.equals(other.mComponent)) {
6847 return false;
6848 }
6849 } else {
6850 if (!other.mComponent.equals(mComponent)) {
6851 return false;
6852 }
6853 }
6854 }
6855 if (mCategories != other.mCategories) {
6856 if (mCategories != null) {
6857 if (!mCategories.equals(other.mCategories)) {
6858 return false;
6859 }
6860 } else {
6861 if (!other.mCategories.equals(mCategories)) {
6862 return false;
6863 }
6864 }
6865 }
6866
6867 return true;
6868 }
6869
6870 /**
6871 * Generate hash code that matches semantics of filterEquals().
6872 *
6873 * @return Returns the hash value of the action, data, type, class, and
6874 * categories.
6875 *
6876 * @see #filterEquals
6877 */
6878 public int filterHashCode() {
6879 int code = 0;
6880 if (mAction != null) {
6881 code += mAction.hashCode();
6882 }
6883 if (mData != null) {
6884 code += mData.hashCode();
6885 }
6886 if (mType != null) {
6887 code += mType.hashCode();
6888 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006889 if (mPackage != null) {
6890 code += mPackage.hashCode();
6891 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006892 if (mComponent != null) {
6893 code += mComponent.hashCode();
6894 }
6895 if (mCategories != null) {
6896 code += mCategories.hashCode();
6897 }
6898 return code;
6899 }
6900
6901 @Override
6902 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006903 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006904
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006905 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006906 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006907 b.append(" }");
6908
6909 return b.toString();
6910 }
6911
6912 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006913 public String toInsecureString() {
6914 StringBuilder b = new StringBuilder(128);
6915
6916 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006917 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006918 b.append(" }");
6919
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006920 return b.toString();
6921 }
Romain Guy4969af72009-06-17 10:53:19 -07006922
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006923 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006924 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006925 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006926
6927 b.append("Intent { ");
6928 toShortString(b, false, true, true, true);
6929 b.append(" }");
6930
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006931 return b.toString();
6932 }
6933
6934 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006935 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6936 StringBuilder b = new StringBuilder(128);
6937 toShortString(b, secure, comp, extras, clip);
6938 return b.toString();
6939 }
6940
6941 /** @hide */
6942 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6943 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006944 boolean first = true;
6945 if (mAction != null) {
6946 b.append("act=").append(mAction);
6947 first = false;
6948 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006949 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006950 if (!first) {
6951 b.append(' ');
6952 }
6953 first = false;
6954 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006955 for (int i=0; i<mCategories.size(); i++) {
6956 if (i > 0) b.append(',');
6957 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006958 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006959 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006960 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006961 if (mData != null) {
6962 if (!first) {
6963 b.append(' ');
6964 }
6965 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006966 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006967 if (secure) {
6968 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006969 } else {
6970 b.append(mData);
6971 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006972 }
6973 if (mType != null) {
6974 if (!first) {
6975 b.append(' ');
6976 }
6977 first = false;
6978 b.append("typ=").append(mType);
6979 }
6980 if (mFlags != 0) {
6981 if (!first) {
6982 b.append(' ');
6983 }
6984 first = false;
6985 b.append("flg=0x").append(Integer.toHexString(mFlags));
6986 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006987 if (mPackage != null) {
6988 if (!first) {
6989 b.append(' ');
6990 }
6991 first = false;
6992 b.append("pkg=").append(mPackage);
6993 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006994 if (comp && mComponent != null) {
6995 if (!first) {
6996 b.append(' ');
6997 }
6998 first = false;
6999 b.append("cmp=").append(mComponent.flattenToShortString());
7000 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007001 if (mSourceBounds != null) {
7002 if (!first) {
7003 b.append(' ');
7004 }
7005 first = false;
7006 b.append("bnds=").append(mSourceBounds.toShortString());
7007 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007008 if (mClipData != null) {
7009 if (!first) {
7010 b.append(' ');
7011 }
7012 first = false;
7013 if (clip) {
7014 b.append("clip={");
7015 mClipData.toShortString(b);
7016 b.append('}');
7017 } else {
7018 b.append("(has clip)");
7019 }
7020 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007021 if (extras && mExtras != null) {
7022 if (!first) {
7023 b.append(' ');
7024 }
7025 first = false;
7026 b.append("(has extras)");
7027 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007028 if (mSelector != null) {
7029 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007030 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007031 b.append("}");
7032 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007033 }
7034
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007035 /**
7036 * Call {@link #toUri} with 0 flags.
7037 * @deprecated Use {@link #toUri} instead.
7038 */
7039 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007040 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007041 return toUri(0);
7042 }
7043
7044 /**
7045 * Convert this Intent into a String holding a URI representation of it.
7046 * The returned URI string has been properly URI encoded, so it can be
7047 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7048 * Intent's data as the base URI, with an additional fragment describing
7049 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007050 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007051 * <p>You can convert the returned string back to an Intent with
7052 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007053 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007054 * @param flags Additional operating flags. Either 0 or
7055 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007056 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007057 * @return Returns a URI encoding URI string describing the entire contents
7058 * of the Intent.
7059 */
7060 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007061 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007062 String scheme = null;
7063 if (mData != null) {
7064 String data = mData.toString();
7065 if ((flags&URI_INTENT_SCHEME) != 0) {
7066 final int N = data.length();
7067 for (int i=0; i<N; i++) {
7068 char c = data.charAt(i);
7069 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7070 || c == '.' || c == '-') {
7071 continue;
7072 }
7073 if (c == ':' && i > 0) {
7074 // Valid scheme.
7075 scheme = data.substring(0, i);
7076 uri.append("intent:");
7077 data = data.substring(i+1);
7078 break;
7079 }
Tom Taylord4a47292009-12-21 13:59:18 -08007080
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007081 // No scheme.
7082 break;
7083 }
7084 }
7085 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007086
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007087 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7088 uri.append("intent:");
7089 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007090
7091 uri.append("#Intent;");
7092
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007093 toUriInner(uri, scheme, flags);
7094 if (mSelector != null) {
7095 uri.append("SEL;");
7096 // Note that for now we are not going to try to handle the
7097 // data part; not clear how to represent this as a URI, and
7098 // not much utility in it.
7099 mSelector.toUriInner(uri, null, flags);
7100 }
7101
7102 uri.append("end");
7103
7104 return uri.toString();
7105 }
7106
7107 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007108 if (scheme != null) {
7109 uri.append("scheme=").append(scheme).append(';');
7110 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007111 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007112 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007113 }
7114 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007115 for (int i=0; i<mCategories.size(); i++) {
7116 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007117 }
7118 }
7119 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007120 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007121 }
7122 if (mFlags != 0) {
7123 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7124 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007125 if (mPackage != null) {
7126 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7127 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007128 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007129 uri.append("component=").append(Uri.encode(
7130 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007131 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007132 if (mSourceBounds != null) {
7133 uri.append("sourceBounds=")
7134 .append(Uri.encode(mSourceBounds.flattenToString()))
7135 .append(';');
7136 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007137 if (mExtras != null) {
7138 for (String key : mExtras.keySet()) {
7139 final Object value = mExtras.get(key);
7140 char entryType =
7141 value instanceof String ? 'S' :
7142 value instanceof Boolean ? 'B' :
7143 value instanceof Byte ? 'b' :
7144 value instanceof Character ? 'c' :
7145 value instanceof Double ? 'd' :
7146 value instanceof Float ? 'f' :
7147 value instanceof Integer ? 'i' :
7148 value instanceof Long ? 'l' :
7149 value instanceof Short ? 's' :
7150 '\0';
7151
7152 if (entryType != '\0') {
7153 uri.append(entryType);
7154 uri.append('.');
7155 uri.append(Uri.encode(key));
7156 uri.append('=');
7157 uri.append(Uri.encode(value.toString()));
7158 uri.append(';');
7159 }
7160 }
7161 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007162 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007163
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007164 public int describeContents() {
7165 return (mExtras != null) ? mExtras.describeContents() : 0;
7166 }
7167
7168 public void writeToParcel(Parcel out, int flags) {
7169 out.writeString(mAction);
7170 Uri.writeToParcel(out, mData);
7171 out.writeString(mType);
7172 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007173 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007174 ComponentName.writeToParcel(mComponent, out);
7175
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007176 if (mSourceBounds != null) {
7177 out.writeInt(1);
7178 mSourceBounds.writeToParcel(out, flags);
7179 } else {
7180 out.writeInt(0);
7181 }
7182
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007183 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007184 final int N = mCategories.size();
7185 out.writeInt(N);
7186 for (int i=0; i<N; i++) {
7187 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007188 }
7189 } else {
7190 out.writeInt(0);
7191 }
7192
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007193 if (mSelector != null) {
7194 out.writeInt(1);
7195 mSelector.writeToParcel(out, flags);
7196 } else {
7197 out.writeInt(0);
7198 }
7199
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007200 if (mClipData != null) {
7201 out.writeInt(1);
7202 mClipData.writeToParcel(out, flags);
7203 } else {
7204 out.writeInt(0);
7205 }
7206
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007207 out.writeBundle(mExtras);
7208 }
7209
7210 public static final Parcelable.Creator<Intent> CREATOR
7211 = new Parcelable.Creator<Intent>() {
7212 public Intent createFromParcel(Parcel in) {
7213 return new Intent(in);
7214 }
7215 public Intent[] newArray(int size) {
7216 return new Intent[size];
7217 }
7218 };
7219
Dianne Hackborneb034652009-09-07 00:49:58 -07007220 /** @hide */
7221 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007222 readFromParcel(in);
7223 }
7224
7225 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007226 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007227 mData = Uri.CREATOR.createFromParcel(in);
7228 mType = in.readString();
7229 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007230 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007231 mComponent = ComponentName.readFromParcel(in);
7232
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007233 if (in.readInt() != 0) {
7234 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7235 }
7236
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007237 int N = in.readInt();
7238 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007239 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007240 int i;
7241 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007242 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007243 }
7244 } else {
7245 mCategories = null;
7246 }
7247
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007248 if (in.readInt() != 0) {
7249 mSelector = new Intent(in);
7250 }
7251
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007252 if (in.readInt() != 0) {
7253 mClipData = new ClipData(in);
7254 }
7255
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007256 mExtras = in.readBundle();
7257 }
7258
7259 /**
7260 * Parses the "intent" element (and its children) from XML and instantiates
7261 * an Intent object. The given XML parser should be located at the tag
7262 * where parsing should start (often named "intent"), from which the
7263 * basic action, data, type, and package and class name will be
7264 * retrieved. The function will then parse in to any child elements,
7265 * looking for <category android:name="xxx"> tags to add categories and
7266 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7267 * to the intent.
7268 *
7269 * @param resources The Resources to use when inflating resources.
7270 * @param parser The XML parser pointing at an "intent" tag.
7271 * @param attrs The AttributeSet interface for retrieving extended
7272 * attribute data at the current <var>parser</var> location.
7273 * @return An Intent object matching the XML data.
7274 * @throws XmlPullParserException If there was an XML parsing error.
7275 * @throws IOException If there was an I/O error.
7276 */
7277 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7278 throws XmlPullParserException, IOException {
7279 Intent intent = new Intent();
7280
7281 TypedArray sa = resources.obtainAttributes(attrs,
7282 com.android.internal.R.styleable.Intent);
7283
7284 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7285
7286 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7287 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7288 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7289
7290 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7291 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7292 if (packageName != null && className != null) {
7293 intent.setComponent(new ComponentName(packageName, className));
7294 }
7295
7296 sa.recycle();
7297
7298 int outerDepth = parser.getDepth();
7299 int type;
7300 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7301 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7302 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7303 continue;
7304 }
7305
7306 String nodeName = parser.getName();
7307 if (nodeName.equals("category")) {
7308 sa = resources.obtainAttributes(attrs,
7309 com.android.internal.R.styleable.IntentCategory);
7310 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7311 sa.recycle();
7312
7313 if (cat != null) {
7314 intent.addCategory(cat);
7315 }
7316 XmlUtils.skipCurrentTag(parser);
7317
7318 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007319 if (intent.mExtras == null) {
7320 intent.mExtras = new Bundle();
7321 }
7322 resources.parseBundleExtra("extra", attrs, intent.mExtras);
7323 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007324
7325 } else {
7326 XmlUtils.skipCurrentTag(parser);
7327 }
7328 }
7329
7330 return intent;
7331 }
Nick Pellyccae4122012-01-09 14:12:58 -08007332
7333 /**
7334 * Normalize a MIME data type.
7335 *
7336 * <p>A normalized MIME type has white-space trimmed,
7337 * content-type parameters removed, and is lower-case.
7338 * This aligns the type with Android best practices for
7339 * intent filtering.
7340 *
7341 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7342 * "text/x-vCard" becomes "text/x-vcard".
7343 *
7344 * <p>All MIME types received from outside Android (such as user input,
7345 * or external sources like Bluetooth, NFC, or the Internet) should
7346 * be normalized before they are used to create an Intent.
7347 *
7348 * @param type MIME data type to normalize
7349 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007350 * @see #setType
7351 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007352 */
7353 public static String normalizeMimeType(String type) {
7354 if (type == null) {
7355 return null;
7356 }
7357
Elliott Hughescb64d432013-08-02 10:00:44 -07007358 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007359
7360 final int semicolonIndex = type.indexOf(';');
7361 if (semicolonIndex != -1) {
7362 type = type.substring(0, semicolonIndex);
7363 }
7364 return type;
7365 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007366
7367 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007368 * Prepare this {@link Intent} to leave an app process.
7369 *
7370 * @hide
7371 */
7372 public void prepareToLeaveProcess() {
7373 setAllowFds(false);
7374
7375 if (mSelector != null) {
7376 mSelector.prepareToLeaveProcess();
7377 }
7378 if (mClipData != null) {
7379 mClipData.prepareToLeaveProcess();
7380 }
7381
7382 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7383 // There are several ACTION_MEDIA_* broadcasts that send file://
7384 // Uris, so only check common actions.
7385 if (ACTION_VIEW.equals(mAction) ||
7386 ACTION_EDIT.equals(mAction) ||
7387 ACTION_ATTACH_DATA.equals(mAction)) {
7388 mData.checkFileUriExposed("Intent.getData()");
7389 }
7390 }
7391 }
7392
7393 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007394 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007395 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7396 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007397 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007398 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007399 * @hide
7400 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007401 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007402 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007403 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007404
7405 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007406 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007407
7408 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007409 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007410 try {
7411 // Inspect target intent to see if we need to migrate
7412 final Intent target = getParcelableExtra(EXTRA_INTENT);
7413 if (target != null && target.migrateExtraStreamToClipData()) {
7414 // Since we migrated in child, we need to promote ClipData
7415 // and flags to ourselves to grant.
7416 setClipData(target.getClipData());
Jeff Sharkey846318a2014-04-04 12:12:41 -07007417 addFlags(target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
7418 | FLAG_GRANT_WRITE_URI_PERMISSION
7419 | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7420 | FLAG_GRANT_PREFIX_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007421 return true;
7422 } else {
7423 return false;
7424 }
7425 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007426 }
7427
7428 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007429 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007430 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7431 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7432 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7433 if (stream != null || text != null || htmlText != null) {
7434 final ClipData clipData = new ClipData(
7435 null, new String[] { getType() },
7436 new ClipData.Item(text, htmlText, null, stream));
7437 setClipData(clipData);
7438 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007439 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007440 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007441 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007442 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007443
7444 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007445 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007446 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7447 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7448 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7449 int num = -1;
7450 if (streams != null) {
7451 num = streams.size();
7452 }
7453 if (texts != null) {
7454 if (num >= 0 && num != texts.size()) {
7455 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007456 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007457 }
7458 num = texts.size();
7459 }
7460 if (htmlTexts != null) {
7461 if (num >= 0 && num != htmlTexts.size()) {
7462 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007463 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007464 }
7465 num = htmlTexts.size();
7466 }
7467 if (num > 0) {
7468 final ClipData clipData = new ClipData(
7469 null, new String[] { getType() },
7470 makeClipItem(streams, texts, htmlTexts, 0));
7471
7472 for (int i = 1; i < num; i++) {
7473 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7474 }
7475
7476 setClipData(clipData);
7477 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007478 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007479 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007480 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007481 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007482 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007483
7484 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007485 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007486
7487 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7488 ArrayList<String> htmlTexts, int which) {
7489 Uri uri = streams != null ? streams.get(which) : null;
7490 CharSequence text = texts != null ? texts.get(which) : null;
7491 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7492 return new ClipData.Item(text, htmlText, null, uri);
7493 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007494
7495 /** @hide */
7496 public boolean isDocument() {
7497 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7498 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007499}