blob: 4153a02cedc2df0c810e4a1e55cf6e4e417cdb7f [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 /**
2685 * Broadcast Action: This is broadcast when a user action should request the
2686 * brightness setting dialog.
2687 * @hide
2688 */
2689 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2690 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2691
Justin Kohd378ad72013-04-01 12:18:26 -07002692 /**
2693 * Broadcast Action: A global button was pressed. Includes a single
2694 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2695 * caused the broadcast.
2696 * @hide
2697 */
2698 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2699
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002700 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002701 * Activity Action: Allow the user to select and return one or more existing
2702 * documents. When invoked, the system will display the various
2703 * {@link DocumentsProvider} instances installed on the device, letting the
2704 * user interactively navigate through them. These documents include local
2705 * media, such as photos and video, and documents provided by installed
2706 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002707 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002708 * Each document is represented as a {@code content://} URI backed by a
2709 * {@link DocumentsProvider}, which can be opened as a stream with
2710 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2711 * {@link android.provider.DocumentsContract.Document} metadata.
2712 * <p>
2713 * All selected documents are returned to the calling application with
2714 * persistable read and write permission grants. If you want to maintain
2715 * access to the documents across device reboots, you need to explicitly
2716 * take the persistable permissions using
2717 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2718 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002719 * Callers must indicate the acceptable document MIME types through
2720 * {@link #setType(String)}. For example, to select photos, use
2721 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2722 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2723 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002724 * <p>
2725 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002726 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2727 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002728 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002729 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2730 * returned URIs can be opened with
2731 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002732 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002733 * Output: The URI of the item that was picked, returned in
2734 * {@link #getData()}. This must be a {@code content://} URI so that any
2735 * receiver can access it. If multiple documents were selected, they are
2736 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002737 *
2738 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002739 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002740 * @see #ACTION_CREATE_DOCUMENT
2741 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002742 */
2743 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2744 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2745
2746 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002747 * Activity Action: Allow the user to create a new document. When invoked,
2748 * the system will display the various {@link DocumentsProvider} instances
2749 * installed on the device, letting the user navigate through them. The
2750 * returned document may be a newly created document with no content, or it
2751 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002752 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002753 * Each document is represented as a {@code content://} URI backed by a
2754 * {@link DocumentsProvider}, which can be opened as a stream with
2755 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2756 * {@link android.provider.DocumentsContract.Document} metadata.
2757 * <p>
2758 * Callers must indicate the concrete MIME type of the document being
2759 * created by setting {@link #setType(String)}. This MIME type cannot be
2760 * changed after the document is created.
2761 * <p>
2762 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2763 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002764 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002765 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2766 * returned URIs can be opened with
2767 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002768 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002769 * Output: The URI of the item that was created. This must be a
2770 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002771 *
2772 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002773 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002774 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002775 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002776 */
2777 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2778 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2779
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002780 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002781 * Activity Action: Allow the user to pick a directory subtree. When
2782 * invoked, the system will display the various {@link DocumentsProvider}
2783 * instances installed on the device, letting the user navigate through
2784 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002785 * <p>
2786 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002787 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2788 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2789 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002790 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002791 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002792 *
2793 * @see DocumentsContract
2794 */
2795 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002796 public static final String
2797 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002798
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002799 // ---------------------------------------------------------------------
2800 // ---------------------------------------------------------------------
2801 // Standard intent categories (see addCategory()).
2802
2803 /**
2804 * Set if the activity should be an option for the default action
2805 * (center press) to perform on a piece of data. Setting this will
2806 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002807 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002808 * Intent when initiating an action -- it is for use in intent filters
2809 * specified in packages.
2810 */
2811 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2812 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2813 /**
2814 * Activities that can be safely invoked from a browser must support this
2815 * category. For example, if the user is viewing a web page or an e-mail
2816 * and clicks on a link in the text, the Intent generated execute that
2817 * link will require the BROWSABLE category, so that only activities
2818 * supporting this category will be considered as possible actions. By
2819 * supporting this category, you are promising that there is nothing
2820 * damaging (without user intervention) that can happen by invoking any
2821 * matching Intent.
2822 */
2823 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2824 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2825 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07002826 * Categories for activities that can participate in voice interaction.
2827 * An activity that supports this category must be prepared to run with
2828 * no UI shown at all (though in some case it may have a UI shown), and
2829 * rely on {@link android.app.VoiceInteractor} to interact with the user.
2830 */
2831 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2832 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2833 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002834 * Set if the activity should be considered as an alternative action to
2835 * the data the user is currently viewing. See also
2836 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2837 * applies to the selection in a list of items.
2838 *
2839 * <p>Supporting this category means that you would like your activity to be
2840 * displayed in the set of alternative things the user can do, usually as
2841 * part of the current activity's options menu. You will usually want to
2842 * include a specific label in the &lt;intent-filter&gt; of this action
2843 * describing to the user what it does.
2844 *
2845 * <p>The action of IntentFilter with this category is important in that it
2846 * describes the specific action the target will perform. This generally
2847 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2848 * a specific name such as "com.android.camera.action.CROP. Only one
2849 * alternative of any particular action will be shown to the user, so using
2850 * a specific action like this makes sure that your alternative will be
2851 * displayed while also allowing other applications to provide their own
2852 * overrides of that particular action.
2853 */
2854 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2855 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2856 /**
2857 * Set if the activity should be considered as an alternative selection
2858 * action to the data the user has currently selected. This is like
2859 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2860 * of items from which the user can select, giving them alternatives to the
2861 * default action that will be performed on it.
2862 */
2863 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2864 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2865 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002866 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002867 */
2868 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2869 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2870 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002871 * Should be displayed in the top-level launcher.
2872 */
2873 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2874 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2875 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002876 * Indicates an activity optimized for Leanback mode, and that should
2877 * be displayed in the Leanback launcher.
2878 */
2879 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2880 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2881 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002882 * Provides information about the package it is in; typically used if
2883 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2884 * a front-door to the user without having to be shown in the all apps list.
2885 */
2886 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2887 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2888 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002889 * This is the home activity, that is the first activity that is displayed
2890 * when the device boots.
2891 */
2892 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2893 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2894 /**
2895 * This activity is a preference panel.
2896 */
2897 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2898 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2899 /**
2900 * This activity is a development preference panel.
2901 */
2902 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2903 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2904 /**
2905 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002906 */
2907 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2908 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2909 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002910 * This activity allows the user to browse and download new applications.
2911 */
2912 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2913 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2914 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002915 * This activity may be exercised by the monkey or other automated test tools.
2916 */
2917 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2918 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2919 /**
2920 * To be used as a test (not part of the normal user experience).
2921 */
2922 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2923 /**
2924 * To be used as a unit test (run through the Test Harness).
2925 */
2926 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2927 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002928 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002929 * experience).
2930 */
2931 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002932
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002933 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002934 * Used to indicate that an intent only wants URIs that can be opened with
2935 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2936 * must support at least the columns defined in {@link OpenableColumns} when
2937 * queried.
2938 *
2939 * @see #ACTION_GET_CONTENT
2940 * @see #ACTION_OPEN_DOCUMENT
2941 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002942 */
2943 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2944 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2945
2946 /**
2947 * To be used as code under test for framework instrumentation tests.
2948 */
2949 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2950 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002951 /**
2952 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002953 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2954 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002955 */
2956 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2957 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2958 /**
2959 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002960 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2961 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002962 */
2963 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2964 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002965 /**
2966 * An activity to run when device is inserted into a analog (low end) dock.
2967 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2968 * information, see {@link android.app.UiModeManager}.
2969 */
2970 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2971 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2972
2973 /**
2974 * An activity to run when device is inserted into a digital (high end) dock.
2975 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2976 * information, see {@link android.app.UiModeManager}.
2977 */
2978 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2979 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002980
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002981 /**
2982 * Used to indicate that the activity can be used in a car environment.
2983 */
2984 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2985 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2986
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002987 // ---------------------------------------------------------------------
2988 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002989 // Application launch intent categories (see addCategory()).
2990
2991 /**
2992 * Used with {@link #ACTION_MAIN} to launch the browser application.
2993 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002994 * <p>NOTE: This should not be used as the primary key of an Intent,
2995 * since it will not result in the app launching with the correct
2996 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002997 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002998 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002999 */
3000 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3001 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3002
3003 /**
3004 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3005 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003006 * <p>NOTE: This should not be used as the primary key of an Intent,
3007 * since it will not result in the app launching with the correct
3008 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003009 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003010 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003011 */
3012 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3013 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3014
3015 /**
3016 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3017 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003018 * <p>NOTE: This should not be used as the primary key of an Intent,
3019 * since it will not result in the app launching with the correct
3020 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003021 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003022 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003023 */
3024 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3025 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3026
3027 /**
3028 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3029 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003030 * <p>NOTE: This should not be used as the primary key of an Intent,
3031 * since it will not result in the app launching with the correct
3032 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003033 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003034 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003035 */
3036 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3037 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3038
3039 /**
3040 * Used with {@link #ACTION_MAIN} to launch the email application.
3041 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003042 * <p>NOTE: This should not be used as the primary key of an Intent,
3043 * since it will not result in the app launching with the correct
3044 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003045 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003046 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003047 */
3048 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3049 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3050
3051 /**
3052 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3053 * The activity should be able to view and manipulate image and video files
3054 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003055 * <p>NOTE: This should not be used as the primary key of an Intent,
3056 * since it will not result in the app launching with the correct
3057 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003058 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003059 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003060 */
3061 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3062 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3063
3064 /**
3065 * Used with {@link #ACTION_MAIN} to launch the maps application.
3066 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003067 * <p>NOTE: This should not be used as the primary key of an Intent,
3068 * since it will not result in the app launching with the correct
3069 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003070 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003071 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003072 */
3073 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3074 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3075
3076 /**
3077 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3078 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003079 * <p>NOTE: This should not be used as the primary key of an Intent,
3080 * since it will not result in the app launching with the correct
3081 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003082 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003083 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003084 */
3085 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3086 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3087
3088 /**
3089 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003090 * The activity should be able to play, browse, or manipulate music files
3091 * stored on the device.
3092 * <p>NOTE: This should not be used as the primary key of an Intent,
3093 * since it will not result in the app launching with the correct
3094 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003095 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003096 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003097 */
3098 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3099 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3100
3101 // ---------------------------------------------------------------------
3102 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003103 // Standard extra data keys.
3104
3105 /**
3106 * The initial data to place in a newly created record. Use with
3107 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3108 * fields as would be given to the underlying ContentProvider.insert()
3109 * call.
3110 */
3111 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3112
3113 /**
3114 * A constant CharSequence that is associated with the Intent, used with
3115 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3116 * this may be a styled CharSequence, so you must use
3117 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3118 * retrieve it.
3119 */
3120 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3121
3122 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003123 * A constant String that is associated with the Intent, used with
3124 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3125 * as HTML formatted text. Note that you <em>must</em> also supply
3126 * {@link #EXTRA_TEXT}.
3127 */
3128 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3129
3130 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003131 * A content: URI holding a stream of data associated with the Intent,
3132 * used with {@link #ACTION_SEND} to supply the data being sent.
3133 */
3134 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3135
3136 /**
3137 * A String[] holding e-mail addresses that should be delivered to.
3138 */
3139 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3140
3141 /**
3142 * A String[] holding e-mail addresses that should be carbon copied.
3143 */
3144 public static final String EXTRA_CC = "android.intent.extra.CC";
3145
3146 /**
3147 * A String[] holding e-mail addresses that should be blind carbon copied.
3148 */
3149 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3150
3151 /**
3152 * A constant string holding the desired subject line of a message.
3153 */
3154 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3155
3156 /**
3157 * An Intent describing the choices you would like shown with
3158 * {@link #ACTION_PICK_ACTIVITY}.
3159 */
3160 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3161
3162 /**
3163 * A CharSequence dialog title to provide to the user when used with a
3164 * {@link #ACTION_CHOOSER}.
3165 */
3166 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3167
3168 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003169 * A Parcelable[] of {@link Intent} or
3170 * {@link android.content.pm.LabeledIntent} objects as set with
3171 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3172 * a the front of the list of choices, when shown to the user with a
3173 * {@link #ACTION_CHOOSER}.
3174 */
3175 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3176
3177 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003178 * A {@link android.view.KeyEvent} object containing the event that
3179 * triggered the creation of the Intent it is in.
3180 */
3181 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3182
3183 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003184 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3185 * before shutting down.
3186 *
3187 * {@hide}
3188 */
3189 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3190
3191 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003192 * 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 -07003193 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3194 * of restarting the application.
3195 */
3196 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3197
3198 /**
3199 * A String holding the phone number originally entered in
3200 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3201 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3202 */
3203 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003204
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003205 /**
3206 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3207 * intents to supply the uid the package had been assigned. Also an optional
3208 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3209 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3210 * purpose.
3211 */
3212 public static final String EXTRA_UID = "android.intent.extra.UID";
3213
3214 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003215 * @hide String array of package names.
3216 */
3217 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3218
3219 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003220 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3221 * intents to indicate whether this represents a full uninstall (removing
3222 * both the code and its data) or a partial uninstall (leaving its data,
3223 * implying that this is an update).
3224 */
3225 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003226
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003227 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003228 * @hide
3229 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3230 * intents to indicate that at this point the package has been removed for
3231 * all users on the device.
3232 */
3233 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3234 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3235
3236 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003237 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3238 * intents to indicate that this is a replacement of the package, so this
3239 * broadcast will immediately be followed by an add broadcast for a
3240 * different version of the same package.
3241 */
3242 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003243
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003244 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003245 * Used as an int extra field in {@link android.app.AlarmManager} intents
3246 * to tell the application being invoked how many pending alarms are being
3247 * delievered with the intent. For one-shot alarms this will always be 1.
3248 * For recurring alarms, this might be greater than 1 if the device was
3249 * asleep or powered off at the time an earlier alarm would have been
3250 * delivered.
3251 */
3252 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003253
Jacek Surazski86b6c532009-05-13 14:38:28 +02003254 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003255 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3256 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003257 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3258 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003259 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3260 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3261 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003262 */
3263 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3264
3265 /**
3266 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3267 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003268 */
3269 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3270
3271 /**
3272 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3273 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003274 */
3275 public static final int EXTRA_DOCK_STATE_DESK = 1;
3276
3277 /**
3278 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3279 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003280 */
3281 public static final int EXTRA_DOCK_STATE_CAR = 2;
3282
3283 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003284 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3285 * to represent that the phone is in a analog (low end) dock.
3286 */
3287 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3288
3289 /**
3290 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3291 * to represent that the phone is in a digital (high end) dock.
3292 */
3293 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3294
3295 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003296 * Boolean that can be supplied as meta-data with a dock activity, to
3297 * indicate that the dock should take over the home key when it is active.
3298 */
3299 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003300
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003301 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003302 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3303 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003304 */
3305 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3306
3307 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003308 * Used in the extra field in the remote intent. It's astring token passed with the
3309 * remote intent.
3310 */
3311 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3312 "android.intent.extra.remote_intent_token";
3313
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003314 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003315 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003316 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003317 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003318 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003319 "android.intent.extra.changed_component_name";
3320
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003321 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003322 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003323 * and contains a string array of all of the components that have changed. If
3324 * the state of the overall package has changed, then it will contain an entry
3325 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003326 */
3327 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3328 "android.intent.extra.changed_component_name_list";
3329
3330 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003331 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003332 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3333 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003334 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003335 */
3336 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3337 "android.intent.extra.changed_package_list";
3338
3339 /**
3340 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003341 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3342 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003343 * and contains an integer array of uids of all of the components
3344 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003345 */
3346 public static final String EXTRA_CHANGED_UID_LIST =
3347 "android.intent.extra.changed_uid_list";
3348
3349 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003350 * @hide
3351 * Magic extra system code can use when binding, to give a label for
3352 * who it is that has bound to a service. This is an integer giving
3353 * a framework string resource that can be displayed to the user.
3354 */
3355 public static final String EXTRA_CLIENT_LABEL =
3356 "android.intent.extra.client_label";
3357
3358 /**
3359 * @hide
3360 * Magic extra system code can use when binding, to give a PendingIntent object
3361 * that can be launched for the user to disable the system's use of this
3362 * service.
3363 */
3364 public static final String EXTRA_CLIENT_INTENT =
3365 "android.intent.extra.client_intent";
3366
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003367 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003368 * Extra used to indicate that an intent should only return data that is on
3369 * the local device. This is a boolean extra; the default is false. If true,
3370 * an implementation should only allow the user to select data that is
3371 * already on the device, not requiring it be downloaded from a remote
3372 * service when opened.
3373 *
3374 * @see #ACTION_GET_CONTENT
3375 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003376 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003377 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003378 */
3379 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003380 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003381
Amith Yamasani13593602012-03-22 16:16:17 -07003382 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003383 * Extra used to indicate that an intent can allow the user to select and
3384 * return multiple items. This is a boolean extra; the default is false. If
3385 * true, an implementation is allowed to present the user with a UI where
3386 * they can pick multiple items that are all returned to the caller. When
3387 * this happens, they should be returned as the {@link #getClipData()} part
3388 * of the result Intent.
3389 *
3390 * @see #ACTION_GET_CONTENT
3391 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003392 */
3393 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003394 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003395
3396 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003397 * The integer userHandle carried with broadcast intents related to addition, removal and
3398 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3399 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3400 *
Amith Yamasani13593602012-03-22 16:16:17 -07003401 * @hide
3402 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003403 public static final String EXTRA_USER_HANDLE =
3404 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003405
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003406 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003407 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3408 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3409 */
3410 public static final String EXTRA_USER =
3411 "android.intent.extra.user";
3412
3413 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003414 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003415 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3416 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003417 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003418 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3419
3420 /**
3421 * Extra sent in the intent to the BroadcastReceiver that handles
3422 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3423 * the restrictions as key/value pairs.
3424 */
3425 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3426 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003427
Amith Yamasani86118ba2013-03-28 14:33:16 -07003428 /**
3429 * Extra used in the response from a BroadcastReceiver that handles
3430 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3431 */
3432 public static final String EXTRA_RESTRICTIONS_INTENT =
3433 "android.intent.extra.restrictions_intent";
3434
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003435 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003436 * Extra used to communicate a set of acceptable MIME types. The type of the
3437 * extra is {@code String[]}. Values may be a combination of concrete MIME
3438 * types (such as "image/png") and/or partial MIME types (such as
3439 * "audio/*").
3440 *
3441 * @see #ACTION_GET_CONTENT
3442 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003443 */
3444 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3445
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003446 /**
3447 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3448 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003449 * When this is true, hardware devices can use this information to determine that
3450 * they shouldn't do a complete shutdown of their device since this is not a
3451 * complete shutdown down to the kernel, but only user space restarting.
3452 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003453 */
3454 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3455 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3456
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003457 /**
3458 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3459 * user has set their time format preferences to the 24 hour format.
3460 *
3461 * @hide for internal use only.
3462 */
3463 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3464 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3465
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003466 // ---------------------------------------------------------------------
3467 // ---------------------------------------------------------------------
3468 // Intent flags (see mFlags variable).
3469
Tor Norbyed9273d62013-05-30 15:59:53 -07003470 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003471 @IntDef(flag = true, value = {
3472 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3473 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003474 @Retention(RetentionPolicy.SOURCE)
3475 public @interface GrantUriMode {}
3476
Jeff Sharkey846318a2014-04-04 12:12:41 -07003477 /** @hide */
3478 @IntDef(flag = true, value = {
3479 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3480 @Retention(RetentionPolicy.SOURCE)
3481 public @interface AccessUriMode {}
3482
3483 /**
3484 * Test if given mode flags specify an access mode, which must be at least
3485 * read and/or write.
3486 *
3487 * @hide
3488 */
3489 public static boolean isAccessUriMode(int modeFlags) {
3490 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3491 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3492 }
3493
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003494 /**
3495 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003496 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003497 * specified in its ClipData. When applying to an Intent's ClipData,
3498 * all URIs as well as recursive traversals through data or other ClipData
3499 * in Intent items will be granted; only the grant flags of the top-level
3500 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003501 */
3502 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3503 /**
3504 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003505 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003506 * specified in its ClipData. When applying to an Intent's ClipData,
3507 * all URIs as well as recursive traversals through data or other ClipData
3508 * in Intent items will be granted; only the grant flags of the top-level
3509 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003510 */
3511 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3512 /**
3513 * Can be set by the caller to indicate that this Intent is coming from
3514 * a background operation, not from direct user interaction.
3515 */
3516 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3517 /**
3518 * A flag you can enable for debugging: when set, log messages will be
3519 * printed during the resolution of this intent to show you what has
3520 * been found to create the final resolved list.
3521 */
3522 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003523 /**
3524 * If set, this intent will not match any components in packages that
3525 * are currently stopped. If this is not set, then the default behavior
3526 * is to include such applications in the result.
3527 */
3528 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3529 /**
3530 * If set, this intent will always match any components in packages that
3531 * are currently stopped. This is the default behavior when
3532 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3533 * flags are set, this one wins (it allows overriding of exclude for
3534 * places where the framework may automatically set the exclude flag).
3535 */
3536 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003537
3538 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003539 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003540 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003541 * persisted across device reboots until explicitly revoked with
3542 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3543 * grant for possible persisting; the receiving application must call
3544 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3545 * actually persist.
3546 *
3547 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3548 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3549 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003550 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003551 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003552 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003553
3554 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003555 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3556 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3557 * applies to any URI that is a prefix match against the original granted
3558 * URI. (Without this flag, the URI must match exactly for access to be
3559 * granted.) Another URI is considered a prefix match only when scheme,
3560 * authority, and all path segments defined by the prefix are an exact
3561 * match.
3562 */
3563 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3564
3565 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003566 * If set, the new activity is not kept in the history stack. As soon as
3567 * the user navigates away from it, the activity is finished. This may also
3568 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3569 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003570 */
3571 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3572 /**
3573 * If set, the activity will not be launched if it is already running
3574 * at the top of the history stack.
3575 */
3576 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3577 /**
3578 * If set, this activity will become the start of a new task on this
3579 * history stack. A task (from the activity that started it to the
3580 * next task activity) defines an atomic group of activities that the
3581 * user can move to. Tasks can be moved to the foreground and background;
3582 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003583 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003584 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3585 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003586 *
3587 * <p>This flag is generally used by activities that want
3588 * to present a "launcher" style behavior: they give the user a list of
3589 * separate things that can be done, which otherwise run completely
3590 * independently of the activity launching them.
3591 *
3592 * <p>When using this flag, if a task is already running for the activity
3593 * you are now starting, then a new activity will not be started; instead,
3594 * the current task will simply be brought to the front of the screen with
3595 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3596 * to disable this behavior.
3597 *
3598 * <p>This flag can not be used when the caller is requesting a result from
3599 * the activity being launched.
3600 */
3601 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3602 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003603 * This flag is used to create a new task and launch an activity into it.
3604 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3605 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3606 * search through existing tasks for ones matching this Intent. Only if no such
3607 * task is found would a new task be created. When paired with
3608 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3609 * the search for a matching task and unconditionally start a new task.
3610 *
3611 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3612 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003613 * top-level application launcher.</strong> Used in conjunction with
3614 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3615 * behavior of bringing an existing task to the foreground. When set,
3616 * a new task is <em>always</em> started to host the Activity for the
3617 * Intent, regardless of whether there is already an existing task running
3618 * the same thing.
3619 *
3620 * <p><strong>Because the default system does not include graphical task management,
3621 * you should not use this flag unless you provide some way for a user to
3622 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003623 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003624 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3625 * creating new document tasks.
3626 *
3627 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
3628 * {@link #FLAG_ACTIVITY_NEW_TASK} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003629 *
Scott Main7aee61f2011-02-08 11:25:01 -08003630 * <p>See
3631 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3632 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003633 *
3634 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3635 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003636 */
3637 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3638 /**
3639 * If set, and the activity being launched is already running in the
3640 * current task, then instead of launching a new instance of that activity,
3641 * all of the other activities on top of it will be closed and this Intent
3642 * will be delivered to the (now on top) old activity as a new Intent.
3643 *
3644 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3645 * If D calls startActivity() with an Intent that resolves to the component
3646 * of activity B, then C and D will be finished and B receive the given
3647 * Intent, resulting in the stack now being: A, B.
3648 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003649 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003650 * either receive the new intent you are starting here in its
3651 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003652 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003653 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3654 * the same intent, then it will be finished and re-created; for all other
3655 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3656 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003657 *
3658 * <p>This launch mode can also be used to good effect in conjunction with
3659 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3660 * of a task, it will bring any currently running instance of that task
3661 * to the foreground, and then clear it to its root state. This is
3662 * especially useful, for example, when launching an activity from the
3663 * notification manager.
3664 *
Scott Main7aee61f2011-02-08 11:25:01 -08003665 * <p>See
3666 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3667 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003668 */
3669 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3670 /**
3671 * If set and this intent is being used to launch a new activity from an
3672 * existing one, then the reply target of the existing activity will be
3673 * transfered to the new activity. This way the new activity can call
3674 * {@link android.app.Activity#setResult} and have that result sent back to
3675 * the reply target of the original activity.
3676 */
3677 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3678 /**
3679 * If set and this intent is being used to launch a new activity from an
3680 * existing one, the current activity will not be counted as the top
3681 * activity for deciding whether the new intent should be delivered to
3682 * the top instead of starting a new one. The previous activity will
3683 * be used as the top, with the assumption being that the current activity
3684 * will finish itself immediately.
3685 */
3686 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3687 /**
3688 * If set, the new activity is not kept in the list of recently launched
3689 * activities.
3690 */
3691 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3692 /**
3693 * This flag is not normally set by application code, but set for you by
3694 * the system as described in the
3695 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3696 * launchMode} documentation for the singleTask mode.
3697 */
3698 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3699 /**
3700 * If set, and this activity is either being started in a new task or
3701 * bringing to the top an existing task, then it will be launched as
3702 * the front door of the task. This will result in the application of
3703 * any affinities needed to have that task in the proper state (either
3704 * moving activities to or from it), or simply resetting that task to
3705 * its initial state if needed.
3706 */
3707 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3708 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003709 * This flag is not normally set by application code, but set for you by
3710 * the system if this activity is being launched from history
3711 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003712 */
3713 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003714 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003715 * @deprecated As of API 21 this performs identically to
3716 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003717 */
3718 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003719 /**
Craig Mautner026596b2014-05-21 15:35:44 -07003720 * This flag is used to open a document into a new task rooted at the activity launched
3721 * by this Intent. Through the use of this flag, or its equivalent attribute,
3722 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
3723 * containing different douments will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003724 *
Craig Mautner026596b2014-05-21 15:35:44 -07003725 * <p>The use of the activity attribute form of this,
3726 * {@link android.R.attr#documentLaunchMode}, is
3727 * preferred over the Intent flag described here. The attribute form allows the
3728 * Activity to specify multiple document behavior for all launchers of the Activity
3729 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003730 *
Craig Mautner026596b2014-05-21 15:35:44 -07003731 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
3732 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
3733 * equivalent of the Activity manifest specifying {@link
3734 * android.R.attr#documentLaunchMode}="intoExisting". When used with
3735 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
3736 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07003737 *
Craig Mautner026596b2014-05-21 15:35:44 -07003738 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003739 *
Craig Mautner026596b2014-05-21 15:35:44 -07003740 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07003741 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3742 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003743 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07003744 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003745 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003746 * callback from occurring on the current frontmost activity before it is
3747 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003748 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003749 * <p>Typically, an activity can rely on that callback to indicate that an
3750 * explicit user action has caused their activity to be moved out of the
3751 * foreground. The callback marks an appropriate point in the activity's
3752 * lifecycle for it to dismiss any notifications that it intends to display
3753 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003754 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003755 * <p>If an activity is ever started via any non-user-driven events such as
3756 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3757 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003758 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003759 */
3760 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003761 /**
3762 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3763 * this flag will cause the launched activity to be brought to the front of its
3764 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003765 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003766 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3767 * If D calls startActivity() with an Intent that resolves to the component
3768 * of activity B, then B will be brought to the front of the history stack,
3769 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003770 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003771 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003772 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003773 */
3774 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003775 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003776 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3777 * this flag will prevent the system from applying an activity transition
3778 * animation to go to the next activity state. This doesn't mean an
3779 * animation will never run -- if another activity change happens that doesn't
3780 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003781 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003782 * when you are going to do a series of activity operations but the
3783 * animation seen by the user shouldn't be driven by the first activity
3784 * change but rather a later one.
3785 */
3786 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3787 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003788 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3789 * this flag will cause any existing task that would be associated with the
3790 * activity to be cleared before the activity is started. That is, the activity
3791 * becomes the new root of an otherwise empty task, and any old activities
3792 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3793 */
3794 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3795 /**
3796 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3797 * this flag will cause a newly launching task to be placed on top of the current
3798 * home activity task (if there is one). That is, pressing back from the task
3799 * will always return the user to home even if that was not the last activity they
3800 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3801 */
3802 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3803 /**
Craig Mautner2dac0562014-05-06 09:06:44 -07003804 * If set and the new activity is the root of a new task, then the task
3805 * will remain in the list of recently launched tasks only until all of
3806 * the activities in it are finished.
3807 *
3808 * <p>This is equivalent to the attribute
3809 * {@link android.R.styleable#AndroidManifestActivity_autoRemoveFromRecents}.
3810 */
3811 public static final int FLAG_ACTIVITY_AUTO_REMOVE_FROM_RECENTS = 0x00002000;
3812 /**
Craig Mautnera228ae92014-07-09 05:44:55 -07003813 * If set along with FLAG_ACTIVITY_NEW_DOCUMENT then the task being launched will not be
3814 * presented to the user but will instead be only available through the recents task list.
3815 * In addition, the new task wil be affiliated with the launching activity's task.
3816 * Affiliated tasks are grouped together in the recents task list.
3817 *
3818 * <p>This behavior is not supported for activities with {@link
3819 * android.R.styleable#AndroidManifestActivity_launchMode launchMode} values of
3820 * <code>singleInstance</code> or <code>singleTask</code>.
3821 */
3822 public static final int FLAG_ACTIVITY_LAUNCH_BEHIND = 0x00001000;
3823
3824 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003825 * If set, when sending a broadcast only registered receivers will be
3826 * called -- no BroadcastReceiver components will be launched.
3827 */
3828 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003829 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003830 * If set, when sending a broadcast the new broadcast will replace
3831 * any existing pending broadcast that matches it. Matching is defined
3832 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3833 * true for the intents of the two broadcasts. When a match is found,
3834 * the new broadcast (and receivers associated with it) will replace the
3835 * existing one in the pending broadcast list, remaining at the same
3836 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003837 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003838 * <p>This flag is most typically used with sticky broadcasts, which
3839 * only care about delivering the most recent values of the broadcast
3840 * to their receivers.
3841 */
3842 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3843 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003844 * If set, when sending a broadcast the recipient is allowed to run at
3845 * foreground priority, with a shorter timeout interval. During normal
3846 * broadcasts the receivers are not automatically hoisted out of the
3847 * background priority class.
3848 */
3849 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3850 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003851 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3852 * They can still propagate results through to later receivers, but they can not prevent
3853 * later receivers from seeing the broadcast.
3854 */
3855 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3856 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003857 * If set, when sending a broadcast <i>before boot has completed</i> only
3858 * registered receivers will be called -- no BroadcastReceiver components
3859 * will be launched. Sticky intent state will be recorded properly even
3860 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3861 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003862 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003863 * <p>This flag is only for use by system sevices as a convenience to
3864 * avoid having to implement a more complex mechanism around detection
3865 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003866 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003867 * @hide
3868 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003869 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003870 /**
3871 * Set when this broadcast is for a boot upgrade, a special mode that
3872 * allows the broadcast to be sent before the system is ready and launches
3873 * the app process with no providers running in it.
3874 * @hide
3875 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003876 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003877
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003878 /**
3879 * @hide Flags that can't be changed with PendingIntent.
3880 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003881 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
3882 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
3883 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003884
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003885 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003886 // ---------------------------------------------------------------------
3887 // toUri() and parseUri() options.
3888
3889 /**
3890 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3891 * always has the "intent:" scheme. This syntax can be used when you want
3892 * to later disambiguate between URIs that are intended to describe an
3893 * Intent vs. all others that should be treated as raw URIs. When used
3894 * with {@link #parseUri}, any other scheme will result in a generic
3895 * VIEW action for that raw URI.
3896 */
3897 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003898
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003899 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003900
3901 private String mAction;
3902 private Uri mData;
3903 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003904 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003905 private ComponentName mComponent;
3906 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003907 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003908 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003909 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003910 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003911 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003912
3913 // ---------------------------------------------------------------------
3914
3915 /**
3916 * Create an empty intent.
3917 */
3918 public Intent() {
3919 }
3920
3921 /**
3922 * Copy constructor.
3923 */
3924 public Intent(Intent o) {
3925 this.mAction = o.mAction;
3926 this.mData = o.mData;
3927 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003928 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003929 this.mComponent = o.mComponent;
3930 this.mFlags = o.mFlags;
3931 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003932 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003933 }
3934 if (o.mExtras != null) {
3935 this.mExtras = new Bundle(o.mExtras);
3936 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003937 if (o.mSourceBounds != null) {
3938 this.mSourceBounds = new Rect(o.mSourceBounds);
3939 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003940 if (o.mSelector != null) {
3941 this.mSelector = new Intent(o.mSelector);
3942 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003943 if (o.mClipData != null) {
3944 this.mClipData = new ClipData(o.mClipData);
3945 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003946 }
3947
3948 @Override
3949 public Object clone() {
3950 return new Intent(this);
3951 }
3952
3953 private Intent(Intent o, boolean all) {
3954 this.mAction = o.mAction;
3955 this.mData = o.mData;
3956 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003957 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003958 this.mComponent = o.mComponent;
3959 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003960 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003961 }
3962 }
3963
3964 /**
3965 * Make a clone of only the parts of the Intent that are relevant for
3966 * filter matching: the action, data, type, component, and categories.
3967 */
3968 public Intent cloneFilter() {
3969 return new Intent(this, false);
3970 }
3971
3972 /**
3973 * Create an intent with a given action. All other fields (data, type,
3974 * class) are null. Note that the action <em>must</em> be in a
3975 * namespace because Intents are used globally in the system -- for
3976 * example the system VIEW action is android.intent.action.VIEW; an
3977 * application's custom action would be something like
3978 * com.google.app.myapp.CUSTOM_ACTION.
3979 *
3980 * @param action The Intent action, such as ACTION_VIEW.
3981 */
3982 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003983 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003984 }
3985
3986 /**
3987 * Create an intent with a given action and for a given data url. Note
3988 * that the action <em>must</em> be in a namespace because Intents are
3989 * used globally in the system -- for example the system VIEW action is
3990 * android.intent.action.VIEW; an application's custom action would be
3991 * something like com.google.app.myapp.CUSTOM_ACTION.
3992 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003993 * <p><em>Note: scheme and host name matching in the Android framework is
3994 * case-sensitive, unlike the formal RFC. As a result,
3995 * you should always ensure that you write your Uri with these elements
3996 * using lower case letters, and normalize any Uris you receive from
3997 * outside of Android to ensure the scheme and host is lower case.</em></p>
3998 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003999 * @param action The Intent action, such as ACTION_VIEW.
4000 * @param uri The Intent data URI.
4001 */
4002 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004003 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004004 mData = uri;
4005 }
4006
4007 /**
4008 * Create an intent for a specific component. All other fields (action, data,
4009 * type, class) are null, though they can be modified later with explicit
4010 * calls. This provides a convenient way to create an intent that is
4011 * intended to execute a hard-coded class name, rather than relying on the
4012 * system to find an appropriate class for you; see {@link #setComponent}
4013 * for more information on the repercussions of this.
4014 *
4015 * @param packageContext A Context of the application package implementing
4016 * this class.
4017 * @param cls The component class that is to be used for the intent.
4018 *
4019 * @see #setClass
4020 * @see #setComponent
4021 * @see #Intent(String, android.net.Uri , Context, Class)
4022 */
4023 public Intent(Context packageContext, Class<?> cls) {
4024 mComponent = new ComponentName(packageContext, cls);
4025 }
4026
4027 /**
4028 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004029 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004030 * construct the Intent and then calling {@link #setClass} to set its
4031 * class.
4032 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004033 * <p><em>Note: scheme and host name matching in the Android framework is
4034 * case-sensitive, unlike the formal RFC. As a result,
4035 * you should always ensure that you write your Uri with these elements
4036 * using lower case letters, and normalize any Uris you receive from
4037 * outside of Android to ensure the scheme and host is lower case.</em></p>
4038 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004039 * @param action The Intent action, such as ACTION_VIEW.
4040 * @param uri The Intent data URI.
4041 * @param packageContext A Context of the application package implementing
4042 * this class.
4043 * @param cls The component class that is to be used for the intent.
4044 *
4045 * @see #Intent(String, android.net.Uri)
4046 * @see #Intent(Context, Class)
4047 * @see #setClass
4048 * @see #setComponent
4049 */
4050 public Intent(String action, Uri uri,
4051 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004052 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004053 mData = uri;
4054 mComponent = new ComponentName(packageContext, cls);
4055 }
4056
4057 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004058 * Create an intent to launch the main (root) activity of a task. This
4059 * is the Intent that is started when the application's is launched from
4060 * Home. For anything else that wants to launch an application in the
4061 * same way, it is important that they use an Intent structured the same
4062 * way, and can use this function to ensure this is the case.
4063 *
4064 * <p>The returned Intent has the given Activity component as its explicit
4065 * component, {@link #ACTION_MAIN} as its action, and includes the
4066 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4067 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4068 * to do that through {@link #addFlags(int)} on the returned Intent.
4069 *
4070 * @param mainActivity The main activity component that this Intent will
4071 * launch.
4072 * @return Returns a newly created Intent that can be used to launch the
4073 * activity as a main application entry.
4074 *
4075 * @see #setClass
4076 * @see #setComponent
4077 */
4078 public static Intent makeMainActivity(ComponentName mainActivity) {
4079 Intent intent = new Intent(ACTION_MAIN);
4080 intent.setComponent(mainActivity);
4081 intent.addCategory(CATEGORY_LAUNCHER);
4082 return intent;
4083 }
4084
4085 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004086 * Make an Intent for the main activity of an application, without
4087 * specifying a specific activity to run but giving a selector to find
4088 * the activity. This results in a final Intent that is structured
4089 * the same as when the application is launched from
4090 * Home. For anything else that wants to launch an application in the
4091 * same way, it is important that they use an Intent structured the same
4092 * way, and can use this function to ensure this is the case.
4093 *
4094 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4095 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4096 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4097 * to do that through {@link #addFlags(int)} on the returned Intent.
4098 *
4099 * @param selectorAction The action name of the Intent's selector.
4100 * @param selectorCategory The name of a category to add to the Intent's
4101 * selector.
4102 * @return Returns a newly created Intent that can be used to launch the
4103 * activity as a main application entry.
4104 *
4105 * @see #setSelector(Intent)
4106 */
4107 public static Intent makeMainSelectorActivity(String selectorAction,
4108 String selectorCategory) {
4109 Intent intent = new Intent(ACTION_MAIN);
4110 intent.addCategory(CATEGORY_LAUNCHER);
4111 Intent selector = new Intent();
4112 selector.setAction(selectorAction);
4113 selector.addCategory(selectorCategory);
4114 intent.setSelector(selector);
4115 return intent;
4116 }
4117
4118 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004119 * Make an Intent that can be used to re-launch an application's task
4120 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4121 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4122 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4123 *
4124 * @param mainActivity The activity component that is the root of the
4125 * task; this is the activity that has been published in the application's
4126 * manifest as the main launcher icon.
4127 *
4128 * @return Returns a newly created Intent that can be used to relaunch the
4129 * activity's task in its root state.
4130 */
4131 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4132 Intent intent = makeMainActivity(mainActivity);
4133 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4134 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4135 return intent;
4136 }
4137
4138 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004139 * Call {@link #parseUri} with 0 flags.
4140 * @deprecated Use {@link #parseUri} instead.
4141 */
4142 @Deprecated
4143 public static Intent getIntent(String uri) throws URISyntaxException {
4144 return parseUri(uri, 0);
4145 }
Tom Taylord4a47292009-12-21 13:59:18 -08004146
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004147 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004148 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004149 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004150 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004151 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004152 *
4153 * <p>The URI given here must not be relative -- that is, it must include
4154 * the scheme and full path.
4155 *
4156 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004157 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004158 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004159 *
4160 * @return Intent The newly created Intent object.
4161 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004162 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4163 * it bad (as parsed by the Uri class) or the Intent data within the
4164 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004165 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004166 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004167 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004168 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004169 int i = 0;
4170 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004171 // Validate intent scheme for if requested.
4172 if ((flags&URI_INTENT_SCHEME) != 0) {
4173 if (!uri.startsWith("intent:")) {
4174 Intent intent = new Intent(ACTION_VIEW);
4175 try {
4176 intent.setData(Uri.parse(uri));
4177 } catch (IllegalArgumentException e) {
4178 throw new URISyntaxException(uri, e.getMessage());
4179 }
4180 return intent;
4181 }
4182 }
Tom Taylord4a47292009-12-21 13:59:18 -08004183
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004184 // simple case
4185 i = uri.lastIndexOf("#");
4186 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4187
4188 // old format Intent URI
4189 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07004190
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004191 // new format
4192 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004193 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004194
4195 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004196 String data = i >= 0 ? uri.substring(0, i) : null;
4197 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004198 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07004199
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004200 // loop over contents of Intent, all name=value;
4201 while (!uri.startsWith("end", i)) {
4202 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004203 if (eq < 0) eq = i-1;
4204 int semi = uri.indexOf(';', i);
4205 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004206
4207 // action
4208 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004209 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004210 }
4211
4212 // categories
4213 else if (uri.startsWith("category=", i)) {
4214 intent.addCategory(value);
4215 }
4216
4217 // type
4218 else if (uri.startsWith("type=", i)) {
4219 intent.mType = value;
4220 }
4221
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004222 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004223 else if (uri.startsWith("launchFlags=", i)) {
4224 intent.mFlags = Integer.decode(value).intValue();
4225 }
4226
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004227 // package
4228 else if (uri.startsWith("package=", i)) {
4229 intent.mPackage = value;
4230 }
4231
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004232 // component
4233 else if (uri.startsWith("component=", i)) {
4234 intent.mComponent = ComponentName.unflattenFromString(value);
4235 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004236
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004237 // scheme
4238 else if (uri.startsWith("scheme=", i)) {
4239 scheme = value;
4240 }
4241
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004242 // source bounds
4243 else if (uri.startsWith("sourceBounds=", i)) {
4244 intent.mSourceBounds = Rect.unflattenFromString(value);
4245 }
4246
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004247 // selector
4248 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4249 intent = new Intent();
4250 }
4251
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004252 // extra
4253 else {
4254 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004255 // create Bundle if it doesn't already exist
4256 if (intent.mExtras == null) intent.mExtras = new Bundle();
4257 Bundle b = intent.mExtras;
4258 // add EXTRA
4259 if (uri.startsWith("S.", i)) b.putString(key, value);
4260 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4261 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4262 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4263 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4264 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4265 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4266 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4267 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4268 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4269 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004270
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004271 // move to the next item
4272 i = semi + 1;
4273 }
4274
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004275 if (intent != baseIntent) {
4276 // The Intent had a selector; fix it up.
4277 baseIntent.setSelector(intent);
4278 intent = baseIntent;
4279 }
4280
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004281 if (data != null) {
4282 if (data.startsWith("intent:")) {
4283 data = data.substring(7);
4284 if (scheme != null) {
4285 data = scheme + ':' + data;
4286 }
4287 }
Tom Taylord4a47292009-12-21 13:59:18 -08004288
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004289 if (data.length() > 0) {
4290 try {
4291 intent.mData = Uri.parse(data);
4292 } catch (IllegalArgumentException e) {
4293 throw new URISyntaxException(uri, e.getMessage());
4294 }
4295 }
4296 }
Tom Taylord4a47292009-12-21 13:59:18 -08004297
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004298 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004299
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004300 } catch (IndexOutOfBoundsException e) {
4301 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4302 }
4303 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004304
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004305 public static Intent getIntentOld(String uri) throws URISyntaxException {
4306 Intent intent;
4307
4308 int i = uri.lastIndexOf('#');
4309 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004310 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004311 final int intentFragmentStart = i;
4312 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004313
4314 i++;
4315
4316 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004317 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004318 i += 7;
4319 int j = uri.indexOf(')', i);
4320 action = uri.substring(i, j);
4321 i = j + 1;
4322 }
4323
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004324 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004325
4326 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004327 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004328 i += 11;
4329 int j = uri.indexOf(')', i);
4330 while (i < j) {
4331 int sep = uri.indexOf('!', i);
4332 if (sep < 0) sep = j;
4333 if (i < sep) {
4334 intent.addCategory(uri.substring(i, sep));
4335 }
4336 i = sep + 1;
4337 }
4338 i = j + 1;
4339 }
4340
4341 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004342 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004343 i += 5;
4344 int j = uri.indexOf(')', i);
4345 intent.mType = uri.substring(i, j);
4346 i = j + 1;
4347 }
4348
4349 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004350 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004351 i += 12;
4352 int j = uri.indexOf(')', i);
4353 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4354 i = j + 1;
4355 }
4356
4357 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004358 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004359 i += 10;
4360 int j = uri.indexOf(')', i);
4361 int sep = uri.indexOf('!', i);
4362 if (sep >= 0 && sep < j) {
4363 String pkg = uri.substring(i, sep);
4364 String cls = uri.substring(sep + 1, j);
4365 intent.mComponent = new ComponentName(pkg, cls);
4366 }
4367 i = j + 1;
4368 }
4369
4370 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004371 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004372 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004373
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004374 final int closeParen = uri.indexOf(')', i);
4375 if (closeParen == -1) throw new URISyntaxException(uri,
4376 "EXTRA missing trailing ')'", i);
4377
4378 while (i < closeParen) {
4379 // fetch the key value
4380 int j = uri.indexOf('=', i);
4381 if (j <= i + 1 || i >= closeParen) {
4382 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4383 }
4384 char type = uri.charAt(i);
4385 i++;
4386 String key = uri.substring(i, j);
4387 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004388
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004389 // get type-value
4390 j = uri.indexOf('!', i);
4391 if (j == -1 || j >= closeParen) j = closeParen;
4392 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4393 String value = uri.substring(i, j);
4394 i = j;
4395
4396 // create Bundle if it doesn't already exist
4397 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004398
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004399 // add item to bundle
4400 try {
4401 switch (type) {
4402 case 'S':
4403 intent.mExtras.putString(key, Uri.decode(value));
4404 break;
4405 case 'B':
4406 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4407 break;
4408 case 'b':
4409 intent.mExtras.putByte(key, Byte.parseByte(value));
4410 break;
4411 case 'c':
4412 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4413 break;
4414 case 'd':
4415 intent.mExtras.putDouble(key, Double.parseDouble(value));
4416 break;
4417 case 'f':
4418 intent.mExtras.putFloat(key, Float.parseFloat(value));
4419 break;
4420 case 'i':
4421 intent.mExtras.putInt(key, Integer.parseInt(value));
4422 break;
4423 case 'l':
4424 intent.mExtras.putLong(key, Long.parseLong(value));
4425 break;
4426 case 's':
4427 intent.mExtras.putShort(key, Short.parseShort(value));
4428 break;
4429 default:
4430 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4431 }
4432 } catch (NumberFormatException e) {
4433 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4434 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004435
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004436 char ch = uri.charAt(i);
4437 if (ch == ')') break;
4438 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4439 i++;
4440 }
4441 }
4442
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004443 if (isIntentFragment) {
4444 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4445 } else {
4446 intent.mData = Uri.parse(uri);
4447 }
Tom Taylord4a47292009-12-21 13:59:18 -08004448
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004449 if (intent.mAction == null) {
4450 // By default, if no action is specified, then use VIEW.
4451 intent.mAction = ACTION_VIEW;
4452 }
4453
4454 } else {
4455 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4456 }
4457
4458 return intent;
4459 }
4460
4461 /**
4462 * Retrieve the general action to be performed, such as
4463 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4464 * the information in the intent should be interpreted -- most importantly,
4465 * what to do with the data returned by {@link #getData}.
4466 *
4467 * @return The action of this intent or null if none is specified.
4468 *
4469 * @see #setAction
4470 */
4471 public String getAction() {
4472 return mAction;
4473 }
4474
4475 /**
4476 * Retrieve data this intent is operating on. This URI specifies the name
4477 * of the data; often it uses the content: scheme, specifying data in a
4478 * content provider. Other schemes may be handled by specific activities,
4479 * such as http: by the web browser.
4480 *
4481 * @return The URI of the data this intent is targeting or null.
4482 *
4483 * @see #getScheme
4484 * @see #setData
4485 */
4486 public Uri getData() {
4487 return mData;
4488 }
4489
4490 /**
4491 * The same as {@link #getData()}, but returns the URI as an encoded
4492 * String.
4493 */
4494 public String getDataString() {
4495 return mData != null ? mData.toString() : null;
4496 }
4497
4498 /**
4499 * Return the scheme portion of the intent's data. If the data is null or
4500 * does not include a scheme, null is returned. Otherwise, the scheme
4501 * prefix without the final ':' is returned, i.e. "http".
4502 *
4503 * <p>This is the same as calling getData().getScheme() (and checking for
4504 * null data).
4505 *
4506 * @return The scheme of this intent.
4507 *
4508 * @see #getData
4509 */
4510 public String getScheme() {
4511 return mData != null ? mData.getScheme() : null;
4512 }
4513
4514 /**
4515 * Retrieve any explicit MIME type included in the intent. This is usually
4516 * null, as the type is determined by the intent data.
4517 *
4518 * @return If a type was manually set, it is returned; else null is
4519 * returned.
4520 *
4521 * @see #resolveType(ContentResolver)
4522 * @see #setType
4523 */
4524 public String getType() {
4525 return mType;
4526 }
4527
4528 /**
4529 * Return the MIME data type of this intent. If the type field is
4530 * explicitly set, that is simply returned. Otherwise, if the data is set,
4531 * the type of that data is returned. If neither fields are set, a null is
4532 * returned.
4533 *
4534 * @return The MIME type of this intent.
4535 *
4536 * @see #getType
4537 * @see #resolveType(ContentResolver)
4538 */
4539 public String resolveType(Context context) {
4540 return resolveType(context.getContentResolver());
4541 }
4542
4543 /**
4544 * Return the MIME data type of this intent. If the type field is
4545 * explicitly set, that is simply returned. Otherwise, if the data is set,
4546 * the type of that data is returned. If neither fields are set, a null is
4547 * returned.
4548 *
4549 * @param resolver A ContentResolver that can be used to determine the MIME
4550 * type of the intent's data.
4551 *
4552 * @return The MIME type of this intent.
4553 *
4554 * @see #getType
4555 * @see #resolveType(Context)
4556 */
4557 public String resolveType(ContentResolver resolver) {
4558 if (mType != null) {
4559 return mType;
4560 }
4561 if (mData != null) {
4562 if ("content".equals(mData.getScheme())) {
4563 return resolver.getType(mData);
4564 }
4565 }
4566 return null;
4567 }
4568
4569 /**
4570 * Return the MIME data type of this intent, only if it will be needed for
4571 * intent resolution. This is not generally useful for application code;
4572 * it is used by the frameworks for communicating with back-end system
4573 * services.
4574 *
4575 * @param resolver A ContentResolver that can be used to determine the MIME
4576 * type of the intent's data.
4577 *
4578 * @return The MIME type of this intent, or null if it is unknown or not
4579 * needed.
4580 */
4581 public String resolveTypeIfNeeded(ContentResolver resolver) {
4582 if (mComponent != null) {
4583 return mType;
4584 }
4585 return resolveType(resolver);
4586 }
4587
4588 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004589 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004590 *
4591 * @param category The category to check.
4592 *
4593 * @return boolean True if the intent contains the category, else false.
4594 *
4595 * @see #getCategories
4596 * @see #addCategory
4597 */
4598 public boolean hasCategory(String category) {
4599 return mCategories != null && mCategories.contains(category);
4600 }
4601
4602 /**
4603 * Return the set of all categories in the intent. If there are no categories,
4604 * returns NULL.
4605 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004606 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004607 *
4608 * @see #hasCategory
4609 * @see #addCategory
4610 */
4611 public Set<String> getCategories() {
4612 return mCategories;
4613 }
4614
4615 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004616 * Return the specific selector associated with this Intent. If there is
4617 * none, returns null. See {@link #setSelector} for more information.
4618 *
4619 * @see #setSelector
4620 */
4621 public Intent getSelector() {
4622 return mSelector;
4623 }
4624
4625 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004626 * Return the {@link ClipData} associated with this Intent. If there is
4627 * none, returns null. See {@link #setClipData} for more information.
4628 *
John Spurlock125d1332013-11-25 11:58:37 -05004629 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004630 */
4631 public ClipData getClipData() {
4632 return mClipData;
4633 }
4634
4635 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004636 * Sets the ClassLoader that will be used when unmarshalling
4637 * any Parcelable values from the extras of this Intent.
4638 *
4639 * @param loader a ClassLoader, or null to use the default loader
4640 * at the time of unmarshalling.
4641 */
4642 public void setExtrasClassLoader(ClassLoader loader) {
4643 if (mExtras != null) {
4644 mExtras.setClassLoader(loader);
4645 }
4646 }
4647
4648 /**
4649 * Returns true if an extra value is associated with the given name.
4650 * @param name the extra's name
4651 * @return true if the given extra is present.
4652 */
4653 public boolean hasExtra(String name) {
4654 return mExtras != null && mExtras.containsKey(name);
4655 }
4656
4657 /**
4658 * Returns true if the Intent's extras contain a parcelled file descriptor.
4659 * @return true if the Intent contains a parcelled file descriptor.
4660 */
4661 public boolean hasFileDescriptors() {
4662 return mExtras != null && mExtras.hasFileDescriptors();
4663 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004664
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004665 /** @hide */
4666 public void setAllowFds(boolean allowFds) {
4667 if (mExtras != null) {
4668 mExtras.setAllowFds(allowFds);
4669 }
4670 }
4671
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004672 /**
4673 * Retrieve extended data from the intent.
4674 *
4675 * @param name The name of the desired item.
4676 *
4677 * @return the value of an item that previously added with putExtra()
4678 * or null if none was found.
4679 *
4680 * @deprecated
4681 * @hide
4682 */
4683 @Deprecated
4684 public Object getExtra(String name) {
4685 return getExtra(name, null);
4686 }
4687
4688 /**
4689 * Retrieve extended data from the intent.
4690 *
4691 * @param name The name of the desired item.
4692 * @param defaultValue the value to be returned if no value of the desired
4693 * type is stored with the given name.
4694 *
4695 * @return the value of an item that previously added with putExtra()
4696 * or the default value if none was found.
4697 *
4698 * @see #putExtra(String, boolean)
4699 */
4700 public boolean getBooleanExtra(String name, boolean defaultValue) {
4701 return mExtras == null ? defaultValue :
4702 mExtras.getBoolean(name, defaultValue);
4703 }
4704
4705 /**
4706 * Retrieve extended data from the intent.
4707 *
4708 * @param name The name of the desired item.
4709 * @param defaultValue the value to be returned if no value of the desired
4710 * type is stored with the given name.
4711 *
4712 * @return the value of an item that previously added with putExtra()
4713 * or the default value if none was found.
4714 *
4715 * @see #putExtra(String, byte)
4716 */
4717 public byte getByteExtra(String name, byte defaultValue) {
4718 return mExtras == null ? defaultValue :
4719 mExtras.getByte(name, defaultValue);
4720 }
4721
4722 /**
4723 * Retrieve extended data from the intent.
4724 *
4725 * @param name The name of the desired item.
4726 * @param defaultValue the value to be returned if no value of the desired
4727 * type is stored with the given name.
4728 *
4729 * @return the value of an item that previously added with putExtra()
4730 * or the default value if none was found.
4731 *
4732 * @see #putExtra(String, short)
4733 */
4734 public short getShortExtra(String name, short defaultValue) {
4735 return mExtras == null ? defaultValue :
4736 mExtras.getShort(name, defaultValue);
4737 }
4738
4739 /**
4740 * Retrieve extended data from the intent.
4741 *
4742 * @param name The name of the desired item.
4743 * @param defaultValue the value to be returned if no value of the desired
4744 * type is stored with the given name.
4745 *
4746 * @return the value of an item that previously added with putExtra()
4747 * or the default value if none was found.
4748 *
4749 * @see #putExtra(String, char)
4750 */
4751 public char getCharExtra(String name, char defaultValue) {
4752 return mExtras == null ? defaultValue :
4753 mExtras.getChar(name, defaultValue);
4754 }
4755
4756 /**
4757 * Retrieve extended data from the intent.
4758 *
4759 * @param name The name of the desired item.
4760 * @param defaultValue the value to be returned if no value of the desired
4761 * type is stored with the given name.
4762 *
4763 * @return the value of an item that previously added with putExtra()
4764 * or the default value if none was found.
4765 *
4766 * @see #putExtra(String, int)
4767 */
4768 public int getIntExtra(String name, int defaultValue) {
4769 return mExtras == null ? defaultValue :
4770 mExtras.getInt(name, defaultValue);
4771 }
4772
4773 /**
4774 * Retrieve extended data from the intent.
4775 *
4776 * @param name The name of the desired item.
4777 * @param defaultValue the value to be returned if no value of the desired
4778 * type is stored with the given name.
4779 *
4780 * @return the value of an item that previously added with putExtra()
4781 * or the default value if none was found.
4782 *
4783 * @see #putExtra(String, long)
4784 */
4785 public long getLongExtra(String name, long defaultValue) {
4786 return mExtras == null ? defaultValue :
4787 mExtras.getLong(name, defaultValue);
4788 }
4789
4790 /**
4791 * Retrieve extended data from the intent.
4792 *
4793 * @param name The name of the desired item.
4794 * @param defaultValue the value to be returned if no value of the desired
4795 * type is stored with the given name.
4796 *
4797 * @return the value of an item that previously added with putExtra(),
4798 * or the default value if no such item is present
4799 *
4800 * @see #putExtra(String, float)
4801 */
4802 public float getFloatExtra(String name, float defaultValue) {
4803 return mExtras == null ? defaultValue :
4804 mExtras.getFloat(name, defaultValue);
4805 }
4806
4807 /**
4808 * Retrieve extended data from the intent.
4809 *
4810 * @param name The name of the desired item.
4811 * @param defaultValue the value to be returned if no value of the desired
4812 * type is stored with the given name.
4813 *
4814 * @return the value of an item that previously added with putExtra()
4815 * or the default value if none was found.
4816 *
4817 * @see #putExtra(String, double)
4818 */
4819 public double getDoubleExtra(String name, double defaultValue) {
4820 return mExtras == null ? defaultValue :
4821 mExtras.getDouble(name, defaultValue);
4822 }
4823
4824 /**
4825 * Retrieve extended data from the intent.
4826 *
4827 * @param name The name of the desired item.
4828 *
4829 * @return the value of an item that previously added with putExtra()
4830 * or null if no String value was found.
4831 *
4832 * @see #putExtra(String, String)
4833 */
4834 public String getStringExtra(String name) {
4835 return mExtras == null ? null : mExtras.getString(name);
4836 }
4837
4838 /**
4839 * Retrieve extended data from the intent.
4840 *
4841 * @param name The name of the desired item.
4842 *
4843 * @return the value of an item that previously added with putExtra()
4844 * or null if no CharSequence value was found.
4845 *
4846 * @see #putExtra(String, CharSequence)
4847 */
4848 public CharSequence getCharSequenceExtra(String name) {
4849 return mExtras == null ? null : mExtras.getCharSequence(name);
4850 }
4851
4852 /**
4853 * Retrieve extended data from the intent.
4854 *
4855 * @param name The name of the desired item.
4856 *
4857 * @return the value of an item that previously added with putExtra()
4858 * or null if no Parcelable value was found.
4859 *
4860 * @see #putExtra(String, Parcelable)
4861 */
4862 public <T extends Parcelable> T getParcelableExtra(String name) {
4863 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4864 }
4865
4866 /**
4867 * Retrieve extended data from the intent.
4868 *
4869 * @param name The name of the desired item.
4870 *
4871 * @return the value of an item that previously added with putExtra()
4872 * or null if no Parcelable[] value was found.
4873 *
4874 * @see #putExtra(String, Parcelable[])
4875 */
4876 public Parcelable[] getParcelableArrayExtra(String name) {
4877 return mExtras == null ? null : mExtras.getParcelableArray(name);
4878 }
4879
4880 /**
4881 * Retrieve extended data from the intent.
4882 *
4883 * @param name The name of the desired item.
4884 *
4885 * @return the value of an item that previously added with putExtra()
4886 * or null if no ArrayList<Parcelable> value was found.
4887 *
4888 * @see #putParcelableArrayListExtra(String, ArrayList)
4889 */
4890 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4891 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4892 }
4893
4894 /**
4895 * Retrieve extended data from the intent.
4896 *
4897 * @param name The name of the desired item.
4898 *
4899 * @return the value of an item that previously added with putExtra()
4900 * or null if no Serializable value was found.
4901 *
4902 * @see #putExtra(String, Serializable)
4903 */
4904 public Serializable getSerializableExtra(String name) {
4905 return mExtras == null ? null : mExtras.getSerializable(name);
4906 }
4907
4908 /**
4909 * Retrieve extended data from the intent.
4910 *
4911 * @param name The name of the desired item.
4912 *
4913 * @return the value of an item that previously added with putExtra()
4914 * or null if no ArrayList<Integer> value was found.
4915 *
4916 * @see #putIntegerArrayListExtra(String, ArrayList)
4917 */
4918 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4919 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4920 }
4921
4922 /**
4923 * Retrieve extended data from the intent.
4924 *
4925 * @param name The name of the desired item.
4926 *
4927 * @return the value of an item that previously added with putExtra()
4928 * or null if no ArrayList<String> value was found.
4929 *
4930 * @see #putStringArrayListExtra(String, ArrayList)
4931 */
4932 public ArrayList<String> getStringArrayListExtra(String name) {
4933 return mExtras == null ? null : mExtras.getStringArrayList(name);
4934 }
4935
4936 /**
4937 * Retrieve extended data from the intent.
4938 *
4939 * @param name The name of the desired item.
4940 *
4941 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004942 * or null if no ArrayList<CharSequence> value was found.
4943 *
4944 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4945 */
4946 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4947 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4948 }
4949
4950 /**
4951 * Retrieve extended data from the intent.
4952 *
4953 * @param name The name of the desired item.
4954 *
4955 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004956 * or null if no boolean array value was found.
4957 *
4958 * @see #putExtra(String, boolean[])
4959 */
4960 public boolean[] getBooleanArrayExtra(String name) {
4961 return mExtras == null ? null : mExtras.getBooleanArray(name);
4962 }
4963
4964 /**
4965 * Retrieve extended data from the intent.
4966 *
4967 * @param name The name of the desired item.
4968 *
4969 * @return the value of an item that previously added with putExtra()
4970 * or null if no byte array value was found.
4971 *
4972 * @see #putExtra(String, byte[])
4973 */
4974 public byte[] getByteArrayExtra(String name) {
4975 return mExtras == null ? null : mExtras.getByteArray(name);
4976 }
4977
4978 /**
4979 * Retrieve extended data from the intent.
4980 *
4981 * @param name The name of the desired item.
4982 *
4983 * @return the value of an item that previously added with putExtra()
4984 * or null if no short array value was found.
4985 *
4986 * @see #putExtra(String, short[])
4987 */
4988 public short[] getShortArrayExtra(String name) {
4989 return mExtras == null ? null : mExtras.getShortArray(name);
4990 }
4991
4992 /**
4993 * Retrieve extended data from the intent.
4994 *
4995 * @param name The name of the desired item.
4996 *
4997 * @return the value of an item that previously added with putExtra()
4998 * or null if no char array value was found.
4999 *
5000 * @see #putExtra(String, char[])
5001 */
5002 public char[] getCharArrayExtra(String name) {
5003 return mExtras == null ? null : mExtras.getCharArray(name);
5004 }
5005
5006 /**
5007 * Retrieve extended data from the intent.
5008 *
5009 * @param name The name of the desired item.
5010 *
5011 * @return the value of an item that previously added with putExtra()
5012 * or null if no int array value was found.
5013 *
5014 * @see #putExtra(String, int[])
5015 */
5016 public int[] getIntArrayExtra(String name) {
5017 return mExtras == null ? null : mExtras.getIntArray(name);
5018 }
5019
5020 /**
5021 * Retrieve extended data from the intent.
5022 *
5023 * @param name The name of the desired item.
5024 *
5025 * @return the value of an item that previously added with putExtra()
5026 * or null if no long array value was found.
5027 *
5028 * @see #putExtra(String, long[])
5029 */
5030 public long[] getLongArrayExtra(String name) {
5031 return mExtras == null ? null : mExtras.getLongArray(name);
5032 }
5033
5034 /**
5035 * Retrieve extended data from the intent.
5036 *
5037 * @param name The name of the desired item.
5038 *
5039 * @return the value of an item that previously added with putExtra()
5040 * or null if no float array value was found.
5041 *
5042 * @see #putExtra(String, float[])
5043 */
5044 public float[] getFloatArrayExtra(String name) {
5045 return mExtras == null ? null : mExtras.getFloatArray(name);
5046 }
5047
5048 /**
5049 * Retrieve extended data from the intent.
5050 *
5051 * @param name The name of the desired item.
5052 *
5053 * @return the value of an item that previously added with putExtra()
5054 * or null if no double array value was found.
5055 *
5056 * @see #putExtra(String, double[])
5057 */
5058 public double[] getDoubleArrayExtra(String name) {
5059 return mExtras == null ? null : mExtras.getDoubleArray(name);
5060 }
5061
5062 /**
5063 * Retrieve extended data from the intent.
5064 *
5065 * @param name The name of the desired item.
5066 *
5067 * @return the value of an item that previously added with putExtra()
5068 * or null if no String array value was found.
5069 *
5070 * @see #putExtra(String, String[])
5071 */
5072 public String[] getStringArrayExtra(String name) {
5073 return mExtras == null ? null : mExtras.getStringArray(name);
5074 }
5075
5076 /**
5077 * Retrieve extended data from the intent.
5078 *
5079 * @param name The name of the desired item.
5080 *
5081 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005082 * or null if no CharSequence array value was found.
5083 *
5084 * @see #putExtra(String, CharSequence[])
5085 */
5086 public CharSequence[] getCharSequenceArrayExtra(String name) {
5087 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5088 }
5089
5090 /**
5091 * Retrieve extended data from the intent.
5092 *
5093 * @param name The name of the desired item.
5094 *
5095 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005096 * or null if no Bundle value was found.
5097 *
5098 * @see #putExtra(String, Bundle)
5099 */
5100 public Bundle getBundleExtra(String name) {
5101 return mExtras == null ? null : mExtras.getBundle(name);
5102 }
5103
5104 /**
5105 * Retrieve extended data from the intent.
5106 *
5107 * @param name The name of the desired item.
5108 *
5109 * @return the value of an item that previously added with putExtra()
5110 * or null if no IBinder value was found.
5111 *
5112 * @see #putExtra(String, IBinder)
5113 *
5114 * @deprecated
5115 * @hide
5116 */
5117 @Deprecated
5118 public IBinder getIBinderExtra(String name) {
5119 return mExtras == null ? null : mExtras.getIBinder(name);
5120 }
5121
5122 /**
5123 * Retrieve extended data from the intent.
5124 *
5125 * @param name The name of the desired item.
5126 * @param defaultValue The default value to return in case no item is
5127 * associated with the key 'name'
5128 *
5129 * @return the value of an item that previously added with putExtra()
5130 * or defaultValue if none was found.
5131 *
5132 * @see #putExtra
5133 *
5134 * @deprecated
5135 * @hide
5136 */
5137 @Deprecated
5138 public Object getExtra(String name, Object defaultValue) {
5139 Object result = defaultValue;
5140 if (mExtras != null) {
5141 Object result2 = mExtras.get(name);
5142 if (result2 != null) {
5143 result = result2;
5144 }
5145 }
5146
5147 return result;
5148 }
5149
5150 /**
5151 * Retrieves a map of extended data from the intent.
5152 *
5153 * @return the map of all extras previously added with putExtra(),
5154 * or null if none have been added.
5155 */
5156 public Bundle getExtras() {
5157 return (mExtras != null)
5158 ? new Bundle(mExtras)
5159 : null;
5160 }
5161
5162 /**
5163 * Retrieve any special flags associated with this intent. You will
5164 * normally just set them with {@link #setFlags} and let the system
5165 * take the appropriate action with them.
5166 *
5167 * @return int The currently set flags.
5168 *
5169 * @see #setFlags
5170 */
5171 public int getFlags() {
5172 return mFlags;
5173 }
5174
Dianne Hackborne7f97212011-02-24 14:40:20 -08005175 /** @hide */
5176 public boolean isExcludingStopped() {
5177 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5178 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5179 }
5180
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005181 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005182 * Retrieve the application package name this Intent is limited to. When
5183 * resolving an Intent, if non-null this limits the resolution to only
5184 * components in the given application package.
5185 *
5186 * @return The name of the application package for the Intent.
5187 *
5188 * @see #resolveActivity
5189 * @see #setPackage
5190 */
5191 public String getPackage() {
5192 return mPackage;
5193 }
5194
5195 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005196 * Retrieve the concrete component associated with the intent. When receiving
5197 * an intent, this is the component that was found to best handle it (that is,
5198 * yourself) and will always be non-null; in all other cases it will be
5199 * null unless explicitly set.
5200 *
5201 * @return The name of the application component to handle the intent.
5202 *
5203 * @see #resolveActivity
5204 * @see #setComponent
5205 */
5206 public ComponentName getComponent() {
5207 return mComponent;
5208 }
5209
5210 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005211 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5212 * used as a hint to the receiver for animations and the like. Null means that there
5213 * is no source bounds.
5214 */
5215 public Rect getSourceBounds() {
5216 return mSourceBounds;
5217 }
5218
5219 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005220 * Return the Activity component that should be used to handle this intent.
5221 * The appropriate component is determined based on the information in the
5222 * intent, evaluated as follows:
5223 *
5224 * <p>If {@link #getComponent} returns an explicit class, that is returned
5225 * without any further consideration.
5226 *
5227 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5228 * category to be considered.
5229 *
5230 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5231 * action.
5232 *
5233 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5234 * this type.
5235 *
5236 * <p>If {@link #addCategory} has added any categories, the activity must
5237 * handle ALL of the categories specified.
5238 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005239 * <p>If {@link #getPackage} is non-NULL, only activity components in
5240 * that application package will be considered.
5241 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005242 * <p>If there are no activities that satisfy all of these conditions, a
5243 * null string is returned.
5244 *
5245 * <p>If multiple activities are found to satisfy the intent, the one with
5246 * the highest priority will be used. If there are multiple activities
5247 * with the same priority, the system will either pick the best activity
5248 * based on user preference, or resolve to a system class that will allow
5249 * the user to pick an activity and forward from there.
5250 *
5251 * <p>This method is implemented simply by calling
5252 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5253 * true.</p>
5254 * <p> This API is called for you as part of starting an activity from an
5255 * intent. You do not normally need to call it yourself.</p>
5256 *
5257 * @param pm The package manager with which to resolve the Intent.
5258 *
5259 * @return Name of the component implementing an activity that can
5260 * display the intent.
5261 *
5262 * @see #setComponent
5263 * @see #getComponent
5264 * @see #resolveActivityInfo
5265 */
5266 public ComponentName resolveActivity(PackageManager pm) {
5267 if (mComponent != null) {
5268 return mComponent;
5269 }
5270
5271 ResolveInfo info = pm.resolveActivity(
5272 this, PackageManager.MATCH_DEFAULT_ONLY);
5273 if (info != null) {
5274 return new ComponentName(
5275 info.activityInfo.applicationInfo.packageName,
5276 info.activityInfo.name);
5277 }
5278
5279 return null;
5280 }
5281
5282 /**
5283 * Resolve the Intent into an {@link ActivityInfo}
5284 * describing the activity that should execute the intent. Resolution
5285 * follows the same rules as described for {@link #resolveActivity}, but
5286 * you get back the completely information about the resolved activity
5287 * instead of just its class name.
5288 *
5289 * @param pm The package manager with which to resolve the Intent.
5290 * @param flags Addition information to retrieve as per
5291 * {@link PackageManager#getActivityInfo(ComponentName, int)
5292 * PackageManager.getActivityInfo()}.
5293 *
5294 * @return PackageManager.ActivityInfo
5295 *
5296 * @see #resolveActivity
5297 */
5298 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5299 ActivityInfo ai = null;
5300 if (mComponent != null) {
5301 try {
5302 ai = pm.getActivityInfo(mComponent, flags);
5303 } catch (PackageManager.NameNotFoundException e) {
5304 // ignore
5305 }
5306 } else {
5307 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005308 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005309 if (info != null) {
5310 ai = info.activityInfo;
5311 }
5312 }
5313
5314 return ai;
5315 }
5316
5317 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005318 * Special function for use by the system to resolve service
5319 * intents to system apps. Throws an exception if there are
5320 * multiple potential matches to the Intent. Returns null if
5321 * there are no matches.
5322 * @hide
5323 */
5324 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5325 if (mComponent != null) {
5326 return mComponent;
5327 }
5328
5329 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5330 if (results == null) {
5331 return null;
5332 }
5333 ComponentName comp = null;
5334 for (int i=0; i<results.size(); i++) {
5335 ResolveInfo ri = results.get(i);
5336 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5337 continue;
5338 }
5339 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5340 ri.serviceInfo.name);
5341 if (comp != null) {
5342 throw new IllegalStateException("Multiple system services handle " + this
5343 + ": " + comp + ", " + foundComp);
5344 }
5345 comp = foundComp;
5346 }
5347 return comp;
5348 }
5349
5350 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005351 * Set the general action to be performed.
5352 *
5353 * @param action An action name, such as ACTION_VIEW. Application-specific
5354 * actions should be prefixed with the vendor's package name.
5355 *
5356 * @return Returns the same Intent object, for chaining multiple calls
5357 * into a single statement.
5358 *
5359 * @see #getAction
5360 */
5361 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005362 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005363 return this;
5364 }
5365
5366 /**
5367 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005368 * clears any type that was previously set by {@link #setType} or
5369 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005370 *
Nick Pellyccae4122012-01-09 14:12:58 -08005371 * <p><em>Note: scheme matching in the Android framework is
5372 * case-sensitive, unlike the formal RFC. As a result,
5373 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005374 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005375 * {@link #setDataAndNormalize}
5376 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005377 *
Nick Pellyccae4122012-01-09 14:12:58 -08005378 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005379 *
5380 * @return Returns the same Intent object, for chaining multiple calls
5381 * into a single statement.
5382 *
5383 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005384 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005385 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005386 */
5387 public Intent setData(Uri data) {
5388 mData = data;
5389 mType = null;
5390 return this;
5391 }
5392
5393 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005394 * Normalize and set the data this intent is operating on.
5395 *
5396 * <p>This method automatically clears any type that was
5397 * previously set (for example, by {@link #setType}).
5398 *
5399 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005400 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005401 * so really this is just a convenience method for
5402 * <pre>
5403 * setData(data.normalize())
5404 * </pre>
5405 *
5406 * @param data The Uri of the data this intent is now targeting.
5407 *
5408 * @return Returns the same Intent object, for chaining multiple calls
5409 * into a single statement.
5410 *
5411 * @see #getData
5412 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005413 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005414 */
5415 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005416 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005417 }
5418
5419 /**
5420 * Set an explicit MIME data type.
5421 *
5422 * <p>This is used to create intents that only specify a type and not data,
5423 * for example to indicate the type of data to return.
5424 *
5425 * <p>This method automatically clears any data that was
5426 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005427 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005428 * <p><em>Note: MIME type matching in the Android framework is
5429 * case-sensitive, unlike formal RFC MIME types. As a result,
5430 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005431 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5432 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005433 *
5434 * @param type The MIME type of the data being handled by this intent.
5435 *
5436 * @return Returns the same Intent object, for chaining multiple calls
5437 * into a single statement.
5438 *
5439 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005440 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005441 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005442 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005443 */
5444 public Intent setType(String type) {
5445 mData = null;
5446 mType = type;
5447 return this;
5448 }
5449
5450 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005451 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005452 *
Nick Pellyccae4122012-01-09 14:12:58 -08005453 * <p>This is used to create intents that only specify a type and not data,
5454 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005455 *
Nick Pellyccae4122012-01-09 14:12:58 -08005456 * <p>This method automatically clears any data that was
5457 * previously set (for example by {@link #setData}).
5458 *
5459 * <p>The MIME type is normalized using
5460 * {@link #normalizeMimeType} before it is set,
5461 * so really this is just a convenience method for
5462 * <pre>
5463 * setType(Intent.normalizeMimeType(type))
5464 * </pre>
5465 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005466 * @param type The MIME type of the data being handled by this intent.
5467 *
5468 * @return Returns the same Intent object, for chaining multiple calls
5469 * into a single statement.
5470 *
Nick Pellyccae4122012-01-09 14:12:58 -08005471 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005472 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005473 * @see #normalizeMimeType
5474 */
5475 public Intent setTypeAndNormalize(String type) {
5476 return setType(normalizeMimeType(type));
5477 }
5478
5479 /**
5480 * (Usually optional) Set the data for the intent along with an explicit
5481 * MIME data type. This method should very rarely be used -- it allows you
5482 * to override the MIME type that would ordinarily be inferred from the
5483 * data with your own type given here.
5484 *
5485 * <p><em>Note: MIME type and Uri scheme matching in the
5486 * Android framework is case-sensitive, unlike the formal RFC definitions.
5487 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005488 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005489 * {@link #setDataAndTypeAndNormalize}
5490 * to ensure that they are converted to lower case.</em>
5491 *
5492 * @param data The Uri of the data this intent is now targeting.
5493 * @param type The MIME type of the data being handled by this intent.
5494 *
5495 * @return Returns the same Intent object, for chaining multiple calls
5496 * into a single statement.
5497 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005498 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005499 * @see #setData
5500 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005501 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005502 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005503 */
5504 public Intent setDataAndType(Uri data, String type) {
5505 mData = data;
5506 mType = type;
5507 return this;
5508 }
5509
5510 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005511 * (Usually optional) Normalize and set both the data Uri and an explicit
5512 * MIME data type. This method should very rarely be used -- it allows you
5513 * to override the MIME type that would ordinarily be inferred from the
5514 * data with your own type given here.
5515 *
5516 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005517 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005518 * before they are set, so really this is just a convenience method for
5519 * <pre>
5520 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5521 * </pre>
5522 *
5523 * @param data The Uri of the data this intent is now targeting.
5524 * @param type The MIME type of the data being handled by this intent.
5525 *
5526 * @return Returns the same Intent object, for chaining multiple calls
5527 * into a single statement.
5528 *
5529 * @see #setType
5530 * @see #setData
5531 * @see #setDataAndType
5532 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005533 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005534 */
5535 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005536 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005537 }
5538
5539 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005540 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005541 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005542 * activities that provide <em>all</em> of the requested categories will be
5543 * used.
5544 *
5545 * @param category The desired category. This can be either one of the
5546 * predefined Intent categories, or a custom category in your own
5547 * namespace.
5548 *
5549 * @return Returns the same Intent object, for chaining multiple calls
5550 * into a single statement.
5551 *
5552 * @see #hasCategory
5553 * @see #removeCategory
5554 */
5555 public Intent addCategory(String category) {
5556 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005557 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005558 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005559 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005560 return this;
5561 }
5562
5563 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005564 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005565 *
5566 * @param category The category to remove.
5567 *
5568 * @see #addCategory
5569 */
5570 public void removeCategory(String category) {
5571 if (mCategories != null) {
5572 mCategories.remove(category);
5573 if (mCategories.size() == 0) {
5574 mCategories = null;
5575 }
5576 }
5577 }
5578
5579 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005580 * Set a selector for this Intent. This is a modification to the kinds of
5581 * things the Intent will match. If the selector is set, it will be used
5582 * when trying to find entities that can handle the Intent, instead of the
5583 * main contents of the Intent. This allows you build an Intent containing
5584 * a generic protocol while targeting it more specifically.
5585 *
5586 * <p>An example of where this may be used is with things like
5587 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5588 * Intent that will launch the Browser application. However, the correct
5589 * main entry point of an application is actually {@link #ACTION_MAIN}
5590 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5591 * used to specify the actual Activity to launch. If you launch the browser
5592 * with something different, undesired behavior may happen if the user has
5593 * previously or later launches it the normal way, since they do not match.
5594 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5595 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5596 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5597 *
5598 * <p>Setting a selector does not impact the behavior of
5599 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5600 * desired behavior of a selector -- it does not impact the base meaning
5601 * of the Intent, just what kinds of things will be matched against it
5602 * when determining who can handle it.</p>
5603 *
5604 * <p>You can not use both a selector and {@link #setPackage(String)} on
5605 * the same base Intent.</p>
5606 *
5607 * @param selector The desired selector Intent; set to null to not use
5608 * a special selector.
5609 */
5610 public void setSelector(Intent selector) {
5611 if (selector == this) {
5612 throw new IllegalArgumentException(
5613 "Intent being set as a selector of itself");
5614 }
5615 if (selector != null && mPackage != null) {
5616 throw new IllegalArgumentException(
5617 "Can't set selector when package name is already set");
5618 }
5619 mSelector = selector;
5620 }
5621
5622 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005623 * Set a {@link ClipData} associated with this Intent. This replaces any
5624 * previously set ClipData.
5625 *
5626 * <p>The ClipData in an intent is not used for Intent matching or other
5627 * such operations. Semantically it is like extras, used to transmit
5628 * additional data with the Intent. The main feature of using this over
5629 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5630 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5631 * items included in the clip data. This is useful, in particular, if
5632 * you want to transmit an Intent containing multiple <code>content:</code>
5633 * URIs for which the recipient may not have global permission to access the
5634 * content provider.
5635 *
5636 * <p>If the ClipData contains items that are themselves Intents, any
5637 * grant flags in those Intents will be ignored. Only the top-level flags
5638 * of the main Intent are respected, and will be applied to all Uri or
5639 * Intent items in the clip (or sub-items of the clip).
5640 *
5641 * <p>The MIME type, label, and icon in the ClipData object are not
5642 * directly used by Intent. Applications should generally rely on the
5643 * MIME type of the Intent itself, not what it may find in the ClipData.
5644 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005645 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005646 *
5647 * @param clip The new clip to set. May be null to clear the current clip.
5648 */
5649 public void setClipData(ClipData clip) {
5650 mClipData = clip;
5651 }
5652
5653 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005654 * Add extended data to the intent. The name must include a package
5655 * prefix, for example the app com.android.contacts would use names
5656 * like "com.android.contacts.ShowAll".
5657 *
5658 * @param name The name of the extra data, with package prefix.
5659 * @param value The boolean data value.
5660 *
5661 * @return Returns the same Intent object, for chaining multiple calls
5662 * into a single statement.
5663 *
5664 * @see #putExtras
5665 * @see #removeExtra
5666 * @see #getBooleanExtra(String, boolean)
5667 */
5668 public Intent putExtra(String name, boolean value) {
5669 if (mExtras == null) {
5670 mExtras = new Bundle();
5671 }
5672 mExtras.putBoolean(name, value);
5673 return this;
5674 }
5675
5676 /**
5677 * Add extended data to the intent. The name must include a package
5678 * prefix, for example the app com.android.contacts would use names
5679 * like "com.android.contacts.ShowAll".
5680 *
5681 * @param name The name of the extra data, with package prefix.
5682 * @param value The byte data value.
5683 *
5684 * @return Returns the same Intent object, for chaining multiple calls
5685 * into a single statement.
5686 *
5687 * @see #putExtras
5688 * @see #removeExtra
5689 * @see #getByteExtra(String, byte)
5690 */
5691 public Intent putExtra(String name, byte value) {
5692 if (mExtras == null) {
5693 mExtras = new Bundle();
5694 }
5695 mExtras.putByte(name, value);
5696 return this;
5697 }
5698
5699 /**
5700 * Add extended data to the intent. The name must include a package
5701 * prefix, for example the app com.android.contacts would use names
5702 * like "com.android.contacts.ShowAll".
5703 *
5704 * @param name The name of the extra data, with package prefix.
5705 * @param value The char data value.
5706 *
5707 * @return Returns the same Intent object, for chaining multiple calls
5708 * into a single statement.
5709 *
5710 * @see #putExtras
5711 * @see #removeExtra
5712 * @see #getCharExtra(String, char)
5713 */
5714 public Intent putExtra(String name, char value) {
5715 if (mExtras == null) {
5716 mExtras = new Bundle();
5717 }
5718 mExtras.putChar(name, value);
5719 return this;
5720 }
5721
5722 /**
5723 * Add extended data to the intent. The name must include a package
5724 * prefix, for example the app com.android.contacts would use names
5725 * like "com.android.contacts.ShowAll".
5726 *
5727 * @param name The name of the extra data, with package prefix.
5728 * @param value The short data value.
5729 *
5730 * @return Returns the same Intent object, for chaining multiple calls
5731 * into a single statement.
5732 *
5733 * @see #putExtras
5734 * @see #removeExtra
5735 * @see #getShortExtra(String, short)
5736 */
5737 public Intent putExtra(String name, short value) {
5738 if (mExtras == null) {
5739 mExtras = new Bundle();
5740 }
5741 mExtras.putShort(name, value);
5742 return this;
5743 }
5744
5745 /**
5746 * Add extended data to the intent. The name must include a package
5747 * prefix, for example the app com.android.contacts would use names
5748 * like "com.android.contacts.ShowAll".
5749 *
5750 * @param name The name of the extra data, with package prefix.
5751 * @param value The integer data value.
5752 *
5753 * @return Returns the same Intent object, for chaining multiple calls
5754 * into a single statement.
5755 *
5756 * @see #putExtras
5757 * @see #removeExtra
5758 * @see #getIntExtra(String, int)
5759 */
5760 public Intent putExtra(String name, int value) {
5761 if (mExtras == null) {
5762 mExtras = new Bundle();
5763 }
5764 mExtras.putInt(name, value);
5765 return this;
5766 }
5767
5768 /**
5769 * Add extended data to the intent. The name must include a package
5770 * prefix, for example the app com.android.contacts would use names
5771 * like "com.android.contacts.ShowAll".
5772 *
5773 * @param name The name of the extra data, with package prefix.
5774 * @param value The long data value.
5775 *
5776 * @return Returns the same Intent object, for chaining multiple calls
5777 * into a single statement.
5778 *
5779 * @see #putExtras
5780 * @see #removeExtra
5781 * @see #getLongExtra(String, long)
5782 */
5783 public Intent putExtra(String name, long value) {
5784 if (mExtras == null) {
5785 mExtras = new Bundle();
5786 }
5787 mExtras.putLong(name, value);
5788 return this;
5789 }
5790
5791 /**
5792 * Add extended data to the intent. The name must include a package
5793 * prefix, for example the app com.android.contacts would use names
5794 * like "com.android.contacts.ShowAll".
5795 *
5796 * @param name The name of the extra data, with package prefix.
5797 * @param value The float data value.
5798 *
5799 * @return Returns the same Intent object, for chaining multiple calls
5800 * into a single statement.
5801 *
5802 * @see #putExtras
5803 * @see #removeExtra
5804 * @see #getFloatExtra(String, float)
5805 */
5806 public Intent putExtra(String name, float value) {
5807 if (mExtras == null) {
5808 mExtras = new Bundle();
5809 }
5810 mExtras.putFloat(name, value);
5811 return this;
5812 }
5813
5814 /**
5815 * Add extended data to the intent. The name must include a package
5816 * prefix, for example the app com.android.contacts would use names
5817 * like "com.android.contacts.ShowAll".
5818 *
5819 * @param name The name of the extra data, with package prefix.
5820 * @param value The double data value.
5821 *
5822 * @return Returns the same Intent object, for chaining multiple calls
5823 * into a single statement.
5824 *
5825 * @see #putExtras
5826 * @see #removeExtra
5827 * @see #getDoubleExtra(String, double)
5828 */
5829 public Intent putExtra(String name, double value) {
5830 if (mExtras == null) {
5831 mExtras = new Bundle();
5832 }
5833 mExtras.putDouble(name, value);
5834 return this;
5835 }
5836
5837 /**
5838 * Add extended data to the intent. The name must include a package
5839 * prefix, for example the app com.android.contacts would use names
5840 * like "com.android.contacts.ShowAll".
5841 *
5842 * @param name The name of the extra data, with package prefix.
5843 * @param value The String data value.
5844 *
5845 * @return Returns the same Intent object, for chaining multiple calls
5846 * into a single statement.
5847 *
5848 * @see #putExtras
5849 * @see #removeExtra
5850 * @see #getStringExtra(String)
5851 */
5852 public Intent putExtra(String name, String value) {
5853 if (mExtras == null) {
5854 mExtras = new Bundle();
5855 }
5856 mExtras.putString(name, value);
5857 return this;
5858 }
5859
5860 /**
5861 * Add extended data to the intent. The name must include a package
5862 * prefix, for example the app com.android.contacts would use names
5863 * like "com.android.contacts.ShowAll".
5864 *
5865 * @param name The name of the extra data, with package prefix.
5866 * @param value The CharSequence data value.
5867 *
5868 * @return Returns the same Intent object, for chaining multiple calls
5869 * into a single statement.
5870 *
5871 * @see #putExtras
5872 * @see #removeExtra
5873 * @see #getCharSequenceExtra(String)
5874 */
5875 public Intent putExtra(String name, CharSequence value) {
5876 if (mExtras == null) {
5877 mExtras = new Bundle();
5878 }
5879 mExtras.putCharSequence(name, value);
5880 return this;
5881 }
5882
5883 /**
5884 * Add extended data to the intent. The name must include a package
5885 * prefix, for example the app com.android.contacts would use names
5886 * like "com.android.contacts.ShowAll".
5887 *
5888 * @param name The name of the extra data, with package prefix.
5889 * @param value The Parcelable data value.
5890 *
5891 * @return Returns the same Intent object, for chaining multiple calls
5892 * into a single statement.
5893 *
5894 * @see #putExtras
5895 * @see #removeExtra
5896 * @see #getParcelableExtra(String)
5897 */
5898 public Intent putExtra(String name, Parcelable value) {
5899 if (mExtras == null) {
5900 mExtras = new Bundle();
5901 }
5902 mExtras.putParcelable(name, value);
5903 return this;
5904 }
5905
5906 /**
5907 * Add extended data to the intent. The name must include a package
5908 * prefix, for example the app com.android.contacts would use names
5909 * like "com.android.contacts.ShowAll".
5910 *
5911 * @param name The name of the extra data, with package prefix.
5912 * @param value The Parcelable[] data value.
5913 *
5914 * @return Returns the same Intent object, for chaining multiple calls
5915 * into a single statement.
5916 *
5917 * @see #putExtras
5918 * @see #removeExtra
5919 * @see #getParcelableArrayExtra(String)
5920 */
5921 public Intent putExtra(String name, Parcelable[] value) {
5922 if (mExtras == null) {
5923 mExtras = new Bundle();
5924 }
5925 mExtras.putParcelableArray(name, value);
5926 return this;
5927 }
5928
5929 /**
5930 * Add extended data to the intent. The name must include a package
5931 * prefix, for example the app com.android.contacts would use names
5932 * like "com.android.contacts.ShowAll".
5933 *
5934 * @param name The name of the extra data, with package prefix.
5935 * @param value The ArrayList<Parcelable> data value.
5936 *
5937 * @return Returns the same Intent object, for chaining multiple calls
5938 * into a single statement.
5939 *
5940 * @see #putExtras
5941 * @see #removeExtra
5942 * @see #getParcelableArrayListExtra(String)
5943 */
5944 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5945 if (mExtras == null) {
5946 mExtras = new Bundle();
5947 }
5948 mExtras.putParcelableArrayList(name, value);
5949 return this;
5950 }
5951
5952 /**
5953 * Add extended data to the intent. The name must include a package
5954 * prefix, for example the app com.android.contacts would use names
5955 * like "com.android.contacts.ShowAll".
5956 *
5957 * @param name The name of the extra data, with package prefix.
5958 * @param value The ArrayList<Integer> data value.
5959 *
5960 * @return Returns the same Intent object, for chaining multiple calls
5961 * into a single statement.
5962 *
5963 * @see #putExtras
5964 * @see #removeExtra
5965 * @see #getIntegerArrayListExtra(String)
5966 */
5967 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5968 if (mExtras == null) {
5969 mExtras = new Bundle();
5970 }
5971 mExtras.putIntegerArrayList(name, value);
5972 return this;
5973 }
5974
5975 /**
5976 * Add extended data to the intent. The name must include a package
5977 * prefix, for example the app com.android.contacts would use names
5978 * like "com.android.contacts.ShowAll".
5979 *
5980 * @param name The name of the extra data, with package prefix.
5981 * @param value The ArrayList<String> data value.
5982 *
5983 * @return Returns the same Intent object, for chaining multiple calls
5984 * into a single statement.
5985 *
5986 * @see #putExtras
5987 * @see #removeExtra
5988 * @see #getStringArrayListExtra(String)
5989 */
5990 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5991 if (mExtras == null) {
5992 mExtras = new Bundle();
5993 }
5994 mExtras.putStringArrayList(name, value);
5995 return this;
5996 }
5997
5998 /**
5999 * Add extended data to the intent. The name must include a package
6000 * prefix, for example the app com.android.contacts would use names
6001 * like "com.android.contacts.ShowAll".
6002 *
6003 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006004 * @param value The ArrayList<CharSequence> data value.
6005 *
6006 * @return Returns the same Intent object, for chaining multiple calls
6007 * into a single statement.
6008 *
6009 * @see #putExtras
6010 * @see #removeExtra
6011 * @see #getCharSequenceArrayListExtra(String)
6012 */
6013 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6014 if (mExtras == null) {
6015 mExtras = new Bundle();
6016 }
6017 mExtras.putCharSequenceArrayList(name, value);
6018 return this;
6019 }
6020
6021 /**
6022 * Add extended data to the intent. The name must include a package
6023 * prefix, for example the app com.android.contacts would use names
6024 * like "com.android.contacts.ShowAll".
6025 *
6026 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006027 * @param value The Serializable data value.
6028 *
6029 * @return Returns the same Intent object, for chaining multiple calls
6030 * into a single statement.
6031 *
6032 * @see #putExtras
6033 * @see #removeExtra
6034 * @see #getSerializableExtra(String)
6035 */
6036 public Intent putExtra(String name, Serializable value) {
6037 if (mExtras == null) {
6038 mExtras = new Bundle();
6039 }
6040 mExtras.putSerializable(name, value);
6041 return this;
6042 }
6043
6044 /**
6045 * Add extended data to the intent. The name must include a package
6046 * prefix, for example the app com.android.contacts would use names
6047 * like "com.android.contacts.ShowAll".
6048 *
6049 * @param name The name of the extra data, with package prefix.
6050 * @param value The boolean array data value.
6051 *
6052 * @return Returns the same Intent object, for chaining multiple calls
6053 * into a single statement.
6054 *
6055 * @see #putExtras
6056 * @see #removeExtra
6057 * @see #getBooleanArrayExtra(String)
6058 */
6059 public Intent putExtra(String name, boolean[] value) {
6060 if (mExtras == null) {
6061 mExtras = new Bundle();
6062 }
6063 mExtras.putBooleanArray(name, value);
6064 return this;
6065 }
6066
6067 /**
6068 * Add extended data to the intent. The name must include a package
6069 * prefix, for example the app com.android.contacts would use names
6070 * like "com.android.contacts.ShowAll".
6071 *
6072 * @param name The name of the extra data, with package prefix.
6073 * @param value The byte array data value.
6074 *
6075 * @return Returns the same Intent object, for chaining multiple calls
6076 * into a single statement.
6077 *
6078 * @see #putExtras
6079 * @see #removeExtra
6080 * @see #getByteArrayExtra(String)
6081 */
6082 public Intent putExtra(String name, byte[] value) {
6083 if (mExtras == null) {
6084 mExtras = new Bundle();
6085 }
6086 mExtras.putByteArray(name, value);
6087 return this;
6088 }
6089
6090 /**
6091 * Add extended data to the intent. The name must include a package
6092 * prefix, for example the app com.android.contacts would use names
6093 * like "com.android.contacts.ShowAll".
6094 *
6095 * @param name The name of the extra data, with package prefix.
6096 * @param value The short array data value.
6097 *
6098 * @return Returns the same Intent object, for chaining multiple calls
6099 * into a single statement.
6100 *
6101 * @see #putExtras
6102 * @see #removeExtra
6103 * @see #getShortArrayExtra(String)
6104 */
6105 public Intent putExtra(String name, short[] value) {
6106 if (mExtras == null) {
6107 mExtras = new Bundle();
6108 }
6109 mExtras.putShortArray(name, value);
6110 return this;
6111 }
6112
6113 /**
6114 * Add extended data to the intent. The name must include a package
6115 * prefix, for example the app com.android.contacts would use names
6116 * like "com.android.contacts.ShowAll".
6117 *
6118 * @param name The name of the extra data, with package prefix.
6119 * @param value The char array data value.
6120 *
6121 * @return Returns the same Intent object, for chaining multiple calls
6122 * into a single statement.
6123 *
6124 * @see #putExtras
6125 * @see #removeExtra
6126 * @see #getCharArrayExtra(String)
6127 */
6128 public Intent putExtra(String name, char[] value) {
6129 if (mExtras == null) {
6130 mExtras = new Bundle();
6131 }
6132 mExtras.putCharArray(name, value);
6133 return this;
6134 }
6135
6136 /**
6137 * Add extended data to the intent. The name must include a package
6138 * prefix, for example the app com.android.contacts would use names
6139 * like "com.android.contacts.ShowAll".
6140 *
6141 * @param name The name of the extra data, with package prefix.
6142 * @param value The int array data value.
6143 *
6144 * @return Returns the same Intent object, for chaining multiple calls
6145 * into a single statement.
6146 *
6147 * @see #putExtras
6148 * @see #removeExtra
6149 * @see #getIntArrayExtra(String)
6150 */
6151 public Intent putExtra(String name, int[] value) {
6152 if (mExtras == null) {
6153 mExtras = new Bundle();
6154 }
6155 mExtras.putIntArray(name, value);
6156 return this;
6157 }
6158
6159 /**
6160 * Add extended data to the intent. The name must include a package
6161 * prefix, for example the app com.android.contacts would use names
6162 * like "com.android.contacts.ShowAll".
6163 *
6164 * @param name The name of the extra data, with package prefix.
6165 * @param value The byte array data value.
6166 *
6167 * @return Returns the same Intent object, for chaining multiple calls
6168 * into a single statement.
6169 *
6170 * @see #putExtras
6171 * @see #removeExtra
6172 * @see #getLongArrayExtra(String)
6173 */
6174 public Intent putExtra(String name, long[] value) {
6175 if (mExtras == null) {
6176 mExtras = new Bundle();
6177 }
6178 mExtras.putLongArray(name, value);
6179 return this;
6180 }
6181
6182 /**
6183 * Add extended data to the intent. The name must include a package
6184 * prefix, for example the app com.android.contacts would use names
6185 * like "com.android.contacts.ShowAll".
6186 *
6187 * @param name The name of the extra data, with package prefix.
6188 * @param value The float array data value.
6189 *
6190 * @return Returns the same Intent object, for chaining multiple calls
6191 * into a single statement.
6192 *
6193 * @see #putExtras
6194 * @see #removeExtra
6195 * @see #getFloatArrayExtra(String)
6196 */
6197 public Intent putExtra(String name, float[] value) {
6198 if (mExtras == null) {
6199 mExtras = new Bundle();
6200 }
6201 mExtras.putFloatArray(name, value);
6202 return this;
6203 }
6204
6205 /**
6206 * Add extended data to the intent. The name must include a package
6207 * prefix, for example the app com.android.contacts would use names
6208 * like "com.android.contacts.ShowAll".
6209 *
6210 * @param name The name of the extra data, with package prefix.
6211 * @param value The double array data value.
6212 *
6213 * @return Returns the same Intent object, for chaining multiple calls
6214 * into a single statement.
6215 *
6216 * @see #putExtras
6217 * @see #removeExtra
6218 * @see #getDoubleArrayExtra(String)
6219 */
6220 public Intent putExtra(String name, double[] value) {
6221 if (mExtras == null) {
6222 mExtras = new Bundle();
6223 }
6224 mExtras.putDoubleArray(name, value);
6225 return this;
6226 }
6227
6228 /**
6229 * Add extended data to the intent. The name must include a package
6230 * prefix, for example the app com.android.contacts would use names
6231 * like "com.android.contacts.ShowAll".
6232 *
6233 * @param name The name of the extra data, with package prefix.
6234 * @param value The String array data value.
6235 *
6236 * @return Returns the same Intent object, for chaining multiple calls
6237 * into a single statement.
6238 *
6239 * @see #putExtras
6240 * @see #removeExtra
6241 * @see #getStringArrayExtra(String)
6242 */
6243 public Intent putExtra(String name, String[] value) {
6244 if (mExtras == null) {
6245 mExtras = new Bundle();
6246 }
6247 mExtras.putStringArray(name, value);
6248 return this;
6249 }
6250
6251 /**
6252 * Add extended data to the intent. The name must include a package
6253 * prefix, for example the app com.android.contacts would use names
6254 * like "com.android.contacts.ShowAll".
6255 *
6256 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006257 * @param value The CharSequence array data value.
6258 *
6259 * @return Returns the same Intent object, for chaining multiple calls
6260 * into a single statement.
6261 *
6262 * @see #putExtras
6263 * @see #removeExtra
6264 * @see #getCharSequenceArrayExtra(String)
6265 */
6266 public Intent putExtra(String name, CharSequence[] value) {
6267 if (mExtras == null) {
6268 mExtras = new Bundle();
6269 }
6270 mExtras.putCharSequenceArray(name, value);
6271 return this;
6272 }
6273
6274 /**
6275 * Add extended data to the intent. The name must include a package
6276 * prefix, for example the app com.android.contacts would use names
6277 * like "com.android.contacts.ShowAll".
6278 *
6279 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006280 * @param value The Bundle data value.
6281 *
6282 * @return Returns the same Intent object, for chaining multiple calls
6283 * into a single statement.
6284 *
6285 * @see #putExtras
6286 * @see #removeExtra
6287 * @see #getBundleExtra(String)
6288 */
6289 public Intent putExtra(String name, Bundle value) {
6290 if (mExtras == null) {
6291 mExtras = new Bundle();
6292 }
6293 mExtras.putBundle(name, value);
6294 return this;
6295 }
6296
6297 /**
6298 * Add extended data to the intent. The name must include a package
6299 * prefix, for example the app com.android.contacts would use names
6300 * like "com.android.contacts.ShowAll".
6301 *
6302 * @param name The name of the extra data, with package prefix.
6303 * @param value The IBinder data value.
6304 *
6305 * @return Returns the same Intent object, for chaining multiple calls
6306 * into a single statement.
6307 *
6308 * @see #putExtras
6309 * @see #removeExtra
6310 * @see #getIBinderExtra(String)
6311 *
6312 * @deprecated
6313 * @hide
6314 */
6315 @Deprecated
6316 public Intent putExtra(String name, IBinder value) {
6317 if (mExtras == null) {
6318 mExtras = new Bundle();
6319 }
6320 mExtras.putIBinder(name, value);
6321 return this;
6322 }
6323
6324 /**
6325 * Copy all extras in 'src' in to this intent.
6326 *
6327 * @param src Contains the extras to copy.
6328 *
6329 * @see #putExtra
6330 */
6331 public Intent putExtras(Intent src) {
6332 if (src.mExtras != null) {
6333 if (mExtras == null) {
6334 mExtras = new Bundle(src.mExtras);
6335 } else {
6336 mExtras.putAll(src.mExtras);
6337 }
6338 }
6339 return this;
6340 }
6341
6342 /**
6343 * Add a set of extended data to the intent. The keys must include a package
6344 * prefix, for example the app com.android.contacts would use names
6345 * like "com.android.contacts.ShowAll".
6346 *
6347 * @param extras The Bundle of extras to add to this intent.
6348 *
6349 * @see #putExtra
6350 * @see #removeExtra
6351 */
6352 public Intent putExtras(Bundle extras) {
6353 if (mExtras == null) {
6354 mExtras = new Bundle();
6355 }
6356 mExtras.putAll(extras);
6357 return this;
6358 }
6359
6360 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006361 * Completely replace the extras in the Intent with the extras in the
6362 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006363 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006364 * @param src The exact extras contained in this Intent are copied
6365 * into the target intent, replacing any that were previously there.
6366 */
6367 public Intent replaceExtras(Intent src) {
6368 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6369 return this;
6370 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006371
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006372 /**
6373 * Completely replace the extras in the Intent with the given Bundle of
6374 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006375 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006376 * @param extras The new set of extras in the Intent, or null to erase
6377 * all extras.
6378 */
6379 public Intent replaceExtras(Bundle extras) {
6380 mExtras = extras != null ? new Bundle(extras) : null;
6381 return this;
6382 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006383
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006384 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006385 * Remove extended data from the intent.
6386 *
6387 * @see #putExtra
6388 */
6389 public void removeExtra(String name) {
6390 if (mExtras != null) {
6391 mExtras.remove(name);
6392 if (mExtras.size() == 0) {
6393 mExtras = null;
6394 }
6395 }
6396 }
6397
6398 /**
6399 * Set special flags controlling how this intent is handled. Most values
6400 * here depend on the type of component being executed by the Intent,
6401 * specifically the FLAG_ACTIVITY_* flags are all for use with
6402 * {@link Context#startActivity Context.startActivity()} and the
6403 * FLAG_RECEIVER_* flags are all for use with
6404 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6405 *
Scott Main7aee61f2011-02-08 11:25:01 -08006406 * <p>See the
6407 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6408 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006409 * the behavior of your application.
6410 *
6411 * @param flags The desired flags.
6412 *
6413 * @return Returns the same Intent object, for chaining multiple calls
6414 * into a single statement.
6415 *
6416 * @see #getFlags
6417 * @see #addFlags
6418 *
6419 * @see #FLAG_GRANT_READ_URI_PERMISSION
6420 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006421 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6422 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006423 * @see #FLAG_DEBUG_LOG_RESOLUTION
6424 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006425 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006426 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006427 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006428 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006429 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6430 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006431 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006432 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006433 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006434 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006435 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006436 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006437 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006438 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6439 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006440 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006441 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006442 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006443 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6444 */
6445 public Intent setFlags(int flags) {
6446 mFlags = flags;
6447 return this;
6448 }
6449
6450 /**
6451 * Add additional flags to the intent (or with existing flags
6452 * value).
6453 *
6454 * @param flags The new flags to set.
6455 *
6456 * @return Returns the same Intent object, for chaining multiple calls
6457 * into a single statement.
6458 *
6459 * @see #setFlags
6460 */
6461 public Intent addFlags(int flags) {
6462 mFlags |= flags;
6463 return this;
6464 }
6465
6466 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006467 * (Usually optional) Set an explicit application package name that limits
6468 * the components this Intent will resolve to. If left to the default
6469 * value of null, all components in all applications will considered.
6470 * If non-null, the Intent can only match the components in the given
6471 * application package.
6472 *
6473 * @param packageName The name of the application package to handle the
6474 * intent, or null to allow any application package.
6475 *
6476 * @return Returns the same Intent object, for chaining multiple calls
6477 * into a single statement.
6478 *
6479 * @see #getPackage
6480 * @see #resolveActivity
6481 */
6482 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006483 if (packageName != null && mSelector != null) {
6484 throw new IllegalArgumentException(
6485 "Can't set package name when selector is already set");
6486 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006487 mPackage = packageName;
6488 return this;
6489 }
6490
6491 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006492 * (Usually optional) Explicitly set the component to handle the intent.
6493 * If left with the default value of null, the system will determine the
6494 * appropriate class to use based on the other fields (action, data,
6495 * type, categories) in the Intent. If this class is defined, the
6496 * specified class will always be used regardless of the other fields. You
6497 * should only set this value when you know you absolutely want a specific
6498 * class to be used; otherwise it is better to let the system find the
6499 * appropriate class so that you will respect the installed applications
6500 * and user preferences.
6501 *
6502 * @param component The name of the application component to handle the
6503 * intent, or null to let the system find one for you.
6504 *
6505 * @return Returns the same Intent object, for chaining multiple calls
6506 * into a single statement.
6507 *
6508 * @see #setClass
6509 * @see #setClassName(Context, String)
6510 * @see #setClassName(String, String)
6511 * @see #getComponent
6512 * @see #resolveActivity
6513 */
6514 public Intent setComponent(ComponentName component) {
6515 mComponent = component;
6516 return this;
6517 }
6518
6519 /**
6520 * Convenience for calling {@link #setComponent} with an
6521 * explicit class name.
6522 *
6523 * @param packageContext A Context of the application package implementing
6524 * this class.
6525 * @param className The name of a class inside of the application package
6526 * that will be used as the component for this Intent.
6527 *
6528 * @return Returns the same Intent object, for chaining multiple calls
6529 * into a single statement.
6530 *
6531 * @see #setComponent
6532 * @see #setClass
6533 */
6534 public Intent setClassName(Context packageContext, String className) {
6535 mComponent = new ComponentName(packageContext, className);
6536 return this;
6537 }
6538
6539 /**
6540 * Convenience for calling {@link #setComponent} with an
6541 * explicit application package name and class name.
6542 *
6543 * @param packageName The name of the package implementing the desired
6544 * component.
6545 * @param className The name of a class inside of the application package
6546 * that will be used as the component for this Intent.
6547 *
6548 * @return Returns the same Intent object, for chaining multiple calls
6549 * into a single statement.
6550 *
6551 * @see #setComponent
6552 * @see #setClass
6553 */
6554 public Intent setClassName(String packageName, String className) {
6555 mComponent = new ComponentName(packageName, className);
6556 return this;
6557 }
6558
6559 /**
6560 * Convenience for calling {@link #setComponent(ComponentName)} with the
6561 * name returned by a {@link Class} object.
6562 *
6563 * @param packageContext A Context of the application package implementing
6564 * this class.
6565 * @param cls The class name to set, equivalent to
6566 * <code>setClassName(context, cls.getName())</code>.
6567 *
6568 * @return Returns the same Intent object, for chaining multiple calls
6569 * into a single statement.
6570 *
6571 * @see #setComponent
6572 */
6573 public Intent setClass(Context packageContext, Class<?> cls) {
6574 mComponent = new ComponentName(packageContext, cls);
6575 return this;
6576 }
6577
6578 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006579 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6580 * used as a hint to the receiver for animations and the like. Null means that there
6581 * is no source bounds.
6582 */
6583 public void setSourceBounds(Rect r) {
6584 if (r != null) {
6585 mSourceBounds = new Rect(r);
6586 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006587 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006588 }
6589 }
6590
Tor Norbyed9273d62013-05-30 15:59:53 -07006591 /** @hide */
6592 @IntDef(flag = true,
6593 value = {
6594 FILL_IN_ACTION,
6595 FILL_IN_DATA,
6596 FILL_IN_CATEGORIES,
6597 FILL_IN_COMPONENT,
6598 FILL_IN_PACKAGE,
6599 FILL_IN_SOURCE_BOUNDS,
6600 FILL_IN_SELECTOR,
6601 FILL_IN_CLIP_DATA
6602 })
6603 @Retention(RetentionPolicy.SOURCE)
6604 public @interface FillInFlags {}
6605
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006606 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006607 * Use with {@link #fillIn} to allow the current action value to be
6608 * overwritten, even if it is already set.
6609 */
6610 public static final int FILL_IN_ACTION = 1<<0;
6611
6612 /**
6613 * Use with {@link #fillIn} to allow the current data or type value
6614 * overwritten, even if it is already set.
6615 */
6616 public static final int FILL_IN_DATA = 1<<1;
6617
6618 /**
6619 * Use with {@link #fillIn} to allow the current categories to be
6620 * overwritten, even if they are already set.
6621 */
6622 public static final int FILL_IN_CATEGORIES = 1<<2;
6623
6624 /**
6625 * Use with {@link #fillIn} to allow the current component value to be
6626 * overwritten, even if it is already set.
6627 */
6628 public static final int FILL_IN_COMPONENT = 1<<3;
6629
6630 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006631 * Use with {@link #fillIn} to allow the current package value to be
6632 * overwritten, even if it is already set.
6633 */
6634 public static final int FILL_IN_PACKAGE = 1<<4;
6635
6636 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006637 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006638 * overwritten, even if it is already set.
6639 */
6640 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6641
6642 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006643 * Use with {@link #fillIn} to allow the current selector to be
6644 * overwritten, even if it is already set.
6645 */
6646 public static final int FILL_IN_SELECTOR = 1<<6;
6647
6648 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006649 * Use with {@link #fillIn} to allow the current ClipData to be
6650 * overwritten, even if it is already set.
6651 */
6652 public static final int FILL_IN_CLIP_DATA = 1<<7;
6653
6654 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006655 * Copy the contents of <var>other</var> in to this object, but only
6656 * where fields are not defined by this object. For purposes of a field
6657 * being defined, the following pieces of data in the Intent are
6658 * considered to be separate fields:
6659 *
6660 * <ul>
6661 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006662 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006663 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6664 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006665 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006666 * <li> component, as set by {@link #setComponent(ComponentName)} or
6667 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006668 * <li> source bounds, as set by {@link #setSourceBounds}.
6669 * <li> selector, as set by {@link #setSelector(Intent)}.
6670 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006671 * <li> each top-level name in the associated extras.
6672 * </ul>
6673 *
6674 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006675 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006676 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6677 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6678 * the restriction where the corresponding field will not be replaced if
6679 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006680 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006681 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6682 * is explicitly specified. The selector will only be copied if
6683 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006684 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006685 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6686 * and Intent B with {action="gotit", data-type="some/thing",
6687 * categories="one","two"}.
6688 *
6689 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6690 * containing: {action="gotit", data-type="some/thing",
6691 * categories="bar"}.
6692 *
6693 * @param other Another Intent whose values are to be used to fill in
6694 * the current one.
6695 * @param flags Options to control which fields can be filled in.
6696 *
6697 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006698 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006699 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6700 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6701 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006702 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006703 @FillInFlags
6704 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006705 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006706 if (other.mAction != null
6707 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006708 mAction = other.mAction;
6709 changes |= FILL_IN_ACTION;
6710 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006711 if ((other.mData != null || other.mType != null)
6712 && ((mData == null && mType == null)
6713 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006714 mData = other.mData;
6715 mType = other.mType;
6716 changes |= FILL_IN_DATA;
6717 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006718 if (other.mCategories != null
6719 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006720 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006721 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006722 }
6723 changes |= FILL_IN_CATEGORIES;
6724 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006725 if (other.mPackage != null
6726 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006727 // Only do this if mSelector is not set.
6728 if (mSelector == null) {
6729 mPackage = other.mPackage;
6730 changes |= FILL_IN_PACKAGE;
6731 }
6732 }
6733 // Selector is special: it can only be set if explicitly allowed,
6734 // for the same reason as the component name.
6735 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6736 if (mPackage == null) {
6737 mSelector = new Intent(other.mSelector);
6738 mPackage = null;
6739 changes |= FILL_IN_SELECTOR;
6740 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006741 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006742 if (other.mClipData != null
6743 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6744 mClipData = other.mClipData;
6745 changes |= FILL_IN_CLIP_DATA;
6746 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006747 // Component is special: it can -only- be set if explicitly allowed,
6748 // since otherwise the sender could force the intent somewhere the
6749 // originator didn't intend.
6750 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006751 mComponent = other.mComponent;
6752 changes |= FILL_IN_COMPONENT;
6753 }
6754 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006755 if (other.mSourceBounds != null
6756 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6757 mSourceBounds = new Rect(other.mSourceBounds);
6758 changes |= FILL_IN_SOURCE_BOUNDS;
6759 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006760 if (mExtras == null) {
6761 if (other.mExtras != null) {
6762 mExtras = new Bundle(other.mExtras);
6763 }
6764 } else if (other.mExtras != null) {
6765 try {
6766 Bundle newb = new Bundle(other.mExtras);
6767 newb.putAll(mExtras);
6768 mExtras = newb;
6769 } catch (RuntimeException e) {
6770 // Modifying the extras can cause us to unparcel the contents
6771 // of the bundle, and if we do this in the system process that
6772 // may fail. We really should handle this (i.e., the Bundle
6773 // impl shouldn't be on top of a plain map), but for now just
6774 // ignore it and keep the original contents. :(
6775 Log.w("Intent", "Failure filling in extras", e);
6776 }
6777 }
6778 return changes;
6779 }
6780
6781 /**
6782 * Wrapper class holding an Intent and implementing comparisons on it for
6783 * the purpose of filtering. The class implements its
6784 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6785 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6786 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6787 * on the wrapped Intent.
6788 */
6789 public static final class FilterComparison {
6790 private final Intent mIntent;
6791 private final int mHashCode;
6792
6793 public FilterComparison(Intent intent) {
6794 mIntent = intent;
6795 mHashCode = intent.filterHashCode();
6796 }
6797
6798 /**
6799 * Return the Intent that this FilterComparison represents.
6800 * @return Returns the Intent held by the FilterComparison. Do
6801 * not modify!
6802 */
6803 public Intent getIntent() {
6804 return mIntent;
6805 }
6806
6807 @Override
6808 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006809 if (obj instanceof FilterComparison) {
6810 Intent other = ((FilterComparison)obj).mIntent;
6811 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006812 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006813 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006814 }
6815
6816 @Override
6817 public int hashCode() {
6818 return mHashCode;
6819 }
6820 }
6821
6822 /**
6823 * Determine if two intents are the same for the purposes of intent
6824 * resolution (filtering). That is, if their action, data, type,
6825 * class, and categories are the same. This does <em>not</em> compare
6826 * any extra data included in the intents.
6827 *
6828 * @param other The other Intent to compare against.
6829 *
6830 * @return Returns true if action, data, type, class, and categories
6831 * are the same.
6832 */
6833 public boolean filterEquals(Intent other) {
6834 if (other == null) {
6835 return false;
6836 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07006837 if (!Objects.equals(this.mAction, other.mAction)) return false;
6838 if (!Objects.equals(this.mData, other.mData)) return false;
6839 if (!Objects.equals(this.mType, other.mType)) return false;
6840 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
6841 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
6842 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006843
6844 return true;
6845 }
6846
6847 /**
6848 * Generate hash code that matches semantics of filterEquals().
6849 *
6850 * @return Returns the hash value of the action, data, type, class, and
6851 * categories.
6852 *
6853 * @see #filterEquals
6854 */
6855 public int filterHashCode() {
6856 int code = 0;
6857 if (mAction != null) {
6858 code += mAction.hashCode();
6859 }
6860 if (mData != null) {
6861 code += mData.hashCode();
6862 }
6863 if (mType != null) {
6864 code += mType.hashCode();
6865 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006866 if (mPackage != null) {
6867 code += mPackage.hashCode();
6868 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006869 if (mComponent != null) {
6870 code += mComponent.hashCode();
6871 }
6872 if (mCategories != null) {
6873 code += mCategories.hashCode();
6874 }
6875 return code;
6876 }
6877
6878 @Override
6879 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006880 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006881
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006882 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006883 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006884 b.append(" }");
6885
6886 return b.toString();
6887 }
6888
6889 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006890 public String toInsecureString() {
6891 StringBuilder b = new StringBuilder(128);
6892
6893 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006894 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006895 b.append(" }");
6896
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006897 return b.toString();
6898 }
Romain Guy4969af72009-06-17 10:53:19 -07006899
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006900 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006901 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006902 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006903
6904 b.append("Intent { ");
6905 toShortString(b, false, true, true, true);
6906 b.append(" }");
6907
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006908 return b.toString();
6909 }
6910
6911 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006912 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6913 StringBuilder b = new StringBuilder(128);
6914 toShortString(b, secure, comp, extras, clip);
6915 return b.toString();
6916 }
6917
6918 /** @hide */
6919 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6920 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006921 boolean first = true;
6922 if (mAction != null) {
6923 b.append("act=").append(mAction);
6924 first = false;
6925 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006926 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006927 if (!first) {
6928 b.append(' ');
6929 }
6930 first = false;
6931 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006932 for (int i=0; i<mCategories.size(); i++) {
6933 if (i > 0) b.append(',');
6934 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006935 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006936 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006937 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006938 if (mData != null) {
6939 if (!first) {
6940 b.append(' ');
6941 }
6942 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006943 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006944 if (secure) {
6945 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006946 } else {
6947 b.append(mData);
6948 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006949 }
6950 if (mType != null) {
6951 if (!first) {
6952 b.append(' ');
6953 }
6954 first = false;
6955 b.append("typ=").append(mType);
6956 }
6957 if (mFlags != 0) {
6958 if (!first) {
6959 b.append(' ');
6960 }
6961 first = false;
6962 b.append("flg=0x").append(Integer.toHexString(mFlags));
6963 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006964 if (mPackage != null) {
6965 if (!first) {
6966 b.append(' ');
6967 }
6968 first = false;
6969 b.append("pkg=").append(mPackage);
6970 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006971 if (comp && mComponent != null) {
6972 if (!first) {
6973 b.append(' ');
6974 }
6975 first = false;
6976 b.append("cmp=").append(mComponent.flattenToShortString());
6977 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006978 if (mSourceBounds != null) {
6979 if (!first) {
6980 b.append(' ');
6981 }
6982 first = false;
6983 b.append("bnds=").append(mSourceBounds.toShortString());
6984 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006985 if (mClipData != null) {
6986 if (!first) {
6987 b.append(' ');
6988 }
6989 first = false;
6990 if (clip) {
6991 b.append("clip={");
6992 mClipData.toShortString(b);
6993 b.append('}');
6994 } else {
6995 b.append("(has clip)");
6996 }
6997 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006998 if (extras && mExtras != null) {
6999 if (!first) {
7000 b.append(' ');
7001 }
7002 first = false;
7003 b.append("(has extras)");
7004 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007005 if (mSelector != null) {
7006 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007007 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007008 b.append("}");
7009 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007010 }
7011
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007012 /**
7013 * Call {@link #toUri} with 0 flags.
7014 * @deprecated Use {@link #toUri} instead.
7015 */
7016 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007017 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007018 return toUri(0);
7019 }
7020
7021 /**
7022 * Convert this Intent into a String holding a URI representation of it.
7023 * The returned URI string has been properly URI encoded, so it can be
7024 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7025 * Intent's data as the base URI, with an additional fragment describing
7026 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007027 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007028 * <p>You can convert the returned string back to an Intent with
7029 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007030 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007031 * @param flags Additional operating flags. Either 0 or
7032 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007033 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007034 * @return Returns a URI encoding URI string describing the entire contents
7035 * of the Intent.
7036 */
7037 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007038 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007039 String scheme = null;
7040 if (mData != null) {
7041 String data = mData.toString();
7042 if ((flags&URI_INTENT_SCHEME) != 0) {
7043 final int N = data.length();
7044 for (int i=0; i<N; i++) {
7045 char c = data.charAt(i);
7046 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7047 || c == '.' || c == '-') {
7048 continue;
7049 }
7050 if (c == ':' && i > 0) {
7051 // Valid scheme.
7052 scheme = data.substring(0, i);
7053 uri.append("intent:");
7054 data = data.substring(i+1);
7055 break;
7056 }
Tom Taylord4a47292009-12-21 13:59:18 -08007057
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007058 // No scheme.
7059 break;
7060 }
7061 }
7062 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007063
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007064 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7065 uri.append("intent:");
7066 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007067
7068 uri.append("#Intent;");
7069
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007070 toUriInner(uri, scheme, flags);
7071 if (mSelector != null) {
7072 uri.append("SEL;");
7073 // Note that for now we are not going to try to handle the
7074 // data part; not clear how to represent this as a URI, and
7075 // not much utility in it.
7076 mSelector.toUriInner(uri, null, flags);
7077 }
7078
7079 uri.append("end");
7080
7081 return uri.toString();
7082 }
7083
7084 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007085 if (scheme != null) {
7086 uri.append("scheme=").append(scheme).append(';');
7087 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007088 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007089 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007090 }
7091 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007092 for (int i=0; i<mCategories.size(); i++) {
7093 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007094 }
7095 }
7096 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007097 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007098 }
7099 if (mFlags != 0) {
7100 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7101 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007102 if (mPackage != null) {
7103 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7104 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007105 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007106 uri.append("component=").append(Uri.encode(
7107 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007108 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007109 if (mSourceBounds != null) {
7110 uri.append("sourceBounds=")
7111 .append(Uri.encode(mSourceBounds.flattenToString()))
7112 .append(';');
7113 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007114 if (mExtras != null) {
7115 for (String key : mExtras.keySet()) {
7116 final Object value = mExtras.get(key);
7117 char entryType =
7118 value instanceof String ? 'S' :
7119 value instanceof Boolean ? 'B' :
7120 value instanceof Byte ? 'b' :
7121 value instanceof Character ? 'c' :
7122 value instanceof Double ? 'd' :
7123 value instanceof Float ? 'f' :
7124 value instanceof Integer ? 'i' :
7125 value instanceof Long ? 'l' :
7126 value instanceof Short ? 's' :
7127 '\0';
7128
7129 if (entryType != '\0') {
7130 uri.append(entryType);
7131 uri.append('.');
7132 uri.append(Uri.encode(key));
7133 uri.append('=');
7134 uri.append(Uri.encode(value.toString()));
7135 uri.append(';');
7136 }
7137 }
7138 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007139 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007140
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007141 public int describeContents() {
7142 return (mExtras != null) ? mExtras.describeContents() : 0;
7143 }
7144
7145 public void writeToParcel(Parcel out, int flags) {
7146 out.writeString(mAction);
7147 Uri.writeToParcel(out, mData);
7148 out.writeString(mType);
7149 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007150 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007151 ComponentName.writeToParcel(mComponent, out);
7152
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007153 if (mSourceBounds != null) {
7154 out.writeInt(1);
7155 mSourceBounds.writeToParcel(out, flags);
7156 } else {
7157 out.writeInt(0);
7158 }
7159
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007160 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007161 final int N = mCategories.size();
7162 out.writeInt(N);
7163 for (int i=0; i<N; i++) {
7164 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007165 }
7166 } else {
7167 out.writeInt(0);
7168 }
7169
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007170 if (mSelector != null) {
7171 out.writeInt(1);
7172 mSelector.writeToParcel(out, flags);
7173 } else {
7174 out.writeInt(0);
7175 }
7176
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007177 if (mClipData != null) {
7178 out.writeInt(1);
7179 mClipData.writeToParcel(out, flags);
7180 } else {
7181 out.writeInt(0);
7182 }
7183
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007184 out.writeBundle(mExtras);
7185 }
7186
7187 public static final Parcelable.Creator<Intent> CREATOR
7188 = new Parcelable.Creator<Intent>() {
7189 public Intent createFromParcel(Parcel in) {
7190 return new Intent(in);
7191 }
7192 public Intent[] newArray(int size) {
7193 return new Intent[size];
7194 }
7195 };
7196
Dianne Hackborneb034652009-09-07 00:49:58 -07007197 /** @hide */
7198 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007199 readFromParcel(in);
7200 }
7201
7202 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007203 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007204 mData = Uri.CREATOR.createFromParcel(in);
7205 mType = in.readString();
7206 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007207 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007208 mComponent = ComponentName.readFromParcel(in);
7209
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007210 if (in.readInt() != 0) {
7211 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7212 }
7213
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007214 int N = in.readInt();
7215 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007216 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007217 int i;
7218 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007219 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007220 }
7221 } else {
7222 mCategories = null;
7223 }
7224
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007225 if (in.readInt() != 0) {
7226 mSelector = new Intent(in);
7227 }
7228
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007229 if (in.readInt() != 0) {
7230 mClipData = new ClipData(in);
7231 }
7232
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007233 mExtras = in.readBundle();
7234 }
7235
7236 /**
7237 * Parses the "intent" element (and its children) from XML and instantiates
7238 * an Intent object. The given XML parser should be located at the tag
7239 * where parsing should start (often named "intent"), from which the
7240 * basic action, data, type, and package and class name will be
7241 * retrieved. The function will then parse in to any child elements,
7242 * looking for <category android:name="xxx"> tags to add categories and
7243 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7244 * to the intent.
7245 *
7246 * @param resources The Resources to use when inflating resources.
7247 * @param parser The XML parser pointing at an "intent" tag.
7248 * @param attrs The AttributeSet interface for retrieving extended
7249 * attribute data at the current <var>parser</var> location.
7250 * @return An Intent object matching the XML data.
7251 * @throws XmlPullParserException If there was an XML parsing error.
7252 * @throws IOException If there was an I/O error.
7253 */
7254 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7255 throws XmlPullParserException, IOException {
7256 Intent intent = new Intent();
7257
7258 TypedArray sa = resources.obtainAttributes(attrs,
7259 com.android.internal.R.styleable.Intent);
7260
7261 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7262
7263 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7264 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7265 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7266
7267 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7268 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7269 if (packageName != null && className != null) {
7270 intent.setComponent(new ComponentName(packageName, className));
7271 }
7272
7273 sa.recycle();
7274
7275 int outerDepth = parser.getDepth();
7276 int type;
7277 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7278 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7279 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7280 continue;
7281 }
7282
7283 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007284 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007285 sa = resources.obtainAttributes(attrs,
7286 com.android.internal.R.styleable.IntentCategory);
7287 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7288 sa.recycle();
7289
7290 if (cat != null) {
7291 intent.addCategory(cat);
7292 }
7293 XmlUtils.skipCurrentTag(parser);
7294
Craig Mautner21d24a22014-04-23 11:45:37 -07007295 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007296 if (intent.mExtras == null) {
7297 intent.mExtras = new Bundle();
7298 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007299 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007300 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007301
7302 } else {
7303 XmlUtils.skipCurrentTag(parser);
7304 }
7305 }
7306
7307 return intent;
7308 }
Nick Pellyccae4122012-01-09 14:12:58 -08007309
Craig Mautner21d24a22014-04-23 11:45:37 -07007310 /** @hide */
7311 public void saveToXml(XmlSerializer out) throws IOException {
7312 if (mAction != null) {
7313 out.attribute(null, ATTR_ACTION, mAction);
7314 }
7315 if (mData != null) {
7316 out.attribute(null, ATTR_DATA, mData.toString());
7317 }
7318 if (mType != null) {
7319 out.attribute(null, ATTR_TYPE, mType);
7320 }
7321 if (mComponent != null) {
7322 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7323 }
7324 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7325
7326 if (mCategories != null) {
7327 out.startTag(null, TAG_CATEGORIES);
7328 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7329 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7330 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007331 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007332 }
7333 }
7334
7335 /** @hide */
7336 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7337 XmlPullParserException {
7338 Intent intent = new Intent();
7339 final int outerDepth = in.getDepth();
7340
7341 int attrCount = in.getAttributeCount();
7342 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7343 final String attrName = in.getAttributeName(attrNdx);
7344 final String attrValue = in.getAttributeValue(attrNdx);
7345 if (ATTR_ACTION.equals(attrName)) {
7346 intent.setAction(attrValue);
7347 } else if (ATTR_DATA.equals(attrName)) {
7348 intent.setData(Uri.parse(attrValue));
7349 } else if (ATTR_TYPE.equals(attrName)) {
7350 intent.setType(attrValue);
7351 } else if (ATTR_COMPONENT.equals(attrName)) {
7352 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7353 } else if (ATTR_FLAGS.equals(attrName)) {
7354 intent.setFlags(Integer.valueOf(attrValue, 16));
7355 } else {
7356 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7357 }
7358 }
7359
7360 int event;
7361 String name;
7362 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7363 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7364 if (event == XmlPullParser.START_TAG) {
7365 name = in.getName();
7366 if (TAG_CATEGORIES.equals(name)) {
7367 attrCount = in.getAttributeCount();
7368 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7369 intent.addCategory(in.getAttributeValue(attrNdx));
7370 }
7371 } else {
7372 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7373 XmlUtils.skipCurrentTag(in);
7374 }
7375 }
7376 }
7377
7378 return intent;
7379 }
7380
Nick Pellyccae4122012-01-09 14:12:58 -08007381 /**
7382 * Normalize a MIME data type.
7383 *
7384 * <p>A normalized MIME type has white-space trimmed,
7385 * content-type parameters removed, and is lower-case.
7386 * This aligns the type with Android best practices for
7387 * intent filtering.
7388 *
7389 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7390 * "text/x-vCard" becomes "text/x-vcard".
7391 *
7392 * <p>All MIME types received from outside Android (such as user input,
7393 * or external sources like Bluetooth, NFC, or the Internet) should
7394 * be normalized before they are used to create an Intent.
7395 *
7396 * @param type MIME data type to normalize
7397 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007398 * @see #setType
7399 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007400 */
7401 public static String normalizeMimeType(String type) {
7402 if (type == null) {
7403 return null;
7404 }
7405
Elliott Hughescb64d432013-08-02 10:00:44 -07007406 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007407
7408 final int semicolonIndex = type.indexOf(';');
7409 if (semicolonIndex != -1) {
7410 type = type.substring(0, semicolonIndex);
7411 }
7412 return type;
7413 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007414
7415 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007416 * Prepare this {@link Intent} to leave an app process.
7417 *
7418 * @hide
7419 */
7420 public void prepareToLeaveProcess() {
7421 setAllowFds(false);
7422
7423 if (mSelector != null) {
7424 mSelector.prepareToLeaveProcess();
7425 }
7426 if (mClipData != null) {
7427 mClipData.prepareToLeaveProcess();
7428 }
7429
7430 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7431 // There are several ACTION_MEDIA_* broadcasts that send file://
7432 // Uris, so only check common actions.
7433 if (ACTION_VIEW.equals(mAction) ||
7434 ACTION_EDIT.equals(mAction) ||
7435 ACTION_ATTACH_DATA.equals(mAction)) {
7436 mData.checkFileUriExposed("Intent.getData()");
7437 }
7438 }
7439 }
7440
7441 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007442 * Prepare this {@link Intent} to be sent to another user
7443 *
7444 * @hide
7445 */
7446 public void prepareToLeaveUser(int userId) {
7447 Uri data = getData();
7448 if (data != null) {
7449 mData = maybeAddUserId(data, userId);
7450 }
7451 if (mSelector != null) {
7452 mSelector.prepareToLeaveUser(userId);
7453 }
7454 if (mClipData != null) {
7455 mClipData.prepareToLeaveUser(userId);
7456 }
7457 String action = getAction();
7458 if (ACTION_SEND.equals(action)) {
7459 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7460 if (stream != null) {
7461 putExtra(EXTRA_STREAM, maybeAddUserId(stream, userId));
7462 }
7463 }
7464 if (ACTION_SEND_MULTIPLE.equals(action)) {
7465 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7466 if (streams != null) {
7467 ArrayList<Uri> newStreams = new ArrayList<Uri>();
7468 for (int i = 0; i < streams.size(); i++) {
7469 newStreams.add(maybeAddUserId(streams.get(i), userId));
7470 }
7471 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
7472 }
7473 }
7474 }
7475
7476 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007477 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007478 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7479 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007480 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007481 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007482 * @hide
7483 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007484 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007485 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007486 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007487
7488 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007489 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007490
7491 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007492 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007493 try {
7494 // Inspect target intent to see if we need to migrate
7495 final Intent target = getParcelableExtra(EXTRA_INTENT);
7496 if (target != null && target.migrateExtraStreamToClipData()) {
7497 // Since we migrated in child, we need to promote ClipData
7498 // and flags to ourselves to grant.
7499 setClipData(target.getClipData());
Jeff Sharkey846318a2014-04-04 12:12:41 -07007500 addFlags(target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
7501 | FLAG_GRANT_WRITE_URI_PERMISSION
7502 | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7503 | FLAG_GRANT_PREFIX_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007504 return true;
7505 } else {
7506 return false;
7507 }
7508 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007509 }
7510
7511 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007512 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007513 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7514 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7515 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7516 if (stream != null || text != null || htmlText != null) {
7517 final ClipData clipData = new ClipData(
7518 null, new String[] { getType() },
7519 new ClipData.Item(text, htmlText, null, stream));
7520 setClipData(clipData);
7521 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007522 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007523 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007524 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007525 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007526
7527 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007528 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007529 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7530 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7531 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7532 int num = -1;
7533 if (streams != null) {
7534 num = streams.size();
7535 }
7536 if (texts != null) {
7537 if (num >= 0 && num != texts.size()) {
7538 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007539 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007540 }
7541 num = texts.size();
7542 }
7543 if (htmlTexts != null) {
7544 if (num >= 0 && num != htmlTexts.size()) {
7545 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007546 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007547 }
7548 num = htmlTexts.size();
7549 }
7550 if (num > 0) {
7551 final ClipData clipData = new ClipData(
7552 null, new String[] { getType() },
7553 makeClipItem(streams, texts, htmlTexts, 0));
7554
7555 for (int i = 1; i < num; i++) {
7556 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7557 }
7558
7559 setClipData(clipData);
7560 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007561 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007562 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007563 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007564 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007565 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007566
7567 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007568 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007569
7570 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7571 ArrayList<String> htmlTexts, int which) {
7572 Uri uri = streams != null ? streams.get(which) : null;
7573 CharSequence text = texts != null ? texts.get(which) : null;
7574 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7575 return new ClipData.Item(text, htmlText, null, uri);
7576 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007577
7578 /** @hide */
7579 public boolean isDocument() {
7580 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7581 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007582}