blob: 4b5ec48d6d9bb83c8505d73207eb4118fc27a5f3 [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;
Nicolas Prevotd85fc722014-04-16 19:52:08 +010029import static android.content.ContentProvider.maybeAddUserId;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.content.pm.PackageManager;
31import android.content.pm.ResolveInfo;
32import android.content.res.Resources;
33import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080034import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070035import android.net.Uri;
36import android.os.Bundle;
37import android.os.IBinder;
38import android.os.Parcel;
39import android.os.Parcelable;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070040import android.os.StrictMode;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070041import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070042import android.provider.DocumentsProvider;
43import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070044import android.util.AttributeSet;
45import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080046
47import com.android.internal.util.XmlUtils;
Craig Mautner21d24a22014-04-23 11:45:37 -070048import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070049
50import java.io.IOException;
51import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070052import java.lang.annotation.Retention;
53import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054import java.net.URISyntaxException;
55import java.util.ArrayList;
Dianne Hackborn221ea892013-08-04 16:50:16 -070056import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080057import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070058import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070059import java.util.Set;
60
61/**
62 * An intent is an abstract description of an operation to be performed. It
63 * can be used with {@link Context#startActivity(Intent) startActivity} to
64 * launch an {@link android.app.Activity},
65 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
66 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
67 * and {@link android.content.Context#startService} or
68 * {@link android.content.Context#bindService} to communicate with a
69 * background {@link android.app.Service}.
70 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070071 * <p>An Intent provides a facility for performing late runtime binding between the code in
72 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070073 * can be thought of as the glue between activities. It is basically a passive data structure
74 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070075 *
76 * <div class="special reference">
77 * <h3>Developer Guides</h3>
78 * <p>For information about how to create and resolve intents, read the
79 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
80 * developer guide.</p>
81 * </div>
82 *
83 * <a name="IntentStructure"></a>
84 * <h3>Intent Structure</h3>
85 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070086 *
87 * <ul>
88 * <li> <p><b>action</b> -- The general action to be performed, such as
89 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
90 * etc.</p>
91 * </li>
92 * <li> <p><b>data</b> -- The data to operate on, such as a person record
93 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
94 * </li>
95 * </ul>
96 *
97 *
98 * <p>Some examples of action/data pairs are:</p>
99 *
100 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700101 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700102 * information about the person whose identifier is "1".</p>
103 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700104 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700105 * the phone dialer with the person filled in.</p>
106 * </li>
107 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
108 * the phone dialer with the given number filled in. Note how the
109 * VIEW action does what what is considered the most reasonable thing for
110 * a particular URI.</p>
111 * </li>
112 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
113 * the phone dialer with the given number filled in.</p>
114 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700115 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700116 * information about the person whose identifier is "1".</p>
117 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700118 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700119 * a list of people, which the user can browse through. This example is a
120 * typical top-level entry into the Contacts application, showing you the
121 * list of people. Selecting a particular person to view would result in a
122 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
123 * being used to start an activity to display that person.</p>
124 * </li>
125 * </ul>
126 *
127 * <p>In addition to these primary attributes, there are a number of secondary
128 * attributes that you can also include with an intent:</p>
129 *
130 * <ul>
131 * <li> <p><b>category</b> -- Gives additional information about the action
132 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
133 * appear in the Launcher as a top-level application, while
134 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
135 * of alternative actions the user can perform on a piece of data.</p>
136 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
137 * intent data. Normally the type is inferred from the data itself.
138 * By setting this attribute, you disable that evaluation and force
139 * an explicit type.</p>
140 * <li> <p><b>component</b> -- Specifies an explicit name of a component
141 * class to use for the intent. Normally this is determined by looking
142 * at the other information in the intent (the action, data/type, and
143 * categories) and matching that with a component that can handle it.
144 * If this attribute is set then none of the evaluation is performed,
145 * and this component is used exactly as is. By specifying this attribute,
146 * all of the other Intent attributes become optional.</p>
147 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
148 * This can be used to provide extended information to the component.
149 * For example, if we have a action to send an e-mail message, we could
150 * also include extra pieces of data here to supply a subject, body,
151 * etc.</p>
152 * </ul>
153 *
154 * <p>Here are some examples of other operations you can specify as intents
155 * using these additional parameters:</p>
156 *
157 * <ul>
158 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
159 * Launch the home screen.</p>
160 * </li>
161 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
162 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
163 * vnd.android.cursor.item/phone}</i></b>
164 * -- Display the list of people's phone numbers, allowing the user to
165 * browse through them and pick one and return it to the parent activity.</p>
166 * </li>
167 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
168 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
169 * -- Display all pickers for data that can be opened with
170 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
171 * allowing the user to pick one of them and then some data inside of it
172 * and returning the resulting URI to the caller. This can be used,
173 * for example, in an e-mail application to allow the user to pick some
174 * data to include as an attachment.</p>
175 * </li>
176 * </ul>
177 *
178 * <p>There are a variety of standard Intent action and category constants
179 * defined in the Intent class, but applications can also define their own.
180 * These strings use java style scoping, to ensure they are unique -- for
181 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700182 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700183 *
184 * <p>Put together, the set of actions, data types, categories, and extra data
185 * defines a language for the system allowing for the expression of phrases
186 * such as "call john smith's cell". As applications are added to the system,
187 * they can extend this language by adding new actions, types, and categories, or
188 * they can modify the behavior of existing phrases by supplying their own
189 * activities that handle them.</p>
190 *
191 * <a name="IntentResolution"></a>
192 * <h3>Intent Resolution</h3>
193 *
194 * <p>There are two primary forms of intents you will use.
195 *
196 * <ul>
197 * <li> <p><b>Explicit Intents</b> have specified a component (via
198 * {@link #setComponent} or {@link #setClass}), which provides the exact
199 * class to be run. Often these will not include any other information,
200 * simply being a way for an application to launch various internal
201 * activities it has as the user interacts with the application.
202 *
203 * <li> <p><b>Implicit Intents</b> have not specified a component;
204 * instead, they must include enough information for the system to
205 * determine which of the available components is best to run for that
206 * intent.
207 * </ul>
208 *
209 * <p>When using implicit intents, given such an arbitrary intent we need to
210 * know what to do with it. This is handled by the process of <em>Intent
211 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
212 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
213 * more activities/receivers) that can handle it.</p>
214 *
215 * <p>The intent resolution mechanism basically revolves around matching an
216 * Intent against all of the &lt;intent-filter&gt; descriptions in the
217 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
218 * objects explicitly registered with {@link Context#registerReceiver}.) More
219 * details on this can be found in the documentation on the {@link
220 * IntentFilter} class.</p>
221 *
222 * <p>There are three pieces of information in the Intent that are used for
223 * resolution: the action, type, and category. Using this information, a query
224 * is done on the {@link PackageManager} for a component that can handle the
225 * intent. The appropriate component is determined based on the intent
226 * information supplied in the <code>AndroidManifest.xml</code> file as
227 * follows:</p>
228 *
229 * <ul>
230 * <li> <p>The <b>action</b>, if given, must be listed by the component as
231 * one it handles.</p>
232 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
233 * already supplied in the Intent. Like the action, if a type is
234 * included in the intent (either explicitly or implicitly in its
235 * data), then this must be listed by the component as one it handles.</p>
236 * <li> For data that is not a <code>content:</code> URI and where no explicit
237 * type is included in the Intent, instead the <b>scheme</b> of the
238 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
239 * considered. Again like the action, if we are matching a scheme it
240 * must be listed by the component as one it can handle.
241 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
242 * by the activity as categories it handles. That is, if you include
243 * the categories {@link #CATEGORY_LAUNCHER} and
244 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
245 * with an intent that lists <em>both</em> of those categories.
246 * Activities will very often need to support the
247 * {@link #CATEGORY_DEFAULT} so that they can be found by
248 * {@link Context#startActivity Context.startActivity()}.</p>
249 * </ul>
250 *
251 * <p>For example, consider the Note Pad sample application that
252 * allows user to browse through a list of notes data and view details about
253 * individual items. Text in italics indicate places were you would replace a
254 * name with one specific to your own package.</p>
255 *
256 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
257 * package="<i>com.android.notepad</i>"&gt;
258 * &lt;application android:icon="@drawable/app_notes"
259 * android:label="@string/app_name"&gt;
260 *
261 * &lt;provider class=".NotePadProvider"
262 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
263 *
264 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
265 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700266 * &lt;action android:name="android.intent.action.MAIN" /&gt;
267 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700268 * &lt;/intent-filter&gt;
269 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700270 * &lt;action android:name="android.intent.action.VIEW" /&gt;
271 * &lt;action android:name="android.intent.action.EDIT" /&gt;
272 * &lt;action android:name="android.intent.action.PICK" /&gt;
273 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
274 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700275 * &lt;/intent-filter&gt;
276 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700277 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
278 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
279 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700280 * &lt;/intent-filter&gt;
281 * &lt;/activity&gt;
282 *
283 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
284 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700285 * &lt;action android:name="android.intent.action.VIEW" /&gt;
286 * &lt;action android:name="android.intent.action.EDIT" /&gt;
287 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
288 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700289 * &lt;/intent-filter&gt;
290 *
291 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700292 * &lt;action android:name="android.intent.action.INSERT" /&gt;
293 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 *
297 * &lt;/activity&gt;
298 *
299 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
300 * android:theme="@android:style/Theme.Dialog"&gt;
301 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700302 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
303 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
304 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
305 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
306 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700307 * &lt;/intent-filter&gt;
308 * &lt;/activity&gt;
309 *
310 * &lt;/application&gt;
311 * &lt;/manifest&gt;</pre>
312 *
313 * <p>The first activity,
314 * <code>com.android.notepad.NotesList</code>, serves as our main
315 * entry into the app. It can do three things as described by its three intent
316 * templates:
317 * <ol>
318 * <li><pre>
319 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700320 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
321 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700322 * &lt;/intent-filter&gt;</pre>
323 * <p>This provides a top-level entry into the NotePad application: the standard
324 * MAIN action is a main entry point (not requiring any other information in
325 * the Intent), and the LAUNCHER category says that this entry point should be
326 * listed in the application launcher.</p>
327 * <li><pre>
328 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700329 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
330 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
331 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
332 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
333 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700334 * &lt;/intent-filter&gt;</pre>
335 * <p>This declares the things that the activity can do on a directory of
336 * notes. The type being supported is given with the &lt;type&gt; tag, where
337 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
338 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
339 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
340 * The activity allows the user to view or edit the directory of data (via
341 * the VIEW and EDIT actions), or to pick a particular note and return it
342 * to the caller (via the PICK action). Note also the DEFAULT category
343 * supplied here: this is <em>required</em> for the
344 * {@link Context#startActivity Context.startActivity} method to resolve your
345 * activity when its component name is not explicitly specified.</p>
346 * <li><pre>
347 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700348 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
349 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
350 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700351 * &lt;/intent-filter&gt;</pre>
352 * <p>This filter describes the ability return to the caller a note selected by
353 * the user without needing to know where it came from. The data type
354 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
355 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
356 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
357 * The GET_CONTENT action is similar to the PICK action, where the activity
358 * will return to its caller a piece of data selected by the user. Here,
359 * however, the caller specifies the type of data they desire instead of
360 * the type of data the user will be picking from.</p>
361 * </ol>
362 *
363 * <p>Given these capabilities, the following intents will resolve to the
364 * NotesList activity:</p>
365 *
366 * <ul>
367 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
368 * activities that can be used as top-level entry points into an
369 * application.</p>
370 * <li> <p><b>{ action=android.app.action.MAIN,
371 * category=android.app.category.LAUNCHER }</b> is the actual intent
372 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700373 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700374 * data=content://com.google.provider.NotePad/notes }</b>
375 * displays a list of all the notes under
376 * "content://com.google.provider.NotePad/notes", which
377 * the user can browse through and see the details on.</p>
378 * <li> <p><b>{ action=android.app.action.PICK
379 * data=content://com.google.provider.NotePad/notes }</b>
380 * provides a list of the notes under
381 * "content://com.google.provider.NotePad/notes", from which
382 * the user can pick a note whose data URL is returned back to the caller.</p>
383 * <li> <p><b>{ action=android.app.action.GET_CONTENT
384 * type=vnd.android.cursor.item/vnd.google.note }</b>
385 * is similar to the pick action, but allows the caller to specify the
386 * kind of data they want back so that the system can find the appropriate
387 * activity to pick something of that data type.</p>
388 * </ul>
389 *
390 * <p>The second activity,
391 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
392 * note entry and allows them to edit it. It can do two things as described
393 * by its two intent templates:
394 * <ol>
395 * <li><pre>
396 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700397 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
398 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
399 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
400 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700401 * &lt;/intent-filter&gt;</pre>
402 * <p>The first, primary, purpose of this activity is to let the user interact
403 * with a single note, as decribed by the MIME type
404 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
405 * either VIEW a note or allow the user to EDIT it. Again we support the
406 * DEFAULT category to allow the activity to be launched without explicitly
407 * specifying its component.</p>
408 * <li><pre>
409 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700410 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
411 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
412 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700413 * &lt;/intent-filter&gt;</pre>
414 * <p>The secondary use of this activity is to insert a new note entry into
415 * an existing directory of notes. This is used when the user creates a new
416 * note: the INSERT action is executed on the directory of notes, causing
417 * this activity to run and have the user create the new note data which
418 * it then adds to the content provider.</p>
419 * </ol>
420 *
421 * <p>Given these capabilities, the following intents will resolve to the
422 * NoteEditor activity:</p>
423 *
424 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700425 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700426 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
427 * shows the user the content of note <var>{ID}</var>.</p>
428 * <li> <p><b>{ action=android.app.action.EDIT
429 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
430 * allows the user to edit the content of note <var>{ID}</var>.</p>
431 * <li> <p><b>{ action=android.app.action.INSERT
432 * data=content://com.google.provider.NotePad/notes }</b>
433 * creates a new, empty note in the notes list at
434 * "content://com.google.provider.NotePad/notes"
435 * and allows the user to edit it. If they keep their changes, the URI
436 * of the newly created note is returned to the caller.</p>
437 * </ul>
438 *
439 * <p>The last activity,
440 * <code>com.android.notepad.TitleEditor</code>, allows the user to
441 * edit the title of a note. This could be implemented as a class that the
442 * application directly invokes (by explicitly setting its component in
443 * the Intent), but here we show a way you can publish alternative
444 * operations on existing data:</p>
445 *
446 * <pre>
447 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700448 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
449 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
450 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
451 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
452 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700453 * &lt;/intent-filter&gt;</pre>
454 *
455 * <p>In the single intent template here, we
456 * have created our own private action called
457 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
458 * edit the title of a note. It must be invoked on a specific note
459 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
460 * view and edit actions, but here displays and edits the title contained
461 * in the note data.
462 *
463 * <p>In addition to supporting the default category as usual, our title editor
464 * also supports two other standard categories: ALTERNATIVE and
465 * SELECTED_ALTERNATIVE. Implementing
466 * these categories allows others to find the special action it provides
467 * without directly knowing about it, through the
468 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
469 * more often to build dynamic menu items with
470 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
471 * template here was also supply an explicit name for the template
472 * (via <code>android:label="@string/resolve_title"</code>) to better control
473 * what the user sees when presented with this activity as an alternative
474 * action to the data they are viewing.
475 *
476 * <p>Given these capabilities, the following intent will resolve to the
477 * TitleEditor activity:</p>
478 *
479 * <ul>
480 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
481 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
482 * displays and allows the user to edit the title associated
483 * with note <var>{ID}</var>.</p>
484 * </ul>
485 *
486 * <h3>Standard Activity Actions</h3>
487 *
488 * <p>These are the current standard actions that Intent defines for launching
489 * activities (usually through {@link Context#startActivity}. The most
490 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
491 * {@link #ACTION_EDIT}.
492 *
493 * <ul>
494 * <li> {@link #ACTION_MAIN}
495 * <li> {@link #ACTION_VIEW}
496 * <li> {@link #ACTION_ATTACH_DATA}
497 * <li> {@link #ACTION_EDIT}
498 * <li> {@link #ACTION_PICK}
499 * <li> {@link #ACTION_CHOOSER}
500 * <li> {@link #ACTION_GET_CONTENT}
501 * <li> {@link #ACTION_DIAL}
502 * <li> {@link #ACTION_CALL}
503 * <li> {@link #ACTION_SEND}
504 * <li> {@link #ACTION_SENDTO}
505 * <li> {@link #ACTION_ANSWER}
506 * <li> {@link #ACTION_INSERT}
507 * <li> {@link #ACTION_DELETE}
508 * <li> {@link #ACTION_RUN}
509 * <li> {@link #ACTION_SYNC}
510 * <li> {@link #ACTION_PICK_ACTIVITY}
511 * <li> {@link #ACTION_SEARCH}
512 * <li> {@link #ACTION_WEB_SEARCH}
513 * <li> {@link #ACTION_FACTORY_TEST}
514 * </ul>
515 *
516 * <h3>Standard Broadcast Actions</h3>
517 *
518 * <p>These are the current standard actions that Intent defines for receiving
519 * broadcasts (usually through {@link Context#registerReceiver} or a
520 * &lt;receiver&gt; tag in a manifest).
521 *
522 * <ul>
523 * <li> {@link #ACTION_TIME_TICK}
524 * <li> {@link #ACTION_TIME_CHANGED}
525 * <li> {@link #ACTION_TIMEZONE_CHANGED}
526 * <li> {@link #ACTION_BOOT_COMPLETED}
527 * <li> {@link #ACTION_PACKAGE_ADDED}
528 * <li> {@link #ACTION_PACKAGE_CHANGED}
529 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800530 * <li> {@link #ACTION_PACKAGE_RESTARTED}
531 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700532 * <li> {@link #ACTION_UID_REMOVED}
533 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700534 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700535 * <li> {@link #ACTION_POWER_DISCONNECTED}
536 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700537 * </ul>
538 *
539 * <h3>Standard Categories</h3>
540 *
541 * <p>These are the current standard categories that can be used to further
542 * clarify an Intent via {@link #addCategory}.
543 *
544 * <ul>
545 * <li> {@link #CATEGORY_DEFAULT}
546 * <li> {@link #CATEGORY_BROWSABLE}
547 * <li> {@link #CATEGORY_TAB}
548 * <li> {@link #CATEGORY_ALTERNATIVE}
549 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
550 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800551 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700552 * <li> {@link #CATEGORY_HOME}
553 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700554 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400555 * <li> {@link #CATEGORY_CAR_DOCK}
556 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500557 * <li> {@link #CATEGORY_LE_DESK_DOCK}
558 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200559 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700560 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700561 * </ul>
562 *
563 * <h3>Standard Extra Data</h3>
564 *
565 * <p>These are the current standard fields that can be used as extra data via
566 * {@link #putExtra}.
567 *
568 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800569 * <li> {@link #EXTRA_ALARM_COUNT}
570 * <li> {@link #EXTRA_BCC}
571 * <li> {@link #EXTRA_CC}
572 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
573 * <li> {@link #EXTRA_DATA_REMOVED}
574 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500575 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
576 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800577 * <li> {@link #EXTRA_DOCK_STATE_CAR}
578 * <li> {@link #EXTRA_DOCK_STATE_DESK}
579 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
580 * <li> {@link #EXTRA_DONT_KILL_APP}
581 * <li> {@link #EXTRA_EMAIL}
582 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700583 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800584 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700585 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800586 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700587 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800588 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
589 * <li> {@link #EXTRA_REPLACING}
590 * <li> {@link #EXTRA_SHORTCUT_ICON}
591 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
592 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700593 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800594 * <li> {@link #EXTRA_SHORTCUT_NAME}
595 * <li> {@link #EXTRA_SUBJECT}
596 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700597 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800598 * <li> {@link #EXTRA_TITLE}
599 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700600 * </ul>
601 *
602 * <h3>Flags</h3>
603 *
604 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800605 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
606 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700607 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800608public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700609 private static final String ATTR_ACTION = "action";
610 private static final String TAG_CATEGORIES = "categories";
611 private static final String ATTR_CATEGORY = "category";
612 private static final String TAG_EXTRA = "extra";
613 private static final String ATTR_TYPE = "type";
614 private static final String ATTR_COMPONENT = "component";
615 private static final String ATTR_DATA = "data";
616 private static final String ATTR_FLAGS = "flags";
617
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 // ---------------------------------------------------------------------
619 // ---------------------------------------------------------------------
620 // Standard intent activity actions (see action variable).
621
622 /**
623 * Activity Action: Start as a main entry point, does not expect to
624 * receive data.
625 * <p>Input: nothing
626 * <p>Output: nothing
627 */
628 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
629 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800630
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700631 /**
632 * Activity Action: Display the data to the user. This is the most common
633 * action performed on data -- it is the generic action you can use on
634 * a piece of data to get the most reasonable thing to occur. For example,
635 * when used on a contacts entry it will view the entry; when used on a
636 * mailto: URI it will bring up a compose window filled with the information
637 * supplied by the URI; when used with a tel: URI it will invoke the
638 * dialer.
639 * <p>Input: {@link #getData} is URI from which to retrieve data.
640 * <p>Output: nothing.
641 */
642 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
643 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800644
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700645 /**
646 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
647 * performed on a piece of data.
648 */
649 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800650
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700651 /**
652 * Used to indicate that some piece of data should be attached to some other
653 * place. For example, image data could be attached to a contact. It is up
654 * to the recipient to decide where the data should be attached; the intent
655 * does not specify the ultimate destination.
656 * <p>Input: {@link #getData} is URI of data to be attached.
657 * <p>Output: nothing.
658 */
659 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
660 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800661
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700662 /**
663 * Activity Action: Provide explicit editable access to the given data.
664 * <p>Input: {@link #getData} is URI of data to be edited.
665 * <p>Output: nothing.
666 */
667 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
668 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800669
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700670 /**
671 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
672 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
673 * The extras can contain type specific data to pass through to the editing/creating
674 * activity.
675 * <p>Output: The URI of the item that was picked. This must be a content:
676 * URI so that any receiver can access it.
677 */
678 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
679 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800680
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700681 /**
682 * Activity Action: Pick an item from the data, returning what was selected.
683 * <p>Input: {@link #getData} is URI containing a directory of data
684 * (vnd.android.cursor.dir/*) from which to pick an item.
685 * <p>Output: The URI of the item that was picked.
686 */
687 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
688 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800689
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700690 /**
691 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800692 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700693 * <p>Output: An Intent representing the shortcut. The intent must contain three
694 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
695 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800696 * (value: ShortcutIconResource).</p>
697 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700698 * @see #EXTRA_SHORTCUT_INTENT
699 * @see #EXTRA_SHORTCUT_NAME
700 * @see #EXTRA_SHORTCUT_ICON
701 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
702 * @see android.content.Intent.ShortcutIconResource
703 */
704 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
705 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
706
707 /**
708 * The name of the extra used to define the Intent of a shortcut.
709 *
710 * @see #ACTION_CREATE_SHORTCUT
711 */
712 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
713 /**
714 * The name of the extra used to define the name of a shortcut.
715 *
716 * @see #ACTION_CREATE_SHORTCUT
717 */
718 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
719 /**
720 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
721 *
722 * @see #ACTION_CREATE_SHORTCUT
723 */
724 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
725 /**
726 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
727 *
728 * @see #ACTION_CREATE_SHORTCUT
729 * @see android.content.Intent.ShortcutIconResource
730 */
731 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
732 "android.intent.extra.shortcut.ICON_RESOURCE";
733
734 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800735 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700736 *
737 * @see Intent#ACTION_CREATE_SHORTCUT
738 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800739 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
740 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700741 */
742 public static class ShortcutIconResource implements Parcelable {
743 /**
744 * The package name of the application containing the icon.
745 */
746 public String packageName;
747
748 /**
749 * The resource name of the icon, including package, name and type.
750 */
751 public String resourceName;
752
753 /**
754 * Creates a new ShortcutIconResource for the specified context and resource
755 * identifier.
756 *
757 * @param context The context of the application.
758 * @param resourceId The resource idenfitier for the icon.
759 * @return A new ShortcutIconResource with the specified's context package name
760 * and icon resource idenfitier.
761 */
762 public static ShortcutIconResource fromContext(Context context, int resourceId) {
763 ShortcutIconResource icon = new ShortcutIconResource();
764 icon.packageName = context.getPackageName();
765 icon.resourceName = context.getResources().getResourceName(resourceId);
766 return icon;
767 }
768
769 /**
770 * Used to read a ShortcutIconResource from a Parcel.
771 */
772 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
773 new Parcelable.Creator<ShortcutIconResource>() {
774
775 public ShortcutIconResource createFromParcel(Parcel source) {
776 ShortcutIconResource icon = new ShortcutIconResource();
777 icon.packageName = source.readString();
778 icon.resourceName = source.readString();
779 return icon;
780 }
781
782 public ShortcutIconResource[] newArray(int size) {
783 return new ShortcutIconResource[size];
784 }
785 };
786
787 /**
788 * No special parcel contents.
789 */
790 public int describeContents() {
791 return 0;
792 }
793
794 public void writeToParcel(Parcel dest, int flags) {
795 dest.writeString(packageName);
796 dest.writeString(resourceName);
797 }
798
799 @Override
800 public String toString() {
801 return resourceName;
802 }
803 }
804
805 /**
806 * Activity Action: Display an activity chooser, allowing the user to pick
807 * what they want to before proceeding. This can be used as an alternative
808 * to the standard activity picker that is displayed by the system when
809 * you try to start an activity with multiple possible matches, with these
810 * differences in behavior:
811 * <ul>
812 * <li>You can specify the title that will appear in the activity chooser.
813 * <li>The user does not have the option to make one of the matching
814 * activities a preferred activity, and all possible activities will
815 * always be shown even if one of them is currently marked as the
816 * preferred activity.
817 * </ul>
818 * <p>
819 * This action should be used when the user will naturally expect to
820 * select an activity in order to proceed. An example if when not to use
821 * it is when the user clicks on a "mailto:" link. They would naturally
822 * expect to go directly to their mail app, so startActivity() should be
823 * called directly: it will
824 * either launch the current preferred app, or put up a dialog allowing the
825 * user to pick an app to use and optionally marking that as preferred.
826 * <p>
827 * In contrast, if the user is selecting a menu item to send a picture
828 * they are viewing to someone else, there are many different things they
829 * may want to do at this point: send it through e-mail, upload it to a
830 * web service, etc. In this case the CHOOSER action should be used, to
831 * always present to the user a list of the things they can do, with a
832 * nice title given by the caller such as "Send this photo with:".
833 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700834 * If you need to grant URI permissions through a chooser, you must specify
835 * the permissions to be granted on the ACTION_CHOOSER Intent
836 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
837 * {@link #setClipData} to specify the URIs to be granted as well as
838 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
839 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
840 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700841 * As a convenience, an Intent of this form can be created with the
842 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700843 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700844 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700845 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
846 * and can optionally have a {@link #EXTRA_TITLE} field containing the
847 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700848 * <p>
849 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700850 */
851 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
852 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
853
854 /**
855 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
856 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700857 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
858 * target intent, also optionally supplying a title. If the target
859 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
860 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
861 * set in the returned chooser intent, with its ClipData set appropriately:
862 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500863 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700864 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700865 * @param target The Intent that the user will be selecting an activity
866 * to perform.
867 * @param title Optional title that will be displayed in the chooser.
868 * @return Return a new Intent object that you can hand to
869 * {@link Context#startActivity(Intent) Context.startActivity()} and
870 * related methods.
871 */
872 public static Intent createChooser(Intent target, CharSequence title) {
873 Intent intent = new Intent(ACTION_CHOOSER);
874 intent.putExtra(EXTRA_INTENT, target);
875 if (title != null) {
876 intent.putExtra(EXTRA_TITLE, title);
877 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700878
879 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700880 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
881 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
882 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700883 if (permFlags != 0) {
884 ClipData targetClipData = target.getClipData();
885 if (targetClipData == null && target.getData() != null) {
886 ClipData.Item item = new ClipData.Item(target.getData());
887 String[] mimeTypes;
888 if (target.getType() != null) {
889 mimeTypes = new String[] { target.getType() };
890 } else {
891 mimeTypes = new String[] { };
892 }
893 targetClipData = new ClipData(null, mimeTypes, item);
894 }
895 if (targetClipData != null) {
896 intent.setClipData(targetClipData);
897 intent.addFlags(permFlags);
898 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700899 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700900
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700901 return intent;
902 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700903
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700904 /**
905 * Activity Action: Allow the user to select a particular kind of data and
906 * return it. This is different than {@link #ACTION_PICK} in that here we
907 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800908 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700909 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900910 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700911 * etc.
912 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900913 * 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 -0700914 * of data, such as a person contact, you set the MIME type to the kind of
915 * data you want and launch it with {@link Context#startActivity(Intent)}.
916 * The system will then launch the best application to select that kind
917 * of data for you.
918 * <p>
919 * You may also be interested in any of a set of types of content the user
920 * can pick. For example, an e-mail application that wants to allow the
921 * user to add an attachment to an e-mail message can use this action to
922 * bring up a list of all of the types of content the user can attach.
923 * <p>
924 * In this case, you should wrap the GET_CONTENT intent with a chooser
925 * (through {@link #createChooser}), which will give the proper interface
926 * for the user to pick how to send your data and allow you to specify
927 * a prompt indicating what they are doing. You will usually specify a
928 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
929 * broad range of content types the user can select from.
930 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900931 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700932 * only pick from data that can be represented as a stream. This is
933 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
934 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800935 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900936 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800937 * is locally available on the device. For example, if this extra is set
938 * to true then an image picker should not show any pictures that are available
939 * from a remote server but not already on the local device (thus requiring
940 * they be downloaded when opened).
941 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800942 * If the caller can handle multiple returned items (the user performing
943 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
944 * to indicate this.
945 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700946 * Input: {@link #getType} is the desired MIME type to retrieve. Note
947 * that no URI is supplied in the intent, as there are no constraints on
948 * where the returned data originally comes from. You may also include the
949 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800950 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800951 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
952 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700953 * <p>
954 * Output: The URI of the item that was picked. This must be a content:
955 * URI so that any receiver can access it.
956 */
957 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
958 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
959 /**
960 * Activity Action: Dial a number as specified by the data. This shows a
961 * UI with the number being dialed, allowing the user to explicitly
962 * initiate the call.
963 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
964 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
965 * number.
966 * <p>Output: nothing.
967 */
968 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
969 public static final String ACTION_DIAL = "android.intent.action.DIAL";
970 /**
971 * Activity Action: Perform a call to someone specified by the data.
972 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
973 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
974 * number.
975 * <p>Output: nothing.
976 *
977 * <p>Note: there will be restrictions on which applications can initiate a
978 * call; most applications should use the {@link #ACTION_DIAL}.
979 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
980 * numbers. Applications can <strong>dial</strong> emergency numbers using
981 * {@link #ACTION_DIAL}, however.
982 */
983 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
984 public static final String ACTION_CALL = "android.intent.action.CALL";
985 /**
986 * Activity Action: Perform a call to an emergency number specified by the
987 * data.
988 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
989 * tel: URI of an explicit phone number.
990 * <p>Output: nothing.
991 * @hide
992 */
993 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
994 /**
995 * Activity action: Perform a call to any number (emergency or not)
996 * specified by the data.
997 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
998 * tel: URI of an explicit phone number.
999 * <p>Output: nothing.
1000 * @hide
1001 */
1002 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1003 /**
1004 * Activity Action: Send a message to someone specified by the data.
1005 * <p>Input: {@link #getData} is URI describing the target.
1006 * <p>Output: nothing.
1007 */
1008 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1009 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1010 /**
1011 * Activity Action: Deliver some data to someone else. Who the data is
1012 * being delivered to is not specified; it is up to the receiver of this
1013 * action to ask the user where the data should be sent.
1014 * <p>
1015 * When launching a SEND intent, you should usually wrap it in a chooser
1016 * (through {@link #createChooser}), which will give the proper interface
1017 * for the user to pick how to send your data and allow you to specify
1018 * a prompt indicating what they are doing.
1019 * <p>
1020 * Input: {@link #getType} is the MIME type of the data being sent.
1021 * get*Extra can have either a {@link #EXTRA_TEXT}
1022 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1023 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1024 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1025 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001026 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1027 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1028 * your text with HTML formatting.
1029 * <p>
1030 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1031 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1032 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1033 * content: URIs and other advanced features of {@link ClipData}. If
1034 * using this approach, you still must supply the same data through the
1035 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1036 * for compatibility with old applications. If you don't set a ClipData,
1037 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001038 * <p>
1039 * Optional standard extras, which may be interpreted by some recipients as
1040 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1041 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1042 * <p>
1043 * Output: nothing.
1044 */
1045 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1046 public static final String ACTION_SEND = "android.intent.action.SEND";
1047 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001048 * Activity Action: Deliver multiple data to someone else.
1049 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001050 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001051 * <p>
1052 * Input: {@link #getType} is the MIME type of the data being sent.
1053 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001054 * #EXTRA_STREAM} field, containing the data to be sent. If using
1055 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1056 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001057 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001058 * Multiple types are supported, and receivers should handle mixed types
1059 * whenever possible. The right way for the receiver to check them is to
1060 * use the content resolver on each URI. The intent sender should try to
1061 * put the most concrete mime type in the intent type, but it can fall
1062 * back to {@literal <type>/*} or {@literal *}/* as needed.
1063 * <p>
1064 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1065 * be image/jpg, but if you are sending image/jpg and image/png, then the
1066 * intent's type should be image/*.
1067 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001068 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1069 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1070 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1071 * content: URIs and other advanced features of {@link ClipData}. If
1072 * using this approach, you still must supply the same data through the
1073 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1074 * for compatibility with old applications. If you don't set a ClipData,
1075 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1076 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001077 * Optional standard extras, which may be interpreted by some recipients as
1078 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1079 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1080 * <p>
1081 * Output: nothing.
1082 */
1083 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1084 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1085 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001086 * Activity Action: Handle an incoming phone call.
1087 * <p>Input: nothing.
1088 * <p>Output: nothing.
1089 */
1090 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1091 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1092 /**
1093 * Activity Action: Insert an empty item into the given container.
1094 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1095 * in which to place the data.
1096 * <p>Output: URI of the new data that was created.
1097 */
1098 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1099 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1100 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001101 * Activity Action: Create a new item in the given container, initializing it
1102 * from the current contents of the clipboard.
1103 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1104 * in which to place the data.
1105 * <p>Output: URI of the new data that was created.
1106 */
1107 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1108 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1109 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001110 * Activity Action: Delete the given data from its container.
1111 * <p>Input: {@link #getData} is URI of data to be deleted.
1112 * <p>Output: nothing.
1113 */
1114 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1115 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1116 /**
1117 * Activity Action: Run the data, whatever that means.
1118 * <p>Input: ? (Note: this is currently specific to the test harness.)
1119 * <p>Output: nothing.
1120 */
1121 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1122 public static final String ACTION_RUN = "android.intent.action.RUN";
1123 /**
1124 * Activity Action: Perform a data synchronization.
1125 * <p>Input: ?
1126 * <p>Output: ?
1127 */
1128 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1129 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1130 /**
1131 * Activity Action: Pick an activity given an intent, returning the class
1132 * selected.
1133 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1134 * used with {@link PackageManager#queryIntentActivities} to determine the
1135 * set of activities from which to pick.
1136 * <p>Output: Class name of the activity that was selected.
1137 */
1138 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1139 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1140 /**
1141 * Activity Action: Perform a search.
1142 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1143 * is the text to search for. If empty, simply
1144 * enter your search results Activity with the search UI activated.
1145 * <p>Output: nothing.
1146 */
1147 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1148 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1149 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001150 * Activity Action: Start the platform-defined tutorial
1151 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1152 * is the text to search for. If empty, simply
1153 * enter your search results Activity with the search UI activated.
1154 * <p>Output: nothing.
1155 */
1156 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1157 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1158 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001159 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001160 * <p>
1161 * Input: {@link android.app.SearchManager#QUERY
1162 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1163 * a url starts with http or https, the site will be opened. If it is plain
1164 * text, Google search will be applied.
1165 * <p>
1166 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001167 */
1168 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1169 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001170
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001171 /**
Jim Miller07994402012-05-02 14:22:27 -07001172 * Activity Action: Perform assist action.
1173 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001174 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1175 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001176 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001177 * Output: nothing.
1178 */
1179 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1180 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001181
1182 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001183 * Activity Action: Perform voice assist action.
1184 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001185 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1186 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001187 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001188 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001189 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001190 */
1191 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1192 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1193
1194 /**
Adam Skory7140a252013-09-11 12:04:58 +01001195 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1196 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001197 */
1198 public static final String EXTRA_ASSIST_PACKAGE
1199 = "android.intent.extra.ASSIST_PACKAGE";
1200
1201 /**
Adam Skory7140a252013-09-11 12:04:58 +01001202 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1203 * information supplied by the current foreground app at the time of the assist request.
1204 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001205 */
1206 public static final String EXTRA_ASSIST_CONTEXT
1207 = "android.intent.extra.ASSIST_CONTEXT";
1208
Jim Miller07994402012-05-02 14:22:27 -07001209 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001210 * Activity Action: List all available applications
1211 * <p>Input: Nothing.
1212 * <p>Output: nothing.
1213 */
1214 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1215 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1216 /**
1217 * Activity Action: Show settings for choosing wallpaper
1218 * <p>Input: Nothing.
1219 * <p>Output: Nothing.
1220 */
1221 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1222 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1223
1224 /**
1225 * Activity Action: Show activity for reporting a bug.
1226 * <p>Input: Nothing.
1227 * <p>Output: Nothing.
1228 */
1229 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1230 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1231
1232 /**
1233 * Activity Action: Main entry point for factory tests. Only used when
1234 * the device is booting in factory test node. The implementing package
1235 * must be installed in the system image.
1236 * <p>Input: nothing
1237 * <p>Output: nothing
1238 */
1239 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1240
1241 /**
1242 * Activity Action: The user pressed the "call" button to go to the dialer
1243 * or other appropriate UI for placing a call.
1244 * <p>Input: Nothing.
1245 * <p>Output: Nothing.
1246 */
1247 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1248 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1249
1250 /**
1251 * Activity Action: Start Voice Command.
1252 * <p>Input: Nothing.
1253 * <p>Output: Nothing.
1254 */
1255 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1256 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001257
1258 /**
1259 * Activity Action: Start action associated with long pressing on the
1260 * search key.
1261 * <p>Input: Nothing.
1262 * <p>Output: Nothing.
1263 */
1264 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1265 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001266
Jacek Surazski86b6c532009-05-13 14:38:28 +02001267 /**
1268 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1269 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001270 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001271 * <p>Input: No data is specified. The bug report is passed in using
1272 * an {@link #EXTRA_BUG_REPORT} field.
1273 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001274 *
1275 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001276 */
1277 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1278 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001279
1280 /**
1281 * Activity Action: Show power usage information to the user.
1282 * <p>Input: Nothing.
1283 * <p>Output: Nothing.
1284 */
1285 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1286 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001287
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001288 /**
1289 * Activity Action: Setup wizard to launch after a platform update. This
1290 * activity should have a string meta-data field associated with it,
1291 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1292 * the platform for setup. The activity will be launched only if
1293 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1294 * same value.
1295 * <p>Input: Nothing.
1296 * <p>Output: Nothing.
1297 * @hide
1298 */
1299 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1300 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001301
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001302 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001303 * Activity Action: Show settings for managing network data usage of a
1304 * specific application. Applications should define an activity that offers
1305 * options to control data usage.
1306 */
1307 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1308 public static final String ACTION_MANAGE_NETWORK_USAGE =
1309 "android.intent.action.MANAGE_NETWORK_USAGE";
1310
1311 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001312 * Activity Action: Launch application installer.
1313 * <p>
1314 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001315 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1316 * you can also use "package:<package-name>" to install an application for the
1317 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001318 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1319 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1320 * <p>
1321 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1322 * succeeded.
1323 *
1324 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1325 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1326 * @see #EXTRA_RETURN_RESULT
1327 */
1328 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1329 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1330
1331 /**
1332 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1333 * package. Specifies the installer package name; this package will receive the
1334 * {@link #ACTION_APP_ERROR} intent.
1335 */
1336 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1337 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1338
1339 /**
1340 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1341 * package. Specifies that the application being installed should not be
1342 * treated as coming from an unknown source, but as coming from the app
1343 * invoking the Intent. For this to work you must start the installer with
1344 * startActivityForResult().
1345 */
1346 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1347 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1348
1349 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001350 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1351 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001352 * data field originated from.
1353 */
rich cannings706e8ba2012-08-20 13:20:14 -07001354 public static final String EXTRA_ORIGINATING_URI
1355 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001356
1357 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001358 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1359 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1360 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001361 */
1362 public static final String EXTRA_REFERRER
1363 = "android.intent.extra.REFERRER";
1364
1365 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001366 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1367 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1368 * @hide
1369 */
1370 public static final String EXTRA_ORIGINATING_UID
1371 = "android.intent.extra.ORIGINATING_UID";
1372
1373 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001374 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1375 * package. Tells the installer UI to skip the confirmation with the user
1376 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001377 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1378 * will no longer show an interstitial message about updating existing
1379 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001380 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001381 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001382 public static final String EXTRA_ALLOW_REPLACE
1383 = "android.intent.extra.ALLOW_REPLACE";
1384
1385 /**
1386 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1387 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1388 * return to the application the result code of the install/uninstall. The returned result
1389 * code will be {@link android.app.Activity#RESULT_OK} on success or
1390 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1391 */
1392 public static final String EXTRA_RETURN_RESULT
1393 = "android.intent.extra.RETURN_RESULT";
1394
1395 /**
1396 * Package manager install result code. @hide because result codes are not
1397 * yet ready to be exposed.
1398 */
1399 public static final String EXTRA_INSTALL_RESULT
1400 = "android.intent.extra.INSTALL_RESULT";
1401
1402 /**
1403 * Activity Action: Launch application uninstaller.
1404 * <p>
1405 * Input: The data must be a package: URI whose scheme specific part is
1406 * the package name of the current installed package to be uninstalled.
1407 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1408 * <p>
1409 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1410 * succeeded.
1411 */
1412 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1413 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1414
1415 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001416 * Specify whether the package should be uninstalled for all users.
1417 * @hide because these should not be part of normal application flow.
1418 */
1419 public static final String EXTRA_UNINSTALL_ALL_USERS
1420 = "android.intent.extra.UNINSTALL_ALL_USERS";
1421
1422 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001423 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1424 * describing the last run version of the platform that was setup.
1425 * @hide
1426 */
1427 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1428
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001429 // ---------------------------------------------------------------------
1430 // ---------------------------------------------------------------------
1431 // Standard intent broadcast actions (see action variable).
1432
1433 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001434 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1435 * <p>
1436 * For historical reasons, the name of this broadcast action refers to the power
1437 * state of the screen but it is actually sent in response to changes in the
1438 * overall interactive state of the device.
1439 * </p><p>
1440 * This broadcast is sent when the device becomes non-interactive which may have
1441 * nothing to do with the screen turning off. To determine the
1442 * actual state of the screen, use {@link android.view.Display#getState}.
1443 * </p><p>
1444 * See {@link android.os.PowerManager#isInteractive} for details.
1445 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001446 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001447 * <p class="note">This is a protected intent that can only be sent
1448 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001449 */
1450 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1451 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001452
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001453 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001454 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1455 * <p>
1456 * For historical reasons, the name of this broadcast action refers to the power
1457 * state of the screen but it is actually sent in response to changes in the
1458 * overall interactive state of the device.
1459 * </p><p>
1460 * This broadcast is sent when the device becomes interactive which may have
1461 * nothing to do with the screen turning on. To determine the
1462 * actual state of the screen, use {@link android.view.Display#getState}.
1463 * </p><p>
1464 * See {@link android.os.PowerManager#isInteractive} for details.
1465 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001466 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001467 * <p class="note">This is a protected intent that can only be sent
1468 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001469 */
1470 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1471 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001472
1473 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001474 * Broadcast Action: Sent after the system stops dreaming.
1475 *
1476 * <p class="note">This is a protected intent that can only be sent by the system.
1477 * It is only sent to registered receivers.</p>
1478 */
1479 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1480 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1481
1482 /**
1483 * Broadcast Action: Sent after the system starts dreaming.
1484 *
1485 * <p class="note">This is a protected intent that can only be sent by the system.
1486 * It is only sent to registered receivers.</p>
1487 */
1488 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1489 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1490
1491 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001492 * 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 -07001493 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001494 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001495 * <p class="note">This is a protected intent that can only be sent
1496 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001497 */
1498 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001499 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001500
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001501 /**
1502 * Broadcast Action: The current time has changed. Sent every
1503 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001504 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001505 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1506 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001507 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001508 * <p class="note">This is a protected intent that can only be sent
1509 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001510 */
1511 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1512 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1513 /**
1514 * Broadcast Action: The time was set.
1515 */
1516 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1517 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1518 /**
1519 * Broadcast Action: The date has changed.
1520 */
1521 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1522 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1523 /**
1524 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1525 * <ul>
1526 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1527 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001528 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001529 * <p class="note">This is a protected intent that can only be sent
1530 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001531 */
1532 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1533 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1534 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001535 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1536 * DNS entries should be tossed.
1537 * @hide
1538 */
1539 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1540 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1541 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001542 * Alarm Changed Action: This is broadcast when the AlarmClock
1543 * application's alarm is set or unset. It is used by the
1544 * AlarmClock application and the StatusBar service.
1545 * @hide
1546 */
1547 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1548 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1549 /**
1550 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1551 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1552 * @hide
1553 */
1554 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1555 public static final String ACTION_SYNC_STATE_CHANGED
1556 = "android.intent.action.SYNC_STATE_CHANGED";
1557 /**
1558 * Broadcast Action: This is broadcast once, after the system has finished
1559 * booting. It can be used to perform application-specific initialization,
1560 * such as installing alarms. You must hold the
1561 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1562 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001563 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001564 * <p class="note">This is a protected intent that can only be sent
1565 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001566 */
1567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1568 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1569 /**
1570 * Broadcast Action: This is broadcast when a user action should request a
1571 * temporary system dialog to dismiss. Some examples of temporary system
1572 * dialogs are the notification window-shade and the recent tasks dialog.
1573 */
1574 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1575 /**
1576 * Broadcast Action: Trigger the download and eventual installation
1577 * of a package.
1578 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001579 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001580 * <p class="note">This is a protected intent that can only be sent
1581 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001582 *
1583 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001584 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001585 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001586 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1587 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1588 /**
1589 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001590 * device. The data contains the name of the package. Note that the
1591 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001592 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001593 * <ul>
1594 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1595 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1596 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1597 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001598 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001599 * <p class="note">This is a protected intent that can only be sent
1600 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001601 */
1602 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1603 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1604 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001605 * Broadcast Action: A new version of an application package has been
1606 * installed, replacing an existing version that was previously installed.
1607 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001608 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001609 * <ul>
1610 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1611 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001612 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001613 * <p class="note">This is a protected intent that can only be sent
1614 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001615 */
1616 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1617 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1618 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001619 * Broadcast Action: A new version of your application has been installed
1620 * over an existing one. This is only sent to the application that was
1621 * replaced. It does not contain any additional data; to receive it, just
1622 * use an intent filter for this action.
1623 *
1624 * <p class="note">This is a protected intent that can only be sent
1625 * by the system.
1626 */
1627 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1628 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1629 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001630 * Broadcast Action: An existing application package has been removed from
1631 * the device. The data contains the name of the package. The package
1632 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001633 * <ul>
1634 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1635 * to the package.
1636 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1637 * application -- data and code -- is being removed.
1638 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1639 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1640 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001641 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001642 * <p class="note">This is a protected intent that can only be sent
1643 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001644 */
1645 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1646 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1647 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001648 * Broadcast Action: An existing application package has been completely
1649 * removed from the device. The data contains the name of the package.
1650 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1651 * {@link #EXTRA_DATA_REMOVED} is true and
1652 * {@link #EXTRA_REPLACING} is false of that broadcast.
1653 *
1654 * <ul>
1655 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1656 * to the package.
1657 * </ul>
1658 *
1659 * <p class="note">This is a protected intent that can only be sent
1660 * by the system.
1661 */
1662 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1663 public static final String ACTION_PACKAGE_FULLY_REMOVED
1664 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1665 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001666 * Broadcast Action: An existing application package has been changed (e.g.
1667 * a component has been enabled or disabled). The data contains the name of
1668 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001669 * <ul>
1670 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001671 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001672 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001673 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1674 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001675 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001676 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001677 * <p class="note">This is a protected intent that can only be sent
1678 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001679 */
1680 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1681 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1682 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001683 * @hide
1684 * Broadcast Action: Ask system services if there is any reason to
1685 * restart the given package. The data contains the name of the
1686 * package.
1687 * <ul>
1688 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1689 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1690 * </ul>
1691 *
1692 * <p class="note">This is a protected intent that can only be sent
1693 * by the system.
1694 */
1695 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1696 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1697 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001698 * Broadcast Action: The user has restarted a package, and all of its
1699 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001700 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001701 * be removed. Note that the restarted package does <em>not</em>
1702 * receive this broadcast.
1703 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001704 * <ul>
1705 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1706 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001707 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001708 * <p class="note">This is a protected intent that can only be sent
1709 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001710 */
1711 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1712 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1713 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001714 * Broadcast Action: The user has cleared the data of a package. This should
1715 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001716 * its persistent data is erased and this broadcast sent.
1717 * Note that the cleared package does <em>not</em>
1718 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001719 * <ul>
1720 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1721 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001722 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001723 * <p class="note">This is a protected intent that can only be sent
1724 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001725 */
1726 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1727 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1728 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001729 * Broadcast Action: A user ID has been removed from the system. The user
1730 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001731 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001732 * <p class="note">This is a protected intent that can only be sent
1733 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001734 */
1735 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1736 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001737
1738 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001739 * Broadcast Action: Sent to the installer package of an application
1740 * when that application is first launched (that is the first time it
1741 * is moved out of the stopped state). The data contains the name of the package.
1742 *
1743 * <p class="note">This is a protected intent that can only be sent
1744 * by the system.
1745 */
1746 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1747 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1748
1749 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001750 * Broadcast Action: Sent to the system package verifier when a package
1751 * needs to be verified. The data contains the package URI.
1752 * <p class="note">
1753 * This is a protected intent that can only be sent by the system.
1754 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001755 */
1756 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1757 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1758
1759 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001760 * Broadcast Action: Sent to the system package verifier when a package is
1761 * verified. The data contains the package URI.
1762 * <p class="note">
1763 * This is a protected intent that can only be sent by the system.
1764 */
1765 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1766 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1767
1768 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001769 * Broadcast Action: Resources for a set of packages (which were
1770 * previously unavailable) are currently
1771 * available since the media on which they exist is available.
1772 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1773 * list of packages whose availability changed.
1774 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1775 * list of uids of packages whose availability changed.
1776 * Note that the
1777 * packages in this list do <em>not</em> receive this broadcast.
1778 * The specified set of packages are now available on the system.
1779 * <p>Includes the following extras:
1780 * <ul>
1781 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1782 * whose resources(were previously unavailable) are currently available.
1783 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1784 * packages whose resources(were previously unavailable)
1785 * are currently available.
1786 * </ul>
1787 *
1788 * <p class="note">This is a protected intent that can only be sent
1789 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001790 */
1791 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001792 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1793 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001794
1795 /**
1796 * Broadcast Action: Resources for a set of packages are currently
1797 * unavailable since the media on which they exist is unavailable.
1798 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1799 * list of packages whose availability changed.
1800 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1801 * list of uids of packages whose availability changed.
1802 * The specified set of packages can no longer be
1803 * launched and are practically unavailable on the system.
1804 * <p>Inclues the following extras:
1805 * <ul>
1806 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1807 * whose resources are no longer available.
1808 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1809 * whose resources are no longer available.
1810 * </ul>
1811 *
1812 * <p class="note">This is a protected intent that can only be sent
1813 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001814 */
1815 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001816 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001817 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001818
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001819 /**
1820 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001821 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001822 * This should <em>only</em> be used to determine when the wallpaper
1823 * has changed to show the new wallpaper to the user. You should certainly
1824 * never, in response to this, change the wallpaper or other attributes of
1825 * it such as the suggested size. That would be crazy, right? You'd cause
1826 * all kinds of loops, especially if other apps are doing similar things,
1827 * right? Of course. So please don't do this.
1828 *
1829 * @deprecated Modern applications should use
1830 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1831 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1832 * shown behind their UI, rather than watching for this broadcast and
1833 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001834 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001835 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001836 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1837 /**
1838 * Broadcast Action: The current device {@link android.content.res.Configuration}
1839 * (orientation, locale, etc) has changed. When such a change happens, the
1840 * UIs (view hierarchy) will need to be rebuilt based on this new
1841 * information; for the most part, applications don't need to worry about
1842 * this, because the system will take care of stopping and restarting the
1843 * application to make sure it sees the new changes. Some system code that
1844 * can not be restarted will need to watch for this action and handle it
1845 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001846 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001847 * <p class="note">
1848 * You can <em>not</em> receive this through components declared
1849 * in manifests, only by explicitly registering for it with
1850 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1851 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001852 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001853 * <p class="note">This is a protected intent that can only be sent
1854 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001855 *
1856 * @see android.content.res.Configuration
1857 */
1858 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1859 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1860 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001861 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001862 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001863 * <p class="note">This is a protected intent that can only be sent
1864 * by the system.
1865 */
1866 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1867 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1868 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001869 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1870 * charging state, level, and other information about the battery.
1871 * See {@link android.os.BatteryManager} for documentation on the
1872 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001873 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001874 * <p class="note">
1875 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001876 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001877 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001878 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1879 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1880 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1881 * broadcasts that are sent and can be received through manifest
1882 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001883 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001884 * <p class="note">This is a protected intent that can only be sent
1885 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001886 */
1887 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1888 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1889 /**
1890 * Broadcast Action: Indicates low battery condition on the device.
1891 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001892 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001893 * <p class="note">This is a protected intent that can only be sent
1894 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001895 */
1896 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1897 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1898 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001899 * Broadcast Action: Indicates the battery is now okay after being low.
1900 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1901 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001902 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001903 * <p class="note">This is a protected intent that can only be sent
1904 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001905 */
1906 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1907 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1908 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001909 * Broadcast Action: External power has been connected to 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
1913 * 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)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001919 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001920 /**
1921 * Broadcast Action: External power has been removed from the device.
1922 * This is intended for applications that wish to register specifically to this notification.
1923 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1924 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001925 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001926 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001927 * <p class="note">This is a protected intent that can only be sent
1928 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001929 */
1930 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001931 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001932 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001933 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001934 * Broadcast Action: Device is shutting down.
1935 * This is broadcast when the device is being shut down (completely turned
1936 * off, not sleeping). Once the broadcast is complete, the final shutdown
1937 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001938 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001939 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001940 * <p class="note">This is a protected intent that can only be sent
1941 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001942 * <p>May include the following extras:
1943 * <ul>
1944 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1945 * shutdown is only for userspace processes. If not set, assumed to be false.
1946 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001947 */
1948 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001949 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001950 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001951 * Activity Action: Start this activity to request system shutdown.
1952 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1953 * to request confirmation from the user before shutting down.
1954 *
1955 * <p class="note">This is a protected intent that can only be sent
1956 * by the system.
1957 *
1958 * {@hide}
1959 */
1960 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1961 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001962 * Broadcast Action: A sticky broadcast that indicates low memory
1963 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001964 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001965 * <p class="note">This is a protected intent that can only be sent
1966 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001967 */
1968 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1969 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1970 /**
1971 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001972 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001973 * <p class="note">This is a protected intent that can only be sent
1974 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001975 */
1976 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1977 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1978 /**
Jake Hambybb371632010-08-23 18:16:48 -07001979 * Broadcast Action: A sticky broadcast that indicates a memory full
1980 * condition on the device. This is intended for activities that want
1981 * to be able to fill the data partition completely, leaving only
1982 * enough free space to prevent system-wide SQLite failures.
1983 *
1984 * <p class="note">This is a protected intent that can only be sent
1985 * by the system.
1986 *
1987 * {@hide}
1988 */
1989 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1990 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1991 /**
1992 * Broadcast Action: Indicates memory full condition on the device
1993 * no longer exists.
1994 *
1995 * <p class="note">This is a protected intent that can only be sent
1996 * by the system.
1997 *
1998 * {@hide}
1999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2002 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002003 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2004 * and package management should be started.
2005 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2006 * notification.
2007 */
2008 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2009 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2010 /**
2011 * Broadcast Action: The device has entered USB Mass Storage mode.
2012 * This is used mainly for the USB Settings panel.
2013 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2014 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002015 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002016 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002017 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002018 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2019
2020 /**
2021 * Broadcast Action: The device has exited USB Mass Storage mode.
2022 * This is used mainly for the USB Settings panel.
2023 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2024 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002025 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002026 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002027 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002028 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2029
2030 /**
2031 * Broadcast Action: External media has been removed.
2032 * The path to the mount point for the removed media is contained in the Intent.mData field.
2033 */
2034 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2035 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2036
2037 /**
2038 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002039 * 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 -07002040 */
2041 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2042 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2043
2044 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002045 * Broadcast Action: External media is present, and being disk-checked
2046 * 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 -08002047 */
2048 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2049 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2050
2051 /**
2052 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2053 * 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 -08002054 */
2055 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2056 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2057
2058 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002059 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002060 * 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 -07002061 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2062 * media was mounted read only.
2063 */
2064 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2065 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2066
2067 /**
2068 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002069 * 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 -07002070 */
2071 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2072 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2073
2074 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002075 * Broadcast Action: External media is no longer being shared via USB mass storage.
2076 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2077 *
2078 * @hide
2079 */
2080 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2081
2082 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002083 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2084 * The path to the mount point for the removed media is contained in the Intent.mData field.
2085 */
2086 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2087 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2088
2089 /**
2090 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002091 * 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 -07002092 */
2093 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2094 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2095
2096 /**
2097 * Broadcast Action: User has expressed the desire to remove the external storage media.
2098 * Applications should close all files they have open within the mount point when they receive this intent.
2099 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2100 */
2101 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2102 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2103
2104 /**
2105 * Broadcast Action: The media scanner has started scanning a directory.
2106 * The path to the directory being scanned is contained in the Intent.mData field.
2107 */
2108 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2109 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2110
2111 /**
2112 * Broadcast Action: The media scanner has finished scanning a directory.
2113 * The path to the scanned directory is contained in the Intent.mData field.
2114 */
2115 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2116 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2117
2118 /**
2119 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2120 * The path to the file is contained in the Intent.mData field.
2121 */
2122 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2123 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2124
2125 /**
2126 * Broadcast Action: The "Media Button" was pressed. Includes a single
2127 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2128 * caused the broadcast.
2129 */
2130 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2131 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2132
2133 /**
2134 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2135 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2136 * caused the broadcast.
2137 */
2138 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2139 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2140
2141 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2142 // location; they are not general-purpose actions.
2143
2144 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002145 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002146 */
2147 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2148 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2149 "android.intent.action.GTALK_CONNECTED";
2150
2151 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002152 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002153 */
2154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2155 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2156 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002157
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002158 /**
2159 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002160 */
2161 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2162 public static final String ACTION_INPUT_METHOD_CHANGED =
2163 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002164
2165 /**
2166 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2167 * more radios have been turned off or on. The intent will have the following extra value:</p>
2168 * <ul>
2169 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2170 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2171 * turned off</li>
2172 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002173 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002174 * <p class="note">This is a protected intent that can only be sent
2175 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002176 */
2177 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2178 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2179
2180 /**
2181 * Broadcast Action: Some content providers have parts of their namespace
2182 * where they publish new events or items that the user may be especially
2183 * interested in. For these things, they may broadcast this action when the
2184 * set of interesting items change.
2185 *
2186 * For example, GmailProvider sends this notification when the set of unread
2187 * mail in the inbox changes.
2188 *
2189 * <p>The data of the intent identifies which part of which provider
2190 * changed. When queried through the content resolver, the data URI will
2191 * return the data set in question.
2192 *
2193 * <p>The intent will have the following extra values:
2194 * <ul>
2195 * <li><em>count</em> - The number of items in the data set. This is the
2196 * same as the number of items in the cursor returned by querying the
2197 * data URI. </li>
2198 * </ul>
2199 *
2200 * This intent will be sent at boot (if the count is non-zero) and when the
2201 * data set changes. It is possible for the data set to change without the
2202 * count changing (for example, if a new unread message arrives in the same
2203 * sync operation in which a message is archived). The phone should still
2204 * ring/vibrate/etc as normal in this case.
2205 */
2206 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2207 public static final String ACTION_PROVIDER_CHANGED =
2208 "android.intent.action.PROVIDER_CHANGED";
2209
2210 /**
2211 * Broadcast Action: Wired Headset plugged in or unplugged.
2212 *
Matt Casey79867f52014-03-26 15:20:25 -07002213 * You <em>cannot</em> receive this through components declared
2214 * in manifests, only by explicitly registering for it with
2215 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2216 * Context.registerReceiver()}.
2217 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002218 * <p>The intent will have the following extra values:
2219 * <ul>
2220 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2221 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002222 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002223 * </ul>
2224 * </ul>
2225 */
2226 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2227 public static final String ACTION_HEADSET_PLUG =
2228 "android.intent.action.HEADSET_PLUG";
2229
2230 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002231 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2232 *
2233 * <p>The intent will have the following extra values:
2234 * <ul>
2235 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2236 * <li><em>name</em> - Headset type, human readable string </li>
2237 * </ul>
2238 * </ul>
2239 * @hide
2240 */
2241 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002242 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2243 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002244
2245 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002246 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002247 *
2248 * <p>The intent will have the following extra values:
2249 * <ul>
2250 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2251 * <li><em>name</em> - Headset type, human readable string </li>
2252 * </ul>
2253 * </ul>
2254 * @hide
2255 */
2256 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002257 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2258 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002259
2260 /**
2261 * Broadcast Action: A HMDI cable was plugged or unplugged
2262 *
2263 * <p>The intent will have the following extra values:
2264 * <ul>
2265 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2266 * <li><em>name</em> - HDMI cable, human readable string </li>
2267 * </ul>
2268 * </ul>
2269 * @hide
2270 */
2271 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2272 public static final String ACTION_HDMI_AUDIO_PLUG =
2273 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002274
2275 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002276 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2277 *
2278 * <p>The intent will have the following extra values:
2279 * <ul>
2280 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2281 * <li><em>card</em> - ALSA card number (integer) </li>
2282 * <li><em>device</em> - ALSA device number (integer) </li>
2283 * </ul>
2284 * </ul>
2285 * @hide
2286 */
2287 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2288 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2289 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2290
2291 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002292 * Broadcast Action: A USB audio device was plugged in or unplugged.
2293 *
2294 * <p>The intent will have the following extra values:
2295 * <ul>
2296 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2297 * <li><em>card</em> - ALSA card number (integer) </li>
2298 * <li><em>device</em> - ALSA device number (integer) </li>
2299 * </ul>
2300 * </ul>
2301 * @hide
2302 */
2303 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2304 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2305 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2306
2307 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002308 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2309 * <ul>
2310 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2311 * </ul>
2312 *
2313 * <p class="note">This is a protected intent that can only be sent
2314 * by the system.
2315 *
2316 * @hide
2317 */
2318 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2319 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2320 = "android.intent.action.ADVANCED_SETTINGS";
2321
2322 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002323 * Broadcast Action: Sent after application restrictions are changed.
2324 *
2325 * <p class="note">This is a protected intent that can only be sent
2326 * by the system.</p>
2327 */
2328 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2329 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2330 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2331
2332 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002333 * Broadcast Action: An outgoing call is about to be placed.
2334 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002335 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002336 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002337 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002338 * the phone number originally intended to be dialed.</li>
2339 * </ul>
2340 * <p>Once the broadcast is finished, the resultData is used as the actual
2341 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002342 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002343 * outgoing call in turn: for example, a parental control application
2344 * might verify that the user is authorized to place the call at that
2345 * time, then a number-rewriting application might add an area code if
2346 * one was not specified.</p>
2347 * <p>For consistency, any receiver whose purpose is to prohibit phone
2348 * calls should have a priority of 0, to ensure it will see the final
2349 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002350 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002351 * should have a positive priority.
2352 * Negative priorities are reserved for the system for this broadcast;
2353 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002354 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2355 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002356 * <p>Emergency calls cannot be intercepted using this mechanism, and
2357 * other calls cannot be modified to call emergency numbers using this
2358 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002359 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2360 * call to use their own service instead. Those apps should first prevent
2361 * the call from being placed by setting resultData to <code>null</code>
2362 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002363 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002364 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2365 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002366 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002367 * <p class="note">This is a protected intent that can only be sent
2368 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002369 */
2370 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2371 public static final String ACTION_NEW_OUTGOING_CALL =
2372 "android.intent.action.NEW_OUTGOING_CALL";
2373
2374 /**
2375 * Broadcast Action: Have the device reboot. This is only for use by
2376 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002377 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002378 * <p class="note">This is a protected intent that can only be sent
2379 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002380 */
2381 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2382 public static final String ACTION_REBOOT =
2383 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002384
Wei Huang97ecc9c2009-05-11 17:44:20 -07002385 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002386 * Broadcast Action: A sticky broadcast for changes in the physical
2387 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002388 *
2389 * <p>The intent will have the following extra values:
2390 * <ul>
2391 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002392 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002393 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002394 * <p>This is intended for monitoring the current physical dock state.
2395 * See {@link android.app.UiModeManager} for the normal API dealing with
2396 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002397 */
2398 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2399 public static final String ACTION_DOCK_EVENT =
2400 "android.intent.action.DOCK_EVENT";
2401
2402 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002403 * Broadcast Action: A broadcast when idle maintenance can be started.
2404 * This means that the user is not interacting with the device and is
2405 * not expected to do so soon. Typical use of the idle maintenance is
2406 * to perform somehow expensive tasks that can be postponed at a moment
2407 * when they will not degrade user experience.
2408 * <p>
2409 * <p class="note">In order to keep the device responsive in case of an
2410 * unexpected user interaction, implementations of a maintenance task
2411 * should be interruptible. In such a scenario a broadcast with action
2412 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2413 * should not do the maintenance work in
2414 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2415 * maintenance service by {@link Context#startService(Intent)}. Also
2416 * you should hold a wake lock while your maintenance service is running
2417 * to prevent the device going to sleep.
2418 * </p>
2419 * <p>
2420 * <p class="note">This is a protected intent that can only be sent by
2421 * the system.
2422 * </p>
2423 *
2424 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002425 *
2426 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002427 */
2428 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2429 public static final String ACTION_IDLE_MAINTENANCE_START =
2430 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2431
2432 /**
2433 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2434 * This means that the user was not interacting with the device as a result
2435 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2436 * was sent and now the user started interacting with the device. Typical
2437 * use of the idle maintenance is to perform somehow expensive tasks that
2438 * can be postponed at a moment when they will not degrade user experience.
2439 * <p>
2440 * <p class="note">In order to keep the device responsive in case of an
2441 * unexpected user interaction, implementations of a maintenance task
2442 * should be interruptible. Hence, on receiving a broadcast with this
2443 * action, the maintenance task should be interrupted as soon as possible.
2444 * In other words, you should not do the maintenance work in
2445 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2446 * maintenance service that was started on receiving of
2447 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2448 * lock you acquired when your maintenance service started.
2449 * </p>
2450 * <p class="note">This is a protected intent that can only be sent
2451 * by the system.
2452 *
2453 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002454 *
2455 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002456 */
2457 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2458 public static final String ACTION_IDLE_MAINTENANCE_END =
2459 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2460
2461 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002462 * Broadcast Action: a remote intent is to be broadcasted.
2463 *
2464 * A remote intent is used for remote RPC between devices. The remote intent
2465 * is serialized and sent from one device to another device. The receiving
2466 * device parses the remote intent and broadcasts it. Note that anyone can
2467 * broadcast a remote intent. However, if the intent receiver of the remote intent
2468 * does not trust intent broadcasts from arbitrary intent senders, it should require
2469 * the sender to hold certain permissions so only trusted sender's broadcast will be
2470 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002471 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002472 */
2473 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002474 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002475
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002476 /**
2477 * Broadcast Action: hook for permforming cleanup after a system update.
2478 *
2479 * The broadcast is sent when the system is booting, before the
2480 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2481 * image. A receiver for this should do its work and then disable itself
2482 * so that it does not get run again at the next boot.
2483 * @hide
2484 */
2485 public static final String ACTION_PRE_BOOT_COMPLETED =
2486 "android.intent.action.PRE_BOOT_COMPLETED";
2487
Amith Yamasani13593602012-03-22 16:16:17 -07002488 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002489 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002490 * on restricted users. The broadcast intent contains an extra
2491 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2492 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2493 * String[] depending on the restriction type.<p/>
2494 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002495 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2496 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2497 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002498 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2499 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002500 * @see RestrictionEntry
2501 */
2502 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2503 "android.intent.action.GET_RESTRICTION_ENTRIES";
2504
2505 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002506 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002507 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002508 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2509 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2510 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002511 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2512 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2513 * challenge.<p/>
2514 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002515 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002516 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002517 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2518 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002519
2520 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002521 * Sent the first time a user is starting, to allow system apps to
2522 * perform one time initialization. (This will not be seen by third
2523 * party applications because a newly initialized user does not have any
2524 * third party applications installed for it.) This is sent early in
2525 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002526 * {@link #ACTION_BOOT_COMPLETED} is sent. 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_INITIALIZE =
2531 "android.intent.action.USER_INITIALIZE";
2532
2533 /**
2534 * Sent when a user switch is happening, causing the process's user to be
2535 * brought to the foreground. 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 * foreground. 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_FOREGROUND =
2543 "android.intent.action.USER_FOREGROUND";
2544
2545 /**
2546 * Sent when a user switch is happening, causing the process's user to be
2547 * sent to the background. This is only sent to receivers registered
2548 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2549 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002550 * background. This is sent as a foreground
2551 * broadcast, since it is part of a visible user interaction; be as quick
2552 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002553 */
2554 public static final String ACTION_USER_BACKGROUND =
2555 "android.intent.action.USER_BACKGROUND";
2556
2557 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002558 * Broadcast sent to the system when a user is added. Carries an extra
2559 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2560 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002561 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002562 * @hide
2563 */
2564 public static final String ACTION_USER_ADDED =
2565 "android.intent.action.USER_ADDED";
2566
2567 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002568 * Broadcast sent by the system when a user is started. Carries an extra
2569 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002570 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002571 * that has been started. This is sent as a foreground
2572 * broadcast, since it is part of a visible user interaction; be as quick
2573 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002574 * @hide
2575 */
2576 public static final String ACTION_USER_STARTED =
2577 "android.intent.action.USER_STARTED";
2578
2579 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002580 * Broadcast sent when a user is in the process of starting. Carries an extra
2581 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2582 * sent to registered receivers, not manifest receivers. It is sent to all
2583 * users (including the one that is being started). You must hold
2584 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2585 * this broadcast. This is sent as a background broadcast, since
2586 * its result is not part of the primary UX flow; to safely keep track of
2587 * started/stopped state of a user you can use this in conjunction with
2588 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2589 * other user state broadcasts since those are foreground broadcasts so can
2590 * execute in a different order.
2591 * @hide
2592 */
2593 public static final String ACTION_USER_STARTING =
2594 "android.intent.action.USER_STARTING";
2595
2596 /**
2597 * Broadcast sent when a user is going to be stopped. Carries an extra
2598 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2599 * sent to registered receivers, not manifest receivers. It is sent to all
2600 * users (including the one that is being stopped). You must hold
2601 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2602 * this broadcast. The user will not stop until all receivers have
2603 * handled the broadcast. This is sent as a background broadcast, since
2604 * its result is not part of the primary UX flow; to safely keep track of
2605 * started/stopped state of a user you can use this in conjunction with
2606 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2607 * other user state broadcasts since those are foreground broadcasts so can
2608 * execute in a different order.
2609 * @hide
2610 */
2611 public static final String ACTION_USER_STOPPING =
2612 "android.intent.action.USER_STOPPING";
2613
2614 /**
2615 * Broadcast sent to the system when a user is stopped. Carries an extra
2616 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2617 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2618 * specific package. This is only sent to registered receivers, not manifest
2619 * receivers. It is sent to all running users <em>except</em> the one that
2620 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002621 * @hide
2622 */
2623 public static final String ACTION_USER_STOPPED =
2624 "android.intent.action.USER_STOPPED";
2625
2626 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002627 * 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 -07002628 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002629 * one that has been removed. The user will not be completely removed until all receivers have
2630 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002631 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002632 * @hide
2633 */
2634 public static final String ACTION_USER_REMOVED =
2635 "android.intent.action.USER_REMOVED";
2636
2637 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002638 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002639 * the userHandle of the user to become the current one. This is only sent to
2640 * registered receivers, not manifest receivers. It is sent to all running users.
2641 * You must hold
2642 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002643 * @hide
2644 */
2645 public static final String ACTION_USER_SWITCHED =
2646 "android.intent.action.USER_SWITCHED";
2647
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002648 /**
2649 * Broadcast sent to the system when a user's information changes. Carries an extra
2650 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002651 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002652 * @hide
2653 */
2654 public static final String ACTION_USER_INFO_CHANGED =
2655 "android.intent.action.USER_INFO_CHANGED";
2656
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002657 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002658 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2659 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002660 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2661 * that need to display merged content across both primary and managed profiles need to
2662 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002663 * not manifest receivers.
2664 */
2665 public static final String ACTION_MANAGED_PROFILE_ADDED =
2666 "android.intent.action.MANAGED_PROFILE_ADDED";
2667
2668 /**
2669 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002670 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2671 * Only applications (for example Launchers) that need to display merged content across both
2672 * primary and managed profiles need to worry about this broadcast. This is only sent to
2673 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002674 */
2675 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2676 "android.intent.action.MANAGED_PROFILE_REMOVED";
2677
2678 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002679 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2680 */
2681 public static final String ACTION_QUICK_CLOCK =
2682 "android.intent.action.QUICK_CLOCK";
2683
Michael Wright0087a142013-02-05 16:29:39 -08002684 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002685 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002686 * @hide
2687 */
2688 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2689 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2690
Justin Kohd378ad72013-04-01 12:18:26 -07002691 /**
2692 * Broadcast Action: A global button was pressed. Includes a single
2693 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2694 * caused the broadcast.
2695 * @hide
2696 */
2697 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2698
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002699 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002700 * Activity Action: Allow the user to select and return one or more existing
2701 * documents. When invoked, the system will display the various
2702 * {@link DocumentsProvider} instances installed on the device, letting the
2703 * user interactively navigate through them. These documents include local
2704 * media, such as photos and video, and documents provided by installed
2705 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002706 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002707 * Each document is represented as a {@code content://} URI backed by a
2708 * {@link DocumentsProvider}, which can be opened as a stream with
2709 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2710 * {@link android.provider.DocumentsContract.Document} metadata.
2711 * <p>
2712 * All selected documents are returned to the calling application with
2713 * persistable read and write permission grants. If you want to maintain
2714 * access to the documents across device reboots, you need to explicitly
2715 * take the persistable permissions using
2716 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2717 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002718 * Callers must indicate the acceptable document MIME types through
2719 * {@link #setType(String)}. For example, to select photos, use
2720 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2721 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2722 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002723 * <p>
2724 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002725 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2726 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002727 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002728 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2729 * returned URIs can be opened with
2730 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002731 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002732 * Output: The URI of the item that was picked, returned in
2733 * {@link #getData()}. This must be a {@code content://} URI so that any
2734 * receiver can access it. If multiple documents were selected, they are
2735 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002736 *
2737 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002738 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002739 * @see #ACTION_CREATE_DOCUMENT
2740 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002741 */
2742 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2743 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2744
2745 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002746 * Activity Action: Allow the user to create a new document. When invoked,
2747 * the system will display the various {@link DocumentsProvider} instances
2748 * installed on the device, letting the user navigate through them. The
2749 * returned document may be a newly created document with no content, or it
2750 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002751 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002752 * Each document is represented as a {@code content://} URI backed by a
2753 * {@link DocumentsProvider}, which can be opened as a stream with
2754 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2755 * {@link android.provider.DocumentsContract.Document} metadata.
2756 * <p>
2757 * Callers must indicate the concrete MIME type of the document being
2758 * created by setting {@link #setType(String)}. This MIME type cannot be
2759 * changed after the document is created.
2760 * <p>
2761 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2762 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002763 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002764 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2765 * returned URIs can be opened with
2766 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002767 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002768 * Output: The URI of the item that was created. This must be a
2769 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002770 *
2771 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002772 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002773 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002774 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002775 */
2776 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2777 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2778
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002779 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002780 * Activity Action: Allow the user to pick a directory subtree. When
2781 * invoked, the system will display the various {@link DocumentsProvider}
2782 * instances installed on the device, letting the user navigate through
2783 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002784 * <p>
2785 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002786 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2787 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2788 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002789 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002790 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002791 *
2792 * @see DocumentsContract
2793 */
2794 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002795 public static final String
2796 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002797
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002798 // ---------------------------------------------------------------------
2799 // ---------------------------------------------------------------------
2800 // Standard intent categories (see addCategory()).
2801
2802 /**
2803 * Set if the activity should be an option for the default action
2804 * (center press) to perform on a piece of data. Setting this will
2805 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002806 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002807 * Intent when initiating an action -- it is for use in intent filters
2808 * specified in packages.
2809 */
2810 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2811 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2812 /**
2813 * Activities that can be safely invoked from a browser must support this
2814 * category. For example, if the user is viewing a web page or an e-mail
2815 * and clicks on a link in the text, the Intent generated execute that
2816 * link will require the BROWSABLE category, so that only activities
2817 * supporting this category will be considered as possible actions. By
2818 * supporting this category, you are promising that there is nothing
2819 * damaging (without user intervention) that can happen by invoking any
2820 * matching Intent.
2821 */
2822 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2823 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2824 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07002825 * Categories for activities that can participate in voice interaction.
2826 * An activity that supports this category must be prepared to run with
2827 * no UI shown at all (though in some case it may have a UI shown), and
2828 * rely on {@link android.app.VoiceInteractor} to interact with the user.
2829 */
2830 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2831 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2832 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002833 * Set if the activity should be considered as an alternative action to
2834 * the data the user is currently viewing. See also
2835 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2836 * applies to the selection in a list of items.
2837 *
2838 * <p>Supporting this category means that you would like your activity to be
2839 * displayed in the set of alternative things the user can do, usually as
2840 * part of the current activity's options menu. You will usually want to
2841 * include a specific label in the &lt;intent-filter&gt; of this action
2842 * describing to the user what it does.
2843 *
2844 * <p>The action of IntentFilter with this category is important in that it
2845 * describes the specific action the target will perform. This generally
2846 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2847 * a specific name such as "com.android.camera.action.CROP. Only one
2848 * alternative of any particular action will be shown to the user, so using
2849 * a specific action like this makes sure that your alternative will be
2850 * displayed while also allowing other applications to provide their own
2851 * overrides of that particular action.
2852 */
2853 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2854 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2855 /**
2856 * Set if the activity should be considered as an alternative selection
2857 * action to the data the user has currently selected. This is like
2858 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2859 * of items from which the user can select, giving them alternatives to the
2860 * default action that will be performed on it.
2861 */
2862 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2863 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2864 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002865 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002866 */
2867 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2868 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2869 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002870 * Should be displayed in the top-level launcher.
2871 */
2872 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2873 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2874 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002875 * Indicates an activity optimized for Leanback mode, and that should
2876 * be displayed in the Leanback launcher.
2877 */
2878 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2879 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2880 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002881 * Provides information about the package it is in; typically used if
2882 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2883 * a front-door to the user without having to be shown in the all apps list.
2884 */
2885 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2886 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2887 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002888 * This is the home activity, that is the first activity that is displayed
2889 * when the device boots.
2890 */
2891 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2892 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2893 /**
2894 * This activity is a preference panel.
2895 */
2896 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2897 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2898 /**
2899 * This activity is a development preference panel.
2900 */
2901 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2902 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2903 /**
2904 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002905 */
2906 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2907 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2908 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002909 * This activity allows the user to browse and download new applications.
2910 */
2911 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2912 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2913 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002914 * This activity may be exercised by the monkey or other automated test tools.
2915 */
2916 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2917 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2918 /**
2919 * To be used as a test (not part of the normal user experience).
2920 */
2921 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2922 /**
2923 * To be used as a unit test (run through the Test Harness).
2924 */
2925 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2926 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002927 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002928 * experience).
2929 */
2930 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002931
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002932 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002933 * Used to indicate that an intent only wants URIs that can be opened with
2934 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2935 * must support at least the columns defined in {@link OpenableColumns} when
2936 * queried.
2937 *
2938 * @see #ACTION_GET_CONTENT
2939 * @see #ACTION_OPEN_DOCUMENT
2940 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002941 */
2942 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2943 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2944
2945 /**
2946 * To be used as code under test for framework instrumentation tests.
2947 */
2948 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2949 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002950 /**
2951 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002952 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2953 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002954 */
2955 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2956 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2957 /**
2958 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002959 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2960 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002961 */
2962 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2963 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002964 /**
2965 * An activity to run when device is inserted into a analog (low end) dock.
2966 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2967 * information, see {@link android.app.UiModeManager}.
2968 */
2969 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2970 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2971
2972 /**
2973 * An activity to run when device is inserted into a digital (high end) dock.
2974 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2975 * information, see {@link android.app.UiModeManager}.
2976 */
2977 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2978 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002979
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002980 /**
2981 * Used to indicate that the activity can be used in a car environment.
2982 */
2983 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2984 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2985
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002986 // ---------------------------------------------------------------------
2987 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002988 // Application launch intent categories (see addCategory()).
2989
2990 /**
2991 * Used with {@link #ACTION_MAIN} to launch the browser application.
2992 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002993 * <p>NOTE: This should not be used as the primary key of an Intent,
2994 * since it will not result in the app launching with the correct
2995 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002996 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002997 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002998 */
2999 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3000 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3001
3002 /**
3003 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3004 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003005 * <p>NOTE: This should not be used as the primary key of an Intent,
3006 * since it will not result in the app launching with the correct
3007 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003008 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003009 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003010 */
3011 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3012 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3013
3014 /**
3015 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3016 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003017 * <p>NOTE: This should not be used as the primary key of an Intent,
3018 * since it will not result in the app launching with the correct
3019 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003020 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003021 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003022 */
3023 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3024 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3025
3026 /**
3027 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3028 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003029 * <p>NOTE: This should not be used as the primary key of an Intent,
3030 * since it will not result in the app launching with the correct
3031 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003032 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003033 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003034 */
3035 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3036 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3037
3038 /**
3039 * Used with {@link #ACTION_MAIN} to launch the email application.
3040 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003041 * <p>NOTE: This should not be used as the primary key of an Intent,
3042 * since it will not result in the app launching with the correct
3043 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003044 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003045 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003046 */
3047 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3048 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3049
3050 /**
3051 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3052 * The activity should be able to view and manipulate image and video files
3053 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003054 * <p>NOTE: This should not be used as the primary key of an Intent,
3055 * since it will not result in the app launching with the correct
3056 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003057 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003058 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003059 */
3060 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3061 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3062
3063 /**
3064 * Used with {@link #ACTION_MAIN} to launch the maps application.
3065 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003066 * <p>NOTE: This should not be used as the primary key of an Intent,
3067 * since it will not result in the app launching with the correct
3068 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003069 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003070 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003071 */
3072 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3073 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3074
3075 /**
3076 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3077 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003078 * <p>NOTE: This should not be used as the primary key of an Intent,
3079 * since it will not result in the app launching with the correct
3080 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003081 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003082 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003083 */
3084 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3085 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3086
3087 /**
3088 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003089 * The activity should be able to play, browse, or manipulate music files
3090 * stored on the device.
3091 * <p>NOTE: This should not be used as the primary key of an Intent,
3092 * since it will not result in the app launching with the correct
3093 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003094 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003095 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003096 */
3097 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3098 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3099
3100 // ---------------------------------------------------------------------
3101 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003102 // Standard extra data keys.
3103
3104 /**
3105 * The initial data to place in a newly created record. Use with
3106 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3107 * fields as would be given to the underlying ContentProvider.insert()
3108 * call.
3109 */
3110 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3111
3112 /**
3113 * A constant CharSequence that is associated with the Intent, used with
3114 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3115 * this may be a styled CharSequence, so you must use
3116 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3117 * retrieve it.
3118 */
3119 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3120
3121 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003122 * A constant String that is associated with the Intent, used with
3123 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3124 * as HTML formatted text. Note that you <em>must</em> also supply
3125 * {@link #EXTRA_TEXT}.
3126 */
3127 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3128
3129 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003130 * A content: URI holding a stream of data associated with the Intent,
3131 * used with {@link #ACTION_SEND} to supply the data being sent.
3132 */
3133 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3134
3135 /**
3136 * A String[] holding e-mail addresses that should be delivered to.
3137 */
3138 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3139
3140 /**
3141 * A String[] holding e-mail addresses that should be carbon copied.
3142 */
3143 public static final String EXTRA_CC = "android.intent.extra.CC";
3144
3145 /**
3146 * A String[] holding e-mail addresses that should be blind carbon copied.
3147 */
3148 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3149
3150 /**
3151 * A constant string holding the desired subject line of a message.
3152 */
3153 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3154
3155 /**
3156 * An Intent describing the choices you would like shown with
3157 * {@link #ACTION_PICK_ACTIVITY}.
3158 */
3159 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3160
3161 /**
3162 * A CharSequence dialog title to provide to the user when used with a
3163 * {@link #ACTION_CHOOSER}.
3164 */
3165 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3166
3167 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003168 * A Parcelable[] of {@link Intent} or
3169 * {@link android.content.pm.LabeledIntent} objects as set with
3170 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3171 * a the front of the list of choices, when shown to the user with a
3172 * {@link #ACTION_CHOOSER}.
3173 */
3174 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3175
3176 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003177 * A {@link android.view.KeyEvent} object containing the event that
3178 * triggered the creation of the Intent it is in.
3179 */
3180 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3181
3182 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003183 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3184 * before shutting down.
3185 *
3186 * {@hide}
3187 */
3188 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3189
3190 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003191 * 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 -07003192 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3193 * of restarting the application.
3194 */
3195 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3196
3197 /**
3198 * A String holding the phone number originally entered in
3199 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3200 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3201 */
3202 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003203
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003204 /**
3205 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3206 * intents to supply the uid the package had been assigned. Also an optional
3207 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3208 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3209 * purpose.
3210 */
3211 public static final String EXTRA_UID = "android.intent.extra.UID";
3212
3213 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003214 * @hide String array of package names.
3215 */
3216 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3217
3218 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003219 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3220 * intents to indicate whether this represents a full uninstall (removing
3221 * both the code and its data) or a partial uninstall (leaving its data,
3222 * implying that this is an update).
3223 */
3224 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003225
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003226 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003227 * @hide
3228 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3229 * intents to indicate that at this point the package has been removed for
3230 * all users on the device.
3231 */
3232 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3233 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3234
3235 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003236 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3237 * intents to indicate that this is a replacement of the package, so this
3238 * broadcast will immediately be followed by an add broadcast for a
3239 * different version of the same package.
3240 */
3241 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003242
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003243 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003244 * Used as an int extra field in {@link android.app.AlarmManager} intents
3245 * to tell the application being invoked how many pending alarms are being
3246 * delievered with the intent. For one-shot alarms this will always be 1.
3247 * For recurring alarms, this might be greater than 1 if the device was
3248 * asleep or powered off at the time an earlier alarm would have been
3249 * delivered.
3250 */
3251 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003252
Jacek Surazski86b6c532009-05-13 14:38:28 +02003253 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003254 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3255 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003256 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3257 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003258 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3259 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3260 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003261 */
3262 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3263
3264 /**
3265 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3266 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003267 */
3268 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3269
3270 /**
3271 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3272 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003273 */
3274 public static final int EXTRA_DOCK_STATE_DESK = 1;
3275
3276 /**
3277 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3278 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003279 */
3280 public static final int EXTRA_DOCK_STATE_CAR = 2;
3281
3282 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003283 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3284 * to represent that the phone is in a analog (low end) dock.
3285 */
3286 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3287
3288 /**
3289 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3290 * to represent that the phone is in a digital (high end) dock.
3291 */
3292 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3293
3294 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003295 * Boolean that can be supplied as meta-data with a dock activity, to
3296 * indicate that the dock should take over the home key when it is active.
3297 */
3298 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003299
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003300 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003301 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3302 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003303 */
3304 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3305
3306 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003307 * Used in the extra field in the remote intent. It's astring token passed with the
3308 * remote intent.
3309 */
3310 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3311 "android.intent.extra.remote_intent_token";
3312
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003313 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003314 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003315 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003316 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003317 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003318 "android.intent.extra.changed_component_name";
3319
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003320 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003321 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003322 * and contains a string array of all of the components that have changed. If
3323 * the state of the overall package has changed, then it will contain an entry
3324 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003325 */
3326 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3327 "android.intent.extra.changed_component_name_list";
3328
3329 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003330 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003331 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3332 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003333 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003334 */
3335 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3336 "android.intent.extra.changed_package_list";
3337
3338 /**
3339 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003340 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3341 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003342 * and contains an integer array of uids of all of the components
3343 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003344 */
3345 public static final String EXTRA_CHANGED_UID_LIST =
3346 "android.intent.extra.changed_uid_list";
3347
3348 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003349 * @hide
3350 * Magic extra system code can use when binding, to give a label for
3351 * who it is that has bound to a service. This is an integer giving
3352 * a framework string resource that can be displayed to the user.
3353 */
3354 public static final String EXTRA_CLIENT_LABEL =
3355 "android.intent.extra.client_label";
3356
3357 /**
3358 * @hide
3359 * Magic extra system code can use when binding, to give a PendingIntent object
3360 * that can be launched for the user to disable the system's use of this
3361 * service.
3362 */
3363 public static final String EXTRA_CLIENT_INTENT =
3364 "android.intent.extra.client_intent";
3365
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003366 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003367 * Extra used to indicate that an intent should only return data that is on
3368 * the local device. This is a boolean extra; the default is false. If true,
3369 * an implementation should only allow the user to select data that is
3370 * already on the device, not requiring it be downloaded from a remote
3371 * service when opened.
3372 *
3373 * @see #ACTION_GET_CONTENT
3374 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003375 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003376 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003377 */
3378 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003379 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003380
Amith Yamasani13593602012-03-22 16:16:17 -07003381 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003382 * Extra used to indicate that an intent can allow the user to select and
3383 * return multiple items. This is a boolean extra; the default is false. If
3384 * true, an implementation is allowed to present the user with a UI where
3385 * they can pick multiple items that are all returned to the caller. When
3386 * this happens, they should be returned as the {@link #getClipData()} part
3387 * of the result Intent.
3388 *
3389 * @see #ACTION_GET_CONTENT
3390 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003391 */
3392 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003393 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003394
3395 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003396 * The integer userHandle carried with broadcast intents related to addition, removal and
3397 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3398 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3399 *
Amith Yamasani13593602012-03-22 16:16:17 -07003400 * @hide
3401 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003402 public static final String EXTRA_USER_HANDLE =
3403 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003404
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003405 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003406 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3407 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3408 */
3409 public static final String EXTRA_USER =
3410 "android.intent.extra.user";
3411
3412 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003413 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003414 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3415 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003416 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003417 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3418
3419 /**
3420 * Extra sent in the intent to the BroadcastReceiver that handles
3421 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3422 * the restrictions as key/value pairs.
3423 */
3424 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3425 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003426
Amith Yamasani86118ba2013-03-28 14:33:16 -07003427 /**
3428 * Extra used in the response from a BroadcastReceiver that handles
3429 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3430 */
3431 public static final String EXTRA_RESTRICTIONS_INTENT =
3432 "android.intent.extra.restrictions_intent";
3433
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003434 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003435 * Extra used to communicate a set of acceptable MIME types. The type of the
3436 * extra is {@code String[]}. Values may be a combination of concrete MIME
3437 * types (such as "image/png") and/or partial MIME types (such as
3438 * "audio/*").
3439 *
3440 * @see #ACTION_GET_CONTENT
3441 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003442 */
3443 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3444
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003445 /**
3446 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3447 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003448 * When this is true, hardware devices can use this information to determine that
3449 * they shouldn't do a complete shutdown of their device since this is not a
3450 * complete shutdown down to the kernel, but only user space restarting.
3451 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003452 */
3453 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3454 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3455
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003456 /**
3457 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3458 * user has set their time format preferences to the 24 hour format.
3459 *
3460 * @hide for internal use only.
3461 */
3462 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3463 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3464
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003465 // ---------------------------------------------------------------------
3466 // ---------------------------------------------------------------------
3467 // Intent flags (see mFlags variable).
3468
Tor Norbyed9273d62013-05-30 15:59:53 -07003469 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003470 @IntDef(flag = true, value = {
3471 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3472 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003473 @Retention(RetentionPolicy.SOURCE)
3474 public @interface GrantUriMode {}
3475
Jeff Sharkey846318a2014-04-04 12:12:41 -07003476 /** @hide */
3477 @IntDef(flag = true, value = {
3478 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3479 @Retention(RetentionPolicy.SOURCE)
3480 public @interface AccessUriMode {}
3481
3482 /**
3483 * Test if given mode flags specify an access mode, which must be at least
3484 * read and/or write.
3485 *
3486 * @hide
3487 */
3488 public static boolean isAccessUriMode(int modeFlags) {
3489 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3490 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3491 }
3492
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003493 /**
3494 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003495 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003496 * specified in its ClipData. When applying to an Intent's ClipData,
3497 * all URIs as well as recursive traversals through data or other ClipData
3498 * in Intent items will be granted; only the grant flags of the top-level
3499 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003500 */
3501 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3502 /**
3503 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003504 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003505 * specified in its ClipData. When applying to an Intent's ClipData,
3506 * all URIs as well as recursive traversals through data or other ClipData
3507 * in Intent items will be granted; only the grant flags of the top-level
3508 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003509 */
3510 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3511 /**
3512 * Can be set by the caller to indicate that this Intent is coming from
3513 * a background operation, not from direct user interaction.
3514 */
3515 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3516 /**
3517 * A flag you can enable for debugging: when set, log messages will be
3518 * printed during the resolution of this intent to show you what has
3519 * been found to create the final resolved list.
3520 */
3521 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003522 /**
3523 * If set, this intent will not match any components in packages that
3524 * are currently stopped. If this is not set, then the default behavior
3525 * is to include such applications in the result.
3526 */
3527 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3528 /**
3529 * If set, this intent will always match any components in packages that
3530 * are currently stopped. This is the default behavior when
3531 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3532 * flags are set, this one wins (it allows overriding of exclude for
3533 * places where the framework may automatically set the exclude flag).
3534 */
3535 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003536
3537 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003538 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003539 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003540 * persisted across device reboots until explicitly revoked with
3541 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3542 * grant for possible persisting; the receiving application must call
3543 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3544 * actually persist.
3545 *
3546 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3547 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3548 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003549 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003550 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003551 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003552
3553 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003554 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3555 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3556 * applies to any URI that is a prefix match against the original granted
3557 * URI. (Without this flag, the URI must match exactly for access to be
3558 * granted.) Another URI is considered a prefix match only when scheme,
3559 * authority, and all path segments defined by the prefix are an exact
3560 * match.
3561 */
3562 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3563
3564 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003565 * If set, the new activity is not kept in the history stack. As soon as
3566 * the user navigates away from it, the activity is finished. This may also
3567 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3568 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003569 */
3570 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3571 /**
3572 * If set, the activity will not be launched if it is already running
3573 * at the top of the history stack.
3574 */
3575 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3576 /**
3577 * If set, this activity will become the start of a new task on this
3578 * history stack. A task (from the activity that started it to the
3579 * next task activity) defines an atomic group of activities that the
3580 * user can move to. Tasks can be moved to the foreground and background;
3581 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003582 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003583 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3584 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003585 *
3586 * <p>This flag is generally used by activities that want
3587 * to present a "launcher" style behavior: they give the user a list of
3588 * separate things that can be done, which otherwise run completely
3589 * independently of the activity launching them.
3590 *
3591 * <p>When using this flag, if a task is already running for the activity
3592 * you are now starting, then a new activity will not be started; instead,
3593 * the current task will simply be brought to the front of the screen with
3594 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3595 * to disable this behavior.
3596 *
3597 * <p>This flag can not be used when the caller is requesting a result from
3598 * the activity being launched.
3599 */
3600 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3601 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003602 * This flag is used to create a new task and launch an activity into it.
3603 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3604 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3605 * search through existing tasks for ones matching this Intent. Only if no such
3606 * task is found would a new task be created. When paired with
3607 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3608 * the search for a matching task and unconditionally start a new task.
3609 *
3610 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3611 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003612 * top-level application launcher.</strong> Used in conjunction with
3613 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3614 * behavior of bringing an existing task to the foreground. When set,
3615 * a new task is <em>always</em> started to host the Activity for the
3616 * Intent, regardless of whether there is already an existing task running
3617 * the same thing.
3618 *
3619 * <p><strong>Because the default system does not include graphical task management,
3620 * you should not use this flag unless you provide some way for a user to
3621 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003622 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003623 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3624 * creating new document tasks.
3625 *
3626 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
3627 * {@link #FLAG_ACTIVITY_NEW_TASK} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003628 *
Scott Main7aee61f2011-02-08 11:25:01 -08003629 * <p>See
3630 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3631 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003632 *
3633 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3634 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003635 */
3636 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3637 /**
3638 * If set, and the activity being launched is already running in the
3639 * current task, then instead of launching a new instance of that activity,
3640 * all of the other activities on top of it will be closed and this Intent
3641 * will be delivered to the (now on top) old activity as a new Intent.
3642 *
3643 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3644 * If D calls startActivity() with an Intent that resolves to the component
3645 * of activity B, then C and D will be finished and B receive the given
3646 * Intent, resulting in the stack now being: A, B.
3647 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003648 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003649 * either receive the new intent you are starting here in its
3650 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003651 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003652 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3653 * the same intent, then it will be finished and re-created; for all other
3654 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3655 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003656 *
3657 * <p>This launch mode can also be used to good effect in conjunction with
3658 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3659 * of a task, it will bring any currently running instance of that task
3660 * to the foreground, and then clear it to its root state. This is
3661 * especially useful, for example, when launching an activity from the
3662 * notification manager.
3663 *
Scott Main7aee61f2011-02-08 11:25:01 -08003664 * <p>See
3665 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3666 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003667 */
3668 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3669 /**
3670 * If set and this intent is being used to launch a new activity from an
3671 * existing one, then the reply target of the existing activity will be
3672 * transfered to the new activity. This way the new activity can call
3673 * {@link android.app.Activity#setResult} and have that result sent back to
3674 * the reply target of the original activity.
3675 */
3676 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3677 /**
3678 * If set and this intent is being used to launch a new activity from an
3679 * existing one, the current activity will not be counted as the top
3680 * activity for deciding whether the new intent should be delivered to
3681 * the top instead of starting a new one. The previous activity will
3682 * be used as the top, with the assumption being that the current activity
3683 * will finish itself immediately.
3684 */
3685 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3686 /**
3687 * If set, the new activity is not kept in the list of recently launched
3688 * activities.
3689 */
3690 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3691 /**
3692 * This flag is not normally set by application code, but set for you by
3693 * the system as described in the
3694 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3695 * launchMode} documentation for the singleTask mode.
3696 */
3697 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3698 /**
3699 * If set, and this activity is either being started in a new task or
3700 * bringing to the top an existing task, then it will be launched as
3701 * the front door of the task. This will result in the application of
3702 * any affinities needed to have that task in the proper state (either
3703 * moving activities to or from it), or simply resetting that task to
3704 * its initial state if needed.
3705 */
3706 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3707 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003708 * This flag is not normally set by application code, but set for you by
3709 * the system if this activity is being launched from history
3710 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003711 */
3712 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003713 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003714 * @deprecated As of API 21 this performs identically to
3715 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003716 */
3717 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003718 /**
Craig Mautner026596b2014-05-21 15:35:44 -07003719 * This flag is used to open a document into a new task rooted at the activity launched
3720 * by this Intent. Through the use of this flag, or its equivalent attribute,
3721 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
3722 * containing different douments will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003723 *
Craig Mautner026596b2014-05-21 15:35:44 -07003724 * <p>The use of the activity attribute form of this,
3725 * {@link android.R.attr#documentLaunchMode}, is
3726 * preferred over the Intent flag described here. The attribute form allows the
3727 * Activity to specify multiple document behavior for all launchers of the Activity
3728 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003729 *
Craig Mautner026596b2014-05-21 15:35:44 -07003730 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
3731 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
3732 * equivalent of the Activity manifest specifying {@link
3733 * android.R.attr#documentLaunchMode}="intoExisting". When used with
3734 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
3735 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07003736 *
Craig Mautner026596b2014-05-21 15:35:44 -07003737 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003738 *
Craig Mautner026596b2014-05-21 15:35:44 -07003739 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07003740 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3741 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003742 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07003743 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003744 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003745 * callback from occurring on the current frontmost activity before it is
3746 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003747 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003748 * <p>Typically, an activity can rely on that callback to indicate that an
3749 * explicit user action has caused their activity to be moved out of the
3750 * foreground. The callback marks an appropriate point in the activity's
3751 * lifecycle for it to dismiss any notifications that it intends to display
3752 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003753 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003754 * <p>If an activity is ever started via any non-user-driven events such as
3755 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3756 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003757 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003758 */
3759 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003760 /**
3761 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3762 * this flag will cause the launched activity to be brought to the front of its
3763 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003764 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003765 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3766 * If D calls startActivity() with an Intent that resolves to the component
3767 * of activity B, then B will be brought to the front of the history stack,
3768 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003769 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003770 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003771 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003772 */
3773 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003774 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003775 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3776 * this flag will prevent the system from applying an activity transition
3777 * animation to go to the next activity state. This doesn't mean an
3778 * animation will never run -- if another activity change happens that doesn't
3779 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003780 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003781 * when you are going to do a series of activity operations but the
3782 * animation seen by the user shouldn't be driven by the first activity
3783 * change but rather a later one.
3784 */
3785 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3786 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003787 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3788 * this flag will cause any existing task that would be associated with the
3789 * activity to be cleared before the activity is started. That is, the activity
3790 * becomes the new root of an otherwise empty task, and any old activities
3791 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3792 */
3793 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3794 /**
3795 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3796 * this flag will cause a newly launching task to be placed on top of the current
3797 * home activity task (if there is one). That is, pressing back from the task
3798 * will always return the user to home even if that was not the last activity they
3799 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3800 */
3801 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3802 /**
Craig Mautner2dac0562014-05-06 09:06:44 -07003803 * If set and the new activity is the root of a new task, then the task
3804 * will remain in the list of recently launched tasks only until all of
3805 * the activities in it are finished.
3806 *
3807 * <p>This is equivalent to the attribute
3808 * {@link android.R.styleable#AndroidManifestActivity_autoRemoveFromRecents}.
3809 */
3810 public static final int FLAG_ACTIVITY_AUTO_REMOVE_FROM_RECENTS = 0x00002000;
3811 /**
Craig Mautnera228ae92014-07-09 05:44:55 -07003812 * If set along with FLAG_ACTIVITY_NEW_DOCUMENT then the task being launched will not be
3813 * presented to the user but will instead be only available through the recents task list.
3814 * In addition, the new task wil be affiliated with the launching activity's task.
3815 * Affiliated tasks are grouped together in the recents task list.
3816 *
3817 * <p>This behavior is not supported for activities with {@link
3818 * android.R.styleable#AndroidManifestActivity_launchMode launchMode} values of
3819 * <code>singleInstance</code> or <code>singleTask</code>.
3820 */
3821 public static final int FLAG_ACTIVITY_LAUNCH_BEHIND = 0x00001000;
3822
3823 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003824 * If set, when sending a broadcast only registered receivers will be
3825 * called -- no BroadcastReceiver components will be launched.
3826 */
3827 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003828 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003829 * If set, when sending a broadcast the new broadcast will replace
3830 * any existing pending broadcast that matches it. Matching is defined
3831 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3832 * true for the intents of the two broadcasts. When a match is found,
3833 * the new broadcast (and receivers associated with it) will replace the
3834 * existing one in the pending broadcast list, remaining at the same
3835 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003836 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003837 * <p>This flag is most typically used with sticky broadcasts, which
3838 * only care about delivering the most recent values of the broadcast
3839 * to their receivers.
3840 */
3841 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3842 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003843 * If set, when sending a broadcast the recipient is allowed to run at
3844 * foreground priority, with a shorter timeout interval. During normal
3845 * broadcasts the receivers are not automatically hoisted out of the
3846 * background priority class.
3847 */
3848 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3849 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003850 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3851 * They can still propagate results through to later receivers, but they can not prevent
3852 * later receivers from seeing the broadcast.
3853 */
3854 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3855 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003856 * If set, when sending a broadcast <i>before boot has completed</i> only
3857 * registered receivers will be called -- no BroadcastReceiver components
3858 * will be launched. Sticky intent state will be recorded properly even
3859 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3860 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003861 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003862 * <p>This flag is only for use by system sevices as a convenience to
3863 * avoid having to implement a more complex mechanism around detection
3864 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003865 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003866 * @hide
3867 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003868 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003869 /**
3870 * Set when this broadcast is for a boot upgrade, a special mode that
3871 * allows the broadcast to be sent before the system is ready and launches
3872 * the app process with no providers running in it.
3873 * @hide
3874 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003875 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003876
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003877 /**
3878 * @hide Flags that can't be changed with PendingIntent.
3879 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003880 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
3881 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
3882 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003883
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003884 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003885 // ---------------------------------------------------------------------
3886 // toUri() and parseUri() options.
3887
3888 /**
3889 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3890 * always has the "intent:" scheme. This syntax can be used when you want
3891 * to later disambiguate between URIs that are intended to describe an
3892 * Intent vs. all others that should be treated as raw URIs. When used
3893 * with {@link #parseUri}, any other scheme will result in a generic
3894 * VIEW action for that raw URI.
3895 */
3896 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003897
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003898 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003899
3900 private String mAction;
3901 private Uri mData;
3902 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003903 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003904 private ComponentName mComponent;
3905 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003906 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003907 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003908 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003909 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003910 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003911
3912 // ---------------------------------------------------------------------
3913
3914 /**
3915 * Create an empty intent.
3916 */
3917 public Intent() {
3918 }
3919
3920 /**
3921 * Copy constructor.
3922 */
3923 public Intent(Intent o) {
3924 this.mAction = o.mAction;
3925 this.mData = o.mData;
3926 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003927 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003928 this.mComponent = o.mComponent;
3929 this.mFlags = o.mFlags;
3930 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003931 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003932 }
3933 if (o.mExtras != null) {
3934 this.mExtras = new Bundle(o.mExtras);
3935 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003936 if (o.mSourceBounds != null) {
3937 this.mSourceBounds = new Rect(o.mSourceBounds);
3938 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003939 if (o.mSelector != null) {
3940 this.mSelector = new Intent(o.mSelector);
3941 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003942 if (o.mClipData != null) {
3943 this.mClipData = new ClipData(o.mClipData);
3944 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003945 }
3946
3947 @Override
3948 public Object clone() {
3949 return new Intent(this);
3950 }
3951
3952 private Intent(Intent o, boolean all) {
3953 this.mAction = o.mAction;
3954 this.mData = o.mData;
3955 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003956 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003957 this.mComponent = o.mComponent;
3958 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003959 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003960 }
3961 }
3962
3963 /**
3964 * Make a clone of only the parts of the Intent that are relevant for
3965 * filter matching: the action, data, type, component, and categories.
3966 */
3967 public Intent cloneFilter() {
3968 return new Intent(this, false);
3969 }
3970
3971 /**
3972 * Create an intent with a given action. All other fields (data, type,
3973 * class) are null. Note that the action <em>must</em> be in a
3974 * namespace because Intents are used globally in the system -- for
3975 * example the system VIEW action is android.intent.action.VIEW; an
3976 * application's custom action would be something like
3977 * com.google.app.myapp.CUSTOM_ACTION.
3978 *
3979 * @param action The Intent action, such as ACTION_VIEW.
3980 */
3981 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003982 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003983 }
3984
3985 /**
3986 * Create an intent with a given action and for a given data url. Note
3987 * that the action <em>must</em> be in a namespace because Intents are
3988 * used globally in the system -- for example the system VIEW action is
3989 * android.intent.action.VIEW; an application's custom action would be
3990 * something like com.google.app.myapp.CUSTOM_ACTION.
3991 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003992 * <p><em>Note: scheme and host name matching in the Android framework is
3993 * case-sensitive, unlike the formal RFC. As a result,
3994 * you should always ensure that you write your Uri with these elements
3995 * using lower case letters, and normalize any Uris you receive from
3996 * outside of Android to ensure the scheme and host is lower case.</em></p>
3997 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003998 * @param action The Intent action, such as ACTION_VIEW.
3999 * @param uri The Intent data URI.
4000 */
4001 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004002 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004003 mData = uri;
4004 }
4005
4006 /**
4007 * Create an intent for a specific component. All other fields (action, data,
4008 * type, class) are null, though they can be modified later with explicit
4009 * calls. This provides a convenient way to create an intent that is
4010 * intended to execute a hard-coded class name, rather than relying on the
4011 * system to find an appropriate class for you; see {@link #setComponent}
4012 * for more information on the repercussions of this.
4013 *
4014 * @param packageContext A Context of the application package implementing
4015 * this class.
4016 * @param cls The component class that is to be used for the intent.
4017 *
4018 * @see #setClass
4019 * @see #setComponent
4020 * @see #Intent(String, android.net.Uri , Context, Class)
4021 */
4022 public Intent(Context packageContext, Class<?> cls) {
4023 mComponent = new ComponentName(packageContext, cls);
4024 }
4025
4026 /**
4027 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004028 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004029 * construct the Intent and then calling {@link #setClass} to set its
4030 * class.
4031 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004032 * <p><em>Note: scheme and host name matching in the Android framework is
4033 * case-sensitive, unlike the formal RFC. As a result,
4034 * you should always ensure that you write your Uri with these elements
4035 * using lower case letters, and normalize any Uris you receive from
4036 * outside of Android to ensure the scheme and host is lower case.</em></p>
4037 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004038 * @param action The Intent action, such as ACTION_VIEW.
4039 * @param uri The Intent data URI.
4040 * @param packageContext A Context of the application package implementing
4041 * this class.
4042 * @param cls The component class that is to be used for the intent.
4043 *
4044 * @see #Intent(String, android.net.Uri)
4045 * @see #Intent(Context, Class)
4046 * @see #setClass
4047 * @see #setComponent
4048 */
4049 public Intent(String action, Uri uri,
4050 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004051 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004052 mData = uri;
4053 mComponent = new ComponentName(packageContext, cls);
4054 }
4055
4056 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004057 * Create an intent to launch the main (root) activity of a task. This
4058 * is the Intent that is started when the application's is launched from
4059 * Home. For anything else that wants to launch an application in the
4060 * same way, it is important that they use an Intent structured the same
4061 * way, and can use this function to ensure this is the case.
4062 *
4063 * <p>The returned Intent has the given Activity component as its explicit
4064 * component, {@link #ACTION_MAIN} as its action, and includes the
4065 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4066 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4067 * to do that through {@link #addFlags(int)} on the returned Intent.
4068 *
4069 * @param mainActivity The main activity component that this Intent will
4070 * launch.
4071 * @return Returns a newly created Intent that can be used to launch the
4072 * activity as a main application entry.
4073 *
4074 * @see #setClass
4075 * @see #setComponent
4076 */
4077 public static Intent makeMainActivity(ComponentName mainActivity) {
4078 Intent intent = new Intent(ACTION_MAIN);
4079 intent.setComponent(mainActivity);
4080 intent.addCategory(CATEGORY_LAUNCHER);
4081 return intent;
4082 }
4083
4084 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004085 * Make an Intent for the main activity of an application, without
4086 * specifying a specific activity to run but giving a selector to find
4087 * the activity. This results in a final Intent that is structured
4088 * the same as when the application is launched from
4089 * Home. For anything else that wants to launch an application in the
4090 * same way, it is important that they use an Intent structured the same
4091 * way, and can use this function to ensure this is the case.
4092 *
4093 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4094 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4095 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4096 * to do that through {@link #addFlags(int)} on the returned Intent.
4097 *
4098 * @param selectorAction The action name of the Intent's selector.
4099 * @param selectorCategory The name of a category to add to the Intent's
4100 * selector.
4101 * @return Returns a newly created Intent that can be used to launch the
4102 * activity as a main application entry.
4103 *
4104 * @see #setSelector(Intent)
4105 */
4106 public static Intent makeMainSelectorActivity(String selectorAction,
4107 String selectorCategory) {
4108 Intent intent = new Intent(ACTION_MAIN);
4109 intent.addCategory(CATEGORY_LAUNCHER);
4110 Intent selector = new Intent();
4111 selector.setAction(selectorAction);
4112 selector.addCategory(selectorCategory);
4113 intent.setSelector(selector);
4114 return intent;
4115 }
4116
4117 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004118 * Make an Intent that can be used to re-launch an application's task
4119 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4120 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4121 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4122 *
4123 * @param mainActivity The activity component that is the root of the
4124 * task; this is the activity that has been published in the application's
4125 * manifest as the main launcher icon.
4126 *
4127 * @return Returns a newly created Intent that can be used to relaunch the
4128 * activity's task in its root state.
4129 */
4130 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4131 Intent intent = makeMainActivity(mainActivity);
4132 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4133 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4134 return intent;
4135 }
4136
4137 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004138 * Call {@link #parseUri} with 0 flags.
4139 * @deprecated Use {@link #parseUri} instead.
4140 */
4141 @Deprecated
4142 public static Intent getIntent(String uri) throws URISyntaxException {
4143 return parseUri(uri, 0);
4144 }
Tom Taylord4a47292009-12-21 13:59:18 -08004145
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004146 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004147 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004148 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004149 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004150 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004151 *
4152 * <p>The URI given here must not be relative -- that is, it must include
4153 * the scheme and full path.
4154 *
4155 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004156 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004157 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004158 *
4159 * @return Intent The newly created Intent object.
4160 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004161 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4162 * it bad (as parsed by the Uri class) or the Intent data within the
4163 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004164 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004165 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004166 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004167 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004168 int i = 0;
4169 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004170 // Validate intent scheme for if requested.
4171 if ((flags&URI_INTENT_SCHEME) != 0) {
4172 if (!uri.startsWith("intent:")) {
4173 Intent intent = new Intent(ACTION_VIEW);
4174 try {
4175 intent.setData(Uri.parse(uri));
4176 } catch (IllegalArgumentException e) {
4177 throw new URISyntaxException(uri, e.getMessage());
4178 }
4179 return intent;
4180 }
4181 }
Tom Taylord4a47292009-12-21 13:59:18 -08004182
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004183 // simple case
4184 i = uri.lastIndexOf("#");
4185 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4186
4187 // old format Intent URI
4188 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07004189
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004190 // new format
4191 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004192 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004193
4194 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004195 String data = i >= 0 ? uri.substring(0, i) : null;
4196 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004197 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07004198
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004199 // loop over contents of Intent, all name=value;
4200 while (!uri.startsWith("end", i)) {
4201 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004202 if (eq < 0) eq = i-1;
4203 int semi = uri.indexOf(';', i);
4204 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004205
4206 // action
4207 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004208 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004209 }
4210
4211 // categories
4212 else if (uri.startsWith("category=", i)) {
4213 intent.addCategory(value);
4214 }
4215
4216 // type
4217 else if (uri.startsWith("type=", i)) {
4218 intent.mType = value;
4219 }
4220
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004221 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004222 else if (uri.startsWith("launchFlags=", i)) {
4223 intent.mFlags = Integer.decode(value).intValue();
4224 }
4225
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004226 // package
4227 else if (uri.startsWith("package=", i)) {
4228 intent.mPackage = value;
4229 }
4230
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004231 // component
4232 else if (uri.startsWith("component=", i)) {
4233 intent.mComponent = ComponentName.unflattenFromString(value);
4234 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004235
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004236 // scheme
4237 else if (uri.startsWith("scheme=", i)) {
4238 scheme = value;
4239 }
4240
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004241 // source bounds
4242 else if (uri.startsWith("sourceBounds=", i)) {
4243 intent.mSourceBounds = Rect.unflattenFromString(value);
4244 }
4245
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004246 // selector
4247 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4248 intent = new Intent();
4249 }
4250
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004251 // extra
4252 else {
4253 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004254 // create Bundle if it doesn't already exist
4255 if (intent.mExtras == null) intent.mExtras = new Bundle();
4256 Bundle b = intent.mExtras;
4257 // add EXTRA
4258 if (uri.startsWith("S.", i)) b.putString(key, value);
4259 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4260 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4261 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4262 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4263 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4264 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4265 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4266 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4267 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4268 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004269
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004270 // move to the next item
4271 i = semi + 1;
4272 }
4273
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004274 if (intent != baseIntent) {
4275 // The Intent had a selector; fix it up.
4276 baseIntent.setSelector(intent);
4277 intent = baseIntent;
4278 }
4279
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004280 if (data != null) {
4281 if (data.startsWith("intent:")) {
4282 data = data.substring(7);
4283 if (scheme != null) {
4284 data = scheme + ':' + data;
4285 }
4286 }
Tom Taylord4a47292009-12-21 13:59:18 -08004287
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004288 if (data.length() > 0) {
4289 try {
4290 intent.mData = Uri.parse(data);
4291 } catch (IllegalArgumentException e) {
4292 throw new URISyntaxException(uri, e.getMessage());
4293 }
4294 }
4295 }
Tom Taylord4a47292009-12-21 13:59:18 -08004296
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004297 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004298
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004299 } catch (IndexOutOfBoundsException e) {
4300 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4301 }
4302 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004303
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004304 public static Intent getIntentOld(String uri) throws URISyntaxException {
4305 Intent intent;
4306
4307 int i = uri.lastIndexOf('#');
4308 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004309 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004310 final int intentFragmentStart = i;
4311 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004312
4313 i++;
4314
4315 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004316 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004317 i += 7;
4318 int j = uri.indexOf(')', i);
4319 action = uri.substring(i, j);
4320 i = j + 1;
4321 }
4322
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004323 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004324
4325 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004326 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004327 i += 11;
4328 int j = uri.indexOf(')', i);
4329 while (i < j) {
4330 int sep = uri.indexOf('!', i);
4331 if (sep < 0) sep = j;
4332 if (i < sep) {
4333 intent.addCategory(uri.substring(i, sep));
4334 }
4335 i = sep + 1;
4336 }
4337 i = j + 1;
4338 }
4339
4340 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004341 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004342 i += 5;
4343 int j = uri.indexOf(')', i);
4344 intent.mType = uri.substring(i, j);
4345 i = j + 1;
4346 }
4347
4348 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004349 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004350 i += 12;
4351 int j = uri.indexOf(')', i);
4352 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4353 i = j + 1;
4354 }
4355
4356 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004357 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004358 i += 10;
4359 int j = uri.indexOf(')', i);
4360 int sep = uri.indexOf('!', i);
4361 if (sep >= 0 && sep < j) {
4362 String pkg = uri.substring(i, sep);
4363 String cls = uri.substring(sep + 1, j);
4364 intent.mComponent = new ComponentName(pkg, cls);
4365 }
4366 i = j + 1;
4367 }
4368
4369 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004370 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004371 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004372
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004373 final int closeParen = uri.indexOf(')', i);
4374 if (closeParen == -1) throw new URISyntaxException(uri,
4375 "EXTRA missing trailing ')'", i);
4376
4377 while (i < closeParen) {
4378 // fetch the key value
4379 int j = uri.indexOf('=', i);
4380 if (j <= i + 1 || i >= closeParen) {
4381 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4382 }
4383 char type = uri.charAt(i);
4384 i++;
4385 String key = uri.substring(i, j);
4386 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004387
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004388 // get type-value
4389 j = uri.indexOf('!', i);
4390 if (j == -1 || j >= closeParen) j = closeParen;
4391 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4392 String value = uri.substring(i, j);
4393 i = j;
4394
4395 // create Bundle if it doesn't already exist
4396 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004397
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004398 // add item to bundle
4399 try {
4400 switch (type) {
4401 case 'S':
4402 intent.mExtras.putString(key, Uri.decode(value));
4403 break;
4404 case 'B':
4405 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4406 break;
4407 case 'b':
4408 intent.mExtras.putByte(key, Byte.parseByte(value));
4409 break;
4410 case 'c':
4411 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4412 break;
4413 case 'd':
4414 intent.mExtras.putDouble(key, Double.parseDouble(value));
4415 break;
4416 case 'f':
4417 intent.mExtras.putFloat(key, Float.parseFloat(value));
4418 break;
4419 case 'i':
4420 intent.mExtras.putInt(key, Integer.parseInt(value));
4421 break;
4422 case 'l':
4423 intent.mExtras.putLong(key, Long.parseLong(value));
4424 break;
4425 case 's':
4426 intent.mExtras.putShort(key, Short.parseShort(value));
4427 break;
4428 default:
4429 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4430 }
4431 } catch (NumberFormatException e) {
4432 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4433 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004434
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004435 char ch = uri.charAt(i);
4436 if (ch == ')') break;
4437 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4438 i++;
4439 }
4440 }
4441
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004442 if (isIntentFragment) {
4443 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4444 } else {
4445 intent.mData = Uri.parse(uri);
4446 }
Tom Taylord4a47292009-12-21 13:59:18 -08004447
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004448 if (intent.mAction == null) {
4449 // By default, if no action is specified, then use VIEW.
4450 intent.mAction = ACTION_VIEW;
4451 }
4452
4453 } else {
4454 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4455 }
4456
4457 return intent;
4458 }
4459
4460 /**
4461 * Retrieve the general action to be performed, such as
4462 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4463 * the information in the intent should be interpreted -- most importantly,
4464 * what to do with the data returned by {@link #getData}.
4465 *
4466 * @return The action of this intent or null if none is specified.
4467 *
4468 * @see #setAction
4469 */
4470 public String getAction() {
4471 return mAction;
4472 }
4473
4474 /**
4475 * Retrieve data this intent is operating on. This URI specifies the name
4476 * of the data; often it uses the content: scheme, specifying data in a
4477 * content provider. Other schemes may be handled by specific activities,
4478 * such as http: by the web browser.
4479 *
4480 * @return The URI of the data this intent is targeting or null.
4481 *
4482 * @see #getScheme
4483 * @see #setData
4484 */
4485 public Uri getData() {
4486 return mData;
4487 }
4488
4489 /**
4490 * The same as {@link #getData()}, but returns the URI as an encoded
4491 * String.
4492 */
4493 public String getDataString() {
4494 return mData != null ? mData.toString() : null;
4495 }
4496
4497 /**
4498 * Return the scheme portion of the intent's data. If the data is null or
4499 * does not include a scheme, null is returned. Otherwise, the scheme
4500 * prefix without the final ':' is returned, i.e. "http".
4501 *
4502 * <p>This is the same as calling getData().getScheme() (and checking for
4503 * null data).
4504 *
4505 * @return The scheme of this intent.
4506 *
4507 * @see #getData
4508 */
4509 public String getScheme() {
4510 return mData != null ? mData.getScheme() : null;
4511 }
4512
4513 /**
4514 * Retrieve any explicit MIME type included in the intent. This is usually
4515 * null, as the type is determined by the intent data.
4516 *
4517 * @return If a type was manually set, it is returned; else null is
4518 * returned.
4519 *
4520 * @see #resolveType(ContentResolver)
4521 * @see #setType
4522 */
4523 public String getType() {
4524 return mType;
4525 }
4526
4527 /**
4528 * Return the MIME data type of this intent. If the type field is
4529 * explicitly set, that is simply returned. Otherwise, if the data is set,
4530 * the type of that data is returned. If neither fields are set, a null is
4531 * returned.
4532 *
4533 * @return The MIME type of this intent.
4534 *
4535 * @see #getType
4536 * @see #resolveType(ContentResolver)
4537 */
4538 public String resolveType(Context context) {
4539 return resolveType(context.getContentResolver());
4540 }
4541
4542 /**
4543 * Return the MIME data type of this intent. If the type field is
4544 * explicitly set, that is simply returned. Otherwise, if the data is set,
4545 * the type of that data is returned. If neither fields are set, a null is
4546 * returned.
4547 *
4548 * @param resolver A ContentResolver that can be used to determine the MIME
4549 * type of the intent's data.
4550 *
4551 * @return The MIME type of this intent.
4552 *
4553 * @see #getType
4554 * @see #resolveType(Context)
4555 */
4556 public String resolveType(ContentResolver resolver) {
4557 if (mType != null) {
4558 return mType;
4559 }
4560 if (mData != null) {
4561 if ("content".equals(mData.getScheme())) {
4562 return resolver.getType(mData);
4563 }
4564 }
4565 return null;
4566 }
4567
4568 /**
4569 * Return the MIME data type of this intent, only if it will be needed for
4570 * intent resolution. This is not generally useful for application code;
4571 * it is used by the frameworks for communicating with back-end system
4572 * services.
4573 *
4574 * @param resolver A ContentResolver that can be used to determine the MIME
4575 * type of the intent's data.
4576 *
4577 * @return The MIME type of this intent, or null if it is unknown or not
4578 * needed.
4579 */
4580 public String resolveTypeIfNeeded(ContentResolver resolver) {
4581 if (mComponent != null) {
4582 return mType;
4583 }
4584 return resolveType(resolver);
4585 }
4586
4587 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004588 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004589 *
4590 * @param category The category to check.
4591 *
4592 * @return boolean True if the intent contains the category, else false.
4593 *
4594 * @see #getCategories
4595 * @see #addCategory
4596 */
4597 public boolean hasCategory(String category) {
4598 return mCategories != null && mCategories.contains(category);
4599 }
4600
4601 /**
4602 * Return the set of all categories in the intent. If there are no categories,
4603 * returns NULL.
4604 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004605 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004606 *
4607 * @see #hasCategory
4608 * @see #addCategory
4609 */
4610 public Set<String> getCategories() {
4611 return mCategories;
4612 }
4613
4614 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004615 * Return the specific selector associated with this Intent. If there is
4616 * none, returns null. See {@link #setSelector} for more information.
4617 *
4618 * @see #setSelector
4619 */
4620 public Intent getSelector() {
4621 return mSelector;
4622 }
4623
4624 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004625 * Return the {@link ClipData} associated with this Intent. If there is
4626 * none, returns null. See {@link #setClipData} for more information.
4627 *
John Spurlock125d1332013-11-25 11:58:37 -05004628 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004629 */
4630 public ClipData getClipData() {
4631 return mClipData;
4632 }
4633
4634 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004635 * Sets the ClassLoader that will be used when unmarshalling
4636 * any Parcelable values from the extras of this Intent.
4637 *
4638 * @param loader a ClassLoader, or null to use the default loader
4639 * at the time of unmarshalling.
4640 */
4641 public void setExtrasClassLoader(ClassLoader loader) {
4642 if (mExtras != null) {
4643 mExtras.setClassLoader(loader);
4644 }
4645 }
4646
4647 /**
4648 * Returns true if an extra value is associated with the given name.
4649 * @param name the extra's name
4650 * @return true if the given extra is present.
4651 */
4652 public boolean hasExtra(String name) {
4653 return mExtras != null && mExtras.containsKey(name);
4654 }
4655
4656 /**
4657 * Returns true if the Intent's extras contain a parcelled file descriptor.
4658 * @return true if the Intent contains a parcelled file descriptor.
4659 */
4660 public boolean hasFileDescriptors() {
4661 return mExtras != null && mExtras.hasFileDescriptors();
4662 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004663
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004664 /** @hide */
4665 public void setAllowFds(boolean allowFds) {
4666 if (mExtras != null) {
4667 mExtras.setAllowFds(allowFds);
4668 }
4669 }
4670
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004671 /**
4672 * Retrieve extended data from the intent.
4673 *
4674 * @param name The name of the desired item.
4675 *
4676 * @return the value of an item that previously added with putExtra()
4677 * or null if none was found.
4678 *
4679 * @deprecated
4680 * @hide
4681 */
4682 @Deprecated
4683 public Object getExtra(String name) {
4684 return getExtra(name, null);
4685 }
4686
4687 /**
4688 * Retrieve extended data from the intent.
4689 *
4690 * @param name The name of the desired item.
4691 * @param defaultValue the value to be returned if no value of the desired
4692 * type is stored with the given name.
4693 *
4694 * @return the value of an item that previously added with putExtra()
4695 * or the default value if none was found.
4696 *
4697 * @see #putExtra(String, boolean)
4698 */
4699 public boolean getBooleanExtra(String name, boolean defaultValue) {
4700 return mExtras == null ? defaultValue :
4701 mExtras.getBoolean(name, defaultValue);
4702 }
4703
4704 /**
4705 * Retrieve extended data from the intent.
4706 *
4707 * @param name The name of the desired item.
4708 * @param defaultValue the value to be returned if no value of the desired
4709 * type is stored with the given name.
4710 *
4711 * @return the value of an item that previously added with putExtra()
4712 * or the default value if none was found.
4713 *
4714 * @see #putExtra(String, byte)
4715 */
4716 public byte getByteExtra(String name, byte defaultValue) {
4717 return mExtras == null ? defaultValue :
4718 mExtras.getByte(name, defaultValue);
4719 }
4720
4721 /**
4722 * Retrieve extended data from the intent.
4723 *
4724 * @param name The name of the desired item.
4725 * @param defaultValue the value to be returned if no value of the desired
4726 * type is stored with the given name.
4727 *
4728 * @return the value of an item that previously added with putExtra()
4729 * or the default value if none was found.
4730 *
4731 * @see #putExtra(String, short)
4732 */
4733 public short getShortExtra(String name, short defaultValue) {
4734 return mExtras == null ? defaultValue :
4735 mExtras.getShort(name, defaultValue);
4736 }
4737
4738 /**
4739 * Retrieve extended data from the intent.
4740 *
4741 * @param name The name of the desired item.
4742 * @param defaultValue the value to be returned if no value of the desired
4743 * type is stored with the given name.
4744 *
4745 * @return the value of an item that previously added with putExtra()
4746 * or the default value if none was found.
4747 *
4748 * @see #putExtra(String, char)
4749 */
4750 public char getCharExtra(String name, char defaultValue) {
4751 return mExtras == null ? defaultValue :
4752 mExtras.getChar(name, defaultValue);
4753 }
4754
4755 /**
4756 * Retrieve extended data from the intent.
4757 *
4758 * @param name The name of the desired item.
4759 * @param defaultValue the value to be returned if no value of the desired
4760 * type is stored with the given name.
4761 *
4762 * @return the value of an item that previously added with putExtra()
4763 * or the default value if none was found.
4764 *
4765 * @see #putExtra(String, int)
4766 */
4767 public int getIntExtra(String name, int defaultValue) {
4768 return mExtras == null ? defaultValue :
4769 mExtras.getInt(name, defaultValue);
4770 }
4771
4772 /**
4773 * Retrieve extended data from the intent.
4774 *
4775 * @param name The name of the desired item.
4776 * @param defaultValue the value to be returned if no value of the desired
4777 * type is stored with the given name.
4778 *
4779 * @return the value of an item that previously added with putExtra()
4780 * or the default value if none was found.
4781 *
4782 * @see #putExtra(String, long)
4783 */
4784 public long getLongExtra(String name, long defaultValue) {
4785 return mExtras == null ? defaultValue :
4786 mExtras.getLong(name, defaultValue);
4787 }
4788
4789 /**
4790 * Retrieve extended data from the intent.
4791 *
4792 * @param name The name of the desired item.
4793 * @param defaultValue the value to be returned if no value of the desired
4794 * type is stored with the given name.
4795 *
4796 * @return the value of an item that previously added with putExtra(),
4797 * or the default value if no such item is present
4798 *
4799 * @see #putExtra(String, float)
4800 */
4801 public float getFloatExtra(String name, float defaultValue) {
4802 return mExtras == null ? defaultValue :
4803 mExtras.getFloat(name, defaultValue);
4804 }
4805
4806 /**
4807 * Retrieve extended data from the intent.
4808 *
4809 * @param name The name of the desired item.
4810 * @param defaultValue the value to be returned if no value of the desired
4811 * type is stored with the given name.
4812 *
4813 * @return the value of an item that previously added with putExtra()
4814 * or the default value if none was found.
4815 *
4816 * @see #putExtra(String, double)
4817 */
4818 public double getDoubleExtra(String name, double defaultValue) {
4819 return mExtras == null ? defaultValue :
4820 mExtras.getDouble(name, defaultValue);
4821 }
4822
4823 /**
4824 * Retrieve extended data from the intent.
4825 *
4826 * @param name The name of the desired item.
4827 *
4828 * @return the value of an item that previously added with putExtra()
4829 * or null if no String value was found.
4830 *
4831 * @see #putExtra(String, String)
4832 */
4833 public String getStringExtra(String name) {
4834 return mExtras == null ? null : mExtras.getString(name);
4835 }
4836
4837 /**
4838 * Retrieve extended data from the intent.
4839 *
4840 * @param name The name of the desired item.
4841 *
4842 * @return the value of an item that previously added with putExtra()
4843 * or null if no CharSequence value was found.
4844 *
4845 * @see #putExtra(String, CharSequence)
4846 */
4847 public CharSequence getCharSequenceExtra(String name) {
4848 return mExtras == null ? null : mExtras.getCharSequence(name);
4849 }
4850
4851 /**
4852 * Retrieve extended data from the intent.
4853 *
4854 * @param name The name of the desired item.
4855 *
4856 * @return the value of an item that previously added with putExtra()
4857 * or null if no Parcelable value was found.
4858 *
4859 * @see #putExtra(String, Parcelable)
4860 */
4861 public <T extends Parcelable> T getParcelableExtra(String name) {
4862 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4863 }
4864
4865 /**
4866 * Retrieve extended data from the intent.
4867 *
4868 * @param name The name of the desired item.
4869 *
4870 * @return the value of an item that previously added with putExtra()
4871 * or null if no Parcelable[] value was found.
4872 *
4873 * @see #putExtra(String, Parcelable[])
4874 */
4875 public Parcelable[] getParcelableArrayExtra(String name) {
4876 return mExtras == null ? null : mExtras.getParcelableArray(name);
4877 }
4878
4879 /**
4880 * Retrieve extended data from the intent.
4881 *
4882 * @param name The name of the desired item.
4883 *
4884 * @return the value of an item that previously added with putExtra()
4885 * or null if no ArrayList<Parcelable> value was found.
4886 *
4887 * @see #putParcelableArrayListExtra(String, ArrayList)
4888 */
4889 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4890 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4891 }
4892
4893 /**
4894 * Retrieve extended data from the intent.
4895 *
4896 * @param name The name of the desired item.
4897 *
4898 * @return the value of an item that previously added with putExtra()
4899 * or null if no Serializable value was found.
4900 *
4901 * @see #putExtra(String, Serializable)
4902 */
4903 public Serializable getSerializableExtra(String name) {
4904 return mExtras == null ? null : mExtras.getSerializable(name);
4905 }
4906
4907 /**
4908 * Retrieve extended data from the intent.
4909 *
4910 * @param name The name of the desired item.
4911 *
4912 * @return the value of an item that previously added with putExtra()
4913 * or null if no ArrayList<Integer> value was found.
4914 *
4915 * @see #putIntegerArrayListExtra(String, ArrayList)
4916 */
4917 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4918 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4919 }
4920
4921 /**
4922 * Retrieve extended data from the intent.
4923 *
4924 * @param name The name of the desired item.
4925 *
4926 * @return the value of an item that previously added with putExtra()
4927 * or null if no ArrayList<String> value was found.
4928 *
4929 * @see #putStringArrayListExtra(String, ArrayList)
4930 */
4931 public ArrayList<String> getStringArrayListExtra(String name) {
4932 return mExtras == null ? null : mExtras.getStringArrayList(name);
4933 }
4934
4935 /**
4936 * Retrieve extended data from the intent.
4937 *
4938 * @param name The name of the desired item.
4939 *
4940 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004941 * or null if no ArrayList<CharSequence> value was found.
4942 *
4943 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4944 */
4945 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4946 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4947 }
4948
4949 /**
4950 * Retrieve extended data from the intent.
4951 *
4952 * @param name The name of the desired item.
4953 *
4954 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004955 * or null if no boolean array value was found.
4956 *
4957 * @see #putExtra(String, boolean[])
4958 */
4959 public boolean[] getBooleanArrayExtra(String name) {
4960 return mExtras == null ? null : mExtras.getBooleanArray(name);
4961 }
4962
4963 /**
4964 * Retrieve extended data from the intent.
4965 *
4966 * @param name The name of the desired item.
4967 *
4968 * @return the value of an item that previously added with putExtra()
4969 * or null if no byte array value was found.
4970 *
4971 * @see #putExtra(String, byte[])
4972 */
4973 public byte[] getByteArrayExtra(String name) {
4974 return mExtras == null ? null : mExtras.getByteArray(name);
4975 }
4976
4977 /**
4978 * Retrieve extended data from the intent.
4979 *
4980 * @param name The name of the desired item.
4981 *
4982 * @return the value of an item that previously added with putExtra()
4983 * or null if no short array value was found.
4984 *
4985 * @see #putExtra(String, short[])
4986 */
4987 public short[] getShortArrayExtra(String name) {
4988 return mExtras == null ? null : mExtras.getShortArray(name);
4989 }
4990
4991 /**
4992 * Retrieve extended data from the intent.
4993 *
4994 * @param name The name of the desired item.
4995 *
4996 * @return the value of an item that previously added with putExtra()
4997 * or null if no char array value was found.
4998 *
4999 * @see #putExtra(String, char[])
5000 */
5001 public char[] getCharArrayExtra(String name) {
5002 return mExtras == null ? null : mExtras.getCharArray(name);
5003 }
5004
5005 /**
5006 * Retrieve extended data from the intent.
5007 *
5008 * @param name The name of the desired item.
5009 *
5010 * @return the value of an item that previously added with putExtra()
5011 * or null if no int array value was found.
5012 *
5013 * @see #putExtra(String, int[])
5014 */
5015 public int[] getIntArrayExtra(String name) {
5016 return mExtras == null ? null : mExtras.getIntArray(name);
5017 }
5018
5019 /**
5020 * Retrieve extended data from the intent.
5021 *
5022 * @param name The name of the desired item.
5023 *
5024 * @return the value of an item that previously added with putExtra()
5025 * or null if no long array value was found.
5026 *
5027 * @see #putExtra(String, long[])
5028 */
5029 public long[] getLongArrayExtra(String name) {
5030 return mExtras == null ? null : mExtras.getLongArray(name);
5031 }
5032
5033 /**
5034 * Retrieve extended data from the intent.
5035 *
5036 * @param name The name of the desired item.
5037 *
5038 * @return the value of an item that previously added with putExtra()
5039 * or null if no float array value was found.
5040 *
5041 * @see #putExtra(String, float[])
5042 */
5043 public float[] getFloatArrayExtra(String name) {
5044 return mExtras == null ? null : mExtras.getFloatArray(name);
5045 }
5046
5047 /**
5048 * Retrieve extended data from the intent.
5049 *
5050 * @param name The name of the desired item.
5051 *
5052 * @return the value of an item that previously added with putExtra()
5053 * or null if no double array value was found.
5054 *
5055 * @see #putExtra(String, double[])
5056 */
5057 public double[] getDoubleArrayExtra(String name) {
5058 return mExtras == null ? null : mExtras.getDoubleArray(name);
5059 }
5060
5061 /**
5062 * Retrieve extended data from the intent.
5063 *
5064 * @param name The name of the desired item.
5065 *
5066 * @return the value of an item that previously added with putExtra()
5067 * or null if no String array value was found.
5068 *
5069 * @see #putExtra(String, String[])
5070 */
5071 public String[] getStringArrayExtra(String name) {
5072 return mExtras == null ? null : mExtras.getStringArray(name);
5073 }
5074
5075 /**
5076 * Retrieve extended data from the intent.
5077 *
5078 * @param name The name of the desired item.
5079 *
5080 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005081 * or null if no CharSequence array value was found.
5082 *
5083 * @see #putExtra(String, CharSequence[])
5084 */
5085 public CharSequence[] getCharSequenceArrayExtra(String name) {
5086 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5087 }
5088
5089 /**
5090 * Retrieve extended data from the intent.
5091 *
5092 * @param name The name of the desired item.
5093 *
5094 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005095 * or null if no Bundle value was found.
5096 *
5097 * @see #putExtra(String, Bundle)
5098 */
5099 public Bundle getBundleExtra(String name) {
5100 return mExtras == null ? null : mExtras.getBundle(name);
5101 }
5102
5103 /**
5104 * Retrieve extended data from the intent.
5105 *
5106 * @param name The name of the desired item.
5107 *
5108 * @return the value of an item that previously added with putExtra()
5109 * or null if no IBinder value was found.
5110 *
5111 * @see #putExtra(String, IBinder)
5112 *
5113 * @deprecated
5114 * @hide
5115 */
5116 @Deprecated
5117 public IBinder getIBinderExtra(String name) {
5118 return mExtras == null ? null : mExtras.getIBinder(name);
5119 }
5120
5121 /**
5122 * Retrieve extended data from the intent.
5123 *
5124 * @param name The name of the desired item.
5125 * @param defaultValue The default value to return in case no item is
5126 * associated with the key 'name'
5127 *
5128 * @return the value of an item that previously added with putExtra()
5129 * or defaultValue if none was found.
5130 *
5131 * @see #putExtra
5132 *
5133 * @deprecated
5134 * @hide
5135 */
5136 @Deprecated
5137 public Object getExtra(String name, Object defaultValue) {
5138 Object result = defaultValue;
5139 if (mExtras != null) {
5140 Object result2 = mExtras.get(name);
5141 if (result2 != null) {
5142 result = result2;
5143 }
5144 }
5145
5146 return result;
5147 }
5148
5149 /**
5150 * Retrieves a map of extended data from the intent.
5151 *
5152 * @return the map of all extras previously added with putExtra(),
5153 * or null if none have been added.
5154 */
5155 public Bundle getExtras() {
5156 return (mExtras != null)
5157 ? new Bundle(mExtras)
5158 : null;
5159 }
5160
5161 /**
5162 * Retrieve any special flags associated with this intent. You will
5163 * normally just set them with {@link #setFlags} and let the system
5164 * take the appropriate action with them.
5165 *
5166 * @return int The currently set flags.
5167 *
5168 * @see #setFlags
5169 */
5170 public int getFlags() {
5171 return mFlags;
5172 }
5173
Dianne Hackborne7f97212011-02-24 14:40:20 -08005174 /** @hide */
5175 public boolean isExcludingStopped() {
5176 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5177 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5178 }
5179
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005180 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005181 * Retrieve the application package name this Intent is limited to. When
5182 * resolving an Intent, if non-null this limits the resolution to only
5183 * components in the given application package.
5184 *
5185 * @return The name of the application package for the Intent.
5186 *
5187 * @see #resolveActivity
5188 * @see #setPackage
5189 */
5190 public String getPackage() {
5191 return mPackage;
5192 }
5193
5194 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005195 * Retrieve the concrete component associated with the intent. When receiving
5196 * an intent, this is the component that was found to best handle it (that is,
5197 * yourself) and will always be non-null; in all other cases it will be
5198 * null unless explicitly set.
5199 *
5200 * @return The name of the application component to handle the intent.
5201 *
5202 * @see #resolveActivity
5203 * @see #setComponent
5204 */
5205 public ComponentName getComponent() {
5206 return mComponent;
5207 }
5208
5209 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005210 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5211 * used as a hint to the receiver for animations and the like. Null means that there
5212 * is no source bounds.
5213 */
5214 public Rect getSourceBounds() {
5215 return mSourceBounds;
5216 }
5217
5218 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005219 * Return the Activity component that should be used to handle this intent.
5220 * The appropriate component is determined based on the information in the
5221 * intent, evaluated as follows:
5222 *
5223 * <p>If {@link #getComponent} returns an explicit class, that is returned
5224 * without any further consideration.
5225 *
5226 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5227 * category to be considered.
5228 *
5229 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5230 * action.
5231 *
5232 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5233 * this type.
5234 *
5235 * <p>If {@link #addCategory} has added any categories, the activity must
5236 * handle ALL of the categories specified.
5237 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005238 * <p>If {@link #getPackage} is non-NULL, only activity components in
5239 * that application package will be considered.
5240 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005241 * <p>If there are no activities that satisfy all of these conditions, a
5242 * null string is returned.
5243 *
5244 * <p>If multiple activities are found to satisfy the intent, the one with
5245 * the highest priority will be used. If there are multiple activities
5246 * with the same priority, the system will either pick the best activity
5247 * based on user preference, or resolve to a system class that will allow
5248 * the user to pick an activity and forward from there.
5249 *
5250 * <p>This method is implemented simply by calling
5251 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5252 * true.</p>
5253 * <p> This API is called for you as part of starting an activity from an
5254 * intent. You do not normally need to call it yourself.</p>
5255 *
5256 * @param pm The package manager with which to resolve the Intent.
5257 *
5258 * @return Name of the component implementing an activity that can
5259 * display the intent.
5260 *
5261 * @see #setComponent
5262 * @see #getComponent
5263 * @see #resolveActivityInfo
5264 */
5265 public ComponentName resolveActivity(PackageManager pm) {
5266 if (mComponent != null) {
5267 return mComponent;
5268 }
5269
5270 ResolveInfo info = pm.resolveActivity(
5271 this, PackageManager.MATCH_DEFAULT_ONLY);
5272 if (info != null) {
5273 return new ComponentName(
5274 info.activityInfo.applicationInfo.packageName,
5275 info.activityInfo.name);
5276 }
5277
5278 return null;
5279 }
5280
5281 /**
5282 * Resolve the Intent into an {@link ActivityInfo}
5283 * describing the activity that should execute the intent. Resolution
5284 * follows the same rules as described for {@link #resolveActivity}, but
5285 * you get back the completely information about the resolved activity
5286 * instead of just its class name.
5287 *
5288 * @param pm The package manager with which to resolve the Intent.
5289 * @param flags Addition information to retrieve as per
5290 * {@link PackageManager#getActivityInfo(ComponentName, int)
5291 * PackageManager.getActivityInfo()}.
5292 *
5293 * @return PackageManager.ActivityInfo
5294 *
5295 * @see #resolveActivity
5296 */
5297 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5298 ActivityInfo ai = null;
5299 if (mComponent != null) {
5300 try {
5301 ai = pm.getActivityInfo(mComponent, flags);
5302 } catch (PackageManager.NameNotFoundException e) {
5303 // ignore
5304 }
5305 } else {
5306 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005307 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005308 if (info != null) {
5309 ai = info.activityInfo;
5310 }
5311 }
5312
5313 return ai;
5314 }
5315
5316 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005317 * Special function for use by the system to resolve service
5318 * intents to system apps. Throws an exception if there are
5319 * multiple potential matches to the Intent. Returns null if
5320 * there are no matches.
5321 * @hide
5322 */
5323 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5324 if (mComponent != null) {
5325 return mComponent;
5326 }
5327
5328 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5329 if (results == null) {
5330 return null;
5331 }
5332 ComponentName comp = null;
5333 for (int i=0; i<results.size(); i++) {
5334 ResolveInfo ri = results.get(i);
5335 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5336 continue;
5337 }
5338 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5339 ri.serviceInfo.name);
5340 if (comp != null) {
5341 throw new IllegalStateException("Multiple system services handle " + this
5342 + ": " + comp + ", " + foundComp);
5343 }
5344 comp = foundComp;
5345 }
5346 return comp;
5347 }
5348
5349 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005350 * Set the general action to be performed.
5351 *
5352 * @param action An action name, such as ACTION_VIEW. Application-specific
5353 * actions should be prefixed with the vendor's package name.
5354 *
5355 * @return Returns the same Intent object, for chaining multiple calls
5356 * into a single statement.
5357 *
5358 * @see #getAction
5359 */
5360 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005361 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005362 return this;
5363 }
5364
5365 /**
5366 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005367 * clears any type that was previously set by {@link #setType} or
5368 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005369 *
Nick Pellyccae4122012-01-09 14:12:58 -08005370 * <p><em>Note: scheme matching in the Android framework is
5371 * case-sensitive, unlike the formal RFC. As a result,
5372 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005373 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005374 * {@link #setDataAndNormalize}
5375 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005376 *
Nick Pellyccae4122012-01-09 14:12:58 -08005377 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005378 *
5379 * @return Returns the same Intent object, for chaining multiple calls
5380 * into a single statement.
5381 *
5382 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005383 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005384 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005385 */
5386 public Intent setData(Uri data) {
5387 mData = data;
5388 mType = null;
5389 return this;
5390 }
5391
5392 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005393 * Normalize and set the data this intent is operating on.
5394 *
5395 * <p>This method automatically clears any type that was
5396 * previously set (for example, by {@link #setType}).
5397 *
5398 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005399 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005400 * so really this is just a convenience method for
5401 * <pre>
5402 * setData(data.normalize())
5403 * </pre>
5404 *
5405 * @param data The Uri of the data this intent is now targeting.
5406 *
5407 * @return Returns the same Intent object, for chaining multiple calls
5408 * into a single statement.
5409 *
5410 * @see #getData
5411 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005412 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005413 */
5414 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005415 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005416 }
5417
5418 /**
5419 * Set an explicit MIME data type.
5420 *
5421 * <p>This is used to create intents that only specify a type and not data,
5422 * for example to indicate the type of data to return.
5423 *
5424 * <p>This method automatically clears any data that was
5425 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005426 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005427 * <p><em>Note: MIME type matching in the Android framework is
5428 * case-sensitive, unlike formal RFC MIME types. As a result,
5429 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005430 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5431 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005432 *
5433 * @param type The MIME type of the data being handled by this intent.
5434 *
5435 * @return Returns the same Intent object, for chaining multiple calls
5436 * into a single statement.
5437 *
5438 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005439 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005440 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005441 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005442 */
5443 public Intent setType(String type) {
5444 mData = null;
5445 mType = type;
5446 return this;
5447 }
5448
5449 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005450 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005451 *
Nick Pellyccae4122012-01-09 14:12:58 -08005452 * <p>This is used to create intents that only specify a type and not data,
5453 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005454 *
Nick Pellyccae4122012-01-09 14:12:58 -08005455 * <p>This method automatically clears any data that was
5456 * previously set (for example by {@link #setData}).
5457 *
5458 * <p>The MIME type is normalized using
5459 * {@link #normalizeMimeType} before it is set,
5460 * so really this is just a convenience method for
5461 * <pre>
5462 * setType(Intent.normalizeMimeType(type))
5463 * </pre>
5464 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005465 * @param type The MIME type of the data being handled by this intent.
5466 *
5467 * @return Returns the same Intent object, for chaining multiple calls
5468 * into a single statement.
5469 *
Nick Pellyccae4122012-01-09 14:12:58 -08005470 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005471 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005472 * @see #normalizeMimeType
5473 */
5474 public Intent setTypeAndNormalize(String type) {
5475 return setType(normalizeMimeType(type));
5476 }
5477
5478 /**
5479 * (Usually optional) Set the data for the intent along with an explicit
5480 * MIME data type. This method should very rarely be used -- it allows you
5481 * to override the MIME type that would ordinarily be inferred from the
5482 * data with your own type given here.
5483 *
5484 * <p><em>Note: MIME type and Uri scheme matching in the
5485 * Android framework is case-sensitive, unlike the formal RFC definitions.
5486 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005487 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005488 * {@link #setDataAndTypeAndNormalize}
5489 * to ensure that they are converted to lower case.</em>
5490 *
5491 * @param data The Uri of the data this intent is now targeting.
5492 * @param type The MIME type of the data being handled by this intent.
5493 *
5494 * @return Returns the same Intent object, for chaining multiple calls
5495 * into a single statement.
5496 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005497 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005498 * @see #setData
5499 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005500 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005501 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005502 */
5503 public Intent setDataAndType(Uri data, String type) {
5504 mData = data;
5505 mType = type;
5506 return this;
5507 }
5508
5509 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005510 * (Usually optional) Normalize and set both the data Uri and an explicit
5511 * MIME data type. This method should very rarely be used -- it allows you
5512 * to override the MIME type that would ordinarily be inferred from the
5513 * data with your own type given here.
5514 *
5515 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005516 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005517 * before they are set, so really this is just a convenience method for
5518 * <pre>
5519 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5520 * </pre>
5521 *
5522 * @param data The Uri of the data this intent is now targeting.
5523 * @param type The MIME type of the data being handled by this intent.
5524 *
5525 * @return Returns the same Intent object, for chaining multiple calls
5526 * into a single statement.
5527 *
5528 * @see #setType
5529 * @see #setData
5530 * @see #setDataAndType
5531 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005532 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005533 */
5534 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005535 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005536 }
5537
5538 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005539 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005540 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005541 * activities that provide <em>all</em> of the requested categories will be
5542 * used.
5543 *
5544 * @param category The desired category. This can be either one of the
5545 * predefined Intent categories, or a custom category in your own
5546 * namespace.
5547 *
5548 * @return Returns the same Intent object, for chaining multiple calls
5549 * into a single statement.
5550 *
5551 * @see #hasCategory
5552 * @see #removeCategory
5553 */
5554 public Intent addCategory(String category) {
5555 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005556 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005557 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005558 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005559 return this;
5560 }
5561
5562 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005563 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005564 *
5565 * @param category The category to remove.
5566 *
5567 * @see #addCategory
5568 */
5569 public void removeCategory(String category) {
5570 if (mCategories != null) {
5571 mCategories.remove(category);
5572 if (mCategories.size() == 0) {
5573 mCategories = null;
5574 }
5575 }
5576 }
5577
5578 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005579 * Set a selector for this Intent. This is a modification to the kinds of
5580 * things the Intent will match. If the selector is set, it will be used
5581 * when trying to find entities that can handle the Intent, instead of the
5582 * main contents of the Intent. This allows you build an Intent containing
5583 * a generic protocol while targeting it more specifically.
5584 *
5585 * <p>An example of where this may be used is with things like
5586 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5587 * Intent that will launch the Browser application. However, the correct
5588 * main entry point of an application is actually {@link #ACTION_MAIN}
5589 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5590 * used to specify the actual Activity to launch. If you launch the browser
5591 * with something different, undesired behavior may happen if the user has
5592 * previously or later launches it the normal way, since they do not match.
5593 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5594 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5595 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5596 *
5597 * <p>Setting a selector does not impact the behavior of
5598 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5599 * desired behavior of a selector -- it does not impact the base meaning
5600 * of the Intent, just what kinds of things will be matched against it
5601 * when determining who can handle it.</p>
5602 *
5603 * <p>You can not use both a selector and {@link #setPackage(String)} on
5604 * the same base Intent.</p>
5605 *
5606 * @param selector The desired selector Intent; set to null to not use
5607 * a special selector.
5608 */
5609 public void setSelector(Intent selector) {
5610 if (selector == this) {
5611 throw new IllegalArgumentException(
5612 "Intent being set as a selector of itself");
5613 }
5614 if (selector != null && mPackage != null) {
5615 throw new IllegalArgumentException(
5616 "Can't set selector when package name is already set");
5617 }
5618 mSelector = selector;
5619 }
5620
5621 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005622 * Set a {@link ClipData} associated with this Intent. This replaces any
5623 * previously set ClipData.
5624 *
5625 * <p>The ClipData in an intent is not used for Intent matching or other
5626 * such operations. Semantically it is like extras, used to transmit
5627 * additional data with the Intent. The main feature of using this over
5628 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5629 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5630 * items included in the clip data. This is useful, in particular, if
5631 * you want to transmit an Intent containing multiple <code>content:</code>
5632 * URIs for which the recipient may not have global permission to access the
5633 * content provider.
5634 *
5635 * <p>If the ClipData contains items that are themselves Intents, any
5636 * grant flags in those Intents will be ignored. Only the top-level flags
5637 * of the main Intent are respected, and will be applied to all Uri or
5638 * Intent items in the clip (or sub-items of the clip).
5639 *
5640 * <p>The MIME type, label, and icon in the ClipData object are not
5641 * directly used by Intent. Applications should generally rely on the
5642 * MIME type of the Intent itself, not what it may find in the ClipData.
5643 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005644 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005645 *
5646 * @param clip The new clip to set. May be null to clear the current clip.
5647 */
5648 public void setClipData(ClipData clip) {
5649 mClipData = clip;
5650 }
5651
5652 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005653 * Add extended data to the intent. The name must include a package
5654 * prefix, for example the app com.android.contacts would use names
5655 * like "com.android.contacts.ShowAll".
5656 *
5657 * @param name The name of the extra data, with package prefix.
5658 * @param value The boolean data value.
5659 *
5660 * @return Returns the same Intent object, for chaining multiple calls
5661 * into a single statement.
5662 *
5663 * @see #putExtras
5664 * @see #removeExtra
5665 * @see #getBooleanExtra(String, boolean)
5666 */
5667 public Intent putExtra(String name, boolean value) {
5668 if (mExtras == null) {
5669 mExtras = new Bundle();
5670 }
5671 mExtras.putBoolean(name, value);
5672 return this;
5673 }
5674
5675 /**
5676 * Add extended data to the intent. The name must include a package
5677 * prefix, for example the app com.android.contacts would use names
5678 * like "com.android.contacts.ShowAll".
5679 *
5680 * @param name The name of the extra data, with package prefix.
5681 * @param value The byte data value.
5682 *
5683 * @return Returns the same Intent object, for chaining multiple calls
5684 * into a single statement.
5685 *
5686 * @see #putExtras
5687 * @see #removeExtra
5688 * @see #getByteExtra(String, byte)
5689 */
5690 public Intent putExtra(String name, byte value) {
5691 if (mExtras == null) {
5692 mExtras = new Bundle();
5693 }
5694 mExtras.putByte(name, value);
5695 return this;
5696 }
5697
5698 /**
5699 * Add extended data to the intent. The name must include a package
5700 * prefix, for example the app com.android.contacts would use names
5701 * like "com.android.contacts.ShowAll".
5702 *
5703 * @param name The name of the extra data, with package prefix.
5704 * @param value The char data value.
5705 *
5706 * @return Returns the same Intent object, for chaining multiple calls
5707 * into a single statement.
5708 *
5709 * @see #putExtras
5710 * @see #removeExtra
5711 * @see #getCharExtra(String, char)
5712 */
5713 public Intent putExtra(String name, char value) {
5714 if (mExtras == null) {
5715 mExtras = new Bundle();
5716 }
5717 mExtras.putChar(name, value);
5718 return this;
5719 }
5720
5721 /**
5722 * Add extended data to the intent. The name must include a package
5723 * prefix, for example the app com.android.contacts would use names
5724 * like "com.android.contacts.ShowAll".
5725 *
5726 * @param name The name of the extra data, with package prefix.
5727 * @param value The short data value.
5728 *
5729 * @return Returns the same Intent object, for chaining multiple calls
5730 * into a single statement.
5731 *
5732 * @see #putExtras
5733 * @see #removeExtra
5734 * @see #getShortExtra(String, short)
5735 */
5736 public Intent putExtra(String name, short value) {
5737 if (mExtras == null) {
5738 mExtras = new Bundle();
5739 }
5740 mExtras.putShort(name, value);
5741 return this;
5742 }
5743
5744 /**
5745 * Add extended data to the intent. The name must include a package
5746 * prefix, for example the app com.android.contacts would use names
5747 * like "com.android.contacts.ShowAll".
5748 *
5749 * @param name The name of the extra data, with package prefix.
5750 * @param value The integer data value.
5751 *
5752 * @return Returns the same Intent object, for chaining multiple calls
5753 * into a single statement.
5754 *
5755 * @see #putExtras
5756 * @see #removeExtra
5757 * @see #getIntExtra(String, int)
5758 */
5759 public Intent putExtra(String name, int value) {
5760 if (mExtras == null) {
5761 mExtras = new Bundle();
5762 }
5763 mExtras.putInt(name, value);
5764 return this;
5765 }
5766
5767 /**
5768 * Add extended data to the intent. The name must include a package
5769 * prefix, for example the app com.android.contacts would use names
5770 * like "com.android.contacts.ShowAll".
5771 *
5772 * @param name The name of the extra data, with package prefix.
5773 * @param value The long data value.
5774 *
5775 * @return Returns the same Intent object, for chaining multiple calls
5776 * into a single statement.
5777 *
5778 * @see #putExtras
5779 * @see #removeExtra
5780 * @see #getLongExtra(String, long)
5781 */
5782 public Intent putExtra(String name, long value) {
5783 if (mExtras == null) {
5784 mExtras = new Bundle();
5785 }
5786 mExtras.putLong(name, value);
5787 return this;
5788 }
5789
5790 /**
5791 * Add extended data to the intent. The name must include a package
5792 * prefix, for example the app com.android.contacts would use names
5793 * like "com.android.contacts.ShowAll".
5794 *
5795 * @param name The name of the extra data, with package prefix.
5796 * @param value The float data value.
5797 *
5798 * @return Returns the same Intent object, for chaining multiple calls
5799 * into a single statement.
5800 *
5801 * @see #putExtras
5802 * @see #removeExtra
5803 * @see #getFloatExtra(String, float)
5804 */
5805 public Intent putExtra(String name, float value) {
5806 if (mExtras == null) {
5807 mExtras = new Bundle();
5808 }
5809 mExtras.putFloat(name, value);
5810 return this;
5811 }
5812
5813 /**
5814 * Add extended data to the intent. The name must include a package
5815 * prefix, for example the app com.android.contacts would use names
5816 * like "com.android.contacts.ShowAll".
5817 *
5818 * @param name The name of the extra data, with package prefix.
5819 * @param value The double data value.
5820 *
5821 * @return Returns the same Intent object, for chaining multiple calls
5822 * into a single statement.
5823 *
5824 * @see #putExtras
5825 * @see #removeExtra
5826 * @see #getDoubleExtra(String, double)
5827 */
5828 public Intent putExtra(String name, double value) {
5829 if (mExtras == null) {
5830 mExtras = new Bundle();
5831 }
5832 mExtras.putDouble(name, value);
5833 return this;
5834 }
5835
5836 /**
5837 * Add extended data to the intent. The name must include a package
5838 * prefix, for example the app com.android.contacts would use names
5839 * like "com.android.contacts.ShowAll".
5840 *
5841 * @param name The name of the extra data, with package prefix.
5842 * @param value The String data value.
5843 *
5844 * @return Returns the same Intent object, for chaining multiple calls
5845 * into a single statement.
5846 *
5847 * @see #putExtras
5848 * @see #removeExtra
5849 * @see #getStringExtra(String)
5850 */
5851 public Intent putExtra(String name, String value) {
5852 if (mExtras == null) {
5853 mExtras = new Bundle();
5854 }
5855 mExtras.putString(name, value);
5856 return this;
5857 }
5858
5859 /**
5860 * Add extended data to the intent. The name must include a package
5861 * prefix, for example the app com.android.contacts would use names
5862 * like "com.android.contacts.ShowAll".
5863 *
5864 * @param name The name of the extra data, with package prefix.
5865 * @param value The CharSequence data value.
5866 *
5867 * @return Returns the same Intent object, for chaining multiple calls
5868 * into a single statement.
5869 *
5870 * @see #putExtras
5871 * @see #removeExtra
5872 * @see #getCharSequenceExtra(String)
5873 */
5874 public Intent putExtra(String name, CharSequence value) {
5875 if (mExtras == null) {
5876 mExtras = new Bundle();
5877 }
5878 mExtras.putCharSequence(name, value);
5879 return this;
5880 }
5881
5882 /**
5883 * Add extended data to the intent. The name must include a package
5884 * prefix, for example the app com.android.contacts would use names
5885 * like "com.android.contacts.ShowAll".
5886 *
5887 * @param name The name of the extra data, with package prefix.
5888 * @param value The Parcelable data value.
5889 *
5890 * @return Returns the same Intent object, for chaining multiple calls
5891 * into a single statement.
5892 *
5893 * @see #putExtras
5894 * @see #removeExtra
5895 * @see #getParcelableExtra(String)
5896 */
5897 public Intent putExtra(String name, Parcelable value) {
5898 if (mExtras == null) {
5899 mExtras = new Bundle();
5900 }
5901 mExtras.putParcelable(name, value);
5902 return this;
5903 }
5904
5905 /**
5906 * Add extended data to the intent. The name must include a package
5907 * prefix, for example the app com.android.contacts would use names
5908 * like "com.android.contacts.ShowAll".
5909 *
5910 * @param name The name of the extra data, with package prefix.
5911 * @param value The Parcelable[] data value.
5912 *
5913 * @return Returns the same Intent object, for chaining multiple calls
5914 * into a single statement.
5915 *
5916 * @see #putExtras
5917 * @see #removeExtra
5918 * @see #getParcelableArrayExtra(String)
5919 */
5920 public Intent putExtra(String name, Parcelable[] value) {
5921 if (mExtras == null) {
5922 mExtras = new Bundle();
5923 }
5924 mExtras.putParcelableArray(name, value);
5925 return this;
5926 }
5927
5928 /**
5929 * Add extended data to the intent. The name must include a package
5930 * prefix, for example the app com.android.contacts would use names
5931 * like "com.android.contacts.ShowAll".
5932 *
5933 * @param name The name of the extra data, with package prefix.
5934 * @param value The ArrayList<Parcelable> data value.
5935 *
5936 * @return Returns the same Intent object, for chaining multiple calls
5937 * into a single statement.
5938 *
5939 * @see #putExtras
5940 * @see #removeExtra
5941 * @see #getParcelableArrayListExtra(String)
5942 */
5943 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5944 if (mExtras == null) {
5945 mExtras = new Bundle();
5946 }
5947 mExtras.putParcelableArrayList(name, value);
5948 return this;
5949 }
5950
5951 /**
5952 * Add extended data to the intent. The name must include a package
5953 * prefix, for example the app com.android.contacts would use names
5954 * like "com.android.contacts.ShowAll".
5955 *
5956 * @param name The name of the extra data, with package prefix.
5957 * @param value The ArrayList<Integer> data value.
5958 *
5959 * @return Returns the same Intent object, for chaining multiple calls
5960 * into a single statement.
5961 *
5962 * @see #putExtras
5963 * @see #removeExtra
5964 * @see #getIntegerArrayListExtra(String)
5965 */
5966 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5967 if (mExtras == null) {
5968 mExtras = new Bundle();
5969 }
5970 mExtras.putIntegerArrayList(name, value);
5971 return this;
5972 }
5973
5974 /**
5975 * Add extended data to the intent. The name must include a package
5976 * prefix, for example the app com.android.contacts would use names
5977 * like "com.android.contacts.ShowAll".
5978 *
5979 * @param name The name of the extra data, with package prefix.
5980 * @param value The ArrayList<String> data value.
5981 *
5982 * @return Returns the same Intent object, for chaining multiple calls
5983 * into a single statement.
5984 *
5985 * @see #putExtras
5986 * @see #removeExtra
5987 * @see #getStringArrayListExtra(String)
5988 */
5989 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5990 if (mExtras == null) {
5991 mExtras = new Bundle();
5992 }
5993 mExtras.putStringArrayList(name, value);
5994 return this;
5995 }
5996
5997 /**
5998 * Add extended data to the intent. The name must include a package
5999 * prefix, for example the app com.android.contacts would use names
6000 * like "com.android.contacts.ShowAll".
6001 *
6002 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006003 * @param value The ArrayList<CharSequence> data value.
6004 *
6005 * @return Returns the same Intent object, for chaining multiple calls
6006 * into a single statement.
6007 *
6008 * @see #putExtras
6009 * @see #removeExtra
6010 * @see #getCharSequenceArrayListExtra(String)
6011 */
6012 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6013 if (mExtras == null) {
6014 mExtras = new Bundle();
6015 }
6016 mExtras.putCharSequenceArrayList(name, value);
6017 return this;
6018 }
6019
6020 /**
6021 * Add extended data to the intent. The name must include a package
6022 * prefix, for example the app com.android.contacts would use names
6023 * like "com.android.contacts.ShowAll".
6024 *
6025 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006026 * @param value The Serializable data value.
6027 *
6028 * @return Returns the same Intent object, for chaining multiple calls
6029 * into a single statement.
6030 *
6031 * @see #putExtras
6032 * @see #removeExtra
6033 * @see #getSerializableExtra(String)
6034 */
6035 public Intent putExtra(String name, Serializable value) {
6036 if (mExtras == null) {
6037 mExtras = new Bundle();
6038 }
6039 mExtras.putSerializable(name, value);
6040 return this;
6041 }
6042
6043 /**
6044 * Add extended data to the intent. The name must include a package
6045 * prefix, for example the app com.android.contacts would use names
6046 * like "com.android.contacts.ShowAll".
6047 *
6048 * @param name The name of the extra data, with package prefix.
6049 * @param value The boolean array data value.
6050 *
6051 * @return Returns the same Intent object, for chaining multiple calls
6052 * into a single statement.
6053 *
6054 * @see #putExtras
6055 * @see #removeExtra
6056 * @see #getBooleanArrayExtra(String)
6057 */
6058 public Intent putExtra(String name, boolean[] value) {
6059 if (mExtras == null) {
6060 mExtras = new Bundle();
6061 }
6062 mExtras.putBooleanArray(name, value);
6063 return this;
6064 }
6065
6066 /**
6067 * Add extended data to the intent. The name must include a package
6068 * prefix, for example the app com.android.contacts would use names
6069 * like "com.android.contacts.ShowAll".
6070 *
6071 * @param name The name of the extra data, with package prefix.
6072 * @param value The byte array data value.
6073 *
6074 * @return Returns the same Intent object, for chaining multiple calls
6075 * into a single statement.
6076 *
6077 * @see #putExtras
6078 * @see #removeExtra
6079 * @see #getByteArrayExtra(String)
6080 */
6081 public Intent putExtra(String name, byte[] value) {
6082 if (mExtras == null) {
6083 mExtras = new Bundle();
6084 }
6085 mExtras.putByteArray(name, value);
6086 return this;
6087 }
6088
6089 /**
6090 * Add extended data to the intent. The name must include a package
6091 * prefix, for example the app com.android.contacts would use names
6092 * like "com.android.contacts.ShowAll".
6093 *
6094 * @param name The name of the extra data, with package prefix.
6095 * @param value The short array data value.
6096 *
6097 * @return Returns the same Intent object, for chaining multiple calls
6098 * into a single statement.
6099 *
6100 * @see #putExtras
6101 * @see #removeExtra
6102 * @see #getShortArrayExtra(String)
6103 */
6104 public Intent putExtra(String name, short[] value) {
6105 if (mExtras == null) {
6106 mExtras = new Bundle();
6107 }
6108 mExtras.putShortArray(name, value);
6109 return this;
6110 }
6111
6112 /**
6113 * Add extended data to the intent. The name must include a package
6114 * prefix, for example the app com.android.contacts would use names
6115 * like "com.android.contacts.ShowAll".
6116 *
6117 * @param name The name of the extra data, with package prefix.
6118 * @param value The char array data value.
6119 *
6120 * @return Returns the same Intent object, for chaining multiple calls
6121 * into a single statement.
6122 *
6123 * @see #putExtras
6124 * @see #removeExtra
6125 * @see #getCharArrayExtra(String)
6126 */
6127 public Intent putExtra(String name, char[] value) {
6128 if (mExtras == null) {
6129 mExtras = new Bundle();
6130 }
6131 mExtras.putCharArray(name, value);
6132 return this;
6133 }
6134
6135 /**
6136 * Add extended data to the intent. The name must include a package
6137 * prefix, for example the app com.android.contacts would use names
6138 * like "com.android.contacts.ShowAll".
6139 *
6140 * @param name The name of the extra data, with package prefix.
6141 * @param value The int array data value.
6142 *
6143 * @return Returns the same Intent object, for chaining multiple calls
6144 * into a single statement.
6145 *
6146 * @see #putExtras
6147 * @see #removeExtra
6148 * @see #getIntArrayExtra(String)
6149 */
6150 public Intent putExtra(String name, int[] value) {
6151 if (mExtras == null) {
6152 mExtras = new Bundle();
6153 }
6154 mExtras.putIntArray(name, value);
6155 return this;
6156 }
6157
6158 /**
6159 * Add extended data to the intent. The name must include a package
6160 * prefix, for example the app com.android.contacts would use names
6161 * like "com.android.contacts.ShowAll".
6162 *
6163 * @param name The name of the extra data, with package prefix.
6164 * @param value The byte array data value.
6165 *
6166 * @return Returns the same Intent object, for chaining multiple calls
6167 * into a single statement.
6168 *
6169 * @see #putExtras
6170 * @see #removeExtra
6171 * @see #getLongArrayExtra(String)
6172 */
6173 public Intent putExtra(String name, long[] value) {
6174 if (mExtras == null) {
6175 mExtras = new Bundle();
6176 }
6177 mExtras.putLongArray(name, value);
6178 return this;
6179 }
6180
6181 /**
6182 * Add extended data to the intent. The name must include a package
6183 * prefix, for example the app com.android.contacts would use names
6184 * like "com.android.contacts.ShowAll".
6185 *
6186 * @param name The name of the extra data, with package prefix.
6187 * @param value The float array data value.
6188 *
6189 * @return Returns the same Intent object, for chaining multiple calls
6190 * into a single statement.
6191 *
6192 * @see #putExtras
6193 * @see #removeExtra
6194 * @see #getFloatArrayExtra(String)
6195 */
6196 public Intent putExtra(String name, float[] value) {
6197 if (mExtras == null) {
6198 mExtras = new Bundle();
6199 }
6200 mExtras.putFloatArray(name, value);
6201 return this;
6202 }
6203
6204 /**
6205 * Add extended data to the intent. The name must include a package
6206 * prefix, for example the app com.android.contacts would use names
6207 * like "com.android.contacts.ShowAll".
6208 *
6209 * @param name The name of the extra data, with package prefix.
6210 * @param value The double array data value.
6211 *
6212 * @return Returns the same Intent object, for chaining multiple calls
6213 * into a single statement.
6214 *
6215 * @see #putExtras
6216 * @see #removeExtra
6217 * @see #getDoubleArrayExtra(String)
6218 */
6219 public Intent putExtra(String name, double[] value) {
6220 if (mExtras == null) {
6221 mExtras = new Bundle();
6222 }
6223 mExtras.putDoubleArray(name, value);
6224 return this;
6225 }
6226
6227 /**
6228 * Add extended data to the intent. The name must include a package
6229 * prefix, for example the app com.android.contacts would use names
6230 * like "com.android.contacts.ShowAll".
6231 *
6232 * @param name The name of the extra data, with package prefix.
6233 * @param value The String array data value.
6234 *
6235 * @return Returns the same Intent object, for chaining multiple calls
6236 * into a single statement.
6237 *
6238 * @see #putExtras
6239 * @see #removeExtra
6240 * @see #getStringArrayExtra(String)
6241 */
6242 public Intent putExtra(String name, String[] value) {
6243 if (mExtras == null) {
6244 mExtras = new Bundle();
6245 }
6246 mExtras.putStringArray(name, value);
6247 return this;
6248 }
6249
6250 /**
6251 * Add extended data to the intent. The name must include a package
6252 * prefix, for example the app com.android.contacts would use names
6253 * like "com.android.contacts.ShowAll".
6254 *
6255 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006256 * @param value The CharSequence array data value.
6257 *
6258 * @return Returns the same Intent object, for chaining multiple calls
6259 * into a single statement.
6260 *
6261 * @see #putExtras
6262 * @see #removeExtra
6263 * @see #getCharSequenceArrayExtra(String)
6264 */
6265 public Intent putExtra(String name, CharSequence[] value) {
6266 if (mExtras == null) {
6267 mExtras = new Bundle();
6268 }
6269 mExtras.putCharSequenceArray(name, value);
6270 return this;
6271 }
6272
6273 /**
6274 * Add extended data to the intent. The name must include a package
6275 * prefix, for example the app com.android.contacts would use names
6276 * like "com.android.contacts.ShowAll".
6277 *
6278 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006279 * @param value The Bundle data value.
6280 *
6281 * @return Returns the same Intent object, for chaining multiple calls
6282 * into a single statement.
6283 *
6284 * @see #putExtras
6285 * @see #removeExtra
6286 * @see #getBundleExtra(String)
6287 */
6288 public Intent putExtra(String name, Bundle value) {
6289 if (mExtras == null) {
6290 mExtras = new Bundle();
6291 }
6292 mExtras.putBundle(name, value);
6293 return this;
6294 }
6295
6296 /**
6297 * Add extended data to the intent. The name must include a package
6298 * prefix, for example the app com.android.contacts would use names
6299 * like "com.android.contacts.ShowAll".
6300 *
6301 * @param name The name of the extra data, with package prefix.
6302 * @param value The IBinder data value.
6303 *
6304 * @return Returns the same Intent object, for chaining multiple calls
6305 * into a single statement.
6306 *
6307 * @see #putExtras
6308 * @see #removeExtra
6309 * @see #getIBinderExtra(String)
6310 *
6311 * @deprecated
6312 * @hide
6313 */
6314 @Deprecated
6315 public Intent putExtra(String name, IBinder value) {
6316 if (mExtras == null) {
6317 mExtras = new Bundle();
6318 }
6319 mExtras.putIBinder(name, value);
6320 return this;
6321 }
6322
6323 /**
6324 * Copy all extras in 'src' in to this intent.
6325 *
6326 * @param src Contains the extras to copy.
6327 *
6328 * @see #putExtra
6329 */
6330 public Intent putExtras(Intent src) {
6331 if (src.mExtras != null) {
6332 if (mExtras == null) {
6333 mExtras = new Bundle(src.mExtras);
6334 } else {
6335 mExtras.putAll(src.mExtras);
6336 }
6337 }
6338 return this;
6339 }
6340
6341 /**
6342 * Add a set of extended data to the intent. The keys must include a package
6343 * prefix, for example the app com.android.contacts would use names
6344 * like "com.android.contacts.ShowAll".
6345 *
6346 * @param extras The Bundle of extras to add to this intent.
6347 *
6348 * @see #putExtra
6349 * @see #removeExtra
6350 */
6351 public Intent putExtras(Bundle extras) {
6352 if (mExtras == null) {
6353 mExtras = new Bundle();
6354 }
6355 mExtras.putAll(extras);
6356 return this;
6357 }
6358
6359 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006360 * Completely replace the extras in the Intent with the extras in the
6361 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006362 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006363 * @param src The exact extras contained in this Intent are copied
6364 * into the target intent, replacing any that were previously there.
6365 */
6366 public Intent replaceExtras(Intent src) {
6367 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6368 return this;
6369 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006370
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006371 /**
6372 * Completely replace the extras in the Intent with the given Bundle of
6373 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006374 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006375 * @param extras The new set of extras in the Intent, or null to erase
6376 * all extras.
6377 */
6378 public Intent replaceExtras(Bundle extras) {
6379 mExtras = extras != null ? new Bundle(extras) : null;
6380 return this;
6381 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006382
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006383 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006384 * Remove extended data from the intent.
6385 *
6386 * @see #putExtra
6387 */
6388 public void removeExtra(String name) {
6389 if (mExtras != null) {
6390 mExtras.remove(name);
6391 if (mExtras.size() == 0) {
6392 mExtras = null;
6393 }
6394 }
6395 }
6396
6397 /**
6398 * Set special flags controlling how this intent is handled. Most values
6399 * here depend on the type of component being executed by the Intent,
6400 * specifically the FLAG_ACTIVITY_* flags are all for use with
6401 * {@link Context#startActivity Context.startActivity()} and the
6402 * FLAG_RECEIVER_* flags are all for use with
6403 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6404 *
Scott Main7aee61f2011-02-08 11:25:01 -08006405 * <p>See the
6406 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6407 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006408 * the behavior of your application.
6409 *
6410 * @param flags The desired flags.
6411 *
6412 * @return Returns the same Intent object, for chaining multiple calls
6413 * into a single statement.
6414 *
6415 * @see #getFlags
6416 * @see #addFlags
6417 *
6418 * @see #FLAG_GRANT_READ_URI_PERMISSION
6419 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006420 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6421 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006422 * @see #FLAG_DEBUG_LOG_RESOLUTION
6423 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006424 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006425 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006426 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006427 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006428 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6429 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006430 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006431 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006432 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006433 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006434 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006435 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006436 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006437 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6438 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006439 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006440 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006441 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006442 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6443 */
6444 public Intent setFlags(int flags) {
6445 mFlags = flags;
6446 return this;
6447 }
6448
6449 /**
6450 * Add additional flags to the intent (or with existing flags
6451 * value).
6452 *
6453 * @param flags The new flags to set.
6454 *
6455 * @return Returns the same Intent object, for chaining multiple calls
6456 * into a single statement.
6457 *
6458 * @see #setFlags
6459 */
6460 public Intent addFlags(int flags) {
6461 mFlags |= flags;
6462 return this;
6463 }
6464
6465 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006466 * (Usually optional) Set an explicit application package name that limits
6467 * the components this Intent will resolve to. If left to the default
6468 * value of null, all components in all applications will considered.
6469 * If non-null, the Intent can only match the components in the given
6470 * application package.
6471 *
6472 * @param packageName The name of the application package to handle the
6473 * intent, or null to allow any application package.
6474 *
6475 * @return Returns the same Intent object, for chaining multiple calls
6476 * into a single statement.
6477 *
6478 * @see #getPackage
6479 * @see #resolveActivity
6480 */
6481 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006482 if (packageName != null && mSelector != null) {
6483 throw new IllegalArgumentException(
6484 "Can't set package name when selector is already set");
6485 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006486 mPackage = packageName;
6487 return this;
6488 }
6489
6490 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006491 * (Usually optional) Explicitly set the component to handle the intent.
6492 * If left with the default value of null, the system will determine the
6493 * appropriate class to use based on the other fields (action, data,
6494 * type, categories) in the Intent. If this class is defined, the
6495 * specified class will always be used regardless of the other fields. You
6496 * should only set this value when you know you absolutely want a specific
6497 * class to be used; otherwise it is better to let the system find the
6498 * appropriate class so that you will respect the installed applications
6499 * and user preferences.
6500 *
6501 * @param component The name of the application component to handle the
6502 * intent, or null to let the system find one for you.
6503 *
6504 * @return Returns the same Intent object, for chaining multiple calls
6505 * into a single statement.
6506 *
6507 * @see #setClass
6508 * @see #setClassName(Context, String)
6509 * @see #setClassName(String, String)
6510 * @see #getComponent
6511 * @see #resolveActivity
6512 */
6513 public Intent setComponent(ComponentName component) {
6514 mComponent = component;
6515 return this;
6516 }
6517
6518 /**
6519 * Convenience for calling {@link #setComponent} with an
6520 * explicit class name.
6521 *
6522 * @param packageContext A Context of the application package implementing
6523 * this class.
6524 * @param className The name of a class inside of the application package
6525 * that will be used as the component for this Intent.
6526 *
6527 * @return Returns the same Intent object, for chaining multiple calls
6528 * into a single statement.
6529 *
6530 * @see #setComponent
6531 * @see #setClass
6532 */
6533 public Intent setClassName(Context packageContext, String className) {
6534 mComponent = new ComponentName(packageContext, className);
6535 return this;
6536 }
6537
6538 /**
6539 * Convenience for calling {@link #setComponent} with an
6540 * explicit application package name and class name.
6541 *
6542 * @param packageName The name of the package implementing the desired
6543 * component.
6544 * @param className The name of a class inside of the application package
6545 * that will be used as the component for this Intent.
6546 *
6547 * @return Returns the same Intent object, for chaining multiple calls
6548 * into a single statement.
6549 *
6550 * @see #setComponent
6551 * @see #setClass
6552 */
6553 public Intent setClassName(String packageName, String className) {
6554 mComponent = new ComponentName(packageName, className);
6555 return this;
6556 }
6557
6558 /**
6559 * Convenience for calling {@link #setComponent(ComponentName)} with the
6560 * name returned by a {@link Class} object.
6561 *
6562 * @param packageContext A Context of the application package implementing
6563 * this class.
6564 * @param cls The class name to set, equivalent to
6565 * <code>setClassName(context, cls.getName())</code>.
6566 *
6567 * @return Returns the same Intent object, for chaining multiple calls
6568 * into a single statement.
6569 *
6570 * @see #setComponent
6571 */
6572 public Intent setClass(Context packageContext, Class<?> cls) {
6573 mComponent = new ComponentName(packageContext, cls);
6574 return this;
6575 }
6576
6577 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006578 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6579 * used as a hint to the receiver for animations and the like. Null means that there
6580 * is no source bounds.
6581 */
6582 public void setSourceBounds(Rect r) {
6583 if (r != null) {
6584 mSourceBounds = new Rect(r);
6585 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006586 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006587 }
6588 }
6589
Tor Norbyed9273d62013-05-30 15:59:53 -07006590 /** @hide */
6591 @IntDef(flag = true,
6592 value = {
6593 FILL_IN_ACTION,
6594 FILL_IN_DATA,
6595 FILL_IN_CATEGORIES,
6596 FILL_IN_COMPONENT,
6597 FILL_IN_PACKAGE,
6598 FILL_IN_SOURCE_BOUNDS,
6599 FILL_IN_SELECTOR,
6600 FILL_IN_CLIP_DATA
6601 })
6602 @Retention(RetentionPolicy.SOURCE)
6603 public @interface FillInFlags {}
6604
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006605 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006606 * Use with {@link #fillIn} to allow the current action value to be
6607 * overwritten, even if it is already set.
6608 */
6609 public static final int FILL_IN_ACTION = 1<<0;
6610
6611 /**
6612 * Use with {@link #fillIn} to allow the current data or type value
6613 * overwritten, even if it is already set.
6614 */
6615 public static final int FILL_IN_DATA = 1<<1;
6616
6617 /**
6618 * Use with {@link #fillIn} to allow the current categories to be
6619 * overwritten, even if they are already set.
6620 */
6621 public static final int FILL_IN_CATEGORIES = 1<<2;
6622
6623 /**
6624 * Use with {@link #fillIn} to allow the current component value to be
6625 * overwritten, even if it is already set.
6626 */
6627 public static final int FILL_IN_COMPONENT = 1<<3;
6628
6629 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006630 * Use with {@link #fillIn} to allow the current package value to be
6631 * overwritten, even if it is already set.
6632 */
6633 public static final int FILL_IN_PACKAGE = 1<<4;
6634
6635 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006636 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006637 * overwritten, even if it is already set.
6638 */
6639 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6640
6641 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006642 * Use with {@link #fillIn} to allow the current selector to be
6643 * overwritten, even if it is already set.
6644 */
6645 public static final int FILL_IN_SELECTOR = 1<<6;
6646
6647 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006648 * Use with {@link #fillIn} to allow the current ClipData to be
6649 * overwritten, even if it is already set.
6650 */
6651 public static final int FILL_IN_CLIP_DATA = 1<<7;
6652
6653 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006654 * Copy the contents of <var>other</var> in to this object, but only
6655 * where fields are not defined by this object. For purposes of a field
6656 * being defined, the following pieces of data in the Intent are
6657 * considered to be separate fields:
6658 *
6659 * <ul>
6660 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006661 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006662 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6663 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006664 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006665 * <li> component, as set by {@link #setComponent(ComponentName)} or
6666 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006667 * <li> source bounds, as set by {@link #setSourceBounds}.
6668 * <li> selector, as set by {@link #setSelector(Intent)}.
6669 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006670 * <li> each top-level name in the associated extras.
6671 * </ul>
6672 *
6673 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006674 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006675 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6676 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6677 * the restriction where the corresponding field will not be replaced if
6678 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006679 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006680 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6681 * is explicitly specified. The selector will only be copied if
6682 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006683 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006684 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6685 * and Intent B with {action="gotit", data-type="some/thing",
6686 * categories="one","two"}.
6687 *
6688 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6689 * containing: {action="gotit", data-type="some/thing",
6690 * categories="bar"}.
6691 *
6692 * @param other Another Intent whose values are to be used to fill in
6693 * the current one.
6694 * @param flags Options to control which fields can be filled in.
6695 *
6696 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006697 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006698 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6699 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6700 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006701 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006702 @FillInFlags
6703 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006704 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006705 if (other.mAction != null
6706 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006707 mAction = other.mAction;
6708 changes |= FILL_IN_ACTION;
6709 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006710 if ((other.mData != null || other.mType != null)
6711 && ((mData == null && mType == null)
6712 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006713 mData = other.mData;
6714 mType = other.mType;
6715 changes |= FILL_IN_DATA;
6716 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006717 if (other.mCategories != null
6718 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006719 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006720 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006721 }
6722 changes |= FILL_IN_CATEGORIES;
6723 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006724 if (other.mPackage != null
6725 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006726 // Only do this if mSelector is not set.
6727 if (mSelector == null) {
6728 mPackage = other.mPackage;
6729 changes |= FILL_IN_PACKAGE;
6730 }
6731 }
6732 // Selector is special: it can only be set if explicitly allowed,
6733 // for the same reason as the component name.
6734 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6735 if (mPackage == null) {
6736 mSelector = new Intent(other.mSelector);
6737 mPackage = null;
6738 changes |= FILL_IN_SELECTOR;
6739 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006740 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006741 if (other.mClipData != null
6742 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6743 mClipData = other.mClipData;
6744 changes |= FILL_IN_CLIP_DATA;
6745 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006746 // Component is special: it can -only- be set if explicitly allowed,
6747 // since otherwise the sender could force the intent somewhere the
6748 // originator didn't intend.
6749 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006750 mComponent = other.mComponent;
6751 changes |= FILL_IN_COMPONENT;
6752 }
6753 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006754 if (other.mSourceBounds != null
6755 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6756 mSourceBounds = new Rect(other.mSourceBounds);
6757 changes |= FILL_IN_SOURCE_BOUNDS;
6758 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006759 if (mExtras == null) {
6760 if (other.mExtras != null) {
6761 mExtras = new Bundle(other.mExtras);
6762 }
6763 } else if (other.mExtras != null) {
6764 try {
6765 Bundle newb = new Bundle(other.mExtras);
6766 newb.putAll(mExtras);
6767 mExtras = newb;
6768 } catch (RuntimeException e) {
6769 // Modifying the extras can cause us to unparcel the contents
6770 // of the bundle, and if we do this in the system process that
6771 // may fail. We really should handle this (i.e., the Bundle
6772 // impl shouldn't be on top of a plain map), but for now just
6773 // ignore it and keep the original contents. :(
6774 Log.w("Intent", "Failure filling in extras", e);
6775 }
6776 }
6777 return changes;
6778 }
6779
6780 /**
6781 * Wrapper class holding an Intent and implementing comparisons on it for
6782 * the purpose of filtering. The class implements its
6783 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6784 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6785 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6786 * on the wrapped Intent.
6787 */
6788 public static final class FilterComparison {
6789 private final Intent mIntent;
6790 private final int mHashCode;
6791
6792 public FilterComparison(Intent intent) {
6793 mIntent = intent;
6794 mHashCode = intent.filterHashCode();
6795 }
6796
6797 /**
6798 * Return the Intent that this FilterComparison represents.
6799 * @return Returns the Intent held by the FilterComparison. Do
6800 * not modify!
6801 */
6802 public Intent getIntent() {
6803 return mIntent;
6804 }
6805
6806 @Override
6807 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006808 if (obj instanceof FilterComparison) {
6809 Intent other = ((FilterComparison)obj).mIntent;
6810 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006811 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006812 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006813 }
6814
6815 @Override
6816 public int hashCode() {
6817 return mHashCode;
6818 }
6819 }
6820
6821 /**
6822 * Determine if two intents are the same for the purposes of intent
6823 * resolution (filtering). That is, if their action, data, type,
6824 * class, and categories are the same. This does <em>not</em> compare
6825 * any extra data included in the intents.
6826 *
6827 * @param other The other Intent to compare against.
6828 *
6829 * @return Returns true if action, data, type, class, and categories
6830 * are the same.
6831 */
6832 public boolean filterEquals(Intent other) {
6833 if (other == null) {
6834 return false;
6835 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07006836 if (!Objects.equals(this.mAction, other.mAction)) return false;
6837 if (!Objects.equals(this.mData, other.mData)) return false;
6838 if (!Objects.equals(this.mType, other.mType)) return false;
6839 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
6840 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
6841 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006842
6843 return true;
6844 }
6845
6846 /**
6847 * Generate hash code that matches semantics of filterEquals().
6848 *
6849 * @return Returns the hash value of the action, data, type, class, and
6850 * categories.
6851 *
6852 * @see #filterEquals
6853 */
6854 public int filterHashCode() {
6855 int code = 0;
6856 if (mAction != null) {
6857 code += mAction.hashCode();
6858 }
6859 if (mData != null) {
6860 code += mData.hashCode();
6861 }
6862 if (mType != null) {
6863 code += mType.hashCode();
6864 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006865 if (mPackage != null) {
6866 code += mPackage.hashCode();
6867 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006868 if (mComponent != null) {
6869 code += mComponent.hashCode();
6870 }
6871 if (mCategories != null) {
6872 code += mCategories.hashCode();
6873 }
6874 return code;
6875 }
6876
6877 @Override
6878 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006879 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006880
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006881 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006882 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006883 b.append(" }");
6884
6885 return b.toString();
6886 }
6887
6888 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006889 public String toInsecureString() {
6890 StringBuilder b = new StringBuilder(128);
6891
6892 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006893 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006894 b.append(" }");
6895
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006896 return b.toString();
6897 }
Romain Guy4969af72009-06-17 10:53:19 -07006898
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006899 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006900 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006901 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006902
6903 b.append("Intent { ");
6904 toShortString(b, false, true, true, true);
6905 b.append(" }");
6906
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006907 return b.toString();
6908 }
6909
6910 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006911 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6912 StringBuilder b = new StringBuilder(128);
6913 toShortString(b, secure, comp, extras, clip);
6914 return b.toString();
6915 }
6916
6917 /** @hide */
6918 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6919 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006920 boolean first = true;
6921 if (mAction != null) {
6922 b.append("act=").append(mAction);
6923 first = false;
6924 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006925 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006926 if (!first) {
6927 b.append(' ');
6928 }
6929 first = false;
6930 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006931 for (int i=0; i<mCategories.size(); i++) {
6932 if (i > 0) b.append(',');
6933 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006934 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006935 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006936 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006937 if (mData != null) {
6938 if (!first) {
6939 b.append(' ');
6940 }
6941 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006942 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006943 if (secure) {
6944 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006945 } else {
6946 b.append(mData);
6947 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006948 }
6949 if (mType != null) {
6950 if (!first) {
6951 b.append(' ');
6952 }
6953 first = false;
6954 b.append("typ=").append(mType);
6955 }
6956 if (mFlags != 0) {
6957 if (!first) {
6958 b.append(' ');
6959 }
6960 first = false;
6961 b.append("flg=0x").append(Integer.toHexString(mFlags));
6962 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006963 if (mPackage != null) {
6964 if (!first) {
6965 b.append(' ');
6966 }
6967 first = false;
6968 b.append("pkg=").append(mPackage);
6969 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006970 if (comp && mComponent != null) {
6971 if (!first) {
6972 b.append(' ');
6973 }
6974 first = false;
6975 b.append("cmp=").append(mComponent.flattenToShortString());
6976 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006977 if (mSourceBounds != null) {
6978 if (!first) {
6979 b.append(' ');
6980 }
6981 first = false;
6982 b.append("bnds=").append(mSourceBounds.toShortString());
6983 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006984 if (mClipData != null) {
6985 if (!first) {
6986 b.append(' ');
6987 }
6988 first = false;
6989 if (clip) {
6990 b.append("clip={");
6991 mClipData.toShortString(b);
6992 b.append('}');
6993 } else {
6994 b.append("(has clip)");
6995 }
6996 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006997 if (extras && mExtras != null) {
6998 if (!first) {
6999 b.append(' ');
7000 }
7001 first = false;
7002 b.append("(has extras)");
7003 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007004 if (mSelector != null) {
7005 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007006 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007007 b.append("}");
7008 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007009 }
7010
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007011 /**
7012 * Call {@link #toUri} with 0 flags.
7013 * @deprecated Use {@link #toUri} instead.
7014 */
7015 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007016 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007017 return toUri(0);
7018 }
7019
7020 /**
7021 * Convert this Intent into a String holding a URI representation of it.
7022 * The returned URI string has been properly URI encoded, so it can be
7023 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7024 * Intent's data as the base URI, with an additional fragment describing
7025 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007026 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007027 * <p>You can convert the returned string back to an Intent with
7028 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007029 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007030 * @param flags Additional operating flags. Either 0 or
7031 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007032 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007033 * @return Returns a URI encoding URI string describing the entire contents
7034 * of the Intent.
7035 */
7036 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007037 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007038 String scheme = null;
7039 if (mData != null) {
7040 String data = mData.toString();
7041 if ((flags&URI_INTENT_SCHEME) != 0) {
7042 final int N = data.length();
7043 for (int i=0; i<N; i++) {
7044 char c = data.charAt(i);
7045 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7046 || c == '.' || c == '-') {
7047 continue;
7048 }
7049 if (c == ':' && i > 0) {
7050 // Valid scheme.
7051 scheme = data.substring(0, i);
7052 uri.append("intent:");
7053 data = data.substring(i+1);
7054 break;
7055 }
Tom Taylord4a47292009-12-21 13:59:18 -08007056
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007057 // No scheme.
7058 break;
7059 }
7060 }
7061 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007062
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007063 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7064 uri.append("intent:");
7065 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007066
7067 uri.append("#Intent;");
7068
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007069 toUriInner(uri, scheme, flags);
7070 if (mSelector != null) {
7071 uri.append("SEL;");
7072 // Note that for now we are not going to try to handle the
7073 // data part; not clear how to represent this as a URI, and
7074 // not much utility in it.
7075 mSelector.toUriInner(uri, null, flags);
7076 }
7077
7078 uri.append("end");
7079
7080 return uri.toString();
7081 }
7082
7083 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007084 if (scheme != null) {
7085 uri.append("scheme=").append(scheme).append(';');
7086 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007087 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007088 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007089 }
7090 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007091 for (int i=0; i<mCategories.size(); i++) {
7092 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007093 }
7094 }
7095 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007096 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007097 }
7098 if (mFlags != 0) {
7099 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7100 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007101 if (mPackage != null) {
7102 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7103 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007104 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007105 uri.append("component=").append(Uri.encode(
7106 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007107 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007108 if (mSourceBounds != null) {
7109 uri.append("sourceBounds=")
7110 .append(Uri.encode(mSourceBounds.flattenToString()))
7111 .append(';');
7112 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007113 if (mExtras != null) {
7114 for (String key : mExtras.keySet()) {
7115 final Object value = mExtras.get(key);
7116 char entryType =
7117 value instanceof String ? 'S' :
7118 value instanceof Boolean ? 'B' :
7119 value instanceof Byte ? 'b' :
7120 value instanceof Character ? 'c' :
7121 value instanceof Double ? 'd' :
7122 value instanceof Float ? 'f' :
7123 value instanceof Integer ? 'i' :
7124 value instanceof Long ? 'l' :
7125 value instanceof Short ? 's' :
7126 '\0';
7127
7128 if (entryType != '\0') {
7129 uri.append(entryType);
7130 uri.append('.');
7131 uri.append(Uri.encode(key));
7132 uri.append('=');
7133 uri.append(Uri.encode(value.toString()));
7134 uri.append(';');
7135 }
7136 }
7137 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007138 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007139
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007140 public int describeContents() {
7141 return (mExtras != null) ? mExtras.describeContents() : 0;
7142 }
7143
7144 public void writeToParcel(Parcel out, int flags) {
7145 out.writeString(mAction);
7146 Uri.writeToParcel(out, mData);
7147 out.writeString(mType);
7148 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007149 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007150 ComponentName.writeToParcel(mComponent, out);
7151
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007152 if (mSourceBounds != null) {
7153 out.writeInt(1);
7154 mSourceBounds.writeToParcel(out, flags);
7155 } else {
7156 out.writeInt(0);
7157 }
7158
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007159 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007160 final int N = mCategories.size();
7161 out.writeInt(N);
7162 for (int i=0; i<N; i++) {
7163 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007164 }
7165 } else {
7166 out.writeInt(0);
7167 }
7168
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007169 if (mSelector != null) {
7170 out.writeInt(1);
7171 mSelector.writeToParcel(out, flags);
7172 } else {
7173 out.writeInt(0);
7174 }
7175
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007176 if (mClipData != null) {
7177 out.writeInt(1);
7178 mClipData.writeToParcel(out, flags);
7179 } else {
7180 out.writeInt(0);
7181 }
7182
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007183 out.writeBundle(mExtras);
7184 }
7185
7186 public static final Parcelable.Creator<Intent> CREATOR
7187 = new Parcelable.Creator<Intent>() {
7188 public Intent createFromParcel(Parcel in) {
7189 return new Intent(in);
7190 }
7191 public Intent[] newArray(int size) {
7192 return new Intent[size];
7193 }
7194 };
7195
Dianne Hackborneb034652009-09-07 00:49:58 -07007196 /** @hide */
7197 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007198 readFromParcel(in);
7199 }
7200
7201 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007202 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007203 mData = Uri.CREATOR.createFromParcel(in);
7204 mType = in.readString();
7205 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007206 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007207 mComponent = ComponentName.readFromParcel(in);
7208
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007209 if (in.readInt() != 0) {
7210 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7211 }
7212
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007213 int N = in.readInt();
7214 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007215 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007216 int i;
7217 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007218 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007219 }
7220 } else {
7221 mCategories = null;
7222 }
7223
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007224 if (in.readInt() != 0) {
7225 mSelector = new Intent(in);
7226 }
7227
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007228 if (in.readInt() != 0) {
7229 mClipData = new ClipData(in);
7230 }
7231
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007232 mExtras = in.readBundle();
7233 }
7234
7235 /**
7236 * Parses the "intent" element (and its children) from XML and instantiates
7237 * an Intent object. The given XML parser should be located at the tag
7238 * where parsing should start (often named "intent"), from which the
7239 * basic action, data, type, and package and class name will be
7240 * retrieved. The function will then parse in to any child elements,
7241 * looking for <category android:name="xxx"> tags to add categories and
7242 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7243 * to the intent.
7244 *
7245 * @param resources The Resources to use when inflating resources.
7246 * @param parser The XML parser pointing at an "intent" tag.
7247 * @param attrs The AttributeSet interface for retrieving extended
7248 * attribute data at the current <var>parser</var> location.
7249 * @return An Intent object matching the XML data.
7250 * @throws XmlPullParserException If there was an XML parsing error.
7251 * @throws IOException If there was an I/O error.
7252 */
7253 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7254 throws XmlPullParserException, IOException {
7255 Intent intent = new Intent();
7256
7257 TypedArray sa = resources.obtainAttributes(attrs,
7258 com.android.internal.R.styleable.Intent);
7259
7260 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7261
7262 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7263 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7264 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7265
7266 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7267 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7268 if (packageName != null && className != null) {
7269 intent.setComponent(new ComponentName(packageName, className));
7270 }
7271
7272 sa.recycle();
7273
7274 int outerDepth = parser.getDepth();
7275 int type;
7276 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7277 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7278 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7279 continue;
7280 }
7281
7282 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007283 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007284 sa = resources.obtainAttributes(attrs,
7285 com.android.internal.R.styleable.IntentCategory);
7286 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7287 sa.recycle();
7288
7289 if (cat != null) {
7290 intent.addCategory(cat);
7291 }
7292 XmlUtils.skipCurrentTag(parser);
7293
Craig Mautner21d24a22014-04-23 11:45:37 -07007294 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007295 if (intent.mExtras == null) {
7296 intent.mExtras = new Bundle();
7297 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007298 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007299 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007300
7301 } else {
7302 XmlUtils.skipCurrentTag(parser);
7303 }
7304 }
7305
7306 return intent;
7307 }
Nick Pellyccae4122012-01-09 14:12:58 -08007308
Craig Mautner21d24a22014-04-23 11:45:37 -07007309 /** @hide */
7310 public void saveToXml(XmlSerializer out) throws IOException {
7311 if (mAction != null) {
7312 out.attribute(null, ATTR_ACTION, mAction);
7313 }
7314 if (mData != null) {
7315 out.attribute(null, ATTR_DATA, mData.toString());
7316 }
7317 if (mType != null) {
7318 out.attribute(null, ATTR_TYPE, mType);
7319 }
7320 if (mComponent != null) {
7321 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7322 }
7323 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7324
7325 if (mCategories != null) {
7326 out.startTag(null, TAG_CATEGORIES);
7327 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7328 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7329 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007330 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007331 }
7332 }
7333
7334 /** @hide */
7335 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7336 XmlPullParserException {
7337 Intent intent = new Intent();
7338 final int outerDepth = in.getDepth();
7339
7340 int attrCount = in.getAttributeCount();
7341 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7342 final String attrName = in.getAttributeName(attrNdx);
7343 final String attrValue = in.getAttributeValue(attrNdx);
7344 if (ATTR_ACTION.equals(attrName)) {
7345 intent.setAction(attrValue);
7346 } else if (ATTR_DATA.equals(attrName)) {
7347 intent.setData(Uri.parse(attrValue));
7348 } else if (ATTR_TYPE.equals(attrName)) {
7349 intent.setType(attrValue);
7350 } else if (ATTR_COMPONENT.equals(attrName)) {
7351 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7352 } else if (ATTR_FLAGS.equals(attrName)) {
7353 intent.setFlags(Integer.valueOf(attrValue, 16));
7354 } else {
7355 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7356 }
7357 }
7358
7359 int event;
7360 String name;
7361 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7362 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7363 if (event == XmlPullParser.START_TAG) {
7364 name = in.getName();
7365 if (TAG_CATEGORIES.equals(name)) {
7366 attrCount = in.getAttributeCount();
7367 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7368 intent.addCategory(in.getAttributeValue(attrNdx));
7369 }
7370 } else {
7371 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7372 XmlUtils.skipCurrentTag(in);
7373 }
7374 }
7375 }
7376
7377 return intent;
7378 }
7379
Nick Pellyccae4122012-01-09 14:12:58 -08007380 /**
7381 * Normalize a MIME data type.
7382 *
7383 * <p>A normalized MIME type has white-space trimmed,
7384 * content-type parameters removed, and is lower-case.
7385 * This aligns the type with Android best practices for
7386 * intent filtering.
7387 *
7388 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7389 * "text/x-vCard" becomes "text/x-vcard".
7390 *
7391 * <p>All MIME types received from outside Android (such as user input,
7392 * or external sources like Bluetooth, NFC, or the Internet) should
7393 * be normalized before they are used to create an Intent.
7394 *
7395 * @param type MIME data type to normalize
7396 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007397 * @see #setType
7398 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007399 */
7400 public static String normalizeMimeType(String type) {
7401 if (type == null) {
7402 return null;
7403 }
7404
Elliott Hughescb64d432013-08-02 10:00:44 -07007405 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007406
7407 final int semicolonIndex = type.indexOf(';');
7408 if (semicolonIndex != -1) {
7409 type = type.substring(0, semicolonIndex);
7410 }
7411 return type;
7412 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007413
7414 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007415 * Prepare this {@link Intent} to leave an app process.
7416 *
7417 * @hide
7418 */
7419 public void prepareToLeaveProcess() {
7420 setAllowFds(false);
7421
7422 if (mSelector != null) {
7423 mSelector.prepareToLeaveProcess();
7424 }
7425 if (mClipData != null) {
7426 mClipData.prepareToLeaveProcess();
7427 }
7428
7429 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7430 // There are several ACTION_MEDIA_* broadcasts that send file://
7431 // Uris, so only check common actions.
7432 if (ACTION_VIEW.equals(mAction) ||
7433 ACTION_EDIT.equals(mAction) ||
7434 ACTION_ATTACH_DATA.equals(mAction)) {
7435 mData.checkFileUriExposed("Intent.getData()");
7436 }
7437 }
7438 }
7439
7440 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007441 * Prepare this {@link Intent} to be sent to another user
7442 *
7443 * @hide
7444 */
7445 public void prepareToLeaveUser(int userId) {
7446 Uri data = getData();
7447 if (data != null) {
7448 mData = maybeAddUserId(data, userId);
7449 }
7450 if (mSelector != null) {
7451 mSelector.prepareToLeaveUser(userId);
7452 }
7453 if (mClipData != null) {
7454 mClipData.prepareToLeaveUser(userId);
7455 }
7456 String action = getAction();
7457 if (ACTION_SEND.equals(action)) {
7458 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7459 if (stream != null) {
7460 putExtra(EXTRA_STREAM, maybeAddUserId(stream, userId));
7461 }
7462 }
7463 if (ACTION_SEND_MULTIPLE.equals(action)) {
7464 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7465 if (streams != null) {
7466 ArrayList<Uri> newStreams = new ArrayList<Uri>();
7467 for (int i = 0; i < streams.size(); i++) {
7468 newStreams.add(maybeAddUserId(streams.get(i), userId));
7469 }
7470 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
7471 }
7472 }
7473 }
7474
7475 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007476 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007477 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7478 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007479 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007480 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007481 * @hide
7482 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007483 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007484 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007485 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007486
7487 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007488 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007489
7490 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007491 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007492 try {
7493 // Inspect target intent to see if we need to migrate
7494 final Intent target = getParcelableExtra(EXTRA_INTENT);
7495 if (target != null && target.migrateExtraStreamToClipData()) {
7496 // Since we migrated in child, we need to promote ClipData
7497 // and flags to ourselves to grant.
7498 setClipData(target.getClipData());
Jeff Sharkey846318a2014-04-04 12:12:41 -07007499 addFlags(target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
7500 | FLAG_GRANT_WRITE_URI_PERMISSION
7501 | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7502 | FLAG_GRANT_PREFIX_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007503 return true;
7504 } else {
7505 return false;
7506 }
7507 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007508 }
7509
7510 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007511 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007512 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7513 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7514 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7515 if (stream != null || text != null || htmlText != null) {
7516 final ClipData clipData = new ClipData(
7517 null, new String[] { getType() },
7518 new ClipData.Item(text, htmlText, null, stream));
7519 setClipData(clipData);
7520 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007521 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007522 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007523 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007524 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007525
7526 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007527 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007528 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7529 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7530 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7531 int num = -1;
7532 if (streams != null) {
7533 num = streams.size();
7534 }
7535 if (texts != null) {
7536 if (num >= 0 && num != texts.size()) {
7537 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007538 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007539 }
7540 num = texts.size();
7541 }
7542 if (htmlTexts != null) {
7543 if (num >= 0 && num != htmlTexts.size()) {
7544 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007545 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007546 }
7547 num = htmlTexts.size();
7548 }
7549 if (num > 0) {
7550 final ClipData clipData = new ClipData(
7551 null, new String[] { getType() },
7552 makeClipItem(streams, texts, htmlTexts, 0));
7553
7554 for (int i = 1; i < num; i++) {
7555 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7556 }
7557
7558 setClipData(clipData);
7559 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007560 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007561 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007562 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007563 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007564 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007565
7566 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007567 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007568
7569 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7570 ArrayList<String> htmlTexts, int which) {
7571 Uri uri = streams != null ? streams.get(which) : null;
7572 CharSequence text = texts != null ? texts.get(which) : null;
7573 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7574 return new ClipData.Item(text, htmlText, null, uri);
7575 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007576
7577 /** @hide */
7578 public boolean isDocument() {
7579 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7580 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007581}