blob: 5ebbf169ef581eaf5ff96e006ca06dd33843f0e2 [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;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010020import android.provider.MediaStore;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070021import android.util.ArraySet;
Jeff Sharkey846318a2014-04-04 12:12:41 -070022
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070023import org.xmlpull.v1.XmlPullParser;
24import org.xmlpull.v1.XmlPullParserException;
25
Tor Norbyed9273d62013-05-30 15:59:53 -070026import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.annotation.SdkConstant;
Jose Lima73915cf2014-07-29 17:16:31 -070028import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070029import android.annotation.SdkConstant.SdkConstantType;
30import android.content.pm.ActivityInfo;
Jose Lima73915cf2014-07-29 17:16:31 -070031
Nicolas Prevotd85fc722014-04-16 19:52:08 +010032import static android.content.ContentProvider.maybeAddUserId;
Jose Lima73915cf2014-07-29 17:16:31 -070033
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.content.pm.PackageManager;
35import android.content.pm.ResolveInfo;
36import android.content.res.Resources;
37import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080038import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039import android.net.Uri;
40import android.os.Bundle;
41import android.os.IBinder;
42import android.os.Parcel;
43import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000044import android.os.Process;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070045import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010046import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070047import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070048import android.provider.DocumentsProvider;
49import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070050import android.util.AttributeSet;
51import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080052
53import com.android.internal.util.XmlUtils;
Jose Lima73915cf2014-07-29 17:16:31 -070054
Craig Mautner21d24a22014-04-23 11:45:37 -070055import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070056
57import java.io.IOException;
58import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070059import java.lang.annotation.Retention;
60import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070061import java.net.URISyntaxException;
62import java.util.ArrayList;
Dianne Hackborn221ea892013-08-04 16:50:16 -070063import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080064import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070065import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.util.Set;
67
68/**
69 * An intent is an abstract description of an operation to be performed. It
70 * can be used with {@link Context#startActivity(Intent) startActivity} to
71 * launch an {@link android.app.Activity},
72 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
73 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
74 * and {@link android.content.Context#startService} or
75 * {@link android.content.Context#bindService} to communicate with a
76 * background {@link android.app.Service}.
77 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070078 * <p>An Intent provides a facility for performing late runtime binding between the code in
79 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070080 * can be thought of as the glue between activities. It is basically a passive data structure
81 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070082 *
83 * <div class="special reference">
84 * <h3>Developer Guides</h3>
85 * <p>For information about how to create and resolve intents, read the
86 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
87 * developer guide.</p>
88 * </div>
89 *
90 * <a name="IntentStructure"></a>
91 * <h3>Intent Structure</h3>
92 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 *
94 * <ul>
95 * <li> <p><b>action</b> -- The general action to be performed, such as
96 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
97 * etc.</p>
98 * </li>
99 * <li> <p><b>data</b> -- The data to operate on, such as a person record
100 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
101 * </li>
102 * </ul>
103 *
104 *
105 * <p>Some examples of action/data pairs are:</p>
106 *
107 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700108 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700109 * information about the person whose identifier is "1".</p>
110 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700111 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700112 * the phone dialer with the person filled in.</p>
113 * </li>
114 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
115 * the phone dialer with the given number filled in. Note how the
116 * VIEW action does what what is considered the most reasonable thing for
117 * a particular URI.</p>
118 * </li>
119 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
120 * the phone dialer with the given number filled in.</p>
121 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700122 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700123 * information about the person whose identifier is "1".</p>
124 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700125 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700126 * a list of people, which the user can browse through. This example is a
127 * typical top-level entry into the Contacts application, showing you the
128 * list of people. Selecting a particular person to view would result in a
129 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
130 * being used to start an activity to display that person.</p>
131 * </li>
132 * </ul>
133 *
134 * <p>In addition to these primary attributes, there are a number of secondary
135 * attributes that you can also include with an intent:</p>
136 *
137 * <ul>
138 * <li> <p><b>category</b> -- Gives additional information about the action
139 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
140 * appear in the Launcher as a top-level application, while
141 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
142 * of alternative actions the user can perform on a piece of data.</p>
143 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
144 * intent data. Normally the type is inferred from the data itself.
145 * By setting this attribute, you disable that evaluation and force
146 * an explicit type.</p>
147 * <li> <p><b>component</b> -- Specifies an explicit name of a component
148 * class to use for the intent. Normally this is determined by looking
149 * at the other information in the intent (the action, data/type, and
150 * categories) and matching that with a component that can handle it.
151 * If this attribute is set then none of the evaluation is performed,
152 * and this component is used exactly as is. By specifying this attribute,
153 * all of the other Intent attributes become optional.</p>
154 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
155 * This can be used to provide extended information to the component.
156 * For example, if we have a action to send an e-mail message, we could
157 * also include extra pieces of data here to supply a subject, body,
158 * etc.</p>
159 * </ul>
160 *
161 * <p>Here are some examples of other operations you can specify as intents
162 * using these additional parameters:</p>
163 *
164 * <ul>
165 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
166 * Launch the home screen.</p>
167 * </li>
168 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
169 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
170 * vnd.android.cursor.item/phone}</i></b>
171 * -- Display the list of people's phone numbers, allowing the user to
172 * browse through them and pick one and return it to the parent activity.</p>
173 * </li>
174 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
175 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
176 * -- Display all pickers for data that can be opened with
177 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
178 * allowing the user to pick one of them and then some data inside of it
179 * and returning the resulting URI to the caller. This can be used,
180 * for example, in an e-mail application to allow the user to pick some
181 * data to include as an attachment.</p>
182 * </li>
183 * </ul>
184 *
185 * <p>There are a variety of standard Intent action and category constants
186 * defined in the Intent class, but applications can also define their own.
187 * These strings use java style scoping, to ensure they are unique -- for
188 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700189 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700190 *
191 * <p>Put together, the set of actions, data types, categories, and extra data
192 * defines a language for the system allowing for the expression of phrases
193 * such as "call john smith's cell". As applications are added to the system,
194 * they can extend this language by adding new actions, types, and categories, or
195 * they can modify the behavior of existing phrases by supplying their own
196 * activities that handle them.</p>
197 *
198 * <a name="IntentResolution"></a>
199 * <h3>Intent Resolution</h3>
200 *
201 * <p>There are two primary forms of intents you will use.
202 *
203 * <ul>
204 * <li> <p><b>Explicit Intents</b> have specified a component (via
205 * {@link #setComponent} or {@link #setClass}), which provides the exact
206 * class to be run. Often these will not include any other information,
207 * simply being a way for an application to launch various internal
208 * activities it has as the user interacts with the application.
209 *
210 * <li> <p><b>Implicit Intents</b> have not specified a component;
211 * instead, they must include enough information for the system to
212 * determine which of the available components is best to run for that
213 * intent.
214 * </ul>
215 *
216 * <p>When using implicit intents, given such an arbitrary intent we need to
217 * know what to do with it. This is handled by the process of <em>Intent
218 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
219 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
220 * more activities/receivers) that can handle it.</p>
221 *
222 * <p>The intent resolution mechanism basically revolves around matching an
223 * Intent against all of the &lt;intent-filter&gt; descriptions in the
224 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
225 * objects explicitly registered with {@link Context#registerReceiver}.) More
226 * details on this can be found in the documentation on the {@link
227 * IntentFilter} class.</p>
228 *
229 * <p>There are three pieces of information in the Intent that are used for
230 * resolution: the action, type, and category. Using this information, a query
231 * is done on the {@link PackageManager} for a component that can handle the
232 * intent. The appropriate component is determined based on the intent
233 * information supplied in the <code>AndroidManifest.xml</code> file as
234 * follows:</p>
235 *
236 * <ul>
237 * <li> <p>The <b>action</b>, if given, must be listed by the component as
238 * one it handles.</p>
239 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
240 * already supplied in the Intent. Like the action, if a type is
241 * included in the intent (either explicitly or implicitly in its
242 * data), then this must be listed by the component as one it handles.</p>
243 * <li> For data that is not a <code>content:</code> URI and where no explicit
244 * type is included in the Intent, instead the <b>scheme</b> of the
245 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
246 * considered. Again like the action, if we are matching a scheme it
247 * must be listed by the component as one it can handle.
248 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
249 * by the activity as categories it handles. That is, if you include
250 * the categories {@link #CATEGORY_LAUNCHER} and
251 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
252 * with an intent that lists <em>both</em> of those categories.
253 * Activities will very often need to support the
254 * {@link #CATEGORY_DEFAULT} so that they can be found by
255 * {@link Context#startActivity Context.startActivity()}.</p>
256 * </ul>
257 *
258 * <p>For example, consider the Note Pad sample application that
259 * allows user to browse through a list of notes data and view details about
260 * individual items. Text in italics indicate places were you would replace a
261 * name with one specific to your own package.</p>
262 *
263 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
264 * package="<i>com.android.notepad</i>"&gt;
265 * &lt;application android:icon="@drawable/app_notes"
266 * android:label="@string/app_name"&gt;
267 *
268 * &lt;provider class=".NotePadProvider"
269 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
270 *
271 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
272 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700273 * &lt;action android:name="android.intent.action.MAIN" /&gt;
274 * &lt;category android:name="android.intent.category.LAUNCHER" /&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.VIEW" /&gt;
278 * &lt;action android:name="android.intent.action.EDIT" /&gt;
279 * &lt;action android:name="android.intent.action.PICK" /&gt;
280 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
281 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700282 * &lt;/intent-filter&gt;
283 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700284 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
285 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
286 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700287 * &lt;/intent-filter&gt;
288 * &lt;/activity&gt;
289 *
290 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
291 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700292 * &lt;action android:name="android.intent.action.VIEW" /&gt;
293 * &lt;action android:name="android.intent.action.EDIT" /&gt;
294 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
295 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700296 * &lt;/intent-filter&gt;
297 *
298 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700299 * &lt;action android:name="android.intent.action.INSERT" /&gt;
300 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
301 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700302 * &lt;/intent-filter&gt;
303 *
304 * &lt;/activity&gt;
305 *
306 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
307 * android:theme="@android:style/Theme.Dialog"&gt;
308 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700309 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
310 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
311 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
312 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
313 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700314 * &lt;/intent-filter&gt;
315 * &lt;/activity&gt;
316 *
317 * &lt;/application&gt;
318 * &lt;/manifest&gt;</pre>
319 *
320 * <p>The first activity,
321 * <code>com.android.notepad.NotesList</code>, serves as our main
322 * entry into the app. It can do three things as described by its three intent
323 * templates:
324 * <ol>
325 * <li><pre>
326 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700327 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
328 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700329 * &lt;/intent-filter&gt;</pre>
330 * <p>This provides a top-level entry into the NotePad application: the standard
331 * MAIN action is a main entry point (not requiring any other information in
332 * the Intent), and the LAUNCHER category says that this entry point should be
333 * listed in the application launcher.</p>
334 * <li><pre>
335 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700336 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
337 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
338 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
339 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
340 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700341 * &lt;/intent-filter&gt;</pre>
342 * <p>This declares the things that the activity can do on a directory of
343 * notes. The type being supported is given with the &lt;type&gt; tag, where
344 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
345 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
346 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
347 * The activity allows the user to view or edit the directory of data (via
348 * the VIEW and EDIT actions), or to pick a particular note and return it
349 * to the caller (via the PICK action). Note also the DEFAULT category
350 * supplied here: this is <em>required</em> for the
351 * {@link Context#startActivity Context.startActivity} method to resolve your
352 * activity when its component name is not explicitly specified.</p>
353 * <li><pre>
354 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700355 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
356 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
357 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700358 * &lt;/intent-filter&gt;</pre>
359 * <p>This filter describes the ability return to the caller a note selected by
360 * the user without needing to know where it came from. The data type
361 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
362 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
363 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
364 * The GET_CONTENT action is similar to the PICK action, where the activity
365 * will return to its caller a piece of data selected by the user. Here,
366 * however, the caller specifies the type of data they desire instead of
367 * the type of data the user will be picking from.</p>
368 * </ol>
369 *
370 * <p>Given these capabilities, the following intents will resolve to the
371 * NotesList activity:</p>
372 *
373 * <ul>
374 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
375 * activities that can be used as top-level entry points into an
376 * application.</p>
377 * <li> <p><b>{ action=android.app.action.MAIN,
378 * category=android.app.category.LAUNCHER }</b> is the actual intent
379 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700380 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700381 * data=content://com.google.provider.NotePad/notes }</b>
382 * displays a list of all the notes under
383 * "content://com.google.provider.NotePad/notes", which
384 * the user can browse through and see the details on.</p>
385 * <li> <p><b>{ action=android.app.action.PICK
386 * data=content://com.google.provider.NotePad/notes }</b>
387 * provides a list of the notes under
388 * "content://com.google.provider.NotePad/notes", from which
389 * the user can pick a note whose data URL is returned back to the caller.</p>
390 * <li> <p><b>{ action=android.app.action.GET_CONTENT
391 * type=vnd.android.cursor.item/vnd.google.note }</b>
392 * is similar to the pick action, but allows the caller to specify the
393 * kind of data they want back so that the system can find the appropriate
394 * activity to pick something of that data type.</p>
395 * </ul>
396 *
397 * <p>The second activity,
398 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
399 * note entry and allows them to edit it. It can do two things as described
400 * by its two intent templates:
401 * <ol>
402 * <li><pre>
403 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700404 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
405 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
406 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
407 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700408 * &lt;/intent-filter&gt;</pre>
409 * <p>The first, primary, purpose of this activity is to let the user interact
410 * with a single note, as decribed by the MIME type
411 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
412 * either VIEW a note or allow the user to EDIT it. Again we support the
413 * DEFAULT category to allow the activity to be launched without explicitly
414 * specifying its component.</p>
415 * <li><pre>
416 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700417 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
418 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
419 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700420 * &lt;/intent-filter&gt;</pre>
421 * <p>The secondary use of this activity is to insert a new note entry into
422 * an existing directory of notes. This is used when the user creates a new
423 * note: the INSERT action is executed on the directory of notes, causing
424 * this activity to run and have the user create the new note data which
425 * it then adds to the content provider.</p>
426 * </ol>
427 *
428 * <p>Given these capabilities, the following intents will resolve to the
429 * NoteEditor activity:</p>
430 *
431 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700432 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700433 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
434 * shows the user the content of note <var>{ID}</var>.</p>
435 * <li> <p><b>{ action=android.app.action.EDIT
436 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
437 * allows the user to edit the content of note <var>{ID}</var>.</p>
438 * <li> <p><b>{ action=android.app.action.INSERT
439 * data=content://com.google.provider.NotePad/notes }</b>
440 * creates a new, empty note in the notes list at
441 * "content://com.google.provider.NotePad/notes"
442 * and allows the user to edit it. If they keep their changes, the URI
443 * of the newly created note is returned to the caller.</p>
444 * </ul>
445 *
446 * <p>The last activity,
447 * <code>com.android.notepad.TitleEditor</code>, allows the user to
448 * edit the title of a note. This could be implemented as a class that the
449 * application directly invokes (by explicitly setting its component in
450 * the Intent), but here we show a way you can publish alternative
451 * operations on existing data:</p>
452 *
453 * <pre>
454 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700455 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
456 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
457 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
458 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
459 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700460 * &lt;/intent-filter&gt;</pre>
461 *
462 * <p>In the single intent template here, we
463 * have created our own private action called
464 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
465 * edit the title of a note. It must be invoked on a specific note
466 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
467 * view and edit actions, but here displays and edits the title contained
468 * in the note data.
469 *
470 * <p>In addition to supporting the default category as usual, our title editor
471 * also supports two other standard categories: ALTERNATIVE and
472 * SELECTED_ALTERNATIVE. Implementing
473 * these categories allows others to find the special action it provides
474 * without directly knowing about it, through the
475 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
476 * more often to build dynamic menu items with
477 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
478 * template here was also supply an explicit name for the template
479 * (via <code>android:label="@string/resolve_title"</code>) to better control
480 * what the user sees when presented with this activity as an alternative
481 * action to the data they are viewing.
482 *
483 * <p>Given these capabilities, the following intent will resolve to the
484 * TitleEditor activity:</p>
485 *
486 * <ul>
487 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
488 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
489 * displays and allows the user to edit the title associated
490 * with note <var>{ID}</var>.</p>
491 * </ul>
492 *
493 * <h3>Standard Activity Actions</h3>
494 *
495 * <p>These are the current standard actions that Intent defines for launching
496 * activities (usually through {@link Context#startActivity}. The most
497 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
498 * {@link #ACTION_EDIT}.
499 *
500 * <ul>
501 * <li> {@link #ACTION_MAIN}
502 * <li> {@link #ACTION_VIEW}
503 * <li> {@link #ACTION_ATTACH_DATA}
504 * <li> {@link #ACTION_EDIT}
505 * <li> {@link #ACTION_PICK}
506 * <li> {@link #ACTION_CHOOSER}
507 * <li> {@link #ACTION_GET_CONTENT}
508 * <li> {@link #ACTION_DIAL}
509 * <li> {@link #ACTION_CALL}
510 * <li> {@link #ACTION_SEND}
511 * <li> {@link #ACTION_SENDTO}
512 * <li> {@link #ACTION_ANSWER}
513 * <li> {@link #ACTION_INSERT}
514 * <li> {@link #ACTION_DELETE}
515 * <li> {@link #ACTION_RUN}
516 * <li> {@link #ACTION_SYNC}
517 * <li> {@link #ACTION_PICK_ACTIVITY}
518 * <li> {@link #ACTION_SEARCH}
519 * <li> {@link #ACTION_WEB_SEARCH}
520 * <li> {@link #ACTION_FACTORY_TEST}
521 * </ul>
522 *
523 * <h3>Standard Broadcast Actions</h3>
524 *
525 * <p>These are the current standard actions that Intent defines for receiving
526 * broadcasts (usually through {@link Context#registerReceiver} or a
527 * &lt;receiver&gt; tag in a manifest).
528 *
529 * <ul>
530 * <li> {@link #ACTION_TIME_TICK}
531 * <li> {@link #ACTION_TIME_CHANGED}
532 * <li> {@link #ACTION_TIMEZONE_CHANGED}
533 * <li> {@link #ACTION_BOOT_COMPLETED}
534 * <li> {@link #ACTION_PACKAGE_ADDED}
535 * <li> {@link #ACTION_PACKAGE_CHANGED}
536 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800537 * <li> {@link #ACTION_PACKAGE_RESTARTED}
538 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700539 * <li> {@link #ACTION_UID_REMOVED}
540 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700541 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700542 * <li> {@link #ACTION_POWER_DISCONNECTED}
543 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700544 * </ul>
545 *
546 * <h3>Standard Categories</h3>
547 *
548 * <p>These are the current standard categories that can be used to further
549 * clarify an Intent via {@link #addCategory}.
550 *
551 * <ul>
552 * <li> {@link #CATEGORY_DEFAULT}
553 * <li> {@link #CATEGORY_BROWSABLE}
554 * <li> {@link #CATEGORY_TAB}
555 * <li> {@link #CATEGORY_ALTERNATIVE}
556 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
557 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800558 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700559 * <li> {@link #CATEGORY_HOME}
560 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700561 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400562 * <li> {@link #CATEGORY_CAR_DOCK}
563 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500564 * <li> {@link #CATEGORY_LE_DESK_DOCK}
565 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200566 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700567 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700568 * </ul>
569 *
570 * <h3>Standard Extra Data</h3>
571 *
572 * <p>These are the current standard fields that can be used as extra data via
573 * {@link #putExtra}.
574 *
575 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800576 * <li> {@link #EXTRA_ALARM_COUNT}
577 * <li> {@link #EXTRA_BCC}
578 * <li> {@link #EXTRA_CC}
579 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
580 * <li> {@link #EXTRA_DATA_REMOVED}
581 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500582 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
583 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800584 * <li> {@link #EXTRA_DOCK_STATE_CAR}
585 * <li> {@link #EXTRA_DOCK_STATE_DESK}
586 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
587 * <li> {@link #EXTRA_DONT_KILL_APP}
588 * <li> {@link #EXTRA_EMAIL}
589 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700590 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800591 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700592 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800593 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700594 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
596 * <li> {@link #EXTRA_REPLACING}
597 * <li> {@link #EXTRA_SHORTCUT_ICON}
598 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
599 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700600 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800601 * <li> {@link #EXTRA_SHORTCUT_NAME}
602 * <li> {@link #EXTRA_SUBJECT}
603 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700604 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800605 * <li> {@link #EXTRA_TITLE}
606 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700607 * </ul>
608 *
609 * <h3>Flags</h3>
610 *
611 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800612 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
613 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700614 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800615public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700616 private static final String ATTR_ACTION = "action";
617 private static final String TAG_CATEGORIES = "categories";
618 private static final String ATTR_CATEGORY = "category";
619 private static final String TAG_EXTRA = "extra";
620 private static final String ATTR_TYPE = "type";
621 private static final String ATTR_COMPONENT = "component";
622 private static final String ATTR_DATA = "data";
623 private static final String ATTR_FLAGS = "flags";
624
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700625 // ---------------------------------------------------------------------
626 // ---------------------------------------------------------------------
627 // Standard intent activity actions (see action variable).
628
629 /**
630 * Activity Action: Start as a main entry point, does not expect to
631 * receive data.
632 * <p>Input: nothing
633 * <p>Output: nothing
634 */
635 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
636 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800637
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700638 /**
639 * Activity Action: Display the data to the user. This is the most common
640 * action performed on data -- it is the generic action you can use on
641 * a piece of data to get the most reasonable thing to occur. For example,
642 * when used on a contacts entry it will view the entry; when used on a
643 * mailto: URI it will bring up a compose window filled with the information
644 * supplied by the URI; when used with a tel: URI it will invoke the
645 * dialer.
646 * <p>Input: {@link #getData} is URI from which to retrieve data.
647 * <p>Output: nothing.
648 */
649 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
650 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800651
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700652 /**
653 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
654 * performed on a piece of data.
655 */
656 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800657
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700658 /**
659 * Used to indicate that some piece of data should be attached to some other
660 * place. For example, image data could be attached to a contact. It is up
661 * to the recipient to decide where the data should be attached; the intent
662 * does not specify the ultimate destination.
663 * <p>Input: {@link #getData} is URI of data to be attached.
664 * <p>Output: nothing.
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700669 /**
670 * Activity Action: Provide explicit editable access to the given data.
671 * <p>Input: {@link #getData} is URI of data to be edited.
672 * <p>Output: nothing.
673 */
674 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
675 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800676
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 /**
678 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
679 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
680 * The extras can contain type specific data to pass through to the editing/creating
681 * activity.
682 * <p>Output: The URI of the item that was picked. This must be a content:
683 * URI so that any receiver can access it.
684 */
685 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
686 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800687
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700688 /**
689 * Activity Action: Pick an item from the data, returning what was selected.
690 * <p>Input: {@link #getData} is URI containing a directory of data
691 * (vnd.android.cursor.dir/*) from which to pick an item.
692 * <p>Output: The URI of the item that was picked.
693 */
694 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
695 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800696
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700697 /**
698 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800699 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700700 * <p>Output: An Intent representing the shortcut. The intent must contain three
701 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
702 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800703 * (value: ShortcutIconResource).</p>
704 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700705 * @see #EXTRA_SHORTCUT_INTENT
706 * @see #EXTRA_SHORTCUT_NAME
707 * @see #EXTRA_SHORTCUT_ICON
708 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
709 * @see android.content.Intent.ShortcutIconResource
710 */
711 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
712 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
713
714 /**
715 * The name of the extra used to define the Intent of a shortcut.
716 *
717 * @see #ACTION_CREATE_SHORTCUT
718 */
719 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
720 /**
721 * The name of the extra used to define the name of a shortcut.
722 *
723 * @see #ACTION_CREATE_SHORTCUT
724 */
725 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
726 /**
727 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
728 *
729 * @see #ACTION_CREATE_SHORTCUT
730 */
731 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
732 /**
733 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
734 *
735 * @see #ACTION_CREATE_SHORTCUT
736 * @see android.content.Intent.ShortcutIconResource
737 */
738 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
739 "android.intent.extra.shortcut.ICON_RESOURCE";
740
741 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800742 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700743 *
744 * @see Intent#ACTION_CREATE_SHORTCUT
745 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800746 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
747 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700748 */
749 public static class ShortcutIconResource implements Parcelable {
750 /**
751 * The package name of the application containing the icon.
752 */
753 public String packageName;
754
755 /**
756 * The resource name of the icon, including package, name and type.
757 */
758 public String resourceName;
759
760 /**
761 * Creates a new ShortcutIconResource for the specified context and resource
762 * identifier.
763 *
764 * @param context The context of the application.
765 * @param resourceId The resource idenfitier for the icon.
766 * @return A new ShortcutIconResource with the specified's context package name
767 * and icon resource idenfitier.
768 */
769 public static ShortcutIconResource fromContext(Context context, int resourceId) {
770 ShortcutIconResource icon = new ShortcutIconResource();
771 icon.packageName = context.getPackageName();
772 icon.resourceName = context.getResources().getResourceName(resourceId);
773 return icon;
774 }
775
776 /**
777 * Used to read a ShortcutIconResource from a Parcel.
778 */
779 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
780 new Parcelable.Creator<ShortcutIconResource>() {
781
782 public ShortcutIconResource createFromParcel(Parcel source) {
783 ShortcutIconResource icon = new ShortcutIconResource();
784 icon.packageName = source.readString();
785 icon.resourceName = source.readString();
786 return icon;
787 }
788
789 public ShortcutIconResource[] newArray(int size) {
790 return new ShortcutIconResource[size];
791 }
792 };
793
794 /**
795 * No special parcel contents.
796 */
797 public int describeContents() {
798 return 0;
799 }
800
801 public void writeToParcel(Parcel dest, int flags) {
802 dest.writeString(packageName);
803 dest.writeString(resourceName);
804 }
805
806 @Override
807 public String toString() {
808 return resourceName;
809 }
810 }
811
812 /**
813 * Activity Action: Display an activity chooser, allowing the user to pick
814 * what they want to before proceeding. This can be used as an alternative
815 * to the standard activity picker that is displayed by the system when
816 * you try to start an activity with multiple possible matches, with these
817 * differences in behavior:
818 * <ul>
819 * <li>You can specify the title that will appear in the activity chooser.
820 * <li>The user does not have the option to make one of the matching
821 * activities a preferred activity, and all possible activities will
822 * always be shown even if one of them is currently marked as the
823 * preferred activity.
824 * </ul>
825 * <p>
826 * This action should be used when the user will naturally expect to
827 * select an activity in order to proceed. An example if when not to use
828 * it is when the user clicks on a "mailto:" link. They would naturally
829 * expect to go directly to their mail app, so startActivity() should be
830 * called directly: it will
831 * either launch the current preferred app, or put up a dialog allowing the
832 * user to pick an app to use and optionally marking that as preferred.
833 * <p>
834 * In contrast, if the user is selecting a menu item to send a picture
835 * they are viewing to someone else, there are many different things they
836 * may want to do at this point: send it through e-mail, upload it to a
837 * web service, etc. In this case the CHOOSER action should be used, to
838 * always present to the user a list of the things they can do, with a
839 * nice title given by the caller such as "Send this photo with:".
840 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700841 * If you need to grant URI permissions through a chooser, you must specify
842 * the permissions to be granted on the ACTION_CHOOSER Intent
843 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
844 * {@link #setClipData} to specify the URIs to be granted as well as
845 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
846 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
847 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700848 * As a convenience, an Intent of this form can be created with the
849 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700850 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700851 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700852 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
853 * and can optionally have a {@link #EXTRA_TITLE} field containing the
854 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700855 * <p>
856 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700857 */
858 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
859 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
860
861 /**
862 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
863 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700864 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
865 * target intent, also optionally supplying a title. If the target
866 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
867 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
868 * set in the returned chooser intent, with its ClipData set appropriately:
869 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500870 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700871 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700872 * @param target The Intent that the user will be selecting an activity
873 * to perform.
874 * @param title Optional title that will be displayed in the chooser.
875 * @return Return a new Intent object that you can hand to
876 * {@link Context#startActivity(Intent) Context.startActivity()} and
877 * related methods.
878 */
879 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700880 return createChooser(target, title, null);
881 }
882
883 /**
884 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
885 *
886 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
887 * target intent, also optionally supplying a title. If the target
888 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
889 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
890 * set in the returned chooser intent, with its ClipData set appropriately:
891 * either a direct reflection of {@link #getClipData()} if that is non-null,
892 * or a new ClipData built from {@link #getData()}.</p>
893 *
894 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
895 * when the user makes a choice. This can be useful if the calling application wants
896 * to remember the last chosen target and surface it as a more prominent or one-touch
897 * affordance elsewhere in the UI for next time.</p>
898 *
899 * @param target The Intent that the user will be selecting an activity
900 * to perform.
901 * @param title Optional title that will be displayed in the chooser.
902 * @param sender Optional IntentSender to be called when a choice is made.
903 * @return Return a new Intent object that you can hand to
904 * {@link Context#startActivity(Intent) Context.startActivity()} and
905 * related methods.
906 */
907 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700908 Intent intent = new Intent(ACTION_CHOOSER);
909 intent.putExtra(EXTRA_INTENT, target);
910 if (title != null) {
911 intent.putExtra(EXTRA_TITLE, title);
912 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700913
Adam Powell0b3c1122014-10-09 12:50:14 -0700914 if (sender != null) {
915 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
916 }
917
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700918 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700919 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
920 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
921 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700922 if (permFlags != 0) {
923 ClipData targetClipData = target.getClipData();
924 if (targetClipData == null && target.getData() != null) {
925 ClipData.Item item = new ClipData.Item(target.getData());
926 String[] mimeTypes;
927 if (target.getType() != null) {
928 mimeTypes = new String[] { target.getType() };
929 } else {
930 mimeTypes = new String[] { };
931 }
932 targetClipData = new ClipData(null, mimeTypes, item);
933 }
934 if (targetClipData != null) {
935 intent.setClipData(targetClipData);
936 intent.addFlags(permFlags);
937 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700938 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700939
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700940 return intent;
941 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700942
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700943 /**
944 * Activity Action: Allow the user to select a particular kind of data and
945 * return it. This is different than {@link #ACTION_PICK} in that here we
946 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800947 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700948 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900949 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700950 * etc.
951 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900952 * 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 -0700953 * of data, such as a person contact, you set the MIME type to the kind of
954 * data you want and launch it with {@link Context#startActivity(Intent)}.
955 * The system will then launch the best application to select that kind
956 * of data for you.
957 * <p>
958 * You may also be interested in any of a set of types of content the user
959 * can pick. For example, an e-mail application that wants to allow the
960 * user to add an attachment to an e-mail message can use this action to
961 * bring up a list of all of the types of content the user can attach.
962 * <p>
963 * In this case, you should wrap the GET_CONTENT intent with a chooser
964 * (through {@link #createChooser}), which will give the proper interface
965 * for the user to pick how to send your data and allow you to specify
966 * a prompt indicating what they are doing. You will usually specify a
967 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
968 * broad range of content types the user can select from.
969 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900970 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700971 * only pick from data that can be represented as a stream. This is
972 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
973 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800974 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900975 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800976 * is locally available on the device. For example, if this extra is set
977 * to true then an image picker should not show any pictures that are available
978 * from a remote server but not already on the local device (thus requiring
979 * they be downloaded when opened).
980 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800981 * If the caller can handle multiple returned items (the user performing
982 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
983 * to indicate this.
984 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700985 * Input: {@link #getType} is the desired MIME type to retrieve. Note
986 * that no URI is supplied in the intent, as there are no constraints on
987 * where the returned data originally comes from. You may also include the
988 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800989 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800990 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
991 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700992 * <p>
993 * Output: The URI of the item that was picked. This must be a content:
994 * URI so that any receiver can access it.
995 */
996 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
997 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
998 /**
999 * Activity Action: Dial a number as specified by the data. This shows a
1000 * UI with the number being dialed, allowing the user to explicitly
1001 * initiate the call.
1002 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1003 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1004 * number.
1005 * <p>Output: nothing.
1006 */
1007 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1008 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1009 /**
1010 * Activity Action: Perform a call to someone specified by the data.
1011 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1012 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1013 * number.
1014 * <p>Output: nothing.
1015 *
1016 * <p>Note: there will be restrictions on which applications can initiate a
1017 * call; most applications should use the {@link #ACTION_DIAL}.
1018 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1019 * numbers. Applications can <strong>dial</strong> emergency numbers using
1020 * {@link #ACTION_DIAL}, however.
1021 */
1022 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1023 public static final String ACTION_CALL = "android.intent.action.CALL";
1024 /**
1025 * Activity Action: Perform a call to an emergency number specified by the
1026 * data.
1027 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1028 * tel: URI of an explicit phone number.
1029 * <p>Output: nothing.
1030 * @hide
1031 */
1032 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1033 /**
1034 * Activity action: Perform a call to any number (emergency or not)
1035 * specified by the data.
1036 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1037 * tel: URI of an explicit phone number.
1038 * <p>Output: nothing.
1039 * @hide
1040 */
1041 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1042 /**
1043 * Activity Action: Send a message to someone specified by the data.
1044 * <p>Input: {@link #getData} is URI describing the target.
1045 * <p>Output: nothing.
1046 */
1047 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1048 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1049 /**
1050 * Activity Action: Deliver some data to someone else. Who the data is
1051 * being delivered to is not specified; it is up to the receiver of this
1052 * action to ask the user where the data should be sent.
1053 * <p>
1054 * When launching a SEND intent, you should usually wrap it in a chooser
1055 * (through {@link #createChooser}), which will give the proper interface
1056 * for the user to pick how to send your data and allow you to specify
1057 * a prompt indicating what they are doing.
1058 * <p>
1059 * Input: {@link #getType} is the MIME type of the data being sent.
1060 * get*Extra can have either a {@link #EXTRA_TEXT}
1061 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1062 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1063 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1064 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001065 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1066 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1067 * your text with HTML formatting.
1068 * <p>
1069 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1070 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1071 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1072 * content: URIs and other advanced features of {@link ClipData}. If
1073 * using this approach, you still must supply the same data through the
1074 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1075 * for compatibility with old applications. If you don't set a ClipData,
1076 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001077 * <p>
1078 * Optional standard extras, which may be interpreted by some recipients as
1079 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1080 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1081 * <p>
1082 * Output: nothing.
1083 */
1084 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1085 public static final String ACTION_SEND = "android.intent.action.SEND";
1086 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001087 * Activity Action: Deliver multiple data to someone else.
1088 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001089 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001090 * <p>
1091 * Input: {@link #getType} is the MIME type of the data being sent.
1092 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001093 * #EXTRA_STREAM} field, containing the data to be sent. If using
1094 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1095 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001096 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001097 * Multiple types are supported, and receivers should handle mixed types
1098 * whenever possible. The right way for the receiver to check them is to
1099 * use the content resolver on each URI. The intent sender should try to
1100 * put the most concrete mime type in the intent type, but it can fall
1101 * back to {@literal <type>/*} or {@literal *}/* as needed.
1102 * <p>
1103 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1104 * be image/jpg, but if you are sending image/jpg and image/png, then the
1105 * intent's type should be image/*.
1106 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001107 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1108 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1109 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1110 * content: URIs and other advanced features of {@link ClipData}. If
1111 * using this approach, you still must supply the same data through the
1112 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1113 * for compatibility with old applications. If you don't set a ClipData,
1114 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1115 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001116 * Optional standard extras, which may be interpreted by some recipients as
1117 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1118 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1119 * <p>
1120 * Output: nothing.
1121 */
1122 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1123 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1124 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001125 * Activity Action: Handle an incoming phone call.
1126 * <p>Input: nothing.
1127 * <p>Output: nothing.
1128 */
1129 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1130 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1131 /**
1132 * Activity Action: Insert an empty item into the given container.
1133 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1134 * in which to place the data.
1135 * <p>Output: URI of the new data that was created.
1136 */
1137 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1138 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1139 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001140 * Activity Action: Create a new item in the given container, initializing it
1141 * from the current contents of the clipboard.
1142 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1143 * in which to place the data.
1144 * <p>Output: URI of the new data that was created.
1145 */
1146 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1147 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1148 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001149 * Activity Action: Delete the given data from its container.
1150 * <p>Input: {@link #getData} is URI of data to be deleted.
1151 * <p>Output: nothing.
1152 */
1153 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1154 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1155 /**
1156 * Activity Action: Run the data, whatever that means.
1157 * <p>Input: ? (Note: this is currently specific to the test harness.)
1158 * <p>Output: nothing.
1159 */
1160 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1161 public static final String ACTION_RUN = "android.intent.action.RUN";
1162 /**
1163 * Activity Action: Perform a data synchronization.
1164 * <p>Input: ?
1165 * <p>Output: ?
1166 */
1167 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1168 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1169 /**
1170 * Activity Action: Pick an activity given an intent, returning the class
1171 * selected.
1172 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1173 * used with {@link PackageManager#queryIntentActivities} to determine the
1174 * set of activities from which to pick.
1175 * <p>Output: Class name of the activity that was selected.
1176 */
1177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1178 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1179 /**
1180 * Activity Action: Perform a search.
1181 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1182 * is the text to search for. If empty, simply
1183 * enter your search results Activity with the search UI activated.
1184 * <p>Output: nothing.
1185 */
1186 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1187 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1188 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001189 * Activity Action: Start the platform-defined tutorial
1190 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1191 * is the text to search for. If empty, simply
1192 * enter your search results Activity with the search UI activated.
1193 * <p>Output: nothing.
1194 */
1195 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1196 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1197 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001198 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001199 * <p>
1200 * Input: {@link android.app.SearchManager#QUERY
1201 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1202 * a url starts with http or https, the site will be opened. If it is plain
1203 * text, Google search will be applied.
1204 * <p>
1205 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001206 */
1207 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1208 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001209
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001210 /**
Jim Miller07994402012-05-02 14:22:27 -07001211 * Activity Action: Perform assist action.
1212 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001213 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1214 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001215 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001216 * Output: nothing.
1217 */
1218 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1219 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001220
1221 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001222 * Activity Action: Perform voice assist action.
1223 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001224 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1225 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001226 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001227 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001228 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001229 */
1230 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1231 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1232
1233 /**
Adam Skory7140a252013-09-11 12:04:58 +01001234 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1235 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001236 */
1237 public static final String EXTRA_ASSIST_PACKAGE
1238 = "android.intent.extra.ASSIST_PACKAGE";
1239
1240 /**
Adam Skory7140a252013-09-11 12:04:58 +01001241 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1242 * information supplied by the current foreground app at the time of the assist request.
1243 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001244 */
1245 public static final String EXTRA_ASSIST_CONTEXT
1246 = "android.intent.extra.ASSIST_CONTEXT";
1247
Jim Miller07994402012-05-02 14:22:27 -07001248 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001249 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1250 * keyboard as the primary input device for assistance.
1251 */
1252 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1253 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1254
1255 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001256 * Activity Action: List all available applications
1257 * <p>Input: Nothing.
1258 * <p>Output: nothing.
1259 */
1260 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1261 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1262 /**
1263 * Activity Action: Show settings for choosing wallpaper
1264 * <p>Input: Nothing.
1265 * <p>Output: Nothing.
1266 */
1267 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1268 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1269
1270 /**
1271 * Activity Action: Show activity for reporting a bug.
1272 * <p>Input: Nothing.
1273 * <p>Output: Nothing.
1274 */
1275 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1276 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1277
1278 /**
1279 * Activity Action: Main entry point for factory tests. Only used when
1280 * the device is booting in factory test node. The implementing package
1281 * must be installed in the system image.
1282 * <p>Input: nothing
1283 * <p>Output: nothing
1284 */
1285 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1286
1287 /**
1288 * Activity Action: The user pressed the "call" button to go to the dialer
1289 * or other appropriate UI for placing a call.
1290 * <p>Input: Nothing.
1291 * <p>Output: Nothing.
1292 */
1293 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1294 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1295
1296 /**
1297 * Activity Action: Start Voice Command.
1298 * <p>Input: Nothing.
1299 * <p>Output: Nothing.
1300 */
1301 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1302 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001303
1304 /**
1305 * Activity Action: Start action associated with long pressing on the
1306 * search key.
1307 * <p>Input: Nothing.
1308 * <p>Output: Nothing.
1309 */
1310 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1311 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001312
Jacek Surazski86b6c532009-05-13 14:38:28 +02001313 /**
1314 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1315 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001316 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001317 * <p>Input: No data is specified. The bug report is passed in using
1318 * an {@link #EXTRA_BUG_REPORT} field.
1319 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001320 *
1321 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001322 */
1323 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1324 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001325
1326 /**
1327 * Activity Action: Show power usage information to the user.
1328 * <p>Input: Nothing.
1329 * <p>Output: Nothing.
1330 */
1331 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1332 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001333
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001334 /**
1335 * Activity Action: Setup wizard to launch after a platform update. This
1336 * activity should have a string meta-data field associated with it,
1337 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1338 * the platform for setup. The activity will be launched only if
1339 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1340 * same value.
1341 * <p>Input: Nothing.
1342 * <p>Output: Nothing.
1343 * @hide
1344 */
1345 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1346 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001347
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001348 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001349 * Activity Action: Show settings for managing network data usage of a
1350 * specific application. Applications should define an activity that offers
1351 * options to control data usage.
1352 */
1353 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1354 public static final String ACTION_MANAGE_NETWORK_USAGE =
1355 "android.intent.action.MANAGE_NETWORK_USAGE";
1356
1357 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001358 * Activity Action: Launch application installer.
1359 * <p>
1360 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001361 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1362 * you can also use "package:<package-name>" to install an application for the
1363 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001364 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1365 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1366 * <p>
1367 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1368 * succeeded.
1369 *
1370 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1371 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1372 * @see #EXTRA_RETURN_RESULT
1373 */
1374 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1375 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1376
1377 /**
1378 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1379 * package. Specifies the installer package name; this package will receive the
1380 * {@link #ACTION_APP_ERROR} intent.
1381 */
1382 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1383 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1384
1385 /**
1386 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1387 * package. Specifies that the application being installed should not be
1388 * treated as coming from an unknown source, but as coming from the app
1389 * invoking the Intent. For this to work you must start the installer with
1390 * startActivityForResult().
1391 */
1392 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1393 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1394
1395 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001396 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1397 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001398 * data field originated from.
1399 */
rich cannings706e8ba2012-08-20 13:20:14 -07001400 public static final String EXTRA_ORIGINATING_URI
1401 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001402
1403 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001404 * This extra can be used with any Intent used to launch an activity, supplying information
1405 * about who is launching that activity. This field contains a {@link android.net.Uri}
1406 * object, typically an http: or https: URI of the web site that the referral came from;
1407 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1408 * a native application that it came from.
1409 *
1410 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1411 * instead of directly retrieving the extra. It is also valid for applications to
1412 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1413 * a string, not a Uri; the field here, if supplied, will always take precedence,
1414 * however.</p>
1415 *
1416 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001417 */
1418 public static final String EXTRA_REFERRER
1419 = "android.intent.extra.REFERRER";
1420
1421 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001422 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1423 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1424 * not be created, in particular when Intent extras are supplied through the
1425 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1426 * schemes.
1427 *
1428 * @see #EXTRA_REFERRER
1429 */
1430 public static final String EXTRA_REFERRER_NAME
1431 = "android.intent.extra.REFERRER_NAME";
1432
1433 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001434 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1435 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1436 * @hide
1437 */
1438 public static final String EXTRA_ORIGINATING_UID
1439 = "android.intent.extra.ORIGINATING_UID";
1440
1441 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001442 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1443 * package. Tells the installer UI to skip the confirmation with the user
1444 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001445 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1446 * will no longer show an interstitial message about updating existing
1447 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001448 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001449 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001450 public static final String EXTRA_ALLOW_REPLACE
1451 = "android.intent.extra.ALLOW_REPLACE";
1452
1453 /**
1454 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1455 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1456 * return to the application the result code of the install/uninstall. The returned result
1457 * code will be {@link android.app.Activity#RESULT_OK} on success or
1458 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1459 */
1460 public static final String EXTRA_RETURN_RESULT
1461 = "android.intent.extra.RETURN_RESULT";
1462
1463 /**
1464 * Package manager install result code. @hide because result codes are not
1465 * yet ready to be exposed.
1466 */
1467 public static final String EXTRA_INSTALL_RESULT
1468 = "android.intent.extra.INSTALL_RESULT";
1469
1470 /**
1471 * Activity Action: Launch application uninstaller.
1472 * <p>
1473 * Input: The data must be a package: URI whose scheme specific part is
1474 * the package name of the current installed package to be uninstalled.
1475 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1476 * <p>
1477 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1478 * succeeded.
1479 */
1480 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1481 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1482
1483 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001484 * Specify whether the package should be uninstalled for all users.
1485 * @hide because these should not be part of normal application flow.
1486 */
1487 public static final String EXTRA_UNINSTALL_ALL_USERS
1488 = "android.intent.extra.UNINSTALL_ALL_USERS";
1489
1490 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001491 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1492 * describing the last run version of the platform that was setup.
1493 * @hide
1494 */
1495 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1496
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001497 // ---------------------------------------------------------------------
1498 // ---------------------------------------------------------------------
1499 // Standard intent broadcast actions (see action variable).
1500
1501 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001502 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1503 * <p>
1504 * For historical reasons, the name of this broadcast action refers to the power
1505 * state of the screen but it is actually sent in response to changes in the
1506 * overall interactive state of the device.
1507 * </p><p>
1508 * This broadcast is sent when the device becomes non-interactive which may have
1509 * nothing to do with the screen turning off. To determine the
1510 * actual state of the screen, use {@link android.view.Display#getState}.
1511 * </p><p>
1512 * See {@link android.os.PowerManager#isInteractive} for details.
1513 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001514 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001515 * <p class="note">This is a protected intent that can only be sent
1516 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001517 */
1518 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1519 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001520
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001521 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001522 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1523 * <p>
1524 * For historical reasons, the name of this broadcast action refers to the power
1525 * state of the screen but it is actually sent in response to changes in the
1526 * overall interactive state of the device.
1527 * </p><p>
1528 * This broadcast is sent when the device becomes interactive which may have
1529 * nothing to do with the screen turning on. To determine the
1530 * actual state of the screen, use {@link android.view.Display#getState}.
1531 * </p><p>
1532 * See {@link android.os.PowerManager#isInteractive} for details.
1533 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001534 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001535 * <p class="note">This is a protected intent that can only be sent
1536 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001537 */
1538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1539 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001540
1541 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001542 * Broadcast Action: Sent after the system stops dreaming.
1543 *
1544 * <p class="note">This is a protected intent that can only be sent by the system.
1545 * It is only sent to registered receivers.</p>
1546 */
1547 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1548 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1549
1550 /**
1551 * Broadcast Action: Sent after the system starts dreaming.
1552 *
1553 * <p class="note">This is a protected intent that can only be sent by the system.
1554 * It is only sent to registered receivers.</p>
1555 */
1556 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1557 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1558
1559 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001560 * 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 -07001561 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001562 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001563 * <p class="note">This is a protected intent that can only be sent
1564 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001565 */
1566 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001567 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001568
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001569 /**
1570 * Broadcast Action: The current time has changed. Sent every
1571 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001572 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001573 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1574 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001575 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001576 * <p class="note">This is a protected intent that can only be sent
1577 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001578 */
1579 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1580 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1581 /**
1582 * Broadcast Action: The time was set.
1583 */
1584 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1585 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1586 /**
1587 * Broadcast Action: The date has changed.
1588 */
1589 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1590 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1591 /**
1592 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1593 * <ul>
1594 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1595 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001596 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001597 * <p class="note">This is a protected intent that can only be sent
1598 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001599 */
1600 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1601 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1602 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001603 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1604 * DNS entries should be tossed.
1605 * @hide
1606 */
1607 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1608 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1609 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001610 * Alarm Changed Action: This is broadcast when the AlarmClock
1611 * application's alarm is set or unset. It is used by the
1612 * AlarmClock application and the StatusBar service.
1613 * @hide
1614 */
1615 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1616 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1617 /**
1618 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1619 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1620 * @hide
1621 */
1622 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1623 public static final String ACTION_SYNC_STATE_CHANGED
1624 = "android.intent.action.SYNC_STATE_CHANGED";
1625 /**
1626 * Broadcast Action: This is broadcast once, after the system has finished
1627 * booting. It can be used to perform application-specific initialization,
1628 * such as installing alarms. You must hold the
1629 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1630 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001631 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001632 * <p class="note">This is a protected intent that can only be sent
1633 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001634 */
1635 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1636 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1637 /**
1638 * Broadcast Action: This is broadcast when a user action should request a
1639 * temporary system dialog to dismiss. Some examples of temporary system
1640 * dialogs are the notification window-shade and the recent tasks dialog.
1641 */
1642 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1643 /**
1644 * Broadcast Action: Trigger the download and eventual installation
1645 * of a package.
1646 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001647 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001648 * <p class="note">This is a protected intent that can only be sent
1649 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001650 *
1651 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001652 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001653 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001654 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1655 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1656 /**
1657 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001658 * device. The data contains the name of the package. Note that the
1659 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001660 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001661 * <ul>
1662 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1663 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1664 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1665 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001666 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001667 * <p class="note">This is a protected intent that can only be sent
1668 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001669 */
1670 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1671 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1672 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001673 * Broadcast Action: A new version of an application package has been
1674 * installed, replacing an existing version that was previously installed.
1675 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001676 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001677 * <ul>
1678 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1679 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001680 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001681 * <p class="note">This is a protected intent that can only be sent
1682 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001683 */
1684 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1685 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1686 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001687 * Broadcast Action: A new version of your application has been installed
1688 * over an existing one. This is only sent to the application that was
1689 * replaced. It does not contain any additional data; to receive it, just
1690 * use an intent filter for this action.
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_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1697 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001698 * Broadcast Action: An existing application package has been removed from
1699 * the device. The data contains the name of the package. The package
1700 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001701 * <ul>
1702 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1703 * to the package.
1704 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1705 * application -- data and code -- is being removed.
1706 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1707 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1708 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001709 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001710 * <p class="note">This is a protected intent that can only be sent
1711 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001712 */
1713 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1714 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1715 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001716 * Broadcast Action: An existing application package has been completely
1717 * removed from the device. The data contains the name of the package.
1718 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1719 * {@link #EXTRA_DATA_REMOVED} is true and
1720 * {@link #EXTRA_REPLACING} is false of that broadcast.
1721 *
1722 * <ul>
1723 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1724 * to the package.
1725 * </ul>
1726 *
1727 * <p class="note">This is a protected intent that can only be sent
1728 * by the system.
1729 */
1730 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1731 public static final String ACTION_PACKAGE_FULLY_REMOVED
1732 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1733 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001734 * Broadcast Action: An existing application package has been changed (e.g.
1735 * a component has been enabled or disabled). The data contains the name of
1736 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001737 * <ul>
1738 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001739 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001740 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001741 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1742 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001743 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001744 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001745 * <p class="note">This is a protected intent that can only be sent
1746 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001747 */
1748 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1749 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1750 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001751 * @hide
1752 * Broadcast Action: Ask system services if there is any reason to
1753 * restart the given package. The data contains the name of the
1754 * package.
1755 * <ul>
1756 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1757 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1758 * </ul>
1759 *
1760 * <p class="note">This is a protected intent that can only be sent
1761 * by the system.
1762 */
1763 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1764 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1765 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001766 * Broadcast Action: The user has restarted a package, and all of its
1767 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001768 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001769 * be removed. Note that the restarted package does <em>not</em>
1770 * receive this broadcast.
1771 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001772 * <ul>
1773 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1774 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001775 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001776 * <p class="note">This is a protected intent that can only be sent
1777 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001778 */
1779 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1780 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1781 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001782 * Broadcast Action: The user has cleared the data of a package. This should
1783 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001784 * its persistent data is erased and this broadcast sent.
1785 * Note that the cleared package does <em>not</em>
1786 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001787 * <ul>
1788 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1789 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001790 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001791 * <p class="note">This is a protected intent that can only be sent
1792 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001793 */
1794 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1795 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1796 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001797 * Broadcast Action: A user ID has been removed from the system. The user
1798 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001799 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001800 * <p class="note">This is a protected intent that can only be sent
1801 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001802 */
1803 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1804 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001805
1806 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001807 * Broadcast Action: Sent to the installer package of an application
1808 * when that application is first launched (that is the first time it
1809 * is moved out of the stopped state). The data contains the name of the package.
1810 *
1811 * <p class="note">This is a protected intent that can only be sent
1812 * by the system.
1813 */
1814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1815 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1816
1817 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001818 * Broadcast Action: Sent to the system package verifier when a package
1819 * needs to be verified. The data contains the package URI.
1820 * <p class="note">
1821 * This is a protected intent that can only be sent by the system.
1822 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001823 */
1824 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1825 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1826
1827 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001828 * Broadcast Action: Sent to the system package verifier when a package is
1829 * verified. The data contains the package URI.
1830 * <p class="note">
1831 * This is a protected intent that can only be sent by the system.
1832 */
1833 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1834 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1835
1836 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001837 * Broadcast Action: Resources for a set of packages (which were
1838 * previously unavailable) are currently
1839 * available since the media on which they exist is available.
1840 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1841 * list of packages whose availability changed.
1842 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1843 * list of uids of packages whose availability changed.
1844 * Note that the
1845 * packages in this list do <em>not</em> receive this broadcast.
1846 * The specified set of packages are now available on the system.
1847 * <p>Includes the following extras:
1848 * <ul>
1849 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1850 * whose resources(were previously unavailable) are currently available.
1851 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1852 * packages whose resources(were previously unavailable)
1853 * are currently available.
1854 * </ul>
1855 *
1856 * <p class="note">This is a protected intent that can only be sent
1857 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001858 */
1859 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001860 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1861 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001862
1863 /**
1864 * Broadcast Action: Resources for a set of packages are currently
1865 * unavailable since the media on which they exist is unavailable.
1866 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1867 * list of packages whose availability changed.
1868 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1869 * list of uids of packages whose availability changed.
1870 * The specified set of packages can no longer be
1871 * launched and are practically unavailable on the system.
1872 * <p>Inclues the following extras:
1873 * <ul>
1874 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1875 * whose resources are no longer available.
1876 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1877 * whose resources are no longer available.
1878 * </ul>
1879 *
1880 * <p class="note">This is a protected intent that can only be sent
1881 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001882 */
1883 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001884 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001885 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001886
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001887 /**
1888 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001889 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001890 * This should <em>only</em> be used to determine when the wallpaper
1891 * has changed to show the new wallpaper to the user. You should certainly
1892 * never, in response to this, change the wallpaper or other attributes of
1893 * it such as the suggested size. That would be crazy, right? You'd cause
1894 * all kinds of loops, especially if other apps are doing similar things,
1895 * right? Of course. So please don't do this.
1896 *
1897 * @deprecated Modern applications should use
1898 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1899 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1900 * shown behind their UI, rather than watching for this broadcast and
1901 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001902 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001903 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001904 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1905 /**
1906 * Broadcast Action: The current device {@link android.content.res.Configuration}
1907 * (orientation, locale, etc) has changed. When such a change happens, the
1908 * UIs (view hierarchy) will need to be rebuilt based on this new
1909 * information; for the most part, applications don't need to worry about
1910 * this, because the system will take care of stopping and restarting the
1911 * application to make sure it sees the new changes. Some system code that
1912 * can not be restarted will need to watch for this action and handle it
1913 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001914 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001915 * <p class="note">
1916 * You can <em>not</em> receive this through components declared
1917 * in manifests, only by explicitly registering for it with
1918 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1919 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001920 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001921 * <p class="note">This is a protected intent that can only be sent
1922 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001923 *
1924 * @see android.content.res.Configuration
1925 */
1926 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1927 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1928 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001929 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001930 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001931 * <p class="note">This is a protected intent that can only be sent
1932 * by the system.
1933 */
1934 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1935 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1936 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001937 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1938 * charging state, level, and other information about the battery.
1939 * See {@link android.os.BatteryManager} for documentation on the
1940 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001941 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001942 * <p class="note">
1943 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001944 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001945 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001946 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1947 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1948 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1949 * broadcasts that are sent and can be received through manifest
1950 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001951 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001952 * <p class="note">This is a protected intent that can only be sent
1953 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001954 */
1955 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1956 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1957 /**
1958 * Broadcast Action: Indicates low battery condition on the device.
1959 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001960 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001961 * <p class="note">This is a protected intent that can only be sent
1962 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001963 */
1964 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1965 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1966 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001967 * Broadcast Action: Indicates the battery is now okay after being low.
1968 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1969 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001970 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001971 * <p class="note">This is a protected intent that can only be sent
1972 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001973 */
1974 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1975 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1976 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001977 * Broadcast Action: External power has been connected to the device.
1978 * This is intended for applications that wish to register specifically to this notification.
1979 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1980 * stay active to receive this notification. This action can be used to implement actions
1981 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001982 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001983 * <p class="note">This is a protected intent that can only be sent
1984 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001985 */
1986 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001987 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001988 /**
1989 * Broadcast Action: External power has been removed from the device.
1990 * This is intended for applications that wish to register specifically to this notification.
1991 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1992 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001993 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001994 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001995 * <p class="note">This is a protected intent that can only be sent
1996 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001997 */
1998 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001999 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002000 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002001 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002002 * Broadcast Action: Device is shutting down.
2003 * This is broadcast when the device is being shut down (completely turned
2004 * off, not sleeping). Once the broadcast is complete, the final shutdown
2005 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002006 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002007 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002008 * <p class="note">This is a protected intent that can only be sent
2009 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002010 * <p>May include the following extras:
2011 * <ul>
2012 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2013 * shutdown is only for userspace processes. If not set, assumed to be false.
2014 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002015 */
2016 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002017 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002018 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002019 * Activity Action: Start this activity to request system shutdown.
2020 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
2021 * to request confirmation from the user before shutting down.
2022 *
2023 * <p class="note">This is a protected intent that can only be sent
2024 * by the system.
2025 *
2026 * {@hide}
2027 */
2028 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2029 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002030 * Broadcast Action: A sticky broadcast that indicates low memory
2031 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002032 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002033 * <p class="note">This is a protected intent that can only be sent
2034 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002035 */
2036 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2037 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2038 /**
2039 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002040 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002041 * <p class="note">This is a protected intent that can only be sent
2042 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002043 */
2044 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2045 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2046 /**
Jake Hambybb371632010-08-23 18:16:48 -07002047 * Broadcast Action: A sticky broadcast that indicates a memory full
2048 * condition on the device. This is intended for activities that want
2049 * to be able to fill the data partition completely, leaving only
2050 * enough free space to prevent system-wide SQLite failures.
2051 *
2052 * <p class="note">This is a protected intent that can only be sent
2053 * by the system.
2054 *
2055 * {@hide}
2056 */
2057 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2058 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2059 /**
2060 * Broadcast Action: Indicates memory full condition on the device
2061 * no longer exists.
2062 *
2063 * <p class="note">This is a protected intent that can only be sent
2064 * by the system.
2065 *
2066 * {@hide}
2067 */
2068 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2069 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2070 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002071 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2072 * and package management should be started.
2073 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2074 * notification.
2075 */
2076 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2077 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2078 /**
2079 * Broadcast Action: The device has entered USB Mass Storage mode.
2080 * This is used mainly for the USB Settings panel.
2081 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2082 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002083 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002084 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002085 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002086 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2087
2088 /**
2089 * Broadcast Action: The device has exited USB Mass Storage mode.
2090 * This is used mainly for the USB Settings panel.
2091 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2092 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002093 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002094 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002095 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002096 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2097
2098 /**
2099 * Broadcast Action: External media has been removed.
2100 * The path to the mount point for the removed media is contained in the Intent.mData field.
2101 */
2102 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2103 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2104
2105 /**
2106 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002107 * 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 -07002108 */
2109 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2110 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2111
2112 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002113 * Broadcast Action: External media is present, and being disk-checked
2114 * 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 -08002115 */
2116 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2117 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2118
2119 /**
2120 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2121 * 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 -08002122 */
2123 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2124 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2125
2126 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002127 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002128 * 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 -07002129 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2130 * media was mounted read only.
2131 */
2132 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2133 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2134
2135 /**
2136 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002137 * 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 -07002138 */
2139 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2140 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2141
2142 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002143 * Broadcast Action: External media is no longer being shared via USB mass storage.
2144 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2145 *
2146 * @hide
2147 */
2148 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2149
2150 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002151 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2152 * The path to the mount point for the removed media is contained in the Intent.mData field.
2153 */
2154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2155 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2156
2157 /**
2158 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002159 * 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 -07002160 */
2161 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2162 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2163
2164 /**
2165 * Broadcast Action: User has expressed the desire to remove the external storage media.
2166 * Applications should close all files they have open within the mount point when they receive this intent.
2167 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2168 */
2169 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2170 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2171
2172 /**
2173 * Broadcast Action: The media scanner has started scanning a directory.
2174 * The path to the directory being scanned is contained in the Intent.mData field.
2175 */
2176 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2177 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2178
2179 /**
2180 * Broadcast Action: The media scanner has finished scanning a directory.
2181 * The path to the scanned directory is contained in the Intent.mData field.
2182 */
2183 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2184 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2185
2186 /**
2187 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2188 * The path to the file is contained in the Intent.mData field.
2189 */
2190 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2191 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2192
2193 /**
2194 * Broadcast Action: The "Media Button" was pressed. Includes a single
2195 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2196 * caused the broadcast.
2197 */
2198 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2199 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2200
2201 /**
2202 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2203 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2204 * caused the broadcast.
2205 */
2206 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2207 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2208
2209 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2210 // location; they are not general-purpose actions.
2211
2212 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002213 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002214 */
2215 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2216 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2217 "android.intent.action.GTALK_CONNECTED";
2218
2219 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002220 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002221 */
2222 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2223 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2224 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002225
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002226 /**
2227 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002228 */
2229 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2230 public static final String ACTION_INPUT_METHOD_CHANGED =
2231 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002232
2233 /**
2234 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2235 * more radios have been turned off or on. The intent will have the following extra value:</p>
2236 * <ul>
2237 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2238 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2239 * turned off</li>
2240 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002241 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002242 * <p class="note">This is a protected intent that can only be sent
2243 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002244 */
2245 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2246 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2247
2248 /**
2249 * Broadcast Action: Some content providers have parts of their namespace
2250 * where they publish new events or items that the user may be especially
2251 * interested in. For these things, they may broadcast this action when the
2252 * set of interesting items change.
2253 *
2254 * For example, GmailProvider sends this notification when the set of unread
2255 * mail in the inbox changes.
2256 *
2257 * <p>The data of the intent identifies which part of which provider
2258 * changed. When queried through the content resolver, the data URI will
2259 * return the data set in question.
2260 *
2261 * <p>The intent will have the following extra values:
2262 * <ul>
2263 * <li><em>count</em> - The number of items in the data set. This is the
2264 * same as the number of items in the cursor returned by querying the
2265 * data URI. </li>
2266 * </ul>
2267 *
2268 * This intent will be sent at boot (if the count is non-zero) and when the
2269 * data set changes. It is possible for the data set to change without the
2270 * count changing (for example, if a new unread message arrives in the same
2271 * sync operation in which a message is archived). The phone should still
2272 * ring/vibrate/etc as normal in this case.
2273 */
2274 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2275 public static final String ACTION_PROVIDER_CHANGED =
2276 "android.intent.action.PROVIDER_CHANGED";
2277
2278 /**
2279 * Broadcast Action: Wired Headset plugged in or unplugged.
2280 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002281 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2282 * and documentation.
2283 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002284 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002285 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002286 */
2287 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002288 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002289
2290 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002291 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2292 * <ul>
2293 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2294 * </ul>
2295 *
2296 * <p class="note">This is a protected intent that can only be sent
2297 * by the system.
2298 *
2299 * @hide
2300 */
2301 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2302 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2303 = "android.intent.action.ADVANCED_SETTINGS";
2304
2305 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002306 * Broadcast Action: Sent after application restrictions are changed.
2307 *
2308 * <p class="note">This is a protected intent that can only be sent
2309 * by the system.</p>
2310 */
2311 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2312 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2313 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2314
2315 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002316 * Broadcast Action: An outgoing call is about to be placed.
2317 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002318 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002319 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002320 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002321 * the phone number originally intended to be dialed.</li>
2322 * </ul>
2323 * <p>Once the broadcast is finished, the resultData is used as the actual
2324 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002325 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002326 * outgoing call in turn: for example, a parental control application
2327 * might verify that the user is authorized to place the call at that
2328 * time, then a number-rewriting application might add an area code if
2329 * one was not specified.</p>
2330 * <p>For consistency, any receiver whose purpose is to prohibit phone
2331 * calls should have a priority of 0, to ensure it will see the final
2332 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002333 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002334 * should have a positive priority.
2335 * Negative priorities are reserved for the system for this broadcast;
2336 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002337 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2338 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002339 * <p>Emergency calls cannot be intercepted using this mechanism, and
2340 * other calls cannot be modified to call emergency numbers using this
2341 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002342 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2343 * call to use their own service instead. Those apps should first prevent
2344 * the call from being placed by setting resultData to <code>null</code>
2345 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002346 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002347 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2348 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002349 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002350 * <p class="note">This is a protected intent that can only be sent
2351 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002352 */
2353 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2354 public static final String ACTION_NEW_OUTGOING_CALL =
2355 "android.intent.action.NEW_OUTGOING_CALL";
2356
2357 /**
2358 * Broadcast Action: Have the device reboot. This is only for use by
2359 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002360 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002361 * <p class="note">This is a protected intent that can only be sent
2362 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002363 */
2364 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2365 public static final String ACTION_REBOOT =
2366 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002367
Wei Huang97ecc9c2009-05-11 17:44:20 -07002368 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002369 * Broadcast Action: A sticky broadcast for changes in the physical
2370 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002371 *
2372 * <p>The intent will have the following extra values:
2373 * <ul>
2374 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002375 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002376 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002377 * <p>This is intended for monitoring the current physical dock state.
2378 * See {@link android.app.UiModeManager} for the normal API dealing with
2379 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002380 */
2381 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2382 public static final String ACTION_DOCK_EVENT =
2383 "android.intent.action.DOCK_EVENT";
2384
2385 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002386 * Broadcast Action: A broadcast when idle maintenance can be started.
2387 * This means that the user is not interacting with the device and is
2388 * not expected to do so soon. Typical use of the idle maintenance is
2389 * to perform somehow expensive tasks that can be postponed at a moment
2390 * when they will not degrade user experience.
2391 * <p>
2392 * <p class="note">In order to keep the device responsive in case of an
2393 * unexpected user interaction, implementations of a maintenance task
2394 * should be interruptible. In such a scenario a broadcast with action
2395 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2396 * should not do the maintenance work in
2397 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2398 * maintenance service by {@link Context#startService(Intent)}. Also
2399 * you should hold a wake lock while your maintenance service is running
2400 * to prevent the device going to sleep.
2401 * </p>
2402 * <p>
2403 * <p class="note">This is a protected intent that can only be sent by
2404 * the system.
2405 * </p>
2406 *
2407 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002408 *
2409 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002410 */
2411 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2412 public static final String ACTION_IDLE_MAINTENANCE_START =
2413 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2414
2415 /**
2416 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2417 * This means that the user was not interacting with the device as a result
2418 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2419 * was sent and now the user started interacting with the device. Typical
2420 * use of the idle maintenance is to perform somehow expensive tasks that
2421 * can be postponed at a moment when they will not degrade user experience.
2422 * <p>
2423 * <p class="note">In order to keep the device responsive in case of an
2424 * unexpected user interaction, implementations of a maintenance task
2425 * should be interruptible. Hence, on receiving a broadcast with this
2426 * action, the maintenance task should be interrupted as soon as possible.
2427 * In other words, you should not do the maintenance work in
2428 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2429 * maintenance service that was started on receiving of
2430 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2431 * lock you acquired when your maintenance service started.
2432 * </p>
2433 * <p class="note">This is a protected intent that can only be sent
2434 * by the system.
2435 *
2436 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002437 *
2438 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002439 */
2440 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2441 public static final String ACTION_IDLE_MAINTENANCE_END =
2442 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2443
2444 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002445 * Broadcast Action: a remote intent is to be broadcasted.
2446 *
2447 * A remote intent is used for remote RPC between devices. The remote intent
2448 * is serialized and sent from one device to another device. The receiving
2449 * device parses the remote intent and broadcasts it. Note that anyone can
2450 * broadcast a remote intent. However, if the intent receiver of the remote intent
2451 * does not trust intent broadcasts from arbitrary intent senders, it should require
2452 * the sender to hold certain permissions so only trusted sender's broadcast will be
2453 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002454 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002455 */
2456 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002457 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002458
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002459 /**
2460 * Broadcast Action: hook for permforming cleanup after a system update.
2461 *
2462 * The broadcast is sent when the system is booting, before the
2463 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2464 * image. A receiver for this should do its work and then disable itself
2465 * so that it does not get run again at the next boot.
2466 * @hide
2467 */
2468 public static final String ACTION_PRE_BOOT_COMPLETED =
2469 "android.intent.action.PRE_BOOT_COMPLETED";
2470
Amith Yamasani13593602012-03-22 16:16:17 -07002471 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002472 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002473 * on restricted users. The broadcast intent contains an extra
2474 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2475 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2476 * String[] depending on the restriction type.<p/>
2477 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002478 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2479 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2480 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002481 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2482 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002483 * @see RestrictionEntry
2484 */
2485 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2486 "android.intent.action.GET_RESTRICTION_ENTRIES";
2487
2488 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002489 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002490 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002491 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2492 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2493 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002494 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2495 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2496 * challenge.<p/>
2497 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002498 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002499 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002500 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2501 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002502
2503 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002504 * Sent the first time a user is starting, to allow system apps to
2505 * perform one time initialization. (This will not be seen by third
2506 * party applications because a newly initialized user does not have any
2507 * third party applications installed for it.) This is sent early in
2508 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002509 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2510 * broadcast, since it is part of a visible user interaction; be as quick
2511 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002512 */
2513 public static final String ACTION_USER_INITIALIZE =
2514 "android.intent.action.USER_INITIALIZE";
2515
2516 /**
2517 * Sent when a user switch is happening, causing the process's user to be
2518 * brought to the foreground. This is only sent to receivers registered
2519 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2520 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002521 * foreground. This is sent as a foreground
2522 * broadcast, since it is part of a visible user interaction; be as quick
2523 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002524 */
2525 public static final String ACTION_USER_FOREGROUND =
2526 "android.intent.action.USER_FOREGROUND";
2527
2528 /**
2529 * Sent when a user switch is happening, causing the process's user to be
2530 * sent to the background. This is only sent to receivers registered
2531 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2532 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002533 * background. This is sent as a foreground
2534 * broadcast, since it is part of a visible user interaction; be as quick
2535 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002536 */
2537 public static final String ACTION_USER_BACKGROUND =
2538 "android.intent.action.USER_BACKGROUND";
2539
2540 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002541 * Broadcast sent to the system when a user is added. Carries an extra
2542 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2543 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002544 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002545 * @hide
2546 */
2547 public static final String ACTION_USER_ADDED =
2548 "android.intent.action.USER_ADDED";
2549
2550 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002551 * Broadcast sent by the system when a user is started. Carries an extra
2552 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002553 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002554 * that has been started. This is sent as a foreground
2555 * broadcast, since it is part of a visible user interaction; be as quick
2556 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002557 * @hide
2558 */
2559 public static final String ACTION_USER_STARTED =
2560 "android.intent.action.USER_STARTED";
2561
2562 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002563 * Broadcast sent when a user is in the process of starting. Carries an extra
2564 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2565 * sent to registered receivers, not manifest receivers. It is sent to all
2566 * users (including the one that is being started). You must hold
2567 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2568 * this broadcast. This is sent as a background broadcast, since
2569 * its result is not part of the primary UX flow; to safely keep track of
2570 * started/stopped state of a user you can use this in conjunction with
2571 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2572 * other user state broadcasts since those are foreground broadcasts so can
2573 * execute in a different order.
2574 * @hide
2575 */
2576 public static final String ACTION_USER_STARTING =
2577 "android.intent.action.USER_STARTING";
2578
2579 /**
2580 * Broadcast sent when a user is going to be stopped. 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 stopped). You must hold
2584 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2585 * this broadcast. The user will not stop until all receivers have
2586 * handled the broadcast. This is sent as a background broadcast, since
2587 * its result is not part of the primary UX flow; to safely keep track of
2588 * started/stopped state of a user you can use this in conjunction with
2589 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2590 * other user state broadcasts since those are foreground broadcasts so can
2591 * execute in a different order.
2592 * @hide
2593 */
2594 public static final String ACTION_USER_STOPPING =
2595 "android.intent.action.USER_STOPPING";
2596
2597 /**
2598 * Broadcast sent to the system when a user is stopped. Carries an extra
2599 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2600 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2601 * specific package. This is only sent to registered receivers, not manifest
2602 * receivers. It is sent to all running users <em>except</em> the one that
2603 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002604 * @hide
2605 */
2606 public static final String ACTION_USER_STOPPED =
2607 "android.intent.action.USER_STOPPED";
2608
2609 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002610 * 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 -07002611 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002612 * one that has been removed. The user will not be completely removed until all receivers have
2613 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002614 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002615 * @hide
2616 */
2617 public static final String ACTION_USER_REMOVED =
2618 "android.intent.action.USER_REMOVED";
2619
2620 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002621 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002622 * the userHandle of the user to become the current one. This is only sent to
2623 * registered receivers, not manifest receivers. It is sent to all running users.
2624 * You must hold
2625 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002626 * @hide
2627 */
2628 public static final String ACTION_USER_SWITCHED =
2629 "android.intent.action.USER_SWITCHED";
2630
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002631 /**
2632 * Broadcast sent to the system when a user's information changes. Carries an extra
2633 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002634 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002635 * @hide
2636 */
2637 public static final String ACTION_USER_INFO_CHANGED =
2638 "android.intent.action.USER_INFO_CHANGED";
2639
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002640 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002641 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2642 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002643 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2644 * that need to display merged content across both primary and managed profiles need to
2645 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002646 * not manifest receivers.
2647 */
2648 public static final String ACTION_MANAGED_PROFILE_ADDED =
2649 "android.intent.action.MANAGED_PROFILE_ADDED";
2650
2651 /**
2652 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002653 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2654 * Only applications (for example Launchers) that need to display merged content across both
2655 * primary and managed profiles need to worry about this broadcast. This is only sent to
2656 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002657 */
2658 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2659 "android.intent.action.MANAGED_PROFILE_REMOVED";
2660
2661 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002662 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2663 */
2664 public static final String ACTION_QUICK_CLOCK =
2665 "android.intent.action.QUICK_CLOCK";
2666
Michael Wright0087a142013-02-05 16:29:39 -08002667 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002668 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002669 * @hide
2670 */
2671 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2672 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2673
Justin Kohd378ad72013-04-01 12:18:26 -07002674 /**
2675 * Broadcast Action: A global button was pressed. Includes a single
2676 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2677 * caused the broadcast.
2678 * @hide
2679 */
2680 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2681
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002682 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002683 * Activity Action: Allow the user to select and return one or more existing
2684 * documents. When invoked, the system will display the various
2685 * {@link DocumentsProvider} instances installed on the device, letting the
2686 * user interactively navigate through them. These documents include local
2687 * media, such as photos and video, and documents provided by installed
2688 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002689 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002690 * Each document is represented as a {@code content://} URI backed by a
2691 * {@link DocumentsProvider}, which can be opened as a stream with
2692 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2693 * {@link android.provider.DocumentsContract.Document} metadata.
2694 * <p>
2695 * All selected documents are returned to the calling application with
2696 * persistable read and write permission grants. If you want to maintain
2697 * access to the documents across device reboots, you need to explicitly
2698 * take the persistable permissions using
2699 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2700 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002701 * Callers must indicate the acceptable document MIME types through
2702 * {@link #setType(String)}. For example, to select photos, use
2703 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2704 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2705 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002706 * <p>
2707 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002708 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2709 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002710 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002711 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2712 * returned URIs can be opened with
2713 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002714 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002715 * Output: The URI of the item that was picked, returned in
2716 * {@link #getData()}. This must be a {@code content://} URI so that any
2717 * receiver can access it. If multiple documents were selected, they are
2718 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002719 *
2720 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002721 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002722 * @see #ACTION_CREATE_DOCUMENT
2723 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002724 */
2725 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2726 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2727
2728 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002729 * Activity Action: Allow the user to create a new document. When invoked,
2730 * the system will display the various {@link DocumentsProvider} instances
2731 * installed on the device, letting the user navigate through them. The
2732 * returned document may be a newly created document with no content, or it
2733 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002734 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002735 * Each document is represented as a {@code content://} URI backed by a
2736 * {@link DocumentsProvider}, which can be opened as a stream with
2737 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2738 * {@link android.provider.DocumentsContract.Document} metadata.
2739 * <p>
2740 * Callers must indicate the concrete MIME type of the document being
2741 * created by setting {@link #setType(String)}. This MIME type cannot be
2742 * changed after the document is created.
2743 * <p>
2744 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2745 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002746 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002747 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2748 * returned URIs can be opened with
2749 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002750 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002751 * Output: The URI of the item that was created. This must be a
2752 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002753 *
2754 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002755 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002756 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002757 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002758 */
2759 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2760 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2761
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002762 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002763 * Activity Action: Allow the user to pick a directory subtree. When
2764 * invoked, the system will display the various {@link DocumentsProvider}
2765 * instances installed on the device, letting the user navigate through
2766 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002767 * <p>
2768 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002769 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2770 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2771 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002772 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002773 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002774 *
2775 * @see DocumentsContract
2776 */
2777 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002778 public static final String
2779 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002780
Jeff Sharkey004a4b22014-09-24 11:45:24 -07002781 /** {@hide} */
2782 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
2783
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002784 // ---------------------------------------------------------------------
2785 // ---------------------------------------------------------------------
2786 // Standard intent categories (see addCategory()).
2787
2788 /**
2789 * Set if the activity should be an option for the default action
2790 * (center press) to perform on a piece of data. Setting this will
2791 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002792 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002793 * Intent when initiating an action -- it is for use in intent filters
2794 * specified in packages.
2795 */
2796 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2797 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2798 /**
2799 * Activities that can be safely invoked from a browser must support this
2800 * category. For example, if the user is viewing a web page or an e-mail
2801 * and clicks on a link in the text, the Intent generated execute that
2802 * link will require the BROWSABLE category, so that only activities
2803 * supporting this category will be considered as possible actions. By
2804 * supporting this category, you are promising that there is nothing
2805 * damaging (without user intervention) that can happen by invoking any
2806 * matching Intent.
2807 */
2808 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2809 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2810 /**
Dianne Hackbornd7c03952014-08-29 17:32:04 -07002811 * @hide
Dianne Hackborn91097de2014-04-04 18:02:06 -07002812 * Categories for activities that can participate in voice interaction.
2813 * An activity that supports this category must be prepared to run with
2814 * no UI shown at all (though in some case it may have a UI shown), and
2815 * rely on {@link android.app.VoiceInteractor} to interact with the user.
2816 */
2817 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
Dianne Hackbornd7c03952014-08-29 17:32:04 -07002818 @SystemApi
Dianne Hackborn91097de2014-04-04 18:02:06 -07002819 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2820 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002821 * Set if the activity should be considered as an alternative action to
2822 * the data the user is currently viewing. See also
2823 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2824 * applies to the selection in a list of items.
2825 *
2826 * <p>Supporting this category means that you would like your activity to be
2827 * displayed in the set of alternative things the user can do, usually as
2828 * part of the current activity's options menu. You will usually want to
2829 * include a specific label in the &lt;intent-filter&gt; of this action
2830 * describing to the user what it does.
2831 *
2832 * <p>The action of IntentFilter with this category is important in that it
2833 * describes the specific action the target will perform. This generally
2834 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2835 * a specific name such as "com.android.camera.action.CROP. Only one
2836 * alternative of any particular action will be shown to the user, so using
2837 * a specific action like this makes sure that your alternative will be
2838 * displayed while also allowing other applications to provide their own
2839 * overrides of that particular action.
2840 */
2841 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2842 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2843 /**
2844 * Set if the activity should be considered as an alternative selection
2845 * action to the data the user has currently selected. This is like
2846 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2847 * of items from which the user can select, giving them alternatives to the
2848 * default action that will be performed on it.
2849 */
2850 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2851 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2852 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002853 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002854 */
2855 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2856 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2857 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002858 * Should be displayed in the top-level launcher.
2859 */
2860 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2861 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2862 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002863 * Indicates an activity optimized for Leanback mode, and that should
2864 * be displayed in the Leanback launcher.
2865 */
2866 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2867 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2868 /**
Jose Lima73915cf2014-07-29 17:16:31 -07002869 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
2870 * @hide
2871 */
2872 @SystemApi
2873 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
2874 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002875 * Provides information about the package it is in; typically used if
2876 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2877 * a front-door to the user without having to be shown in the all apps list.
2878 */
2879 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2880 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2881 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002882 * This is the home activity, that is the first activity that is displayed
2883 * when the device boots.
2884 */
2885 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2886 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2887 /**
2888 * This activity is a preference panel.
2889 */
2890 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2891 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2892 /**
2893 * This activity is a development preference panel.
2894 */
2895 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2896 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2897 /**
2898 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002899 */
2900 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2901 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2902 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002903 * This activity allows the user to browse and download new applications.
2904 */
2905 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2906 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2907 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002908 * This activity may be exercised by the monkey or other automated test tools.
2909 */
2910 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2911 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2912 /**
2913 * To be used as a test (not part of the normal user experience).
2914 */
2915 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2916 /**
2917 * To be used as a unit test (run through the Test Harness).
2918 */
2919 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2920 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002921 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002922 * experience).
2923 */
2924 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002925
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002926 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002927 * Used to indicate that an intent only wants URIs that can be opened with
2928 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2929 * must support at least the columns defined in {@link OpenableColumns} when
2930 * queried.
2931 *
2932 * @see #ACTION_GET_CONTENT
2933 * @see #ACTION_OPEN_DOCUMENT
2934 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002935 */
2936 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2937 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2938
2939 /**
2940 * To be used as code under test for framework instrumentation tests.
2941 */
2942 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2943 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002944 /**
2945 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002946 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2947 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002948 */
2949 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2950 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2951 /**
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_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002958 /**
2959 * An activity to run when device is inserted into a analog (low end) dock.
2960 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2961 * information, see {@link android.app.UiModeManager}.
2962 */
2963 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2964 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2965
2966 /**
2967 * An activity to run when device is inserted into a digital (high end) dock.
2968 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2969 * information, see {@link android.app.UiModeManager}.
2970 */
2971 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2972 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002973
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002974 /**
2975 * Used to indicate that the activity can be used in a car environment.
2976 */
2977 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2978 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2979
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002980 // ---------------------------------------------------------------------
2981 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002982 // Application launch intent categories (see addCategory()).
2983
2984 /**
2985 * Used with {@link #ACTION_MAIN} to launch the browser application.
2986 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002987 * <p>NOTE: This should not be used as the primary key of an Intent,
2988 * since it will not result in the app launching with the correct
2989 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002990 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002991 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002992 */
2993 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2994 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2995
2996 /**
2997 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2998 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002999 * <p>NOTE: This should not be used as the primary key of an Intent,
3000 * since it will not result in the app launching with the correct
3001 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003002 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003003 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003004 */
3005 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3006 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3007
3008 /**
3009 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3010 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003011 * <p>NOTE: This should not be used as the primary key of an Intent,
3012 * since it will not result in the app launching with the correct
3013 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003014 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003015 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003016 */
3017 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3018 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3019
3020 /**
3021 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3022 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003023 * <p>NOTE: This should not be used as the primary key of an Intent,
3024 * since it will not result in the app launching with the correct
3025 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003026 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003027 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003028 */
3029 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3030 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3031
3032 /**
3033 * Used with {@link #ACTION_MAIN} to launch the email application.
3034 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003035 * <p>NOTE: This should not be used as the primary key of an Intent,
3036 * since it will not result in the app launching with the correct
3037 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003038 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003039 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003040 */
3041 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3042 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3043
3044 /**
3045 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3046 * The activity should be able to view and manipulate image and video files
3047 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003048 * <p>NOTE: This should not be used as the primary key of an Intent,
3049 * since it will not result in the app launching with the correct
3050 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003051 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003052 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003053 */
3054 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3055 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3056
3057 /**
3058 * Used with {@link #ACTION_MAIN} to launch the maps application.
3059 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003060 * <p>NOTE: This should not be used as the primary key of an Intent,
3061 * since it will not result in the app launching with the correct
3062 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003063 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003064 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003065 */
3066 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3067 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3068
3069 /**
3070 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3071 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003072 * <p>NOTE: This should not be used as the primary key of an Intent,
3073 * since it will not result in the app launching with the correct
3074 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003075 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003076 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003077 */
3078 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3079 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3080
3081 /**
3082 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003083 * The activity should be able to play, browse, or manipulate music files
3084 * stored on the device.
3085 * <p>NOTE: This should not be used as the primary key of an Intent,
3086 * since it will not result in the app launching with the correct
3087 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003088 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003089 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003090 */
3091 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3092 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3093
3094 // ---------------------------------------------------------------------
3095 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003096 // Standard extra data keys.
3097
3098 /**
3099 * The initial data to place in a newly created record. Use with
3100 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3101 * fields as would be given to the underlying ContentProvider.insert()
3102 * call.
3103 */
3104 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3105
3106 /**
3107 * A constant CharSequence that is associated with the Intent, used with
3108 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3109 * this may be a styled CharSequence, so you must use
3110 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3111 * retrieve it.
3112 */
3113 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3114
3115 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003116 * A constant String that is associated with the Intent, used with
3117 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3118 * as HTML formatted text. Note that you <em>must</em> also supply
3119 * {@link #EXTRA_TEXT}.
3120 */
3121 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3122
3123 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003124 * A content: URI holding a stream of data associated with the Intent,
3125 * used with {@link #ACTION_SEND} to supply the data being sent.
3126 */
3127 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3128
3129 /**
3130 * A String[] holding e-mail addresses that should be delivered to.
3131 */
3132 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3133
3134 /**
3135 * A String[] holding e-mail addresses that should be carbon copied.
3136 */
3137 public static final String EXTRA_CC = "android.intent.extra.CC";
3138
3139 /**
3140 * A String[] holding e-mail addresses that should be blind carbon copied.
3141 */
3142 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3143
3144 /**
3145 * A constant string holding the desired subject line of a message.
3146 */
3147 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3148
3149 /**
3150 * An Intent describing the choices you would like shown with
3151 * {@link #ACTION_PICK_ACTIVITY}.
3152 */
3153 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3154
3155 /**
3156 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003157 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003158 */
3159 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3160
3161 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003162 * A Parcelable[] of {@link Intent} or
3163 * {@link android.content.pm.LabeledIntent} objects as set with
3164 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3165 * a the front of the list of choices, when shown to the user with a
3166 * {@link #ACTION_CHOOSER}.
3167 */
3168 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3169
3170 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003171 * A Bundle forming a mapping of potential target package names to different extras Bundles
3172 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3173 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3174 * be currently installed on the device.
3175 *
3176 * <p>An application may choose to provide alternate extras for the case where a user
3177 * selects an activity from a predetermined set of target packages. If the activity
3178 * the user selects from the chooser belongs to a package with its package name as
3179 * a key in this bundle, the corresponding extras for that package will be merged with
3180 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3181 * extra has the same key as an extra already present in the intent it will overwrite
3182 * the extra from the intent.</p>
3183 *
3184 * <p><em>Examples:</em>
3185 * <ul>
3186 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3187 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3188 * parameters for that target.</li>
3189 * <li>An application may offer additional metadata for known targets of a given intent
3190 * to pass along information only relevant to that target such as account or content
3191 * identifiers already known to that application.</li>
3192 * </ul></p>
3193 */
3194 public static final String EXTRA_REPLACEMENT_EXTRAS =
3195 "android.intent.extra.REPLACEMENT_EXTRAS";
3196
3197 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003198 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3199 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3200 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3201 * {@link ComponentName} of the chosen component.
3202 *
3203 * <p>In some situations this callback may never come, for example if the user abandons
3204 * the chooser, switches to another task or any number of other reasons. Apps should not
3205 * be written assuming that this callback will always occur.</p>
3206 */
3207 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3208 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3209
3210 /**
3211 * The {@link ComponentName} chosen by the user to complete an action.
3212 *
3213 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3214 */
3215 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3216
3217 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003218 * A {@link android.view.KeyEvent} object containing the event that
3219 * triggered the creation of the Intent it is in.
3220 */
3221 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3222
3223 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003224 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3225 * before shutting down.
3226 *
3227 * {@hide}
3228 */
3229 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3230
3231 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003232 * 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 -07003233 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3234 * of restarting the application.
3235 */
3236 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3237
3238 /**
3239 * A String holding the phone number originally entered in
3240 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3241 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3242 */
3243 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003244
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003245 /**
3246 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3247 * intents to supply the uid the package had been assigned. Also an optional
3248 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3249 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3250 * purpose.
3251 */
3252 public static final String EXTRA_UID = "android.intent.extra.UID";
3253
3254 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003255 * @hide String array of package names.
3256 */
3257 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3258
3259 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003260 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3261 * intents to indicate whether this represents a full uninstall (removing
3262 * both the code and its data) or a partial uninstall (leaving its data,
3263 * implying that this is an update).
3264 */
3265 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003266
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003267 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003268 * @hide
3269 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3270 * intents to indicate that at this point the package has been removed for
3271 * all users on the device.
3272 */
3273 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3274 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3275
3276 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003277 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3278 * intents to indicate that this is a replacement of the package, so this
3279 * broadcast will immediately be followed by an add broadcast for a
3280 * different version of the same package.
3281 */
3282 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003283
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003284 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003285 * Used as an int extra field in {@link android.app.AlarmManager} intents
3286 * to tell the application being invoked how many pending alarms are being
3287 * delievered with the intent. For one-shot alarms this will always be 1.
3288 * For recurring alarms, this might be greater than 1 if the device was
3289 * asleep or powered off at the time an earlier alarm would have been
3290 * delivered.
3291 */
3292 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003293
Jacek Surazski86b6c532009-05-13 14:38:28 +02003294 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003295 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3296 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003297 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3298 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003299 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3300 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3301 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003302 */
3303 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3304
3305 /**
3306 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3307 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003308 */
3309 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3310
3311 /**
3312 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3313 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003314 */
3315 public static final int EXTRA_DOCK_STATE_DESK = 1;
3316
3317 /**
3318 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3319 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003320 */
3321 public static final int EXTRA_DOCK_STATE_CAR = 2;
3322
3323 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003324 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3325 * to represent that the phone is in a analog (low end) dock.
3326 */
3327 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3328
3329 /**
3330 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3331 * to represent that the phone is in a digital (high end) dock.
3332 */
3333 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3334
3335 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003336 * Boolean that can be supplied as meta-data with a dock activity, to
3337 * indicate that the dock should take over the home key when it is active.
3338 */
3339 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003340
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003341 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003342 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3343 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003344 */
3345 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3346
3347 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003348 * Used in the extra field in the remote intent. It's astring token passed with the
3349 * remote intent.
3350 */
3351 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3352 "android.intent.extra.remote_intent_token";
3353
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003354 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003355 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003356 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003357 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003358 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003359 "android.intent.extra.changed_component_name";
3360
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003361 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003362 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003363 * and contains a string array of all of the components that have changed. If
3364 * the state of the overall package has changed, then it will contain an entry
3365 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003366 */
3367 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3368 "android.intent.extra.changed_component_name_list";
3369
3370 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003371 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003372 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3373 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003374 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003375 */
3376 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3377 "android.intent.extra.changed_package_list";
3378
3379 /**
3380 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003381 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3382 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003383 * and contains an integer array of uids of all of the components
3384 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003385 */
3386 public static final String EXTRA_CHANGED_UID_LIST =
3387 "android.intent.extra.changed_uid_list";
3388
3389 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003390 * @hide
3391 * Magic extra system code can use when binding, to give a label for
3392 * who it is that has bound to a service. This is an integer giving
3393 * a framework string resource that can be displayed to the user.
3394 */
3395 public static final String EXTRA_CLIENT_LABEL =
3396 "android.intent.extra.client_label";
3397
3398 /**
3399 * @hide
3400 * Magic extra system code can use when binding, to give a PendingIntent object
3401 * that can be launched for the user to disable the system's use of this
3402 * service.
3403 */
3404 public static final String EXTRA_CLIENT_INTENT =
3405 "android.intent.extra.client_intent";
3406
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003407 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003408 * Extra used to indicate that an intent should only return data that is on
3409 * the local device. This is a boolean extra; the default is false. If true,
3410 * an implementation should only allow the user to select data that is
3411 * already on the device, not requiring it be downloaded from a remote
3412 * service when opened.
3413 *
3414 * @see #ACTION_GET_CONTENT
3415 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003416 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003417 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003418 */
3419 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003420 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003421
Amith Yamasani13593602012-03-22 16:16:17 -07003422 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003423 * Extra used to indicate that an intent can allow the user to select and
3424 * return multiple items. This is a boolean extra; the default is false. If
3425 * true, an implementation is allowed to present the user with a UI where
3426 * they can pick multiple items that are all returned to the caller. When
3427 * this happens, they should be returned as the {@link #getClipData()} part
3428 * of the result Intent.
3429 *
3430 * @see #ACTION_GET_CONTENT
3431 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003432 */
3433 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003434 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003435
3436 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003437 * The integer userHandle carried with broadcast intents related to addition, removal and
3438 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3439 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3440 *
Amith Yamasani13593602012-03-22 16:16:17 -07003441 * @hide
3442 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003443 public static final String EXTRA_USER_HANDLE =
3444 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003445
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003446 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003447 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3448 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3449 */
3450 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01003451 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003452
3453 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003454 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003455 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3456 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003457 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003458 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3459
3460 /**
3461 * Extra sent in the intent to the BroadcastReceiver that handles
3462 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3463 * the restrictions as key/value pairs.
3464 */
3465 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3466 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003467
Amith Yamasani86118ba2013-03-28 14:33:16 -07003468 /**
3469 * Extra used in the response from a BroadcastReceiver that handles
3470 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3471 */
3472 public static final String EXTRA_RESTRICTIONS_INTENT =
3473 "android.intent.extra.restrictions_intent";
3474
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003475 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003476 * Extra used to communicate a set of acceptable MIME types. The type of the
3477 * extra is {@code String[]}. Values may be a combination of concrete MIME
3478 * types (such as "image/png") and/or partial MIME types (such as
3479 * "audio/*").
3480 *
3481 * @see #ACTION_GET_CONTENT
3482 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003483 */
3484 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3485
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003486 /**
3487 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3488 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003489 * When this is true, hardware devices can use this information to determine that
3490 * they shouldn't do a complete shutdown of their device since this is not a
3491 * complete shutdown down to the kernel, but only user space restarting.
3492 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003493 */
3494 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3495 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3496
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003497 /**
3498 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3499 * user has set their time format preferences to the 24 hour format.
3500 *
3501 * @hide for internal use only.
3502 */
3503 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3504 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3505
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003506 /** {@hide} */
3507 public static final String EXTRA_REASON = "android.intent.extra.REASON";
3508
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003509 // ---------------------------------------------------------------------
3510 // ---------------------------------------------------------------------
3511 // Intent flags (see mFlags variable).
3512
Tor Norbyed9273d62013-05-30 15:59:53 -07003513 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003514 @IntDef(flag = true, value = {
3515 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3516 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003517 @Retention(RetentionPolicy.SOURCE)
3518 public @interface GrantUriMode {}
3519
Jeff Sharkey846318a2014-04-04 12:12:41 -07003520 /** @hide */
3521 @IntDef(flag = true, value = {
3522 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3523 @Retention(RetentionPolicy.SOURCE)
3524 public @interface AccessUriMode {}
3525
3526 /**
3527 * Test if given mode flags specify an access mode, which must be at least
3528 * read and/or write.
3529 *
3530 * @hide
3531 */
3532 public static boolean isAccessUriMode(int modeFlags) {
3533 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3534 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3535 }
3536
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003537 /**
3538 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003539 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003540 * specified in its ClipData. When applying to an Intent's ClipData,
3541 * all URIs as well as recursive traversals through data or other ClipData
3542 * in Intent items will be granted; only the grant flags of the top-level
3543 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003544 */
3545 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3546 /**
3547 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003548 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003549 * specified in its ClipData. When applying to an Intent's ClipData,
3550 * all URIs as well as recursive traversals through data or other ClipData
3551 * in Intent items will be granted; only the grant flags of the top-level
3552 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003553 */
3554 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3555 /**
3556 * Can be set by the caller to indicate that this Intent is coming from
3557 * a background operation, not from direct user interaction.
3558 */
3559 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3560 /**
3561 * A flag you can enable for debugging: when set, log messages will be
3562 * printed during the resolution of this intent to show you what has
3563 * been found to create the final resolved list.
3564 */
3565 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003566 /**
3567 * If set, this intent will not match any components in packages that
3568 * are currently stopped. If this is not set, then the default behavior
3569 * is to include such applications in the result.
3570 */
3571 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3572 /**
3573 * If set, this intent will always match any components in packages that
3574 * are currently stopped. This is the default behavior when
3575 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3576 * flags are set, this one wins (it allows overriding of exclude for
3577 * places where the framework may automatically set the exclude flag).
3578 */
3579 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003580
3581 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003582 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003583 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003584 * persisted across device reboots until explicitly revoked with
3585 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3586 * grant for possible persisting; the receiving application must call
3587 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3588 * actually persist.
3589 *
3590 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3591 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3592 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003593 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003594 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003595 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003596
3597 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003598 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3599 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3600 * applies to any URI that is a prefix match against the original granted
3601 * URI. (Without this flag, the URI must match exactly for access to be
3602 * granted.) Another URI is considered a prefix match only when scheme,
3603 * authority, and all path segments defined by the prefix are an exact
3604 * match.
3605 */
3606 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3607
3608 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003609 * If set, the new activity is not kept in the history stack. As soon as
3610 * the user navigates away from it, the activity is finished. This may also
3611 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3612 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003613 */
3614 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3615 /**
3616 * If set, the activity will not be launched if it is already running
3617 * at the top of the history stack.
3618 */
3619 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3620 /**
3621 * If set, this activity will become the start of a new task on this
3622 * history stack. A task (from the activity that started it to the
3623 * next task activity) defines an atomic group of activities that the
3624 * user can move to. Tasks can be moved to the foreground and background;
3625 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003626 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003627 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3628 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003629 *
3630 * <p>This flag is generally used by activities that want
3631 * to present a "launcher" style behavior: they give the user a list of
3632 * separate things that can be done, which otherwise run completely
3633 * independently of the activity launching them.
3634 *
3635 * <p>When using this flag, if a task is already running for the activity
3636 * you are now starting, then a new activity will not be started; instead,
3637 * the current task will simply be brought to the front of the screen with
3638 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3639 * to disable this behavior.
3640 *
3641 * <p>This flag can not be used when the caller is requesting a result from
3642 * the activity being launched.
3643 */
3644 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3645 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003646 * This flag is used to create a new task and launch an activity into it.
3647 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3648 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3649 * search through existing tasks for ones matching this Intent. Only if no such
3650 * task is found would a new task be created. When paired with
3651 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3652 * the search for a matching task and unconditionally start a new task.
3653 *
3654 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3655 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003656 * top-level application launcher.</strong> Used in conjunction with
3657 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3658 * behavior of bringing an existing task to the foreground. When set,
3659 * a new task is <em>always</em> started to host the Activity for the
3660 * Intent, regardless of whether there is already an existing task running
3661 * the same thing.
3662 *
3663 * <p><strong>Because the default system does not include graphical task management,
3664 * you should not use this flag unless you provide some way for a user to
3665 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003666 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003667 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3668 * creating new document tasks.
3669 *
3670 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07003671 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003672 *
Scott Main7aee61f2011-02-08 11:25:01 -08003673 * <p>See
3674 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3675 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003676 *
3677 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3678 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003679 */
3680 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3681 /**
3682 * If set, and the activity being launched is already running in the
3683 * current task, then instead of launching a new instance of that activity,
3684 * all of the other activities on top of it will be closed and this Intent
3685 * will be delivered to the (now on top) old activity as a new Intent.
3686 *
3687 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3688 * If D calls startActivity() with an Intent that resolves to the component
3689 * of activity B, then C and D will be finished and B receive the given
3690 * Intent, resulting in the stack now being: A, B.
3691 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003692 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003693 * either receive the new intent you are starting here in its
3694 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003695 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003696 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3697 * the same intent, then it will be finished and re-created; for all other
3698 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3699 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003700 *
3701 * <p>This launch mode can also be used to good effect in conjunction with
3702 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3703 * of a task, it will bring any currently running instance of that task
3704 * to the foreground, and then clear it to its root state. This is
3705 * especially useful, for example, when launching an activity from the
3706 * notification manager.
3707 *
Scott Main7aee61f2011-02-08 11:25:01 -08003708 * <p>See
3709 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3710 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003711 */
3712 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3713 /**
3714 * If set and this intent is being used to launch a new activity from an
3715 * existing one, then the reply target of the existing activity will be
3716 * transfered to the new activity. This way the new activity can call
3717 * {@link android.app.Activity#setResult} and have that result sent back to
3718 * the reply target of the original activity.
3719 */
3720 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3721 /**
3722 * If set and this intent is being used to launch a new activity from an
3723 * existing one, the current activity will not be counted as the top
3724 * activity for deciding whether the new intent should be delivered to
3725 * the top instead of starting a new one. The previous activity will
3726 * be used as the top, with the assumption being that the current activity
3727 * will finish itself immediately.
3728 */
3729 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3730 /**
3731 * If set, the new activity is not kept in the list of recently launched
3732 * activities.
3733 */
3734 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3735 /**
3736 * This flag is not normally set by application code, but set for you by
3737 * the system as described in the
3738 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3739 * launchMode} documentation for the singleTask mode.
3740 */
3741 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3742 /**
3743 * If set, and this activity is either being started in a new task or
3744 * bringing to the top an existing task, then it will be launched as
3745 * the front door of the task. This will result in the application of
3746 * any affinities needed to have that task in the proper state (either
3747 * moving activities to or from it), or simply resetting that task to
3748 * its initial state if needed.
3749 */
3750 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3751 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003752 * This flag is not normally set by application code, but set for you by
3753 * the system if this activity is being launched from history
3754 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003755 */
3756 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003757 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003758 * @deprecated As of API 21 this performs identically to
3759 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003760 */
3761 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003762 /**
Craig Mautner026596b2014-05-21 15:35:44 -07003763 * This flag is used to open a document into a new task rooted at the activity launched
3764 * by this Intent. Through the use of this flag, or its equivalent attribute,
3765 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00003766 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003767 *
Craig Mautner026596b2014-05-21 15:35:44 -07003768 * <p>The use of the activity attribute form of this,
3769 * {@link android.R.attr#documentLaunchMode}, is
3770 * preferred over the Intent flag described here. The attribute form allows the
3771 * Activity to specify multiple document behavior for all launchers of the Activity
3772 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003773 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07003774 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
3775 * it is kept after the activity is finished is different than the use of
3776 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
3777 * this flag is being used to create a new recents entry, then by default that entry
3778 * will be removed once the activity is finished. You can modify this behavior with
3779 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
3780 *
Craig Mautner026596b2014-05-21 15:35:44 -07003781 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
3782 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
3783 * equivalent of the Activity manifest specifying {@link
3784 * android.R.attr#documentLaunchMode}="intoExisting". When used with
3785 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
3786 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07003787 *
Craig Mautner026596b2014-05-21 15:35:44 -07003788 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003789 *
Craig Mautner026596b2014-05-21 15:35:44 -07003790 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07003791 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3792 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003793 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07003794 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003795 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003796 * callback from occurring on the current frontmost activity before it is
3797 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003798 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003799 * <p>Typically, an activity can rely on that callback to indicate that an
3800 * explicit user action has caused their activity to be moved out of the
3801 * foreground. The callback marks an appropriate point in the activity's
3802 * lifecycle for it to dismiss any notifications that it intends to display
3803 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003804 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003805 * <p>If an activity is ever started via any non-user-driven events such as
3806 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3807 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003808 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003809 */
3810 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003811 /**
3812 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3813 * this flag will cause the launched activity to be brought to the front of its
3814 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003815 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003816 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3817 * If D calls startActivity() with an Intent that resolves to the component
3818 * of activity B, then B will be brought to the front of the history stack,
3819 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003820 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003821 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003822 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003823 */
3824 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003825 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003826 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3827 * this flag will prevent the system from applying an activity transition
3828 * animation to go to the next activity state. This doesn't mean an
3829 * animation will never run -- if another activity change happens that doesn't
3830 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003831 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003832 * when you are going to do a series of activity operations but the
3833 * animation seen by the user shouldn't be driven by the first activity
3834 * change but rather a later one.
3835 */
3836 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3837 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003838 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3839 * this flag will cause any existing task that would be associated with the
3840 * activity to be cleared before the activity is started. That is, the activity
3841 * becomes the new root of an otherwise empty task, and any old activities
3842 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3843 */
3844 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3845 /**
3846 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3847 * this flag will cause a newly launching task to be placed on top of the current
3848 * home activity task (if there is one). That is, pressing back from the task
3849 * will always return the user to home even if that was not the last activity they
3850 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3851 */
3852 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3853 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07003854 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
3855 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003856 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07003857 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003858 * this flag. When set and the task's activity is finished, the recents
3859 * entry will remain in the interface for the user to re-launch it, like a
3860 * recents entry for a top-level application.
3861 * <p>
3862 * The receiving activity can override this request with
3863 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
3864 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07003865 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07003866 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07003867 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07003868
3869 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003870 * If set, when sending a broadcast only registered receivers will be
3871 * called -- no BroadcastReceiver components will be launched.
3872 */
3873 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003874 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003875 * If set, when sending a broadcast the new broadcast will replace
3876 * any existing pending broadcast that matches it. Matching is defined
3877 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3878 * true for the intents of the two broadcasts. When a match is found,
3879 * the new broadcast (and receivers associated with it) will replace the
3880 * existing one in the pending broadcast list, remaining at the same
3881 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003882 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003883 * <p>This flag is most typically used with sticky broadcasts, which
3884 * only care about delivering the most recent values of the broadcast
3885 * to their receivers.
3886 */
3887 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3888 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003889 * If set, when sending a broadcast the recipient is allowed to run at
3890 * foreground priority, with a shorter timeout interval. During normal
3891 * broadcasts the receivers are not automatically hoisted out of the
3892 * background priority class.
3893 */
3894 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3895 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003896 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3897 * They can still propagate results through to later receivers, but they can not prevent
3898 * later receivers from seeing the broadcast.
3899 */
3900 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3901 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003902 * If set, when sending a broadcast <i>before boot has completed</i> only
3903 * registered receivers will be called -- no BroadcastReceiver components
3904 * will be launched. Sticky intent state will be recorded properly even
3905 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3906 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003907 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003908 * <p>This flag is only for use by system sevices as a convenience to
3909 * avoid having to implement a more complex mechanism around detection
3910 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003911 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003912 * @hide
3913 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003914 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003915 /**
3916 * Set when this broadcast is for a boot upgrade, a special mode that
3917 * allows the broadcast to be sent before the system is ready and launches
3918 * the app process with no providers running in it.
3919 * @hide
3920 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003921 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003922
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003923 /**
3924 * @hide Flags that can't be changed with PendingIntent.
3925 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003926 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
3927 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
3928 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003929
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003930 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003931 // ---------------------------------------------------------------------
3932 // toUri() and parseUri() options.
3933
3934 /**
3935 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3936 * always has the "intent:" scheme. This syntax can be used when you want
3937 * to later disambiguate between URIs that are intended to describe an
3938 * Intent vs. all others that should be treated as raw URIs. When used
3939 * with {@link #parseUri}, any other scheme will result in a generic
3940 * VIEW action for that raw URI.
3941 */
3942 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003943
Dianne Hackborn85d558c2014-11-04 10:31:54 -08003944 /**
3945 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3946 * always has the "android-app:" scheme. This is a variation of
3947 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
3948 * http/https URI being delivered to a specific package name. The format
3949 * is:
3950 *
3951 * <pre class="prettyprint">
3952 * android-app://{package_id}/{scheme}/{host}/{path}{#Intent;...}</pre>
3953 *
3954 * <p>In this scheme, only the <code>pacakge_id</code> is required, and all
3955 * other components can be included as desired. Note that this can not be
3956 * used with intents that have a {@link #setSelector}, since the base intent
3957 * will always have an explicit package name.</p>
3958 *
3959 * <p>Some examples of how this scheme maps to Intent objects:</p>
3960 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
3961 * <colgroup align="left" />
3962 * <colgroup align="left" />
3963 * <thead>
3964 * <tr><th>URI</th> <th>Intent</th></tr>
3965 * </thead>
3966 *
3967 * <tbody>
3968 * <tr><td><code>android-app://com.example.app</code></td>
3969 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
3970 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
3971 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
3972 * </table></td>
3973 * </tr>
3974 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
3975 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
3976 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
3977 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
3978 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
3979 * </table></td>
3980 * </tr>
3981 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
3982 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
3983 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
3984 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
3985 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
3986 * </table></td>
3987 * </tr>
3988 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
3989 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
3990 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
3991 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
3992 * </table></td>
3993 * </tr>
3994 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
3995 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
3996 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
3997 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
3998 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
3999 * </table></td>
4000 * </tr>
4001 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;<br />i.some_int=100;S.some_str=hello;end</code></td>
4002 * <td><table border="" style="margin:0" >
4003 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4004 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4005 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4006 * </table></td>
4007 * </tr>
4008 * </tbody>
4009 * </table>
4010 */
4011 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4012
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004013 /**
4014 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4015 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4016 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4017 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4018 * generated Intent can not cause unexpected data access to happen.
4019 *
4020 * <p>If you do not trust the source of the URI being parsed, you should still do further
4021 * processing to protect yourself from it. In particular, when using it to start an
4022 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4023 * that can handle it.</p>
4024 */
4025 public static final int URI_ALLOW_UNSAFE = 1<<2;
4026
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004027 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004028
4029 private String mAction;
4030 private Uri mData;
4031 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004032 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004033 private ComponentName mComponent;
4034 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004035 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004036 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004037 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004038 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004039 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004040 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004041
4042 // ---------------------------------------------------------------------
4043
4044 /**
4045 * Create an empty intent.
4046 */
4047 public Intent() {
4048 }
4049
4050 /**
4051 * Copy constructor.
4052 */
4053 public Intent(Intent o) {
4054 this.mAction = o.mAction;
4055 this.mData = o.mData;
4056 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004057 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004058 this.mComponent = o.mComponent;
4059 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004060 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004061 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004062 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004063 }
4064 if (o.mExtras != null) {
4065 this.mExtras = new Bundle(o.mExtras);
4066 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004067 if (o.mSourceBounds != null) {
4068 this.mSourceBounds = new Rect(o.mSourceBounds);
4069 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004070 if (o.mSelector != null) {
4071 this.mSelector = new Intent(o.mSelector);
4072 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004073 if (o.mClipData != null) {
4074 this.mClipData = new ClipData(o.mClipData);
4075 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004076 }
4077
4078 @Override
4079 public Object clone() {
4080 return new Intent(this);
4081 }
4082
4083 private Intent(Intent o, boolean all) {
4084 this.mAction = o.mAction;
4085 this.mData = o.mData;
4086 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004087 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004088 this.mComponent = o.mComponent;
4089 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004090 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004091 }
4092 }
4093
4094 /**
4095 * Make a clone of only the parts of the Intent that are relevant for
4096 * filter matching: the action, data, type, component, and categories.
4097 */
4098 public Intent cloneFilter() {
4099 return new Intent(this, false);
4100 }
4101
4102 /**
4103 * Create an intent with a given action. All other fields (data, type,
4104 * class) are null. Note that the action <em>must</em> be in a
4105 * namespace because Intents are used globally in the system -- for
4106 * example the system VIEW action is android.intent.action.VIEW; an
4107 * application's custom action would be something like
4108 * com.google.app.myapp.CUSTOM_ACTION.
4109 *
4110 * @param action The Intent action, such as ACTION_VIEW.
4111 */
4112 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004113 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004114 }
4115
4116 /**
4117 * Create an intent with a given action and for a given data url. Note
4118 * that the action <em>must</em> be in a namespace because Intents are
4119 * used globally in the system -- for example the system VIEW action is
4120 * android.intent.action.VIEW; an application's custom action would be
4121 * something like com.google.app.myapp.CUSTOM_ACTION.
4122 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004123 * <p><em>Note: scheme and host name matching in the Android framework is
4124 * case-sensitive, unlike the formal RFC. As a result,
4125 * you should always ensure that you write your Uri with these elements
4126 * using lower case letters, and normalize any Uris you receive from
4127 * outside of Android to ensure the scheme and host is lower case.</em></p>
4128 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004129 * @param action The Intent action, such as ACTION_VIEW.
4130 * @param uri The Intent data URI.
4131 */
4132 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004133 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004134 mData = uri;
4135 }
4136
4137 /**
4138 * Create an intent for a specific component. All other fields (action, data,
4139 * type, class) are null, though they can be modified later with explicit
4140 * calls. This provides a convenient way to create an intent that is
4141 * intended to execute a hard-coded class name, rather than relying on the
4142 * system to find an appropriate class for you; see {@link #setComponent}
4143 * for more information on the repercussions of this.
4144 *
4145 * @param packageContext A Context of the application package implementing
4146 * this class.
4147 * @param cls The component class that is to be used for the intent.
4148 *
4149 * @see #setClass
4150 * @see #setComponent
4151 * @see #Intent(String, android.net.Uri , Context, Class)
4152 */
4153 public Intent(Context packageContext, Class<?> cls) {
4154 mComponent = new ComponentName(packageContext, cls);
4155 }
4156
4157 /**
4158 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004159 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004160 * construct the Intent and then calling {@link #setClass} to set its
4161 * class.
4162 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004163 * <p><em>Note: scheme and host name matching in the Android framework is
4164 * case-sensitive, unlike the formal RFC. As a result,
4165 * you should always ensure that you write your Uri with these elements
4166 * using lower case letters, and normalize any Uris you receive from
4167 * outside of Android to ensure the scheme and host is lower case.</em></p>
4168 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004169 * @param action The Intent action, such as ACTION_VIEW.
4170 * @param uri The Intent data URI.
4171 * @param packageContext A Context of the application package implementing
4172 * this class.
4173 * @param cls The component class that is to be used for the intent.
4174 *
4175 * @see #Intent(String, android.net.Uri)
4176 * @see #Intent(Context, Class)
4177 * @see #setClass
4178 * @see #setComponent
4179 */
4180 public Intent(String action, Uri uri,
4181 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004182 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004183 mData = uri;
4184 mComponent = new ComponentName(packageContext, cls);
4185 }
4186
4187 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004188 * Create an intent to launch the main (root) activity of a task. This
4189 * is the Intent that is started when the application's is launched from
4190 * Home. For anything else that wants to launch an application in the
4191 * same way, it is important that they use an Intent structured the same
4192 * way, and can use this function to ensure this is the case.
4193 *
4194 * <p>The returned Intent has the given Activity component as its explicit
4195 * component, {@link #ACTION_MAIN} as its action, and includes the
4196 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4197 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4198 * to do that through {@link #addFlags(int)} on the returned Intent.
4199 *
4200 * @param mainActivity The main activity component that this Intent will
4201 * launch.
4202 * @return Returns a newly created Intent that can be used to launch the
4203 * activity as a main application entry.
4204 *
4205 * @see #setClass
4206 * @see #setComponent
4207 */
4208 public static Intent makeMainActivity(ComponentName mainActivity) {
4209 Intent intent = new Intent(ACTION_MAIN);
4210 intent.setComponent(mainActivity);
4211 intent.addCategory(CATEGORY_LAUNCHER);
4212 return intent;
4213 }
4214
4215 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004216 * Make an Intent for the main activity of an application, without
4217 * specifying a specific activity to run but giving a selector to find
4218 * the activity. This results in a final Intent that is structured
4219 * the same as when the application is launched from
4220 * Home. For anything else that wants to launch an application in the
4221 * same way, it is important that they use an Intent structured the same
4222 * way, and can use this function to ensure this is the case.
4223 *
4224 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4225 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4226 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4227 * to do that through {@link #addFlags(int)} on the returned Intent.
4228 *
4229 * @param selectorAction The action name of the Intent's selector.
4230 * @param selectorCategory The name of a category to add to the Intent's
4231 * selector.
4232 * @return Returns a newly created Intent that can be used to launch the
4233 * activity as a main application entry.
4234 *
4235 * @see #setSelector(Intent)
4236 */
4237 public static Intent makeMainSelectorActivity(String selectorAction,
4238 String selectorCategory) {
4239 Intent intent = new Intent(ACTION_MAIN);
4240 intent.addCategory(CATEGORY_LAUNCHER);
4241 Intent selector = new Intent();
4242 selector.setAction(selectorAction);
4243 selector.addCategory(selectorCategory);
4244 intent.setSelector(selector);
4245 return intent;
4246 }
4247
4248 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004249 * Make an Intent that can be used to re-launch an application's task
4250 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4251 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4252 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4253 *
4254 * @param mainActivity The activity component that is the root of the
4255 * task; this is the activity that has been published in the application's
4256 * manifest as the main launcher icon.
4257 *
4258 * @return Returns a newly created Intent that can be used to relaunch the
4259 * activity's task in its root state.
4260 */
4261 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4262 Intent intent = makeMainActivity(mainActivity);
4263 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4264 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4265 return intent;
4266 }
4267
4268 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004269 * Call {@link #parseUri} with 0 flags.
4270 * @deprecated Use {@link #parseUri} instead.
4271 */
4272 @Deprecated
4273 public static Intent getIntent(String uri) throws URISyntaxException {
4274 return parseUri(uri, 0);
4275 }
Tom Taylord4a47292009-12-21 13:59:18 -08004276
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004277 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004278 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004279 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004280 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004281 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004282 *
4283 * <p>The URI given here must not be relative -- that is, it must include
4284 * the scheme and full path.
4285 *
4286 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004287 * @param flags Additional processing flags. Either 0,
4288 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004289 *
4290 * @return Intent The newly created Intent object.
4291 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004292 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4293 * it bad (as parsed by the Uri class) or the Intent data within the
4294 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004295 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004296 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004297 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004298 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004299 int i = 0;
4300 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004301 final boolean androidApp = uri.startsWith("android-app:");
4302
4303 // Validate intent scheme if requested.
4304 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
4305 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004306 Intent intent = new Intent(ACTION_VIEW);
4307 try {
4308 intent.setData(Uri.parse(uri));
4309 } catch (IllegalArgumentException e) {
4310 throw new URISyntaxException(uri, e.getMessage());
4311 }
4312 return intent;
4313 }
4314 }
Tom Taylord4a47292009-12-21 13:59:18 -08004315
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004316 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004317 // simple case
4318 if (i == -1) {
4319 if (!androidApp) {
4320 return new Intent(ACTION_VIEW, Uri.parse(uri));
4321 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004322
4323 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004324 } else if (!uri.startsWith("#Intent;", i)) {
4325 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004326 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004327 } else {
4328 i = -1;
4329 }
4330 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004331
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004332 // new format
4333 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004334 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004335 boolean explicitAction = false;
4336 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004337
4338 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004339 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004340 String data;
4341 if (i >= 0) {
4342 data = uri.substring(0, i);
4343 i += 8; // length of "#Intent;"
4344 } else {
4345 data = uri;
4346 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004347
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004348 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004349 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004350 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004351 if (eq < 0) eq = i-1;
4352 int semi = uri.indexOf(';', i);
4353 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004354
4355 // action
4356 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004357 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004358 if (!inSelector) {
4359 explicitAction = true;
4360 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004361 }
4362
4363 // categories
4364 else if (uri.startsWith("category=", i)) {
4365 intent.addCategory(value);
4366 }
4367
4368 // type
4369 else if (uri.startsWith("type=", i)) {
4370 intent.mType = value;
4371 }
4372
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004373 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004374 else if (uri.startsWith("launchFlags=", i)) {
4375 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004376 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4377 intent.mFlags &= ~IMMUTABLE_FLAGS;
4378 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004379 }
4380
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004381 // package
4382 else if (uri.startsWith("package=", i)) {
4383 intent.mPackage = value;
4384 }
4385
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004386 // component
4387 else if (uri.startsWith("component=", i)) {
4388 intent.mComponent = ComponentName.unflattenFromString(value);
4389 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004390
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004391 // scheme
4392 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004393 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004394 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004395 } else {
4396 scheme = value;
4397 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004398 }
4399
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004400 // source bounds
4401 else if (uri.startsWith("sourceBounds=", i)) {
4402 intent.mSourceBounds = Rect.unflattenFromString(value);
4403 }
4404
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004405 // selector
4406 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4407 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004408 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004409 }
4410
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004411 // extra
4412 else {
4413 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004414 // create Bundle if it doesn't already exist
4415 if (intent.mExtras == null) intent.mExtras = new Bundle();
4416 Bundle b = intent.mExtras;
4417 // add EXTRA
4418 if (uri.startsWith("S.", i)) b.putString(key, value);
4419 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4420 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4421 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4422 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4423 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4424 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4425 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4426 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4427 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4428 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004429
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004430 // move to the next item
4431 i = semi + 1;
4432 }
4433
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004434 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004435 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004436 if (baseIntent.mPackage == null) {
4437 baseIntent.setSelector(intent);
4438 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004439 intent = baseIntent;
4440 }
4441
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004442 if (data != null) {
4443 if (data.startsWith("intent:")) {
4444 data = data.substring(7);
4445 if (scheme != null) {
4446 data = scheme + ':' + data;
4447 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004448 } else if (data.startsWith("android-app:")) {
4449 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
4450 // Correctly formed android-app, first part is package name.
4451 int end = data.indexOf('/', 14);
4452 if (end < 0) {
4453 // All we have is a package name.
4454 intent.mPackage = data.substring(14);
4455 if (!explicitAction) {
4456 intent.setAction(ACTION_MAIN);
4457 }
4458 data = "";
4459 } else {
4460 // Target the Intent at the given package name always.
4461 String authority = null;
4462 intent.mPackage = data.substring(14, end);
4463 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004464 if ((end+1) < data.length()) {
4465 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
4466 // Found a scheme, remember it.
4467 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004468 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004469 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
4470 // Found a authority, remember it.
4471 authority = data.substring(end+1, newEnd);
4472 end = newEnd;
4473 }
4474 } else {
4475 // All we have is a scheme.
4476 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004477 }
4478 }
4479 if (scheme == null) {
4480 // If there was no scheme, then this just targets the package.
4481 if (!explicitAction) {
4482 intent.setAction(ACTION_MAIN);
4483 }
4484 data = "";
4485 } else if (authority == null) {
4486 data = scheme + ":";
4487 } else {
4488 data = scheme + "://" + authority + data.substring(end);
4489 }
4490 }
4491 } else {
4492 data = "";
4493 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004494 }
Tom Taylord4a47292009-12-21 13:59:18 -08004495
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004496 if (data.length() > 0) {
4497 try {
4498 intent.mData = Uri.parse(data);
4499 } catch (IllegalArgumentException e) {
4500 throw new URISyntaxException(uri, e.getMessage());
4501 }
4502 }
4503 }
Tom Taylord4a47292009-12-21 13:59:18 -08004504
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004505 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004506
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004507 } catch (IndexOutOfBoundsException e) {
4508 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4509 }
4510 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004511
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004512 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004513 return getIntentOld(uri, 0);
4514 }
4515
4516 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004517 Intent intent;
4518
4519 int i = uri.lastIndexOf('#');
4520 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004521 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004522 final int intentFragmentStart = i;
4523 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004524
4525 i++;
4526
4527 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004528 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004529 i += 7;
4530 int j = uri.indexOf(')', i);
4531 action = uri.substring(i, j);
4532 i = j + 1;
4533 }
4534
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004535 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004536
4537 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004538 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004539 i += 11;
4540 int j = uri.indexOf(')', i);
4541 while (i < j) {
4542 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07004543 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004544 if (i < sep) {
4545 intent.addCategory(uri.substring(i, sep));
4546 }
4547 i = sep + 1;
4548 }
4549 i = j + 1;
4550 }
4551
4552 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004553 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004554 i += 5;
4555 int j = uri.indexOf(')', i);
4556 intent.mType = uri.substring(i, j);
4557 i = j + 1;
4558 }
4559
4560 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004561 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004562 i += 12;
4563 int j = uri.indexOf(')', i);
4564 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004565 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4566 intent.mFlags &= ~IMMUTABLE_FLAGS;
4567 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004568 i = j + 1;
4569 }
4570
4571 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004572 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004573 i += 10;
4574 int j = uri.indexOf(')', i);
4575 int sep = uri.indexOf('!', i);
4576 if (sep >= 0 && sep < j) {
4577 String pkg = uri.substring(i, sep);
4578 String cls = uri.substring(sep + 1, j);
4579 intent.mComponent = new ComponentName(pkg, cls);
4580 }
4581 i = j + 1;
4582 }
4583
4584 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004585 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004586 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004587
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004588 final int closeParen = uri.indexOf(')', i);
4589 if (closeParen == -1) throw new URISyntaxException(uri,
4590 "EXTRA missing trailing ')'", i);
4591
4592 while (i < closeParen) {
4593 // fetch the key value
4594 int j = uri.indexOf('=', i);
4595 if (j <= i + 1 || i >= closeParen) {
4596 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4597 }
4598 char type = uri.charAt(i);
4599 i++;
4600 String key = uri.substring(i, j);
4601 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004602
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004603 // get type-value
4604 j = uri.indexOf('!', i);
4605 if (j == -1 || j >= closeParen) j = closeParen;
4606 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4607 String value = uri.substring(i, j);
4608 i = j;
4609
4610 // create Bundle if it doesn't already exist
4611 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004612
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004613 // add item to bundle
4614 try {
4615 switch (type) {
4616 case 'S':
4617 intent.mExtras.putString(key, Uri.decode(value));
4618 break;
4619 case 'B':
4620 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4621 break;
4622 case 'b':
4623 intent.mExtras.putByte(key, Byte.parseByte(value));
4624 break;
4625 case 'c':
4626 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4627 break;
4628 case 'd':
4629 intent.mExtras.putDouble(key, Double.parseDouble(value));
4630 break;
4631 case 'f':
4632 intent.mExtras.putFloat(key, Float.parseFloat(value));
4633 break;
4634 case 'i':
4635 intent.mExtras.putInt(key, Integer.parseInt(value));
4636 break;
4637 case 'l':
4638 intent.mExtras.putLong(key, Long.parseLong(value));
4639 break;
4640 case 's':
4641 intent.mExtras.putShort(key, Short.parseShort(value));
4642 break;
4643 default:
4644 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4645 }
4646 } catch (NumberFormatException e) {
4647 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4648 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004650 char ch = uri.charAt(i);
4651 if (ch == ')') break;
4652 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4653 i++;
4654 }
4655 }
4656
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004657 if (isIntentFragment) {
4658 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4659 } else {
4660 intent.mData = Uri.parse(uri);
4661 }
Tom Taylord4a47292009-12-21 13:59:18 -08004662
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004663 if (intent.mAction == null) {
4664 // By default, if no action is specified, then use VIEW.
4665 intent.mAction = ACTION_VIEW;
4666 }
4667
4668 } else {
4669 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4670 }
4671
4672 return intent;
4673 }
4674
4675 /**
4676 * Retrieve the general action to be performed, such as
4677 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4678 * the information in the intent should be interpreted -- most importantly,
4679 * what to do with the data returned by {@link #getData}.
4680 *
4681 * @return The action of this intent or null if none is specified.
4682 *
4683 * @see #setAction
4684 */
4685 public String getAction() {
4686 return mAction;
4687 }
4688
4689 /**
4690 * Retrieve data this intent is operating on. This URI specifies the name
4691 * of the data; often it uses the content: scheme, specifying data in a
4692 * content provider. Other schemes may be handled by specific activities,
4693 * such as http: by the web browser.
4694 *
4695 * @return The URI of the data this intent is targeting or null.
4696 *
4697 * @see #getScheme
4698 * @see #setData
4699 */
4700 public Uri getData() {
4701 return mData;
4702 }
4703
4704 /**
4705 * The same as {@link #getData()}, but returns the URI as an encoded
4706 * String.
4707 */
4708 public String getDataString() {
4709 return mData != null ? mData.toString() : null;
4710 }
4711
4712 /**
4713 * Return the scheme portion of the intent's data. If the data is null or
4714 * does not include a scheme, null is returned. Otherwise, the scheme
4715 * prefix without the final ':' is returned, i.e. "http".
4716 *
4717 * <p>This is the same as calling getData().getScheme() (and checking for
4718 * null data).
4719 *
4720 * @return The scheme of this intent.
4721 *
4722 * @see #getData
4723 */
4724 public String getScheme() {
4725 return mData != null ? mData.getScheme() : null;
4726 }
4727
4728 /**
4729 * Retrieve any explicit MIME type included in the intent. This is usually
4730 * null, as the type is determined by the intent data.
4731 *
4732 * @return If a type was manually set, it is returned; else null is
4733 * returned.
4734 *
4735 * @see #resolveType(ContentResolver)
4736 * @see #setType
4737 */
4738 public String getType() {
4739 return mType;
4740 }
4741
4742 /**
4743 * Return the MIME data type of this intent. If the type field is
4744 * explicitly set, that is simply returned. Otherwise, if the data is set,
4745 * the type of that data is returned. If neither fields are set, a null is
4746 * returned.
4747 *
4748 * @return The MIME type of this intent.
4749 *
4750 * @see #getType
4751 * @see #resolveType(ContentResolver)
4752 */
4753 public String resolveType(Context context) {
4754 return resolveType(context.getContentResolver());
4755 }
4756
4757 /**
4758 * Return the MIME data type of this intent. If the type field is
4759 * explicitly set, that is simply returned. Otherwise, if the data is set,
4760 * the type of that data is returned. If neither fields are set, a null is
4761 * returned.
4762 *
4763 * @param resolver A ContentResolver that can be used to determine the MIME
4764 * type of the intent's data.
4765 *
4766 * @return The MIME type of this intent.
4767 *
4768 * @see #getType
4769 * @see #resolveType(Context)
4770 */
4771 public String resolveType(ContentResolver resolver) {
4772 if (mType != null) {
4773 return mType;
4774 }
4775 if (mData != null) {
4776 if ("content".equals(mData.getScheme())) {
4777 return resolver.getType(mData);
4778 }
4779 }
4780 return null;
4781 }
4782
4783 /**
4784 * Return the MIME data type of this intent, only if it will be needed for
4785 * intent resolution. This is not generally useful for application code;
4786 * it is used by the frameworks for communicating with back-end system
4787 * services.
4788 *
4789 * @param resolver A ContentResolver that can be used to determine the MIME
4790 * type of the intent's data.
4791 *
4792 * @return The MIME type of this intent, or null if it is unknown or not
4793 * needed.
4794 */
4795 public String resolveTypeIfNeeded(ContentResolver resolver) {
4796 if (mComponent != null) {
4797 return mType;
4798 }
4799 return resolveType(resolver);
4800 }
4801
4802 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004803 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004804 *
4805 * @param category The category to check.
4806 *
4807 * @return boolean True if the intent contains the category, else false.
4808 *
4809 * @see #getCategories
4810 * @see #addCategory
4811 */
4812 public boolean hasCategory(String category) {
4813 return mCategories != null && mCategories.contains(category);
4814 }
4815
4816 /**
4817 * Return the set of all categories in the intent. If there are no categories,
4818 * returns NULL.
4819 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004820 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004821 *
4822 * @see #hasCategory
4823 * @see #addCategory
4824 */
4825 public Set<String> getCategories() {
4826 return mCategories;
4827 }
4828
4829 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004830 * Return the specific selector associated with this Intent. If there is
4831 * none, returns null. See {@link #setSelector} for more information.
4832 *
4833 * @see #setSelector
4834 */
4835 public Intent getSelector() {
4836 return mSelector;
4837 }
4838
4839 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004840 * Return the {@link ClipData} associated with this Intent. If there is
4841 * none, returns null. See {@link #setClipData} for more information.
4842 *
John Spurlock125d1332013-11-25 11:58:37 -05004843 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004844 */
4845 public ClipData getClipData() {
4846 return mClipData;
4847 }
4848
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004849 /** @hide */
4850 public int getContentUserHint() {
4851 return mContentUserHint;
4852 }
4853
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004854 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004855 * Sets the ClassLoader that will be used when unmarshalling
4856 * any Parcelable values from the extras of this Intent.
4857 *
4858 * @param loader a ClassLoader, or null to use the default loader
4859 * at the time of unmarshalling.
4860 */
4861 public void setExtrasClassLoader(ClassLoader loader) {
4862 if (mExtras != null) {
4863 mExtras.setClassLoader(loader);
4864 }
4865 }
4866
4867 /**
4868 * Returns true if an extra value is associated with the given name.
4869 * @param name the extra's name
4870 * @return true if the given extra is present.
4871 */
4872 public boolean hasExtra(String name) {
4873 return mExtras != null && mExtras.containsKey(name);
4874 }
4875
4876 /**
4877 * Returns true if the Intent's extras contain a parcelled file descriptor.
4878 * @return true if the Intent contains a parcelled file descriptor.
4879 */
4880 public boolean hasFileDescriptors() {
4881 return mExtras != null && mExtras.hasFileDescriptors();
4882 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004883
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004884 /** @hide */
4885 public void setAllowFds(boolean allowFds) {
4886 if (mExtras != null) {
4887 mExtras.setAllowFds(allowFds);
4888 }
4889 }
4890
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004891 /**
4892 * Retrieve extended data from the intent.
4893 *
4894 * @param name The name of the desired item.
4895 *
4896 * @return the value of an item that previously added with putExtra()
4897 * or null if none was found.
4898 *
4899 * @deprecated
4900 * @hide
4901 */
4902 @Deprecated
4903 public Object getExtra(String name) {
4904 return getExtra(name, null);
4905 }
4906
4907 /**
4908 * Retrieve extended data from the intent.
4909 *
4910 * @param name The name of the desired item.
4911 * @param defaultValue the value to be returned if no value of the desired
4912 * type is stored with the given name.
4913 *
4914 * @return the value of an item that previously added with putExtra()
4915 * or the default value if none was found.
4916 *
4917 * @see #putExtra(String, boolean)
4918 */
4919 public boolean getBooleanExtra(String name, boolean defaultValue) {
4920 return mExtras == null ? defaultValue :
4921 mExtras.getBoolean(name, defaultValue);
4922 }
4923
4924 /**
4925 * Retrieve extended data from the intent.
4926 *
4927 * @param name The name of the desired item.
4928 * @param defaultValue the value to be returned if no value of the desired
4929 * type is stored with the given name.
4930 *
4931 * @return the value of an item that previously added with putExtra()
4932 * or the default value if none was found.
4933 *
4934 * @see #putExtra(String, byte)
4935 */
4936 public byte getByteExtra(String name, byte defaultValue) {
4937 return mExtras == null ? defaultValue :
4938 mExtras.getByte(name, defaultValue);
4939 }
4940
4941 /**
4942 * Retrieve extended data from the intent.
4943 *
4944 * @param name The name of the desired item.
4945 * @param defaultValue the value to be returned if no value of the desired
4946 * type is stored with the given name.
4947 *
4948 * @return the value of an item that previously added with putExtra()
4949 * or the default value if none was found.
4950 *
4951 * @see #putExtra(String, short)
4952 */
4953 public short getShortExtra(String name, short defaultValue) {
4954 return mExtras == null ? defaultValue :
4955 mExtras.getShort(name, defaultValue);
4956 }
4957
4958 /**
4959 * Retrieve extended data from the intent.
4960 *
4961 * @param name The name of the desired item.
4962 * @param defaultValue the value to be returned if no value of the desired
4963 * type is stored with the given name.
4964 *
4965 * @return the value of an item that previously added with putExtra()
4966 * or the default value if none was found.
4967 *
4968 * @see #putExtra(String, char)
4969 */
4970 public char getCharExtra(String name, char defaultValue) {
4971 return mExtras == null ? defaultValue :
4972 mExtras.getChar(name, defaultValue);
4973 }
4974
4975 /**
4976 * Retrieve extended data from the intent.
4977 *
4978 * @param name The name of the desired item.
4979 * @param defaultValue the value to be returned if no value of the desired
4980 * type is stored with the given name.
4981 *
4982 * @return the value of an item that previously added with putExtra()
4983 * or the default value if none was found.
4984 *
4985 * @see #putExtra(String, int)
4986 */
4987 public int getIntExtra(String name, int defaultValue) {
4988 return mExtras == null ? defaultValue :
4989 mExtras.getInt(name, defaultValue);
4990 }
4991
4992 /**
4993 * Retrieve extended data from the intent.
4994 *
4995 * @param name The name of the desired item.
4996 * @param defaultValue the value to be returned if no value of the desired
4997 * type is stored with the given name.
4998 *
4999 * @return the value of an item that previously added with putExtra()
5000 * or the default value if none was found.
5001 *
5002 * @see #putExtra(String, long)
5003 */
5004 public long getLongExtra(String name, long defaultValue) {
5005 return mExtras == null ? defaultValue :
5006 mExtras.getLong(name, defaultValue);
5007 }
5008
5009 /**
5010 * Retrieve extended data from the intent.
5011 *
5012 * @param name The name of the desired item.
5013 * @param defaultValue the value to be returned if no value of the desired
5014 * type is stored with the given name.
5015 *
5016 * @return the value of an item that previously added with putExtra(),
5017 * or the default value if no such item is present
5018 *
5019 * @see #putExtra(String, float)
5020 */
5021 public float getFloatExtra(String name, float defaultValue) {
5022 return mExtras == null ? defaultValue :
5023 mExtras.getFloat(name, defaultValue);
5024 }
5025
5026 /**
5027 * Retrieve extended data from the intent.
5028 *
5029 * @param name The name of the desired item.
5030 * @param defaultValue the value to be returned if no value of the desired
5031 * type is stored with the given name.
5032 *
5033 * @return the value of an item that previously added with putExtra()
5034 * or the default value if none was found.
5035 *
5036 * @see #putExtra(String, double)
5037 */
5038 public double getDoubleExtra(String name, double defaultValue) {
5039 return mExtras == null ? defaultValue :
5040 mExtras.getDouble(name, defaultValue);
5041 }
5042
5043 /**
5044 * Retrieve extended data from the intent.
5045 *
5046 * @param name The name of the desired item.
5047 *
5048 * @return the value of an item that previously added with putExtra()
5049 * or null if no String value was found.
5050 *
5051 * @see #putExtra(String, String)
5052 */
5053 public String getStringExtra(String name) {
5054 return mExtras == null ? null : mExtras.getString(name);
5055 }
5056
5057 /**
5058 * Retrieve extended data from the intent.
5059 *
5060 * @param name The name of the desired item.
5061 *
5062 * @return the value of an item that previously added with putExtra()
5063 * or null if no CharSequence value was found.
5064 *
5065 * @see #putExtra(String, CharSequence)
5066 */
5067 public CharSequence getCharSequenceExtra(String name) {
5068 return mExtras == null ? null : mExtras.getCharSequence(name);
5069 }
5070
5071 /**
5072 * Retrieve extended data from the intent.
5073 *
5074 * @param name The name of the desired item.
5075 *
5076 * @return the value of an item that previously added with putExtra()
5077 * or null if no Parcelable value was found.
5078 *
5079 * @see #putExtra(String, Parcelable)
5080 */
5081 public <T extends Parcelable> T getParcelableExtra(String name) {
5082 return mExtras == null ? null : mExtras.<T>getParcelable(name);
5083 }
5084
5085 /**
5086 * Retrieve extended data from the intent.
5087 *
5088 * @param name The name of the desired item.
5089 *
5090 * @return the value of an item that previously added with putExtra()
5091 * or null if no Parcelable[] value was found.
5092 *
5093 * @see #putExtra(String, Parcelable[])
5094 */
5095 public Parcelable[] getParcelableArrayExtra(String name) {
5096 return mExtras == null ? null : mExtras.getParcelableArray(name);
5097 }
5098
5099 /**
5100 * Retrieve extended data from the intent.
5101 *
5102 * @param name The name of the desired item.
5103 *
5104 * @return the value of an item that previously added with putExtra()
5105 * or null if no ArrayList<Parcelable> value was found.
5106 *
5107 * @see #putParcelableArrayListExtra(String, ArrayList)
5108 */
5109 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
5110 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
5111 }
5112
5113 /**
5114 * Retrieve extended data from the intent.
5115 *
5116 * @param name The name of the desired item.
5117 *
5118 * @return the value of an item that previously added with putExtra()
5119 * or null if no Serializable value was found.
5120 *
5121 * @see #putExtra(String, Serializable)
5122 */
5123 public Serializable getSerializableExtra(String name) {
5124 return mExtras == null ? null : mExtras.getSerializable(name);
5125 }
5126
5127 /**
5128 * Retrieve extended data from the intent.
5129 *
5130 * @param name The name of the desired item.
5131 *
5132 * @return the value of an item that previously added with putExtra()
5133 * or null if no ArrayList<Integer> value was found.
5134 *
5135 * @see #putIntegerArrayListExtra(String, ArrayList)
5136 */
5137 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
5138 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
5139 }
5140
5141 /**
5142 * Retrieve extended data from the intent.
5143 *
5144 * @param name The name of the desired item.
5145 *
5146 * @return the value of an item that previously added with putExtra()
5147 * or null if no ArrayList<String> value was found.
5148 *
5149 * @see #putStringArrayListExtra(String, ArrayList)
5150 */
5151 public ArrayList<String> getStringArrayListExtra(String name) {
5152 return mExtras == null ? null : mExtras.getStringArrayList(name);
5153 }
5154
5155 /**
5156 * Retrieve extended data from the intent.
5157 *
5158 * @param name The name of the desired item.
5159 *
5160 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005161 * or null if no ArrayList<CharSequence> value was found.
5162 *
5163 * @see #putCharSequenceArrayListExtra(String, ArrayList)
5164 */
5165 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
5166 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
5167 }
5168
5169 /**
5170 * Retrieve extended data from the intent.
5171 *
5172 * @param name The name of the desired item.
5173 *
5174 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005175 * or null if no boolean array value was found.
5176 *
5177 * @see #putExtra(String, boolean[])
5178 */
5179 public boolean[] getBooleanArrayExtra(String name) {
5180 return mExtras == null ? null : mExtras.getBooleanArray(name);
5181 }
5182
5183 /**
5184 * Retrieve extended data from the intent.
5185 *
5186 * @param name The name of the desired item.
5187 *
5188 * @return the value of an item that previously added with putExtra()
5189 * or null if no byte array value was found.
5190 *
5191 * @see #putExtra(String, byte[])
5192 */
5193 public byte[] getByteArrayExtra(String name) {
5194 return mExtras == null ? null : mExtras.getByteArray(name);
5195 }
5196
5197 /**
5198 * Retrieve extended data from the intent.
5199 *
5200 * @param name The name of the desired item.
5201 *
5202 * @return the value of an item that previously added with putExtra()
5203 * or null if no short array value was found.
5204 *
5205 * @see #putExtra(String, short[])
5206 */
5207 public short[] getShortArrayExtra(String name) {
5208 return mExtras == null ? null : mExtras.getShortArray(name);
5209 }
5210
5211 /**
5212 * Retrieve extended data from the intent.
5213 *
5214 * @param name The name of the desired item.
5215 *
5216 * @return the value of an item that previously added with putExtra()
5217 * or null if no char array value was found.
5218 *
5219 * @see #putExtra(String, char[])
5220 */
5221 public char[] getCharArrayExtra(String name) {
5222 return mExtras == null ? null : mExtras.getCharArray(name);
5223 }
5224
5225 /**
5226 * Retrieve extended data from the intent.
5227 *
5228 * @param name The name of the desired item.
5229 *
5230 * @return the value of an item that previously added with putExtra()
5231 * or null if no int array value was found.
5232 *
5233 * @see #putExtra(String, int[])
5234 */
5235 public int[] getIntArrayExtra(String name) {
5236 return mExtras == null ? null : mExtras.getIntArray(name);
5237 }
5238
5239 /**
5240 * Retrieve extended data from the intent.
5241 *
5242 * @param name The name of the desired item.
5243 *
5244 * @return the value of an item that previously added with putExtra()
5245 * or null if no long array value was found.
5246 *
5247 * @see #putExtra(String, long[])
5248 */
5249 public long[] getLongArrayExtra(String name) {
5250 return mExtras == null ? null : mExtras.getLongArray(name);
5251 }
5252
5253 /**
5254 * Retrieve extended data from the intent.
5255 *
5256 * @param name The name of the desired item.
5257 *
5258 * @return the value of an item that previously added with putExtra()
5259 * or null if no float array value was found.
5260 *
5261 * @see #putExtra(String, float[])
5262 */
5263 public float[] getFloatArrayExtra(String name) {
5264 return mExtras == null ? null : mExtras.getFloatArray(name);
5265 }
5266
5267 /**
5268 * Retrieve extended data from the intent.
5269 *
5270 * @param name The name of the desired item.
5271 *
5272 * @return the value of an item that previously added with putExtra()
5273 * or null if no double array value was found.
5274 *
5275 * @see #putExtra(String, double[])
5276 */
5277 public double[] getDoubleArrayExtra(String name) {
5278 return mExtras == null ? null : mExtras.getDoubleArray(name);
5279 }
5280
5281 /**
5282 * Retrieve extended data from the intent.
5283 *
5284 * @param name The name of the desired item.
5285 *
5286 * @return the value of an item that previously added with putExtra()
5287 * or null if no String array value was found.
5288 *
5289 * @see #putExtra(String, String[])
5290 */
5291 public String[] getStringArrayExtra(String name) {
5292 return mExtras == null ? null : mExtras.getStringArray(name);
5293 }
5294
5295 /**
5296 * Retrieve extended data from the intent.
5297 *
5298 * @param name The name of the desired item.
5299 *
5300 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005301 * or null if no CharSequence array value was found.
5302 *
5303 * @see #putExtra(String, CharSequence[])
5304 */
5305 public CharSequence[] getCharSequenceArrayExtra(String name) {
5306 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5307 }
5308
5309 /**
5310 * Retrieve extended data from the intent.
5311 *
5312 * @param name The name of the desired item.
5313 *
5314 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005315 * or null if no Bundle value was found.
5316 *
5317 * @see #putExtra(String, Bundle)
5318 */
5319 public Bundle getBundleExtra(String name) {
5320 return mExtras == null ? null : mExtras.getBundle(name);
5321 }
5322
5323 /**
5324 * Retrieve extended data from the intent.
5325 *
5326 * @param name The name of the desired item.
5327 *
5328 * @return the value of an item that previously added with putExtra()
5329 * or null if no IBinder value was found.
5330 *
5331 * @see #putExtra(String, IBinder)
5332 *
5333 * @deprecated
5334 * @hide
5335 */
5336 @Deprecated
5337 public IBinder getIBinderExtra(String name) {
5338 return mExtras == null ? null : mExtras.getIBinder(name);
5339 }
5340
5341 /**
5342 * Retrieve extended data from the intent.
5343 *
5344 * @param name The name of the desired item.
5345 * @param defaultValue The default value to return in case no item is
5346 * associated with the key 'name'
5347 *
5348 * @return the value of an item that previously added with putExtra()
5349 * or defaultValue if none was found.
5350 *
5351 * @see #putExtra
5352 *
5353 * @deprecated
5354 * @hide
5355 */
5356 @Deprecated
5357 public Object getExtra(String name, Object defaultValue) {
5358 Object result = defaultValue;
5359 if (mExtras != null) {
5360 Object result2 = mExtras.get(name);
5361 if (result2 != null) {
5362 result = result2;
5363 }
5364 }
5365
5366 return result;
5367 }
5368
5369 /**
5370 * Retrieves a map of extended data from the intent.
5371 *
5372 * @return the map of all extras previously added with putExtra(),
5373 * or null if none have been added.
5374 */
5375 public Bundle getExtras() {
5376 return (mExtras != null)
5377 ? new Bundle(mExtras)
5378 : null;
5379 }
5380
5381 /**
5382 * Retrieve any special flags associated with this intent. You will
5383 * normally just set them with {@link #setFlags} and let the system
5384 * take the appropriate action with them.
5385 *
5386 * @return int The currently set flags.
5387 *
5388 * @see #setFlags
5389 */
5390 public int getFlags() {
5391 return mFlags;
5392 }
5393
Dianne Hackborne7f97212011-02-24 14:40:20 -08005394 /** @hide */
5395 public boolean isExcludingStopped() {
5396 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5397 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5398 }
5399
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005400 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005401 * Retrieve the application package name this Intent is limited to. When
5402 * resolving an Intent, if non-null this limits the resolution to only
5403 * components in the given application package.
5404 *
5405 * @return The name of the application package for the Intent.
5406 *
5407 * @see #resolveActivity
5408 * @see #setPackage
5409 */
5410 public String getPackage() {
5411 return mPackage;
5412 }
5413
5414 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005415 * Retrieve the concrete component associated with the intent. When receiving
5416 * an intent, this is the component that was found to best handle it (that is,
5417 * yourself) and will always be non-null; in all other cases it will be
5418 * null unless explicitly set.
5419 *
5420 * @return The name of the application component to handle the intent.
5421 *
5422 * @see #resolveActivity
5423 * @see #setComponent
5424 */
5425 public ComponentName getComponent() {
5426 return mComponent;
5427 }
5428
5429 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005430 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5431 * used as a hint to the receiver for animations and the like. Null means that there
5432 * is no source bounds.
5433 */
5434 public Rect getSourceBounds() {
5435 return mSourceBounds;
5436 }
5437
5438 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005439 * Return the Activity component that should be used to handle this intent.
5440 * The appropriate component is determined based on the information in the
5441 * intent, evaluated as follows:
5442 *
5443 * <p>If {@link #getComponent} returns an explicit class, that is returned
5444 * without any further consideration.
5445 *
5446 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5447 * category to be considered.
5448 *
5449 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5450 * action.
5451 *
5452 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5453 * this type.
5454 *
5455 * <p>If {@link #addCategory} has added any categories, the activity must
5456 * handle ALL of the categories specified.
5457 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005458 * <p>If {@link #getPackage} is non-NULL, only activity components in
5459 * that application package will be considered.
5460 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005461 * <p>If there are no activities that satisfy all of these conditions, a
5462 * null string is returned.
5463 *
5464 * <p>If multiple activities are found to satisfy the intent, the one with
5465 * the highest priority will be used. If there are multiple activities
5466 * with the same priority, the system will either pick the best activity
5467 * based on user preference, or resolve to a system class that will allow
5468 * the user to pick an activity and forward from there.
5469 *
5470 * <p>This method is implemented simply by calling
5471 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5472 * true.</p>
5473 * <p> This API is called for you as part of starting an activity from an
5474 * intent. You do not normally need to call it yourself.</p>
5475 *
5476 * @param pm The package manager with which to resolve the Intent.
5477 *
5478 * @return Name of the component implementing an activity that can
5479 * display the intent.
5480 *
5481 * @see #setComponent
5482 * @see #getComponent
5483 * @see #resolveActivityInfo
5484 */
5485 public ComponentName resolveActivity(PackageManager pm) {
5486 if (mComponent != null) {
5487 return mComponent;
5488 }
5489
5490 ResolveInfo info = pm.resolveActivity(
5491 this, PackageManager.MATCH_DEFAULT_ONLY);
5492 if (info != null) {
5493 return new ComponentName(
5494 info.activityInfo.applicationInfo.packageName,
5495 info.activityInfo.name);
5496 }
5497
5498 return null;
5499 }
5500
5501 /**
5502 * Resolve the Intent into an {@link ActivityInfo}
5503 * describing the activity that should execute the intent. Resolution
5504 * follows the same rules as described for {@link #resolveActivity}, but
5505 * you get back the completely information about the resolved activity
5506 * instead of just its class name.
5507 *
5508 * @param pm The package manager with which to resolve the Intent.
5509 * @param flags Addition information to retrieve as per
5510 * {@link PackageManager#getActivityInfo(ComponentName, int)
5511 * PackageManager.getActivityInfo()}.
5512 *
5513 * @return PackageManager.ActivityInfo
5514 *
5515 * @see #resolveActivity
5516 */
5517 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5518 ActivityInfo ai = null;
5519 if (mComponent != null) {
5520 try {
5521 ai = pm.getActivityInfo(mComponent, flags);
5522 } catch (PackageManager.NameNotFoundException e) {
5523 // ignore
5524 }
5525 } else {
5526 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005527 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005528 if (info != null) {
5529 ai = info.activityInfo;
5530 }
5531 }
5532
5533 return ai;
5534 }
5535
5536 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005537 * Special function for use by the system to resolve service
5538 * intents to system apps. Throws an exception if there are
5539 * multiple potential matches to the Intent. Returns null if
5540 * there are no matches.
5541 * @hide
5542 */
5543 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5544 if (mComponent != null) {
5545 return mComponent;
5546 }
5547
5548 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5549 if (results == null) {
5550 return null;
5551 }
5552 ComponentName comp = null;
5553 for (int i=0; i<results.size(); i++) {
5554 ResolveInfo ri = results.get(i);
5555 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5556 continue;
5557 }
5558 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5559 ri.serviceInfo.name);
5560 if (comp != null) {
5561 throw new IllegalStateException("Multiple system services handle " + this
5562 + ": " + comp + ", " + foundComp);
5563 }
5564 comp = foundComp;
5565 }
5566 return comp;
5567 }
5568
5569 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005570 * Set the general action to be performed.
5571 *
5572 * @param action An action name, such as ACTION_VIEW. Application-specific
5573 * actions should be prefixed with the vendor's package name.
5574 *
5575 * @return Returns the same Intent object, for chaining multiple calls
5576 * into a single statement.
5577 *
5578 * @see #getAction
5579 */
5580 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005581 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005582 return this;
5583 }
5584
5585 /**
5586 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005587 * clears any type that was previously set by {@link #setType} or
5588 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005589 *
Nick Pellyccae4122012-01-09 14:12:58 -08005590 * <p><em>Note: scheme matching in the Android framework is
5591 * case-sensitive, unlike the formal RFC. As a result,
5592 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005593 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005594 * {@link #setDataAndNormalize}
5595 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005596 *
Nick Pellyccae4122012-01-09 14:12:58 -08005597 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005598 *
5599 * @return Returns the same Intent object, for chaining multiple calls
5600 * into a single statement.
5601 *
5602 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005603 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005604 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005605 */
5606 public Intent setData(Uri data) {
5607 mData = data;
5608 mType = null;
5609 return this;
5610 }
5611
5612 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005613 * Normalize and set the data this intent is operating on.
5614 *
5615 * <p>This method automatically clears any type that was
5616 * previously set (for example, by {@link #setType}).
5617 *
5618 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005619 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005620 * so really this is just a convenience method for
5621 * <pre>
5622 * setData(data.normalize())
5623 * </pre>
5624 *
5625 * @param data The Uri of the data this intent is now targeting.
5626 *
5627 * @return Returns the same Intent object, for chaining multiple calls
5628 * into a single statement.
5629 *
5630 * @see #getData
5631 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005632 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005633 */
5634 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005635 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005636 }
5637
5638 /**
5639 * Set an explicit MIME data type.
5640 *
5641 * <p>This is used to create intents that only specify a type and not data,
5642 * for example to indicate the type of data to return.
5643 *
5644 * <p>This method automatically clears any data that was
5645 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005646 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005647 * <p><em>Note: MIME type matching in the Android framework is
5648 * case-sensitive, unlike formal RFC MIME types. As a result,
5649 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005650 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5651 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005652 *
5653 * @param type The MIME type of the data being handled by this intent.
5654 *
5655 * @return Returns the same Intent object, for chaining multiple calls
5656 * into a single statement.
5657 *
5658 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005659 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005660 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005661 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005662 */
5663 public Intent setType(String type) {
5664 mData = null;
5665 mType = type;
5666 return this;
5667 }
5668
5669 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005670 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005671 *
Nick Pellyccae4122012-01-09 14:12:58 -08005672 * <p>This is used to create intents that only specify a type and not data,
5673 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005674 *
Nick Pellyccae4122012-01-09 14:12:58 -08005675 * <p>This method automatically clears any data that was
5676 * previously set (for example by {@link #setData}).
5677 *
5678 * <p>The MIME type is normalized using
5679 * {@link #normalizeMimeType} before it is set,
5680 * so really this is just a convenience method for
5681 * <pre>
5682 * setType(Intent.normalizeMimeType(type))
5683 * </pre>
5684 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005685 * @param type The MIME type of the data being handled by this intent.
5686 *
5687 * @return Returns the same Intent object, for chaining multiple calls
5688 * into a single statement.
5689 *
Nick Pellyccae4122012-01-09 14:12:58 -08005690 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005691 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005692 * @see #normalizeMimeType
5693 */
5694 public Intent setTypeAndNormalize(String type) {
5695 return setType(normalizeMimeType(type));
5696 }
5697
5698 /**
5699 * (Usually optional) Set the data for the intent along with an explicit
5700 * MIME data type. This method should very rarely be used -- it allows you
5701 * to override the MIME type that would ordinarily be inferred from the
5702 * data with your own type given here.
5703 *
5704 * <p><em>Note: MIME type and Uri scheme matching in the
5705 * Android framework is case-sensitive, unlike the formal RFC definitions.
5706 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005707 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005708 * {@link #setDataAndTypeAndNormalize}
5709 * to ensure that they are converted to lower case.</em>
5710 *
5711 * @param data The Uri of the data this intent is now targeting.
5712 * @param type The MIME type of the data being handled by this intent.
5713 *
5714 * @return Returns the same Intent object, for chaining multiple calls
5715 * into a single statement.
5716 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005717 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005718 * @see #setData
5719 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005720 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005721 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005722 */
5723 public Intent setDataAndType(Uri data, String type) {
5724 mData = data;
5725 mType = type;
5726 return this;
5727 }
5728
5729 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005730 * (Usually optional) Normalize and set both the data Uri and an explicit
5731 * MIME data type. This method should very rarely be used -- it allows you
5732 * to override the MIME type that would ordinarily be inferred from the
5733 * data with your own type given here.
5734 *
5735 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005736 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005737 * before they are set, so really this is just a convenience method for
5738 * <pre>
5739 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5740 * </pre>
5741 *
5742 * @param data The Uri of the data this intent is now targeting.
5743 * @param type The MIME type of the data being handled by this intent.
5744 *
5745 * @return Returns the same Intent object, for chaining multiple calls
5746 * into a single statement.
5747 *
5748 * @see #setType
5749 * @see #setData
5750 * @see #setDataAndType
5751 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005752 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005753 */
5754 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005755 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005756 }
5757
5758 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005759 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005760 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005761 * activities that provide <em>all</em> of the requested categories will be
5762 * used.
5763 *
5764 * @param category The desired category. This can be either one of the
5765 * predefined Intent categories, or a custom category in your own
5766 * namespace.
5767 *
5768 * @return Returns the same Intent object, for chaining multiple calls
5769 * into a single statement.
5770 *
5771 * @see #hasCategory
5772 * @see #removeCategory
5773 */
5774 public Intent addCategory(String category) {
5775 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005776 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005777 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005778 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005779 return this;
5780 }
5781
5782 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005783 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005784 *
5785 * @param category The category to remove.
5786 *
5787 * @see #addCategory
5788 */
5789 public void removeCategory(String category) {
5790 if (mCategories != null) {
5791 mCategories.remove(category);
5792 if (mCategories.size() == 0) {
5793 mCategories = null;
5794 }
5795 }
5796 }
5797
5798 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005799 * Set a selector for this Intent. This is a modification to the kinds of
5800 * things the Intent will match. If the selector is set, it will be used
5801 * when trying to find entities that can handle the Intent, instead of the
5802 * main contents of the Intent. This allows you build an Intent containing
5803 * a generic protocol while targeting it more specifically.
5804 *
5805 * <p>An example of where this may be used is with things like
5806 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5807 * Intent that will launch the Browser application. However, the correct
5808 * main entry point of an application is actually {@link #ACTION_MAIN}
5809 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5810 * used to specify the actual Activity to launch. If you launch the browser
5811 * with something different, undesired behavior may happen if the user has
5812 * previously or later launches it the normal way, since they do not match.
5813 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5814 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5815 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5816 *
5817 * <p>Setting a selector does not impact the behavior of
5818 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5819 * desired behavior of a selector -- it does not impact the base meaning
5820 * of the Intent, just what kinds of things will be matched against it
5821 * when determining who can handle it.</p>
5822 *
5823 * <p>You can not use both a selector and {@link #setPackage(String)} on
5824 * the same base Intent.</p>
5825 *
5826 * @param selector The desired selector Intent; set to null to not use
5827 * a special selector.
5828 */
5829 public void setSelector(Intent selector) {
5830 if (selector == this) {
5831 throw new IllegalArgumentException(
5832 "Intent being set as a selector of itself");
5833 }
5834 if (selector != null && mPackage != null) {
5835 throw new IllegalArgumentException(
5836 "Can't set selector when package name is already set");
5837 }
5838 mSelector = selector;
5839 }
5840
5841 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005842 * Set a {@link ClipData} associated with this Intent. This replaces any
5843 * previously set ClipData.
5844 *
5845 * <p>The ClipData in an intent is not used for Intent matching or other
5846 * such operations. Semantically it is like extras, used to transmit
5847 * additional data with the Intent. The main feature of using this over
5848 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5849 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5850 * items included in the clip data. This is useful, in particular, if
5851 * you want to transmit an Intent containing multiple <code>content:</code>
5852 * URIs for which the recipient may not have global permission to access the
5853 * content provider.
5854 *
5855 * <p>If the ClipData contains items that are themselves Intents, any
5856 * grant flags in those Intents will be ignored. Only the top-level flags
5857 * of the main Intent are respected, and will be applied to all Uri or
5858 * Intent items in the clip (or sub-items of the clip).
5859 *
5860 * <p>The MIME type, label, and icon in the ClipData object are not
5861 * directly used by Intent. Applications should generally rely on the
5862 * MIME type of the Intent itself, not what it may find in the ClipData.
5863 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005864 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005865 *
5866 * @param clip The new clip to set. May be null to clear the current clip.
5867 */
5868 public void setClipData(ClipData clip) {
5869 mClipData = clip;
5870 }
5871
5872 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005873 * This is NOT a secure mechanism to identify the user who sent the intent.
5874 * When the intent is sent to a different user, it is used to fix uris by adding the userId
5875 * who sent the intent.
5876 * @hide
5877 */
5878 public void setContentUserHint(int contentUserHint) {
5879 mContentUserHint = contentUserHint;
5880 }
5881
5882 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005883 * Add extended data to the intent. The name must include a package
5884 * prefix, for example the app com.android.contacts would use names
5885 * like "com.android.contacts.ShowAll".
5886 *
5887 * @param name The name of the extra data, with package prefix.
5888 * @param value The boolean data value.
5889 *
5890 * @return Returns the same Intent object, for chaining multiple calls
5891 * into a single statement.
5892 *
5893 * @see #putExtras
5894 * @see #removeExtra
5895 * @see #getBooleanExtra(String, boolean)
5896 */
5897 public Intent putExtra(String name, boolean value) {
5898 if (mExtras == null) {
5899 mExtras = new Bundle();
5900 }
5901 mExtras.putBoolean(name, value);
5902 return this;
5903 }
5904
5905 /**
5906 * Add extended data to the intent. The name must include a package
5907 * prefix, for example the app com.android.contacts would use names
5908 * like "com.android.contacts.ShowAll".
5909 *
5910 * @param name The name of the extra data, with package prefix.
5911 * @param value The byte data value.
5912 *
5913 * @return Returns the same Intent object, for chaining multiple calls
5914 * into a single statement.
5915 *
5916 * @see #putExtras
5917 * @see #removeExtra
5918 * @see #getByteExtra(String, byte)
5919 */
5920 public Intent putExtra(String name, byte value) {
5921 if (mExtras == null) {
5922 mExtras = new Bundle();
5923 }
5924 mExtras.putByte(name, value);
5925 return this;
5926 }
5927
5928 /**
5929 * Add extended data to the intent. The name must include a package
5930 * prefix, for example the app com.android.contacts would use names
5931 * like "com.android.contacts.ShowAll".
5932 *
5933 * @param name The name of the extra data, with package prefix.
5934 * @param value The char data value.
5935 *
5936 * @return Returns the same Intent object, for chaining multiple calls
5937 * into a single statement.
5938 *
5939 * @see #putExtras
5940 * @see #removeExtra
5941 * @see #getCharExtra(String, char)
5942 */
5943 public Intent putExtra(String name, char value) {
5944 if (mExtras == null) {
5945 mExtras = new Bundle();
5946 }
5947 mExtras.putChar(name, value);
5948 return this;
5949 }
5950
5951 /**
5952 * Add extended data to the intent. The name must include a package
5953 * prefix, for example the app com.android.contacts would use names
5954 * like "com.android.contacts.ShowAll".
5955 *
5956 * @param name The name of the extra data, with package prefix.
5957 * @param value The short data value.
5958 *
5959 * @return Returns the same Intent object, for chaining multiple calls
5960 * into a single statement.
5961 *
5962 * @see #putExtras
5963 * @see #removeExtra
5964 * @see #getShortExtra(String, short)
5965 */
5966 public Intent putExtra(String name, short value) {
5967 if (mExtras == null) {
5968 mExtras = new Bundle();
5969 }
5970 mExtras.putShort(name, value);
5971 return this;
5972 }
5973
5974 /**
5975 * Add extended data to the intent. The name must include a package
5976 * prefix, for example the app com.android.contacts would use names
5977 * like "com.android.contacts.ShowAll".
5978 *
5979 * @param name The name of the extra data, with package prefix.
5980 * @param value The integer data value.
5981 *
5982 * @return Returns the same Intent object, for chaining multiple calls
5983 * into a single statement.
5984 *
5985 * @see #putExtras
5986 * @see #removeExtra
5987 * @see #getIntExtra(String, int)
5988 */
5989 public Intent putExtra(String name, int value) {
5990 if (mExtras == null) {
5991 mExtras = new Bundle();
5992 }
5993 mExtras.putInt(name, value);
5994 return this;
5995 }
5996
5997 /**
5998 * Add extended data to the intent. The name must include a package
5999 * prefix, for example the app com.android.contacts would use names
6000 * like "com.android.contacts.ShowAll".
6001 *
6002 * @param name The name of the extra data, with package prefix.
6003 * @param value The long data value.
6004 *
6005 * @return Returns the same Intent object, for chaining multiple calls
6006 * into a single statement.
6007 *
6008 * @see #putExtras
6009 * @see #removeExtra
6010 * @see #getLongExtra(String, long)
6011 */
6012 public Intent putExtra(String name, long value) {
6013 if (mExtras == null) {
6014 mExtras = new Bundle();
6015 }
6016 mExtras.putLong(name, value);
6017 return this;
6018 }
6019
6020 /**
6021 * Add extended data to the intent. The name must include a package
6022 * prefix, for example the app com.android.contacts would use names
6023 * like "com.android.contacts.ShowAll".
6024 *
6025 * @param name The name of the extra data, with package prefix.
6026 * @param value The float data value.
6027 *
6028 * @return Returns the same Intent object, for chaining multiple calls
6029 * into a single statement.
6030 *
6031 * @see #putExtras
6032 * @see #removeExtra
6033 * @see #getFloatExtra(String, float)
6034 */
6035 public Intent putExtra(String name, float value) {
6036 if (mExtras == null) {
6037 mExtras = new Bundle();
6038 }
6039 mExtras.putFloat(name, value);
6040 return this;
6041 }
6042
6043 /**
6044 * Add extended data to the intent. The name must include a package
6045 * prefix, for example the app com.android.contacts would use names
6046 * like "com.android.contacts.ShowAll".
6047 *
6048 * @param name The name of the extra data, with package prefix.
6049 * @param value The double data value.
6050 *
6051 * @return Returns the same Intent object, for chaining multiple calls
6052 * into a single statement.
6053 *
6054 * @see #putExtras
6055 * @see #removeExtra
6056 * @see #getDoubleExtra(String, double)
6057 */
6058 public Intent putExtra(String name, double value) {
6059 if (mExtras == null) {
6060 mExtras = new Bundle();
6061 }
6062 mExtras.putDouble(name, value);
6063 return this;
6064 }
6065
6066 /**
6067 * Add extended data to the intent. The name must include a package
6068 * prefix, for example the app com.android.contacts would use names
6069 * like "com.android.contacts.ShowAll".
6070 *
6071 * @param name The name of the extra data, with package prefix.
6072 * @param value The String data value.
6073 *
6074 * @return Returns the same Intent object, for chaining multiple calls
6075 * into a single statement.
6076 *
6077 * @see #putExtras
6078 * @see #removeExtra
6079 * @see #getStringExtra(String)
6080 */
6081 public Intent putExtra(String name, String value) {
6082 if (mExtras == null) {
6083 mExtras = new Bundle();
6084 }
6085 mExtras.putString(name, value);
6086 return this;
6087 }
6088
6089 /**
6090 * Add extended data to the intent. The name must include a package
6091 * prefix, for example the app com.android.contacts would use names
6092 * like "com.android.contacts.ShowAll".
6093 *
6094 * @param name The name of the extra data, with package prefix.
6095 * @param value The CharSequence data value.
6096 *
6097 * @return Returns the same Intent object, for chaining multiple calls
6098 * into a single statement.
6099 *
6100 * @see #putExtras
6101 * @see #removeExtra
6102 * @see #getCharSequenceExtra(String)
6103 */
6104 public Intent putExtra(String name, CharSequence value) {
6105 if (mExtras == null) {
6106 mExtras = new Bundle();
6107 }
6108 mExtras.putCharSequence(name, value);
6109 return this;
6110 }
6111
6112 /**
6113 * Add extended data to the intent. The name must include a package
6114 * prefix, for example the app com.android.contacts would use names
6115 * like "com.android.contacts.ShowAll".
6116 *
6117 * @param name The name of the extra data, with package prefix.
6118 * @param value The Parcelable data value.
6119 *
6120 * @return Returns the same Intent object, for chaining multiple calls
6121 * into a single statement.
6122 *
6123 * @see #putExtras
6124 * @see #removeExtra
6125 * @see #getParcelableExtra(String)
6126 */
6127 public Intent putExtra(String name, Parcelable value) {
6128 if (mExtras == null) {
6129 mExtras = new Bundle();
6130 }
6131 mExtras.putParcelable(name, value);
6132 return this;
6133 }
6134
6135 /**
6136 * Add extended data to the intent. The name must include a package
6137 * prefix, for example the app com.android.contacts would use names
6138 * like "com.android.contacts.ShowAll".
6139 *
6140 * @param name The name of the extra data, with package prefix.
6141 * @param value The Parcelable[] data value.
6142 *
6143 * @return Returns the same Intent object, for chaining multiple calls
6144 * into a single statement.
6145 *
6146 * @see #putExtras
6147 * @see #removeExtra
6148 * @see #getParcelableArrayExtra(String)
6149 */
6150 public Intent putExtra(String name, Parcelable[] value) {
6151 if (mExtras == null) {
6152 mExtras = new Bundle();
6153 }
6154 mExtras.putParcelableArray(name, value);
6155 return this;
6156 }
6157
6158 /**
6159 * Add extended data to the intent. The name must include a package
6160 * prefix, for example the app com.android.contacts would use names
6161 * like "com.android.contacts.ShowAll".
6162 *
6163 * @param name The name of the extra data, with package prefix.
6164 * @param value The ArrayList<Parcelable> data value.
6165 *
6166 * @return Returns the same Intent object, for chaining multiple calls
6167 * into a single statement.
6168 *
6169 * @see #putExtras
6170 * @see #removeExtra
6171 * @see #getParcelableArrayListExtra(String)
6172 */
6173 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
6174 if (mExtras == null) {
6175 mExtras = new Bundle();
6176 }
6177 mExtras.putParcelableArrayList(name, value);
6178 return this;
6179 }
6180
6181 /**
6182 * Add extended data to the intent. The name must include a package
6183 * prefix, for example the app com.android.contacts would use names
6184 * like "com.android.contacts.ShowAll".
6185 *
6186 * @param name The name of the extra data, with package prefix.
6187 * @param value The ArrayList<Integer> data value.
6188 *
6189 * @return Returns the same Intent object, for chaining multiple calls
6190 * into a single statement.
6191 *
6192 * @see #putExtras
6193 * @see #removeExtra
6194 * @see #getIntegerArrayListExtra(String)
6195 */
6196 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
6197 if (mExtras == null) {
6198 mExtras = new Bundle();
6199 }
6200 mExtras.putIntegerArrayList(name, value);
6201 return this;
6202 }
6203
6204 /**
6205 * Add extended data to the intent. The name must include a package
6206 * prefix, for example the app com.android.contacts would use names
6207 * like "com.android.contacts.ShowAll".
6208 *
6209 * @param name The name of the extra data, with package prefix.
6210 * @param value The ArrayList<String> data value.
6211 *
6212 * @return Returns the same Intent object, for chaining multiple calls
6213 * into a single statement.
6214 *
6215 * @see #putExtras
6216 * @see #removeExtra
6217 * @see #getStringArrayListExtra(String)
6218 */
6219 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
6220 if (mExtras == null) {
6221 mExtras = new Bundle();
6222 }
6223 mExtras.putStringArrayList(name, value);
6224 return this;
6225 }
6226
6227 /**
6228 * Add extended data to the intent. The name must include a package
6229 * prefix, for example the app com.android.contacts would use names
6230 * like "com.android.contacts.ShowAll".
6231 *
6232 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006233 * @param value The ArrayList<CharSequence> data value.
6234 *
6235 * @return Returns the same Intent object, for chaining multiple calls
6236 * into a single statement.
6237 *
6238 * @see #putExtras
6239 * @see #removeExtra
6240 * @see #getCharSequenceArrayListExtra(String)
6241 */
6242 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6243 if (mExtras == null) {
6244 mExtras = new Bundle();
6245 }
6246 mExtras.putCharSequenceArrayList(name, value);
6247 return this;
6248 }
6249
6250 /**
6251 * Add extended data to the intent. The name must include a package
6252 * prefix, for example the app com.android.contacts would use names
6253 * like "com.android.contacts.ShowAll".
6254 *
6255 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006256 * @param value The Serializable data value.
6257 *
6258 * @return Returns the same Intent object, for chaining multiple calls
6259 * into a single statement.
6260 *
6261 * @see #putExtras
6262 * @see #removeExtra
6263 * @see #getSerializableExtra(String)
6264 */
6265 public Intent putExtra(String name, Serializable value) {
6266 if (mExtras == null) {
6267 mExtras = new Bundle();
6268 }
6269 mExtras.putSerializable(name, value);
6270 return this;
6271 }
6272
6273 /**
6274 * Add extended data to the intent. The name must include a package
6275 * prefix, for example the app com.android.contacts would use names
6276 * like "com.android.contacts.ShowAll".
6277 *
6278 * @param name The name of the extra data, with package prefix.
6279 * @param value The boolean array data value.
6280 *
6281 * @return Returns the same Intent object, for chaining multiple calls
6282 * into a single statement.
6283 *
6284 * @see #putExtras
6285 * @see #removeExtra
6286 * @see #getBooleanArrayExtra(String)
6287 */
6288 public Intent putExtra(String name, boolean[] value) {
6289 if (mExtras == null) {
6290 mExtras = new Bundle();
6291 }
6292 mExtras.putBooleanArray(name, value);
6293 return this;
6294 }
6295
6296 /**
6297 * Add extended data to the intent. The name must include a package
6298 * prefix, for example the app com.android.contacts would use names
6299 * like "com.android.contacts.ShowAll".
6300 *
6301 * @param name The name of the extra data, with package prefix.
6302 * @param value The byte array data value.
6303 *
6304 * @return Returns the same Intent object, for chaining multiple calls
6305 * into a single statement.
6306 *
6307 * @see #putExtras
6308 * @see #removeExtra
6309 * @see #getByteArrayExtra(String)
6310 */
6311 public Intent putExtra(String name, byte[] value) {
6312 if (mExtras == null) {
6313 mExtras = new Bundle();
6314 }
6315 mExtras.putByteArray(name, value);
6316 return this;
6317 }
6318
6319 /**
6320 * Add extended data to the intent. The name must include a package
6321 * prefix, for example the app com.android.contacts would use names
6322 * like "com.android.contacts.ShowAll".
6323 *
6324 * @param name The name of the extra data, with package prefix.
6325 * @param value The short array data value.
6326 *
6327 * @return Returns the same Intent object, for chaining multiple calls
6328 * into a single statement.
6329 *
6330 * @see #putExtras
6331 * @see #removeExtra
6332 * @see #getShortArrayExtra(String)
6333 */
6334 public Intent putExtra(String name, short[] value) {
6335 if (mExtras == null) {
6336 mExtras = new Bundle();
6337 }
6338 mExtras.putShortArray(name, value);
6339 return this;
6340 }
6341
6342 /**
6343 * Add extended data to the intent. The name 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 name The name of the extra data, with package prefix.
6348 * @param value The char array data value.
6349 *
6350 * @return Returns the same Intent object, for chaining multiple calls
6351 * into a single statement.
6352 *
6353 * @see #putExtras
6354 * @see #removeExtra
6355 * @see #getCharArrayExtra(String)
6356 */
6357 public Intent putExtra(String name, char[] value) {
6358 if (mExtras == null) {
6359 mExtras = new Bundle();
6360 }
6361 mExtras.putCharArray(name, value);
6362 return this;
6363 }
6364
6365 /**
6366 * Add extended data to the intent. The name must include a package
6367 * prefix, for example the app com.android.contacts would use names
6368 * like "com.android.contacts.ShowAll".
6369 *
6370 * @param name The name of the extra data, with package prefix.
6371 * @param value The int array data value.
6372 *
6373 * @return Returns the same Intent object, for chaining multiple calls
6374 * into a single statement.
6375 *
6376 * @see #putExtras
6377 * @see #removeExtra
6378 * @see #getIntArrayExtra(String)
6379 */
6380 public Intent putExtra(String name, int[] value) {
6381 if (mExtras == null) {
6382 mExtras = new Bundle();
6383 }
6384 mExtras.putIntArray(name, value);
6385 return this;
6386 }
6387
6388 /**
6389 * Add extended data to the intent. The name must include a package
6390 * prefix, for example the app com.android.contacts would use names
6391 * like "com.android.contacts.ShowAll".
6392 *
6393 * @param name The name of the extra data, with package prefix.
6394 * @param value The byte array data value.
6395 *
6396 * @return Returns the same Intent object, for chaining multiple calls
6397 * into a single statement.
6398 *
6399 * @see #putExtras
6400 * @see #removeExtra
6401 * @see #getLongArrayExtra(String)
6402 */
6403 public Intent putExtra(String name, long[] value) {
6404 if (mExtras == null) {
6405 mExtras = new Bundle();
6406 }
6407 mExtras.putLongArray(name, value);
6408 return this;
6409 }
6410
6411 /**
6412 * Add extended data to the intent. The name must include a package
6413 * prefix, for example the app com.android.contacts would use names
6414 * like "com.android.contacts.ShowAll".
6415 *
6416 * @param name The name of the extra data, with package prefix.
6417 * @param value The float array data value.
6418 *
6419 * @return Returns the same Intent object, for chaining multiple calls
6420 * into a single statement.
6421 *
6422 * @see #putExtras
6423 * @see #removeExtra
6424 * @see #getFloatArrayExtra(String)
6425 */
6426 public Intent putExtra(String name, float[] value) {
6427 if (mExtras == null) {
6428 mExtras = new Bundle();
6429 }
6430 mExtras.putFloatArray(name, value);
6431 return this;
6432 }
6433
6434 /**
6435 * Add extended data to the intent. The name must include a package
6436 * prefix, for example the app com.android.contacts would use names
6437 * like "com.android.contacts.ShowAll".
6438 *
6439 * @param name The name of the extra data, with package prefix.
6440 * @param value The double array data value.
6441 *
6442 * @return Returns the same Intent object, for chaining multiple calls
6443 * into a single statement.
6444 *
6445 * @see #putExtras
6446 * @see #removeExtra
6447 * @see #getDoubleArrayExtra(String)
6448 */
6449 public Intent putExtra(String name, double[] value) {
6450 if (mExtras == null) {
6451 mExtras = new Bundle();
6452 }
6453 mExtras.putDoubleArray(name, value);
6454 return this;
6455 }
6456
6457 /**
6458 * Add extended data to the intent. The name must include a package
6459 * prefix, for example the app com.android.contacts would use names
6460 * like "com.android.contacts.ShowAll".
6461 *
6462 * @param name The name of the extra data, with package prefix.
6463 * @param value The String array data value.
6464 *
6465 * @return Returns the same Intent object, for chaining multiple calls
6466 * into a single statement.
6467 *
6468 * @see #putExtras
6469 * @see #removeExtra
6470 * @see #getStringArrayExtra(String)
6471 */
6472 public Intent putExtra(String name, String[] value) {
6473 if (mExtras == null) {
6474 mExtras = new Bundle();
6475 }
6476 mExtras.putStringArray(name, value);
6477 return this;
6478 }
6479
6480 /**
6481 * Add extended data to the intent. The name must include a package
6482 * prefix, for example the app com.android.contacts would use names
6483 * like "com.android.contacts.ShowAll".
6484 *
6485 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006486 * @param value The CharSequence array data value.
6487 *
6488 * @return Returns the same Intent object, for chaining multiple calls
6489 * into a single statement.
6490 *
6491 * @see #putExtras
6492 * @see #removeExtra
6493 * @see #getCharSequenceArrayExtra(String)
6494 */
6495 public Intent putExtra(String name, CharSequence[] value) {
6496 if (mExtras == null) {
6497 mExtras = new Bundle();
6498 }
6499 mExtras.putCharSequenceArray(name, value);
6500 return this;
6501 }
6502
6503 /**
6504 * Add extended data to the intent. The name must include a package
6505 * prefix, for example the app com.android.contacts would use names
6506 * like "com.android.contacts.ShowAll".
6507 *
6508 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006509 * @param value The Bundle data value.
6510 *
6511 * @return Returns the same Intent object, for chaining multiple calls
6512 * into a single statement.
6513 *
6514 * @see #putExtras
6515 * @see #removeExtra
6516 * @see #getBundleExtra(String)
6517 */
6518 public Intent putExtra(String name, Bundle value) {
6519 if (mExtras == null) {
6520 mExtras = new Bundle();
6521 }
6522 mExtras.putBundle(name, value);
6523 return this;
6524 }
6525
6526 /**
6527 * Add extended data to the intent. The name must include a package
6528 * prefix, for example the app com.android.contacts would use names
6529 * like "com.android.contacts.ShowAll".
6530 *
6531 * @param name The name of the extra data, with package prefix.
6532 * @param value The IBinder data value.
6533 *
6534 * @return Returns the same Intent object, for chaining multiple calls
6535 * into a single statement.
6536 *
6537 * @see #putExtras
6538 * @see #removeExtra
6539 * @see #getIBinderExtra(String)
6540 *
6541 * @deprecated
6542 * @hide
6543 */
6544 @Deprecated
6545 public Intent putExtra(String name, IBinder value) {
6546 if (mExtras == null) {
6547 mExtras = new Bundle();
6548 }
6549 mExtras.putIBinder(name, value);
6550 return this;
6551 }
6552
6553 /**
6554 * Copy all extras in 'src' in to this intent.
6555 *
6556 * @param src Contains the extras to copy.
6557 *
6558 * @see #putExtra
6559 */
6560 public Intent putExtras(Intent src) {
6561 if (src.mExtras != null) {
6562 if (mExtras == null) {
6563 mExtras = new Bundle(src.mExtras);
6564 } else {
6565 mExtras.putAll(src.mExtras);
6566 }
6567 }
6568 return this;
6569 }
6570
6571 /**
6572 * Add a set of extended data to the intent. The keys must include a package
6573 * prefix, for example the app com.android.contacts would use names
6574 * like "com.android.contacts.ShowAll".
6575 *
6576 * @param extras The Bundle of extras to add to this intent.
6577 *
6578 * @see #putExtra
6579 * @see #removeExtra
6580 */
6581 public Intent putExtras(Bundle extras) {
6582 if (mExtras == null) {
6583 mExtras = new Bundle();
6584 }
6585 mExtras.putAll(extras);
6586 return this;
6587 }
6588
6589 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006590 * Completely replace the extras in the Intent with the extras in the
6591 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006592 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006593 * @param src The exact extras contained in this Intent are copied
6594 * into the target intent, replacing any that were previously there.
6595 */
6596 public Intent replaceExtras(Intent src) {
6597 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6598 return this;
6599 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006600
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006601 /**
6602 * Completely replace the extras in the Intent with the given Bundle of
6603 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006604 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006605 * @param extras The new set of extras in the Intent, or null to erase
6606 * all extras.
6607 */
6608 public Intent replaceExtras(Bundle extras) {
6609 mExtras = extras != null ? new Bundle(extras) : null;
6610 return this;
6611 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006612
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006613 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006614 * Remove extended data from the intent.
6615 *
6616 * @see #putExtra
6617 */
6618 public void removeExtra(String name) {
6619 if (mExtras != null) {
6620 mExtras.remove(name);
6621 if (mExtras.size() == 0) {
6622 mExtras = null;
6623 }
6624 }
6625 }
6626
6627 /**
6628 * Set special flags controlling how this intent is handled. Most values
6629 * here depend on the type of component being executed by the Intent,
6630 * specifically the FLAG_ACTIVITY_* flags are all for use with
6631 * {@link Context#startActivity Context.startActivity()} and the
6632 * FLAG_RECEIVER_* flags are all for use with
6633 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6634 *
Scott Main7aee61f2011-02-08 11:25:01 -08006635 * <p>See the
6636 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6637 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006638 * the behavior of your application.
6639 *
6640 * @param flags The desired flags.
6641 *
6642 * @return Returns the same Intent object, for chaining multiple calls
6643 * into a single statement.
6644 *
6645 * @see #getFlags
6646 * @see #addFlags
6647 *
6648 * @see #FLAG_GRANT_READ_URI_PERMISSION
6649 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006650 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6651 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006652 * @see #FLAG_DEBUG_LOG_RESOLUTION
6653 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006654 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006655 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006656 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006657 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006658 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6659 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006660 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006661 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006662 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006663 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006664 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006665 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006666 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006667 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6668 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006669 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006670 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006671 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006672 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6673 */
6674 public Intent setFlags(int flags) {
6675 mFlags = flags;
6676 return this;
6677 }
6678
6679 /**
6680 * Add additional flags to the intent (or with existing flags
6681 * value).
6682 *
6683 * @param flags The new flags to set.
6684 *
6685 * @return Returns the same Intent object, for chaining multiple calls
6686 * into a single statement.
6687 *
6688 * @see #setFlags
6689 */
6690 public Intent addFlags(int flags) {
6691 mFlags |= flags;
6692 return this;
6693 }
6694
6695 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006696 * (Usually optional) Set an explicit application package name that limits
6697 * the components this Intent will resolve to. If left to the default
6698 * value of null, all components in all applications will considered.
6699 * If non-null, the Intent can only match the components in the given
6700 * application package.
6701 *
6702 * @param packageName The name of the application package to handle the
6703 * intent, or null to allow any application package.
6704 *
6705 * @return Returns the same Intent object, for chaining multiple calls
6706 * into a single statement.
6707 *
6708 * @see #getPackage
6709 * @see #resolveActivity
6710 */
6711 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006712 if (packageName != null && mSelector != null) {
6713 throw new IllegalArgumentException(
6714 "Can't set package name when selector is already set");
6715 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006716 mPackage = packageName;
6717 return this;
6718 }
6719
6720 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006721 * (Usually optional) Explicitly set the component to handle the intent.
6722 * If left with the default value of null, the system will determine the
6723 * appropriate class to use based on the other fields (action, data,
6724 * type, categories) in the Intent. If this class is defined, the
6725 * specified class will always be used regardless of the other fields. You
6726 * should only set this value when you know you absolutely want a specific
6727 * class to be used; otherwise it is better to let the system find the
6728 * appropriate class so that you will respect the installed applications
6729 * and user preferences.
6730 *
6731 * @param component The name of the application component to handle the
6732 * intent, or null to let the system find one for you.
6733 *
6734 * @return Returns the same Intent object, for chaining multiple calls
6735 * into a single statement.
6736 *
6737 * @see #setClass
6738 * @see #setClassName(Context, String)
6739 * @see #setClassName(String, String)
6740 * @see #getComponent
6741 * @see #resolveActivity
6742 */
6743 public Intent setComponent(ComponentName component) {
6744 mComponent = component;
6745 return this;
6746 }
6747
6748 /**
6749 * Convenience for calling {@link #setComponent} with an
6750 * explicit class name.
6751 *
6752 * @param packageContext A Context of the application package implementing
6753 * this class.
6754 * @param className The name of a class inside of the application package
6755 * that will be used as the component for this Intent.
6756 *
6757 * @return Returns the same Intent object, for chaining multiple calls
6758 * into a single statement.
6759 *
6760 * @see #setComponent
6761 * @see #setClass
6762 */
6763 public Intent setClassName(Context packageContext, String className) {
6764 mComponent = new ComponentName(packageContext, className);
6765 return this;
6766 }
6767
6768 /**
6769 * Convenience for calling {@link #setComponent} with an
6770 * explicit application package name and class name.
6771 *
6772 * @param packageName The name of the package implementing the desired
6773 * component.
6774 * @param className The name of a class inside of the application package
6775 * that will be used as the component for this Intent.
6776 *
6777 * @return Returns the same Intent object, for chaining multiple calls
6778 * into a single statement.
6779 *
6780 * @see #setComponent
6781 * @see #setClass
6782 */
6783 public Intent setClassName(String packageName, String className) {
6784 mComponent = new ComponentName(packageName, className);
6785 return this;
6786 }
6787
6788 /**
6789 * Convenience for calling {@link #setComponent(ComponentName)} with the
6790 * name returned by a {@link Class} object.
6791 *
6792 * @param packageContext A Context of the application package implementing
6793 * this class.
6794 * @param cls The class name to set, equivalent to
6795 * <code>setClassName(context, cls.getName())</code>.
6796 *
6797 * @return Returns the same Intent object, for chaining multiple calls
6798 * into a single statement.
6799 *
6800 * @see #setComponent
6801 */
6802 public Intent setClass(Context packageContext, Class<?> cls) {
6803 mComponent = new ComponentName(packageContext, cls);
6804 return this;
6805 }
6806
6807 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006808 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6809 * used as a hint to the receiver for animations and the like. Null means that there
6810 * is no source bounds.
6811 */
6812 public void setSourceBounds(Rect r) {
6813 if (r != null) {
6814 mSourceBounds = new Rect(r);
6815 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006816 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006817 }
6818 }
6819
Tor Norbyed9273d62013-05-30 15:59:53 -07006820 /** @hide */
6821 @IntDef(flag = true,
6822 value = {
6823 FILL_IN_ACTION,
6824 FILL_IN_DATA,
6825 FILL_IN_CATEGORIES,
6826 FILL_IN_COMPONENT,
6827 FILL_IN_PACKAGE,
6828 FILL_IN_SOURCE_BOUNDS,
6829 FILL_IN_SELECTOR,
6830 FILL_IN_CLIP_DATA
6831 })
6832 @Retention(RetentionPolicy.SOURCE)
6833 public @interface FillInFlags {}
6834
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006835 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006836 * Use with {@link #fillIn} to allow the current action value to be
6837 * overwritten, even if it is already set.
6838 */
6839 public static final int FILL_IN_ACTION = 1<<0;
6840
6841 /**
6842 * Use with {@link #fillIn} to allow the current data or type value
6843 * overwritten, even if it is already set.
6844 */
6845 public static final int FILL_IN_DATA = 1<<1;
6846
6847 /**
6848 * Use with {@link #fillIn} to allow the current categories to be
6849 * overwritten, even if they are already set.
6850 */
6851 public static final int FILL_IN_CATEGORIES = 1<<2;
6852
6853 /**
6854 * Use with {@link #fillIn} to allow the current component value to be
6855 * overwritten, even if it is already set.
6856 */
6857 public static final int FILL_IN_COMPONENT = 1<<3;
6858
6859 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006860 * Use with {@link #fillIn} to allow the current package value to be
6861 * overwritten, even if it is already set.
6862 */
6863 public static final int FILL_IN_PACKAGE = 1<<4;
6864
6865 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006866 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006867 * overwritten, even if it is already set.
6868 */
6869 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6870
6871 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006872 * Use with {@link #fillIn} to allow the current selector to be
6873 * overwritten, even if it is already set.
6874 */
6875 public static final int FILL_IN_SELECTOR = 1<<6;
6876
6877 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006878 * Use with {@link #fillIn} to allow the current ClipData to be
6879 * overwritten, even if it is already set.
6880 */
6881 public static final int FILL_IN_CLIP_DATA = 1<<7;
6882
6883 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006884 * Copy the contents of <var>other</var> in to this object, but only
6885 * where fields are not defined by this object. For purposes of a field
6886 * being defined, the following pieces of data in the Intent are
6887 * considered to be separate fields:
6888 *
6889 * <ul>
6890 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006891 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006892 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6893 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006894 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006895 * <li> component, as set by {@link #setComponent(ComponentName)} or
6896 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006897 * <li> source bounds, as set by {@link #setSourceBounds}.
6898 * <li> selector, as set by {@link #setSelector(Intent)}.
6899 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006900 * <li> each top-level name in the associated extras.
6901 * </ul>
6902 *
6903 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006904 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006905 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6906 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6907 * the restriction where the corresponding field will not be replaced if
6908 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006909 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006910 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6911 * is explicitly specified. The selector will only be copied if
6912 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006913 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006914 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6915 * and Intent B with {action="gotit", data-type="some/thing",
6916 * categories="one","two"}.
6917 *
6918 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6919 * containing: {action="gotit", data-type="some/thing",
6920 * categories="bar"}.
6921 *
6922 * @param other Another Intent whose values are to be used to fill in
6923 * the current one.
6924 * @param flags Options to control which fields can be filled in.
6925 *
6926 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006927 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006928 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6929 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6930 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006931 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006932 @FillInFlags
6933 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006934 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006935 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006936 if (other.mAction != null
6937 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006938 mAction = other.mAction;
6939 changes |= FILL_IN_ACTION;
6940 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006941 if ((other.mData != null || other.mType != null)
6942 && ((mData == null && mType == null)
6943 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006944 mData = other.mData;
6945 mType = other.mType;
6946 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006947 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006948 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006949 if (other.mCategories != null
6950 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006951 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006952 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006953 }
6954 changes |= FILL_IN_CATEGORIES;
6955 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006956 if (other.mPackage != null
6957 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006958 // Only do this if mSelector is not set.
6959 if (mSelector == null) {
6960 mPackage = other.mPackage;
6961 changes |= FILL_IN_PACKAGE;
6962 }
6963 }
6964 // Selector is special: it can only be set if explicitly allowed,
6965 // for the same reason as the component name.
6966 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6967 if (mPackage == null) {
6968 mSelector = new Intent(other.mSelector);
6969 mPackage = null;
6970 changes |= FILL_IN_SELECTOR;
6971 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006972 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006973 if (other.mClipData != null
6974 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6975 mClipData = other.mClipData;
6976 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006977 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006978 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006979 // Component is special: it can -only- be set if explicitly allowed,
6980 // since otherwise the sender could force the intent somewhere the
6981 // originator didn't intend.
6982 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006983 mComponent = other.mComponent;
6984 changes |= FILL_IN_COMPONENT;
6985 }
6986 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006987 if (other.mSourceBounds != null
6988 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6989 mSourceBounds = new Rect(other.mSourceBounds);
6990 changes |= FILL_IN_SOURCE_BOUNDS;
6991 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006992 if (mExtras == null) {
6993 if (other.mExtras != null) {
6994 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006995 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006996 }
6997 } else if (other.mExtras != null) {
6998 try {
6999 Bundle newb = new Bundle(other.mExtras);
7000 newb.putAll(mExtras);
7001 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007002 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007003 } catch (RuntimeException e) {
7004 // Modifying the extras can cause us to unparcel the contents
7005 // of the bundle, and if we do this in the system process that
7006 // may fail. We really should handle this (i.e., the Bundle
7007 // impl shouldn't be on top of a plain map), but for now just
7008 // ignore it and keep the original contents. :(
7009 Log.w("Intent", "Failure filling in extras", e);
7010 }
7011 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007012 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
7013 && other.mContentUserHint != UserHandle.USER_CURRENT) {
7014 mContentUserHint = other.mContentUserHint;
7015 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007016 return changes;
7017 }
7018
7019 /**
7020 * Wrapper class holding an Intent and implementing comparisons on it for
7021 * the purpose of filtering. The class implements its
7022 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
7023 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
7024 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
7025 * on the wrapped Intent.
7026 */
7027 public static final class FilterComparison {
7028 private final Intent mIntent;
7029 private final int mHashCode;
7030
7031 public FilterComparison(Intent intent) {
7032 mIntent = intent;
7033 mHashCode = intent.filterHashCode();
7034 }
7035
7036 /**
7037 * Return the Intent that this FilterComparison represents.
7038 * @return Returns the Intent held by the FilterComparison. Do
7039 * not modify!
7040 */
7041 public Intent getIntent() {
7042 return mIntent;
7043 }
7044
7045 @Override
7046 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007047 if (obj instanceof FilterComparison) {
7048 Intent other = ((FilterComparison)obj).mIntent;
7049 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007050 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007051 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007052 }
7053
7054 @Override
7055 public int hashCode() {
7056 return mHashCode;
7057 }
7058 }
7059
7060 /**
7061 * Determine if two intents are the same for the purposes of intent
7062 * resolution (filtering). That is, if their action, data, type,
7063 * class, and categories are the same. This does <em>not</em> compare
7064 * any extra data included in the intents.
7065 *
7066 * @param other The other Intent to compare against.
7067 *
7068 * @return Returns true if action, data, type, class, and categories
7069 * are the same.
7070 */
7071 public boolean filterEquals(Intent other) {
7072 if (other == null) {
7073 return false;
7074 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07007075 if (!Objects.equals(this.mAction, other.mAction)) return false;
7076 if (!Objects.equals(this.mData, other.mData)) return false;
7077 if (!Objects.equals(this.mType, other.mType)) return false;
7078 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
7079 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
7080 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007081
7082 return true;
7083 }
7084
7085 /**
7086 * Generate hash code that matches semantics of filterEquals().
7087 *
7088 * @return Returns the hash value of the action, data, type, class, and
7089 * categories.
7090 *
7091 * @see #filterEquals
7092 */
7093 public int filterHashCode() {
7094 int code = 0;
7095 if (mAction != null) {
7096 code += mAction.hashCode();
7097 }
7098 if (mData != null) {
7099 code += mData.hashCode();
7100 }
7101 if (mType != null) {
7102 code += mType.hashCode();
7103 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007104 if (mPackage != null) {
7105 code += mPackage.hashCode();
7106 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007107 if (mComponent != null) {
7108 code += mComponent.hashCode();
7109 }
7110 if (mCategories != null) {
7111 code += mCategories.hashCode();
7112 }
7113 return code;
7114 }
7115
7116 @Override
7117 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007118 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007119
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007120 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007121 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007122 b.append(" }");
7123
7124 return b.toString();
7125 }
7126
7127 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007128 public String toInsecureString() {
7129 StringBuilder b = new StringBuilder(128);
7130
7131 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007132 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007133 b.append(" }");
7134
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007135 return b.toString();
7136 }
Romain Guy4969af72009-06-17 10:53:19 -07007137
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007138 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007139 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007140 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007141
7142 b.append("Intent { ");
7143 toShortString(b, false, true, true, true);
7144 b.append(" }");
7145
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007146 return b.toString();
7147 }
7148
7149 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007150 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
7151 StringBuilder b = new StringBuilder(128);
7152 toShortString(b, secure, comp, extras, clip);
7153 return b.toString();
7154 }
7155
7156 /** @hide */
7157 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
7158 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007159 boolean first = true;
7160 if (mAction != null) {
7161 b.append("act=").append(mAction);
7162 first = false;
7163 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007164 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007165 if (!first) {
7166 b.append(' ');
7167 }
7168 first = false;
7169 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007170 for (int i=0; i<mCategories.size(); i++) {
7171 if (i > 0) b.append(',');
7172 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007173 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007174 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007175 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007176 if (mData != null) {
7177 if (!first) {
7178 b.append(' ');
7179 }
7180 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07007181 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007182 if (secure) {
7183 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07007184 } else {
7185 b.append(mData);
7186 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007187 }
7188 if (mType != null) {
7189 if (!first) {
7190 b.append(' ');
7191 }
7192 first = false;
7193 b.append("typ=").append(mType);
7194 }
7195 if (mFlags != 0) {
7196 if (!first) {
7197 b.append(' ');
7198 }
7199 first = false;
7200 b.append("flg=0x").append(Integer.toHexString(mFlags));
7201 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007202 if (mPackage != null) {
7203 if (!first) {
7204 b.append(' ');
7205 }
7206 first = false;
7207 b.append("pkg=").append(mPackage);
7208 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007209 if (comp && mComponent != null) {
7210 if (!first) {
7211 b.append(' ');
7212 }
7213 first = false;
7214 b.append("cmp=").append(mComponent.flattenToShortString());
7215 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007216 if (mSourceBounds != null) {
7217 if (!first) {
7218 b.append(' ');
7219 }
7220 first = false;
7221 b.append("bnds=").append(mSourceBounds.toShortString());
7222 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007223 if (mClipData != null) {
7224 if (!first) {
7225 b.append(' ');
7226 }
7227 first = false;
7228 if (clip) {
7229 b.append("clip={");
7230 mClipData.toShortString(b);
7231 b.append('}');
7232 } else {
7233 b.append("(has clip)");
7234 }
7235 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007236 if (extras && mExtras != null) {
7237 if (!first) {
7238 b.append(' ');
7239 }
7240 first = false;
7241 b.append("(has extras)");
7242 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007243 if (mContentUserHint != UserHandle.USER_CURRENT) {
7244 if (!first) {
7245 b.append(' ');
7246 }
7247 first = false;
7248 b.append("u=").append(mContentUserHint);
7249 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007250 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007251 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007252 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007253 b.append("}");
7254 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007255 }
7256
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007257 /**
7258 * Call {@link #toUri} with 0 flags.
7259 * @deprecated Use {@link #toUri} instead.
7260 */
7261 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007262 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007263 return toUri(0);
7264 }
7265
7266 /**
7267 * Convert this Intent into a String holding a URI representation of it.
7268 * The returned URI string has been properly URI encoded, so it can be
7269 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7270 * Intent's data as the base URI, with an additional fragment describing
7271 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007272 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007273 * <p>You can convert the returned string back to an Intent with
7274 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007275 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007276 * @param flags Additional operating flags. Either 0,
7277 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007278 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007279 * @return Returns a URI encoding URI string describing the entire contents
7280 * of the Intent.
7281 */
7282 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007283 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007284 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
7285 if (mPackage == null) {
7286 throw new IllegalArgumentException(
7287 "Intent must include an explicit package name to build an android-app: "
7288 + this);
7289 }
7290 uri.append("android-app://");
7291 uri.append(mPackage);
7292 String scheme = null;
7293 if (mData != null) {
7294 scheme = mData.getScheme();
7295 if (scheme != null) {
7296 uri.append('/');
7297 uri.append(scheme);
7298 String authority = mData.getEncodedAuthority();
7299 if (authority != null) {
7300 uri.append('/');
7301 uri.append(authority);
7302 String path = mData.getEncodedPath();
7303 if (path != null) {
7304 uri.append(path);
7305 }
7306 String queryParams = mData.getEncodedQuery();
7307 if (queryParams != null) {
7308 uri.append('?');
7309 uri.append(queryParams);
7310 }
7311 String fragment = mData.getEncodedFragment();
7312 if (fragment != null) {
7313 uri.append('#');
7314 uri.append(fragment);
7315 }
7316 }
7317 }
7318 }
7319 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
7320 mPackage, flags);
7321 return uri.toString();
7322 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007323 String scheme = null;
7324 if (mData != null) {
7325 String data = mData.toString();
7326 if ((flags&URI_INTENT_SCHEME) != 0) {
7327 final int N = data.length();
7328 for (int i=0; i<N; i++) {
7329 char c = data.charAt(i);
7330 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7331 || c == '.' || c == '-') {
7332 continue;
7333 }
7334 if (c == ':' && i > 0) {
7335 // Valid scheme.
7336 scheme = data.substring(0, i);
7337 uri.append("intent:");
7338 data = data.substring(i+1);
7339 break;
7340 }
Tom Taylord4a47292009-12-21 13:59:18 -08007341
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007342 // No scheme.
7343 break;
7344 }
7345 }
7346 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007347
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007348 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7349 uri.append("intent:");
7350 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007351
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007352 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007353
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007354 return uri.toString();
7355 }
7356
7357 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
7358 String defPackage, int flags) {
7359 StringBuilder frag = new StringBuilder(128);
7360
7361 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007362 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08007363 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007364 // Note that for now we are not going to try to handle the
7365 // data part; not clear how to represent this as a URI, and
7366 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007367 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
7368 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007369 }
7370
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007371 if (frag.length() > 0) {
7372 uri.append("#Intent;");
7373 uri.append(frag);
7374 uri.append("end");
7375 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007376 }
7377
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007378 private void toUriInner(StringBuilder uri, String scheme, String defAction,
7379 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007380 if (scheme != null) {
7381 uri.append("scheme=").append(scheme).append(';');
7382 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007383 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007384 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007385 }
7386 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007387 for (int i=0; i<mCategories.size(); i++) {
7388 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007389 }
7390 }
7391 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007392 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007393 }
7394 if (mFlags != 0) {
7395 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7396 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007397 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007398 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7399 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007400 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007401 uri.append("component=").append(Uri.encode(
7402 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007403 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007404 if (mSourceBounds != null) {
7405 uri.append("sourceBounds=")
7406 .append(Uri.encode(mSourceBounds.flattenToString()))
7407 .append(';');
7408 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007409 if (mExtras != null) {
7410 for (String key : mExtras.keySet()) {
7411 final Object value = mExtras.get(key);
7412 char entryType =
7413 value instanceof String ? 'S' :
7414 value instanceof Boolean ? 'B' :
7415 value instanceof Byte ? 'b' :
7416 value instanceof Character ? 'c' :
7417 value instanceof Double ? 'd' :
7418 value instanceof Float ? 'f' :
7419 value instanceof Integer ? 'i' :
7420 value instanceof Long ? 'l' :
7421 value instanceof Short ? 's' :
7422 '\0';
7423
7424 if (entryType != '\0') {
7425 uri.append(entryType);
7426 uri.append('.');
7427 uri.append(Uri.encode(key));
7428 uri.append('=');
7429 uri.append(Uri.encode(value.toString()));
7430 uri.append(';');
7431 }
7432 }
7433 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007434 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007435
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007436 public int describeContents() {
7437 return (mExtras != null) ? mExtras.describeContents() : 0;
7438 }
7439
7440 public void writeToParcel(Parcel out, int flags) {
7441 out.writeString(mAction);
7442 Uri.writeToParcel(out, mData);
7443 out.writeString(mType);
7444 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007445 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007446 ComponentName.writeToParcel(mComponent, out);
7447
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007448 if (mSourceBounds != null) {
7449 out.writeInt(1);
7450 mSourceBounds.writeToParcel(out, flags);
7451 } else {
7452 out.writeInt(0);
7453 }
7454
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007455 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007456 final int N = mCategories.size();
7457 out.writeInt(N);
7458 for (int i=0; i<N; i++) {
7459 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007460 }
7461 } else {
7462 out.writeInt(0);
7463 }
7464
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007465 if (mSelector != null) {
7466 out.writeInt(1);
7467 mSelector.writeToParcel(out, flags);
7468 } else {
7469 out.writeInt(0);
7470 }
7471
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007472 if (mClipData != null) {
7473 out.writeInt(1);
7474 mClipData.writeToParcel(out, flags);
7475 } else {
7476 out.writeInt(0);
7477 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007478 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007479 out.writeBundle(mExtras);
7480 }
7481
7482 public static final Parcelable.Creator<Intent> CREATOR
7483 = new Parcelable.Creator<Intent>() {
7484 public Intent createFromParcel(Parcel in) {
7485 return new Intent(in);
7486 }
7487 public Intent[] newArray(int size) {
7488 return new Intent[size];
7489 }
7490 };
7491
Dianne Hackborneb034652009-09-07 00:49:58 -07007492 /** @hide */
7493 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007494 readFromParcel(in);
7495 }
7496
7497 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007498 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007499 mData = Uri.CREATOR.createFromParcel(in);
7500 mType = in.readString();
7501 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007502 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007503 mComponent = ComponentName.readFromParcel(in);
7504
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007505 if (in.readInt() != 0) {
7506 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7507 }
7508
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007509 int N = in.readInt();
7510 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007511 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007512 int i;
7513 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007514 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007515 }
7516 } else {
7517 mCategories = null;
7518 }
7519
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007520 if (in.readInt() != 0) {
7521 mSelector = new Intent(in);
7522 }
7523
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007524 if (in.readInt() != 0) {
7525 mClipData = new ClipData(in);
7526 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007527 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007528 mExtras = in.readBundle();
7529 }
7530
7531 /**
7532 * Parses the "intent" element (and its children) from XML and instantiates
7533 * an Intent object. The given XML parser should be located at the tag
7534 * where parsing should start (often named "intent"), from which the
7535 * basic action, data, type, and package and class name will be
7536 * retrieved. The function will then parse in to any child elements,
7537 * looking for <category android:name="xxx"> tags to add categories and
7538 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7539 * to the intent.
7540 *
7541 * @param resources The Resources to use when inflating resources.
7542 * @param parser The XML parser pointing at an "intent" tag.
7543 * @param attrs The AttributeSet interface for retrieving extended
7544 * attribute data at the current <var>parser</var> location.
7545 * @return An Intent object matching the XML data.
7546 * @throws XmlPullParserException If there was an XML parsing error.
7547 * @throws IOException If there was an I/O error.
7548 */
7549 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7550 throws XmlPullParserException, IOException {
7551 Intent intent = new Intent();
7552
7553 TypedArray sa = resources.obtainAttributes(attrs,
7554 com.android.internal.R.styleable.Intent);
7555
7556 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7557
7558 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7559 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7560 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7561
7562 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7563 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7564 if (packageName != null && className != null) {
7565 intent.setComponent(new ComponentName(packageName, className));
7566 }
7567
7568 sa.recycle();
7569
7570 int outerDepth = parser.getDepth();
7571 int type;
7572 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7573 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7574 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7575 continue;
7576 }
7577
7578 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007579 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007580 sa = resources.obtainAttributes(attrs,
7581 com.android.internal.R.styleable.IntentCategory);
7582 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7583 sa.recycle();
7584
7585 if (cat != null) {
7586 intent.addCategory(cat);
7587 }
7588 XmlUtils.skipCurrentTag(parser);
7589
Craig Mautner21d24a22014-04-23 11:45:37 -07007590 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007591 if (intent.mExtras == null) {
7592 intent.mExtras = new Bundle();
7593 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007594 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007595 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007596
7597 } else {
7598 XmlUtils.skipCurrentTag(parser);
7599 }
7600 }
7601
7602 return intent;
7603 }
Nick Pellyccae4122012-01-09 14:12:58 -08007604
Craig Mautner21d24a22014-04-23 11:45:37 -07007605 /** @hide */
7606 public void saveToXml(XmlSerializer out) throws IOException {
7607 if (mAction != null) {
7608 out.attribute(null, ATTR_ACTION, mAction);
7609 }
7610 if (mData != null) {
7611 out.attribute(null, ATTR_DATA, mData.toString());
7612 }
7613 if (mType != null) {
7614 out.attribute(null, ATTR_TYPE, mType);
7615 }
7616 if (mComponent != null) {
7617 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7618 }
7619 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7620
7621 if (mCategories != null) {
7622 out.startTag(null, TAG_CATEGORIES);
7623 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7624 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7625 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007626 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007627 }
7628 }
7629
7630 /** @hide */
7631 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7632 XmlPullParserException {
7633 Intent intent = new Intent();
7634 final int outerDepth = in.getDepth();
7635
7636 int attrCount = in.getAttributeCount();
7637 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7638 final String attrName = in.getAttributeName(attrNdx);
7639 final String attrValue = in.getAttributeValue(attrNdx);
7640 if (ATTR_ACTION.equals(attrName)) {
7641 intent.setAction(attrValue);
7642 } else if (ATTR_DATA.equals(attrName)) {
7643 intent.setData(Uri.parse(attrValue));
7644 } else if (ATTR_TYPE.equals(attrName)) {
7645 intent.setType(attrValue);
7646 } else if (ATTR_COMPONENT.equals(attrName)) {
7647 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7648 } else if (ATTR_FLAGS.equals(attrName)) {
7649 intent.setFlags(Integer.valueOf(attrValue, 16));
7650 } else {
7651 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7652 }
7653 }
7654
7655 int event;
7656 String name;
7657 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7658 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7659 if (event == XmlPullParser.START_TAG) {
7660 name = in.getName();
7661 if (TAG_CATEGORIES.equals(name)) {
7662 attrCount = in.getAttributeCount();
7663 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7664 intent.addCategory(in.getAttributeValue(attrNdx));
7665 }
7666 } else {
7667 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7668 XmlUtils.skipCurrentTag(in);
7669 }
7670 }
7671 }
7672
7673 return intent;
7674 }
7675
Nick Pellyccae4122012-01-09 14:12:58 -08007676 /**
7677 * Normalize a MIME data type.
7678 *
7679 * <p>A normalized MIME type has white-space trimmed,
7680 * content-type parameters removed, and is lower-case.
7681 * This aligns the type with Android best practices for
7682 * intent filtering.
7683 *
7684 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7685 * "text/x-vCard" becomes "text/x-vcard".
7686 *
7687 * <p>All MIME types received from outside Android (such as user input,
7688 * or external sources like Bluetooth, NFC, or the Internet) should
7689 * be normalized before they are used to create an Intent.
7690 *
7691 * @param type MIME data type to normalize
7692 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007693 * @see #setType
7694 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007695 */
7696 public static String normalizeMimeType(String type) {
7697 if (type == null) {
7698 return null;
7699 }
7700
Elliott Hughescb64d432013-08-02 10:00:44 -07007701 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007702
7703 final int semicolonIndex = type.indexOf(';');
7704 if (semicolonIndex != -1) {
7705 type = type.substring(0, semicolonIndex);
7706 }
7707 return type;
7708 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007709
7710 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007711 * Prepare this {@link Intent} to leave an app process.
7712 *
7713 * @hide
7714 */
7715 public void prepareToLeaveProcess() {
7716 setAllowFds(false);
7717
7718 if (mSelector != null) {
7719 mSelector.prepareToLeaveProcess();
7720 }
7721 if (mClipData != null) {
7722 mClipData.prepareToLeaveProcess();
7723 }
7724
7725 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7726 // There are several ACTION_MEDIA_* broadcasts that send file://
7727 // Uris, so only check common actions.
7728 if (ACTION_VIEW.equals(mAction) ||
7729 ACTION_EDIT.equals(mAction) ||
7730 ACTION_ATTACH_DATA.equals(mAction)) {
7731 mData.checkFileUriExposed("Intent.getData()");
7732 }
7733 }
7734 }
7735
7736 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007737 * @hide
7738 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007739 public void prepareToEnterProcess() {
7740 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00007741 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
7742 fixUris(mContentUserHint);
7743 mContentUserHint = UserHandle.USER_CURRENT;
7744 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007745 }
7746 }
7747
7748 /**
7749 * @hide
7750 */
7751 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007752 Uri data = getData();
7753 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007754 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007755 }
7756 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007757 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007758 }
7759 String action = getAction();
7760 if (ACTION_SEND.equals(action)) {
7761 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7762 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007763 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007764 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007765 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007766 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7767 if (streams != null) {
7768 ArrayList<Uri> newStreams = new ArrayList<Uri>();
7769 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007770 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007771 }
7772 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
7773 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007774 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7775 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7776 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7777 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7778 if (output != null) {
7779 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
7780 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007781 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007782 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007783
7784 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007785 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007786 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7787 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007788 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007789 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007790 * @hide
7791 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007792 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007793 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007794 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007795
7796 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007797 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007798
7799 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007800 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007801 // Inspect contained intents to see if we need to migrate extras. We
7802 // don't promote ClipData to the parent, since ChooserActivity will
7803 // already start the picked item as the caller, and we can't combine
7804 // the flags in a safe way.
7805
7806 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07007807 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007808 final Intent intent = getParcelableExtra(EXTRA_INTENT);
7809 if (intent != null) {
7810 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07007811 }
7812 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007813 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007814 try {
7815 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
7816 if (intents != null) {
7817 for (int i = 0; i < intents.length; i++) {
7818 final Intent intent = (Intent) intents[i];
7819 if (intent != null) {
7820 migrated |= intent.migrateExtraStreamToClipData();
7821 }
7822 }
7823 }
7824 } catch (ClassCastException e) {
7825 }
7826 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007827
7828 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007829 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007830 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7831 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7832 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7833 if (stream != null || text != null || htmlText != null) {
7834 final ClipData clipData = new ClipData(
7835 null, new String[] { getType() },
7836 new ClipData.Item(text, htmlText, null, stream));
7837 setClipData(clipData);
7838 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007839 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007840 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007841 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007842 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007843
7844 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007845 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007846 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7847 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7848 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7849 int num = -1;
7850 if (streams != null) {
7851 num = streams.size();
7852 }
7853 if (texts != null) {
7854 if (num >= 0 && num != texts.size()) {
7855 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007856 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007857 }
7858 num = texts.size();
7859 }
7860 if (htmlTexts != null) {
7861 if (num >= 0 && num != htmlTexts.size()) {
7862 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007863 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007864 }
7865 num = htmlTexts.size();
7866 }
7867 if (num > 0) {
7868 final ClipData clipData = new ClipData(
7869 null, new String[] { getType() },
7870 makeClipItem(streams, texts, htmlTexts, 0));
7871
7872 for (int i = 1; i < num; i++) {
7873 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7874 }
7875
7876 setClipData(clipData);
7877 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007878 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007879 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007880 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007881 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007882 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7883 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7884 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7885 final Uri output;
7886 try {
7887 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7888 } catch (ClassCastException e) {
7889 return false;
7890 }
7891 if (output != null) {
7892 setClipData(ClipData.newRawUri("", output));
7893 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
7894 return true;
7895 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007896 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007897
7898 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007899 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007900
7901 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7902 ArrayList<String> htmlTexts, int which) {
7903 Uri uri = streams != null ? streams.get(which) : null;
7904 CharSequence text = texts != null ? texts.get(which) : null;
7905 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7906 return new ClipData.Item(text, htmlText, null, uri);
7907 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007908
7909 /** @hide */
7910 public boolean isDocument() {
7911 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7912 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007913}