blob: cafccbf8726579c69eaeb264e08b5a47eb5ddc7f [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
Yusuke Sato705ffd12015-07-21 15:52:11 -07002021 * to request confirmation from the user before shutting down. The optional boolean
2022 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2023 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002024 *
2025 * <p class="note">This is a protected intent that can only be sent
2026 * by the system.
2027 *
2028 * {@hide}
2029 */
2030 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2031 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002032 * Broadcast Action: A sticky broadcast that indicates low memory
2033 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002034 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002035 * <p class="note">This is a protected intent that can only be sent
2036 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002037 */
2038 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2039 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2040 /**
2041 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002042 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002043 * <p class="note">This is a protected intent that can only be sent
2044 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002045 */
2046 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2047 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2048 /**
Jake Hambybb371632010-08-23 18:16:48 -07002049 * Broadcast Action: A sticky broadcast that indicates a memory full
2050 * condition on the device. This is intended for activities that want
2051 * to be able to fill the data partition completely, leaving only
2052 * enough free space to prevent system-wide SQLite failures.
2053 *
2054 * <p class="note">This is a protected intent that can only be sent
2055 * by the system.
2056 *
2057 * {@hide}
2058 */
2059 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2060 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2061 /**
2062 * Broadcast Action: Indicates memory full condition on the device
2063 * no longer exists.
2064 *
2065 * <p class="note">This is a protected intent that can only be sent
2066 * by the system.
2067 *
2068 * {@hide}
2069 */
2070 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2071 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2072 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002073 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2074 * and package management should be started.
2075 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2076 * notification.
2077 */
2078 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2079 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2080 /**
2081 * Broadcast Action: The device has entered USB Mass Storage mode.
2082 * This is used mainly for the USB Settings panel.
2083 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2084 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002085 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002086 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002087 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002088 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2089
2090 /**
2091 * Broadcast Action: The device has exited USB Mass Storage mode.
2092 * This is used mainly for the USB Settings panel.
2093 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2094 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002095 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002096 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002097 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002098 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2099
2100 /**
2101 * Broadcast Action: External media has been removed.
2102 * The path to the mount point for the removed media is contained in the Intent.mData field.
2103 */
2104 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2105 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2106
2107 /**
2108 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002109 * 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 -07002110 */
2111 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2112 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2113
2114 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002115 * Broadcast Action: External media is present, and being disk-checked
2116 * 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 -08002117 */
2118 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2119 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2120
2121 /**
2122 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2123 * 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 -08002124 */
2125 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2126 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2127
2128 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002129 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002130 * 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 -07002131 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2132 * media was mounted read only.
2133 */
2134 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2135 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2136
2137 /**
2138 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002139 * 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 -07002140 */
2141 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2142 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2143
2144 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002145 * Broadcast Action: External media is no longer being shared via USB mass storage.
2146 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2147 *
2148 * @hide
2149 */
2150 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2151
2152 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002153 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2154 * The path to the mount point for the removed media is contained in the Intent.mData field.
2155 */
2156 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2157 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2158
2159 /**
2160 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002161 * 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 -07002162 */
2163 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2164 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2165
2166 /**
2167 * Broadcast Action: User has expressed the desire to remove the external storage media.
2168 * Applications should close all files they have open within the mount point when they receive this intent.
2169 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2170 */
2171 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2172 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2173
2174 /**
2175 * Broadcast Action: The media scanner has started scanning a directory.
2176 * The path to the directory being scanned is contained in the Intent.mData field.
2177 */
2178 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2179 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2180
2181 /**
2182 * Broadcast Action: The media scanner has finished scanning a directory.
2183 * The path to the scanned directory is contained in the Intent.mData field.
2184 */
2185 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2186 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2187
2188 /**
2189 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2190 * The path to the file is contained in the Intent.mData field.
2191 */
2192 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2193 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2194
2195 /**
2196 * Broadcast Action: The "Media Button" was pressed. Includes a single
2197 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2198 * caused the broadcast.
2199 */
2200 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2201 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2202
2203 /**
2204 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2205 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2206 * caused the broadcast.
2207 */
2208 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2209 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2210
2211 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2212 // location; they are not general-purpose actions.
2213
2214 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002215 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002216 */
2217 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2218 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2219 "android.intent.action.GTALK_CONNECTED";
2220
2221 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002222 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002223 */
2224 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2225 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2226 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002227
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002228 /**
2229 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002230 */
2231 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2232 public static final String ACTION_INPUT_METHOD_CHANGED =
2233 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002234
2235 /**
2236 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2237 * more radios have been turned off or on. The intent will have the following extra value:</p>
2238 * <ul>
2239 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2240 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2241 * turned off</li>
2242 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002243 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002244 * <p class="note">This is a protected intent that can only be sent
2245 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002246 */
2247 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2248 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2249
2250 /**
2251 * Broadcast Action: Some content providers have parts of their namespace
2252 * where they publish new events or items that the user may be especially
2253 * interested in. For these things, they may broadcast this action when the
2254 * set of interesting items change.
2255 *
2256 * For example, GmailProvider sends this notification when the set of unread
2257 * mail in the inbox changes.
2258 *
2259 * <p>The data of the intent identifies which part of which provider
2260 * changed. When queried through the content resolver, the data URI will
2261 * return the data set in question.
2262 *
2263 * <p>The intent will have the following extra values:
2264 * <ul>
2265 * <li><em>count</em> - The number of items in the data set. This is the
2266 * same as the number of items in the cursor returned by querying the
2267 * data URI. </li>
2268 * </ul>
2269 *
2270 * This intent will be sent at boot (if the count is non-zero) and when the
2271 * data set changes. It is possible for the data set to change without the
2272 * count changing (for example, if a new unread message arrives in the same
2273 * sync operation in which a message is archived). The phone should still
2274 * ring/vibrate/etc as normal in this case.
2275 */
2276 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2277 public static final String ACTION_PROVIDER_CHANGED =
2278 "android.intent.action.PROVIDER_CHANGED";
2279
2280 /**
2281 * Broadcast Action: Wired Headset plugged in or unplugged.
2282 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002283 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2284 * and documentation.
2285 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002286 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002287 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002288 */
2289 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002290 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002291
2292 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002293 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2294 * <ul>
2295 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2296 * </ul>
2297 *
2298 * <p class="note">This is a protected intent that can only be sent
2299 * by the system.
2300 *
2301 * @hide
2302 */
2303 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2304 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2305 = "android.intent.action.ADVANCED_SETTINGS";
2306
2307 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002308 * Broadcast Action: Sent after application restrictions are changed.
2309 *
2310 * <p class="note">This is a protected intent that can only be sent
2311 * by the system.</p>
2312 */
2313 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2314 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2315 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2316
2317 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002318 * Broadcast Action: An outgoing call is about to be placed.
2319 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002320 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002321 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002322 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002323 * the phone number originally intended to be dialed.</li>
2324 * </ul>
2325 * <p>Once the broadcast is finished, the resultData is used as the actual
2326 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002327 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002328 * outgoing call in turn: for example, a parental control application
2329 * might verify that the user is authorized to place the call at that
2330 * time, then a number-rewriting application might add an area code if
2331 * one was not specified.</p>
2332 * <p>For consistency, any receiver whose purpose is to prohibit phone
2333 * calls should have a priority of 0, to ensure it will see the final
2334 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002335 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002336 * should have a positive priority.
2337 * Negative priorities are reserved for the system for this broadcast;
2338 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002339 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2340 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002341 * <p>Emergency calls cannot be intercepted using this mechanism, and
2342 * other calls cannot be modified to call emergency numbers using this
2343 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002344 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2345 * call to use their own service instead. Those apps should first prevent
2346 * the call from being placed by setting resultData to <code>null</code>
2347 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002348 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002349 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2350 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002351 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002352 * <p class="note">This is a protected intent that can only be sent
2353 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002354 */
2355 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2356 public static final String ACTION_NEW_OUTGOING_CALL =
2357 "android.intent.action.NEW_OUTGOING_CALL";
2358
2359 /**
2360 * Broadcast Action: Have the device reboot. This is only for use by
2361 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002362 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002363 * <p class="note">This is a protected intent that can only be sent
2364 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002365 */
2366 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2367 public static final String ACTION_REBOOT =
2368 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002369
Wei Huang97ecc9c2009-05-11 17:44:20 -07002370 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002371 * Broadcast Action: A sticky broadcast for changes in the physical
2372 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002373 *
2374 * <p>The intent will have the following extra values:
2375 * <ul>
2376 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002377 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002378 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002379 * <p>This is intended for monitoring the current physical dock state.
2380 * See {@link android.app.UiModeManager} for the normal API dealing with
2381 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002382 */
2383 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2384 public static final String ACTION_DOCK_EVENT =
2385 "android.intent.action.DOCK_EVENT";
2386
2387 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002388 * Broadcast Action: A broadcast when idle maintenance can be started.
2389 * This means that the user is not interacting with the device and is
2390 * not expected to do so soon. Typical use of the idle maintenance is
2391 * to perform somehow expensive tasks that can be postponed at a moment
2392 * when they will not degrade user experience.
2393 * <p>
2394 * <p class="note">In order to keep the device responsive in case of an
2395 * unexpected user interaction, implementations of a maintenance task
2396 * should be interruptible. In such a scenario a broadcast with action
2397 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2398 * should not do the maintenance work in
2399 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2400 * maintenance service by {@link Context#startService(Intent)}. Also
2401 * you should hold a wake lock while your maintenance service is running
2402 * to prevent the device going to sleep.
2403 * </p>
2404 * <p>
2405 * <p class="note">This is a protected intent that can only be sent by
2406 * the system.
2407 * </p>
2408 *
2409 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002410 *
2411 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002412 */
2413 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2414 public static final String ACTION_IDLE_MAINTENANCE_START =
2415 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2416
2417 /**
2418 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2419 * This means that the user was not interacting with the device as a result
2420 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2421 * was sent and now the user started interacting with the device. Typical
2422 * use of the idle maintenance is to perform somehow expensive tasks that
2423 * can be postponed at a moment when they will not degrade user experience.
2424 * <p>
2425 * <p class="note">In order to keep the device responsive in case of an
2426 * unexpected user interaction, implementations of a maintenance task
2427 * should be interruptible. Hence, on receiving a broadcast with this
2428 * action, the maintenance task should be interrupted as soon as possible.
2429 * In other words, you should not do the maintenance work in
2430 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2431 * maintenance service that was started on receiving of
2432 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2433 * lock you acquired when your maintenance service started.
2434 * </p>
2435 * <p class="note">This is a protected intent that can only be sent
2436 * by the system.
2437 *
2438 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002439 *
2440 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002441 */
2442 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2443 public static final String ACTION_IDLE_MAINTENANCE_END =
2444 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2445
2446 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002447 * Broadcast Action: a remote intent is to be broadcasted.
2448 *
2449 * A remote intent is used for remote RPC between devices. The remote intent
2450 * is serialized and sent from one device to another device. The receiving
2451 * device parses the remote intent and broadcasts it. Note that anyone can
2452 * broadcast a remote intent. However, if the intent receiver of the remote intent
2453 * does not trust intent broadcasts from arbitrary intent senders, it should require
2454 * the sender to hold certain permissions so only trusted sender's broadcast will be
2455 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002456 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002457 */
2458 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002459 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002460
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002461 /**
2462 * Broadcast Action: hook for permforming cleanup after a system update.
2463 *
2464 * The broadcast is sent when the system is booting, before the
2465 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2466 * image. A receiver for this should do its work and then disable itself
2467 * so that it does not get run again at the next boot.
2468 * @hide
2469 */
2470 public static final String ACTION_PRE_BOOT_COMPLETED =
2471 "android.intent.action.PRE_BOOT_COMPLETED";
2472
Amith Yamasani13593602012-03-22 16:16:17 -07002473 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002474 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002475 * on restricted users. The broadcast intent contains an extra
2476 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2477 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2478 * String[] depending on the restriction type.<p/>
2479 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002480 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2481 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2482 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002483 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2484 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002485 * @see RestrictionEntry
2486 */
2487 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2488 "android.intent.action.GET_RESTRICTION_ENTRIES";
2489
2490 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002491 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002492 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002493 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2494 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2495 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002496 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2497 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2498 * challenge.<p/>
2499 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002500 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002501 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002502 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2503 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002504
2505 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002506 * Sent the first time a user is starting, to allow system apps to
2507 * perform one time initialization. (This will not be seen by third
2508 * party applications because a newly initialized user does not have any
2509 * third party applications installed for it.) This is sent early in
2510 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002511 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2512 * broadcast, since it is part of a visible user interaction; be as quick
2513 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002514 */
2515 public static final String ACTION_USER_INITIALIZE =
2516 "android.intent.action.USER_INITIALIZE";
2517
2518 /**
2519 * Sent when a user switch is happening, causing the process's user to be
2520 * brought to the foreground. This is only sent to receivers registered
2521 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2522 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002523 * foreground. This is sent as a foreground
2524 * broadcast, since it is part of a visible user interaction; be as quick
2525 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002526 */
2527 public static final String ACTION_USER_FOREGROUND =
2528 "android.intent.action.USER_FOREGROUND";
2529
2530 /**
2531 * Sent when a user switch is happening, causing the process's user to be
2532 * sent to the background. This is only sent to receivers registered
2533 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2534 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002535 * background. This is sent as a foreground
2536 * broadcast, since it is part of a visible user interaction; be as quick
2537 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002538 */
2539 public static final String ACTION_USER_BACKGROUND =
2540 "android.intent.action.USER_BACKGROUND";
2541
2542 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002543 * Broadcast sent to the system when a user is added. Carries an extra
2544 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2545 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002546 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002547 * @hide
2548 */
2549 public static final String ACTION_USER_ADDED =
2550 "android.intent.action.USER_ADDED";
2551
2552 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002553 * Broadcast sent by the system when a user is started. Carries an extra
2554 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002555 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002556 * that has been started. This is sent as a foreground
2557 * broadcast, since it is part of a visible user interaction; be as quick
2558 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002559 * @hide
2560 */
2561 public static final String ACTION_USER_STARTED =
2562 "android.intent.action.USER_STARTED";
2563
2564 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002565 * Broadcast sent when a user is in the process of starting. Carries an extra
2566 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2567 * sent to registered receivers, not manifest receivers. It is sent to all
2568 * users (including the one that is being started). You must hold
2569 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2570 * this broadcast. This is sent as a background broadcast, since
2571 * its result is not part of the primary UX flow; to safely keep track of
2572 * started/stopped state of a user you can use this in conjunction with
2573 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2574 * other user state broadcasts since those are foreground broadcasts so can
2575 * execute in a different order.
2576 * @hide
2577 */
2578 public static final String ACTION_USER_STARTING =
2579 "android.intent.action.USER_STARTING";
2580
2581 /**
2582 * Broadcast sent when a user is going to be stopped. Carries an extra
2583 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2584 * sent to registered receivers, not manifest receivers. It is sent to all
2585 * users (including the one that is being stopped). You must hold
2586 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2587 * this broadcast. The user will not stop until all receivers have
2588 * handled the broadcast. This is sent as a background broadcast, since
2589 * its result is not part of the primary UX flow; to safely keep track of
2590 * started/stopped state of a user you can use this in conjunction with
2591 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2592 * other user state broadcasts since those are foreground broadcasts so can
2593 * execute in a different order.
2594 * @hide
2595 */
2596 public static final String ACTION_USER_STOPPING =
2597 "android.intent.action.USER_STOPPING";
2598
2599 /**
2600 * Broadcast sent to the system when a user is stopped. Carries an extra
2601 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2602 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2603 * specific package. This is only sent to registered receivers, not manifest
2604 * receivers. It is sent to all running users <em>except</em> the one that
2605 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002606 * @hide
2607 */
2608 public static final String ACTION_USER_STOPPED =
2609 "android.intent.action.USER_STOPPED";
2610
2611 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002612 * 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 -07002613 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002614 * one that has been removed. The user will not be completely removed until all receivers have
2615 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002616 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002617 * @hide
2618 */
2619 public static final String ACTION_USER_REMOVED =
2620 "android.intent.action.USER_REMOVED";
2621
2622 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002623 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002624 * the userHandle of the user to become the current one. This is only sent to
2625 * registered receivers, not manifest receivers. It is sent to all running users.
2626 * You must hold
2627 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002628 * @hide
2629 */
2630 public static final String ACTION_USER_SWITCHED =
2631 "android.intent.action.USER_SWITCHED";
2632
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002633 /**
2634 * Broadcast sent to the system when a user's information changes. Carries an extra
2635 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002636 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002637 * @hide
2638 */
2639 public static final String ACTION_USER_INFO_CHANGED =
2640 "android.intent.action.USER_INFO_CHANGED";
2641
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002642 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002643 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2644 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002645 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2646 * that need to display merged content across both primary and managed profiles need to
2647 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002648 * not manifest receivers.
2649 */
2650 public static final String ACTION_MANAGED_PROFILE_ADDED =
2651 "android.intent.action.MANAGED_PROFILE_ADDED";
2652
2653 /**
2654 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002655 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2656 * Only applications (for example Launchers) that need to display merged content across both
2657 * primary and managed profiles need to worry about this broadcast. This is only sent to
2658 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002659 */
2660 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2661 "android.intent.action.MANAGED_PROFILE_REMOVED";
2662
2663 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002664 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2665 */
2666 public static final String ACTION_QUICK_CLOCK =
2667 "android.intent.action.QUICK_CLOCK";
2668
Michael Wright0087a142013-02-05 16:29:39 -08002669 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002670 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002671 * @hide
2672 */
2673 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2674 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2675
Justin Kohd378ad72013-04-01 12:18:26 -07002676 /**
2677 * Broadcast Action: A global button was pressed. Includes a single
2678 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2679 * caused the broadcast.
2680 * @hide
2681 */
2682 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2683
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002684 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002685 * Activity Action: Allow the user to select and return one or more existing
2686 * documents. When invoked, the system will display the various
2687 * {@link DocumentsProvider} instances installed on the device, letting the
2688 * user interactively navigate through them. These documents include local
2689 * media, such as photos and video, and documents provided by installed
2690 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002691 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002692 * Each document is represented as a {@code content://} URI backed by a
2693 * {@link DocumentsProvider}, which can be opened as a stream with
2694 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2695 * {@link android.provider.DocumentsContract.Document} metadata.
2696 * <p>
2697 * All selected documents are returned to the calling application with
2698 * persistable read and write permission grants. If you want to maintain
2699 * access to the documents across device reboots, you need to explicitly
2700 * take the persistable permissions using
2701 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2702 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002703 * Callers must indicate the acceptable document MIME types through
2704 * {@link #setType(String)}. For example, to select photos, use
2705 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2706 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2707 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002708 * <p>
2709 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002710 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2711 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002712 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002713 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2714 * returned URIs can be opened with
2715 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002716 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002717 * Output: The URI of the item that was picked, returned in
2718 * {@link #getData()}. This must be a {@code content://} URI so that any
2719 * receiver can access it. If multiple documents were selected, they are
2720 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002721 *
2722 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002723 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002724 * @see #ACTION_CREATE_DOCUMENT
2725 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002726 */
2727 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2728 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2729
2730 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002731 * Activity Action: Allow the user to create a new document. When invoked,
2732 * the system will display the various {@link DocumentsProvider} instances
2733 * installed on the device, letting the user navigate through them. The
2734 * returned document may be a newly created document with no content, or it
2735 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002736 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002737 * Each document is represented as a {@code content://} URI backed by a
2738 * {@link DocumentsProvider}, which can be opened as a stream with
2739 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2740 * {@link android.provider.DocumentsContract.Document} metadata.
2741 * <p>
2742 * Callers must indicate the concrete MIME type of the document being
2743 * created by setting {@link #setType(String)}. This MIME type cannot be
2744 * changed after the document is created.
2745 * <p>
2746 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2747 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002748 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002749 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2750 * returned URIs can be opened with
2751 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002752 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002753 * Output: The URI of the item that was created. This must be a
2754 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002755 *
2756 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002757 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002758 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002759 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002760 */
2761 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2762 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2763
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002764 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002765 * Activity Action: Allow the user to pick a directory subtree. When
2766 * invoked, the system will display the various {@link DocumentsProvider}
2767 * instances installed on the device, letting the user navigate through
2768 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002769 * <p>
2770 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002771 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2772 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2773 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002774 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002775 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002776 *
2777 * @see DocumentsContract
2778 */
2779 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002780 public static final String
2781 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002782
Jeff Sharkey004a4b22014-09-24 11:45:24 -07002783 /** {@hide} */
2784 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
2785
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002786 // ---------------------------------------------------------------------
2787 // ---------------------------------------------------------------------
2788 // Standard intent categories (see addCategory()).
2789
2790 /**
2791 * Set if the activity should be an option for the default action
2792 * (center press) to perform on a piece of data. Setting this will
2793 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002794 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002795 * Intent when initiating an action -- it is for use in intent filters
2796 * specified in packages.
2797 */
2798 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2799 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2800 /**
2801 * Activities that can be safely invoked from a browser must support this
2802 * category. For example, if the user is viewing a web page or an e-mail
2803 * and clicks on a link in the text, the Intent generated execute that
2804 * link will require the BROWSABLE category, so that only activities
2805 * supporting this category will be considered as possible actions. By
2806 * supporting this category, you are promising that there is nothing
2807 * damaging (without user intervention) that can happen by invoking any
2808 * matching Intent.
2809 */
2810 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2811 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2812 /**
Dianne Hackbornd7c03952014-08-29 17:32:04 -07002813 * @hide
Dianne Hackborn91097de2014-04-04 18:02:06 -07002814 * Categories for activities that can participate in voice interaction.
2815 * An activity that supports this category must be prepared to run with
2816 * no UI shown at all (though in some case it may have a UI shown), and
2817 * rely on {@link android.app.VoiceInteractor} to interact with the user.
2818 */
2819 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
Dianne Hackbornd7c03952014-08-29 17:32:04 -07002820 @SystemApi
Dianne Hackborn91097de2014-04-04 18:02:06 -07002821 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2822 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002823 * Set if the activity should be considered as an alternative action to
2824 * the data the user is currently viewing. See also
2825 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2826 * applies to the selection in a list of items.
2827 *
2828 * <p>Supporting this category means that you would like your activity to be
2829 * displayed in the set of alternative things the user can do, usually as
2830 * part of the current activity's options menu. You will usually want to
2831 * include a specific label in the &lt;intent-filter&gt; of this action
2832 * describing to the user what it does.
2833 *
2834 * <p>The action of IntentFilter with this category is important in that it
2835 * describes the specific action the target will perform. This generally
2836 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2837 * a specific name such as "com.android.camera.action.CROP. Only one
2838 * alternative of any particular action will be shown to the user, so using
2839 * a specific action like this makes sure that your alternative will be
2840 * displayed while also allowing other applications to provide their own
2841 * overrides of that particular action.
2842 */
2843 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2844 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2845 /**
2846 * Set if the activity should be considered as an alternative selection
2847 * action to the data the user has currently selected. This is like
2848 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2849 * of items from which the user can select, giving them alternatives to the
2850 * default action that will be performed on it.
2851 */
2852 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2853 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2854 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002855 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002856 */
2857 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2858 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2859 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002860 * Should be displayed in the top-level launcher.
2861 */
2862 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2863 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2864 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002865 * Indicates an activity optimized for Leanback mode, and that should
2866 * be displayed in the Leanback launcher.
2867 */
2868 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2869 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2870 /**
Jose Lima73915cf2014-07-29 17:16:31 -07002871 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
2872 * @hide
2873 */
2874 @SystemApi
2875 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
2876 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002877 * Provides information about the package it is in; typically used if
2878 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2879 * a front-door to the user without having to be shown in the all apps list.
2880 */
2881 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2882 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2883 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002884 * This is the home activity, that is the first activity that is displayed
2885 * when the device boots.
2886 */
2887 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2888 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2889 /**
2890 * This activity is a preference panel.
2891 */
2892 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2893 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2894 /**
2895 * This activity is a development preference panel.
2896 */
2897 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2898 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2899 /**
2900 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002901 */
2902 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2903 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2904 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002905 * This activity allows the user to browse and download new applications.
2906 */
2907 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2908 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2909 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002910 * This activity may be exercised by the monkey or other automated test tools.
2911 */
2912 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2913 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2914 /**
2915 * To be used as a test (not part of the normal user experience).
2916 */
2917 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2918 /**
2919 * To be used as a unit test (run through the Test Harness).
2920 */
2921 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2922 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002923 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002924 * experience).
2925 */
2926 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002927
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002928 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002929 * Used to indicate that an intent only wants URIs that can be opened with
2930 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2931 * must support at least the columns defined in {@link OpenableColumns} when
2932 * queried.
2933 *
2934 * @see #ACTION_GET_CONTENT
2935 * @see #ACTION_OPEN_DOCUMENT
2936 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002937 */
2938 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2939 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2940
2941 /**
2942 * To be used as code under test for framework instrumentation tests.
2943 */
2944 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2945 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002946 /**
2947 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002948 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2949 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002950 */
2951 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2952 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2953 /**
2954 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002955 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2956 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002957 */
2958 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2959 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002960 /**
2961 * An activity to run when device is inserted into a analog (low end) dock.
2962 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2963 * information, see {@link android.app.UiModeManager}.
2964 */
2965 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2966 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2967
2968 /**
2969 * An activity to run when device is inserted into a digital (high end) dock.
2970 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2971 * information, see {@link android.app.UiModeManager}.
2972 */
2973 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2974 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002975
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002976 /**
2977 * Used to indicate that the activity can be used in a car environment.
2978 */
2979 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2980 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2981
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002982 // ---------------------------------------------------------------------
2983 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002984 // Application launch intent categories (see addCategory()).
2985
2986 /**
2987 * Used with {@link #ACTION_MAIN} to launch the browser application.
2988 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002989 * <p>NOTE: This should not be used as the primary key of an Intent,
2990 * since it will not result in the app launching with the correct
2991 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002992 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002993 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002994 */
2995 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2996 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2997
2998 /**
2999 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3000 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003001 * <p>NOTE: This should not be used as the primary key of an Intent,
3002 * since it will not result in the app launching with the correct
3003 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003004 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003005 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003006 */
3007 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3008 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3009
3010 /**
3011 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3012 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003013 * <p>NOTE: This should not be used as the primary key of an Intent,
3014 * since it will not result in the app launching with the correct
3015 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003016 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003017 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003018 */
3019 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3020 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3021
3022 /**
3023 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3024 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003025 * <p>NOTE: This should not be used as the primary key of an Intent,
3026 * since it will not result in the app launching with the correct
3027 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003028 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003029 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003030 */
3031 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3032 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3033
3034 /**
3035 * Used with {@link #ACTION_MAIN} to launch the email application.
3036 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003037 * <p>NOTE: This should not be used as the primary key of an Intent,
3038 * since it will not result in the app launching with the correct
3039 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003040 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003041 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003042 */
3043 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3044 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3045
3046 /**
3047 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3048 * The activity should be able to view and manipulate image and video files
3049 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003050 * <p>NOTE: This should not be used as the primary key of an Intent,
3051 * since it will not result in the app launching with the correct
3052 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003053 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003054 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003055 */
3056 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3057 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3058
3059 /**
3060 * Used with {@link #ACTION_MAIN} to launch the maps application.
3061 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003062 * <p>NOTE: This should not be used as the primary key of an Intent,
3063 * since it will not result in the app launching with the correct
3064 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003065 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003066 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003067 */
3068 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3069 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3070
3071 /**
3072 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3073 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003074 * <p>NOTE: This should not be used as the primary key of an Intent,
3075 * since it will not result in the app launching with the correct
3076 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003077 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003078 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003079 */
3080 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3081 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3082
3083 /**
3084 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003085 * The activity should be able to play, browse, or manipulate music files
3086 * stored on the device.
3087 * <p>NOTE: This should not be used as the primary key of an Intent,
3088 * since it will not result in the app launching with the correct
3089 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003090 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003091 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003092 */
3093 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3094 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3095
3096 // ---------------------------------------------------------------------
3097 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003098 // Standard extra data keys.
3099
3100 /**
3101 * The initial data to place in a newly created record. Use with
3102 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3103 * fields as would be given to the underlying ContentProvider.insert()
3104 * call.
3105 */
3106 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3107
3108 /**
3109 * A constant CharSequence that is associated with the Intent, used with
3110 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3111 * this may be a styled CharSequence, so you must use
3112 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3113 * retrieve it.
3114 */
3115 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3116
3117 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003118 * A constant String that is associated with the Intent, used with
3119 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3120 * as HTML formatted text. Note that you <em>must</em> also supply
3121 * {@link #EXTRA_TEXT}.
3122 */
3123 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3124
3125 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003126 * A content: URI holding a stream of data associated with the Intent,
3127 * used with {@link #ACTION_SEND} to supply the data being sent.
3128 */
3129 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3130
3131 /**
3132 * A String[] holding e-mail addresses that should be delivered to.
3133 */
3134 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3135
3136 /**
3137 * A String[] holding e-mail addresses that should be carbon copied.
3138 */
3139 public static final String EXTRA_CC = "android.intent.extra.CC";
3140
3141 /**
3142 * A String[] holding e-mail addresses that should be blind carbon copied.
3143 */
3144 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3145
3146 /**
3147 * A constant string holding the desired subject line of a message.
3148 */
3149 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3150
3151 /**
3152 * An Intent describing the choices you would like shown with
3153 * {@link #ACTION_PICK_ACTIVITY}.
3154 */
3155 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3156
3157 /**
3158 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003159 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003160 */
3161 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3162
3163 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003164 * A Parcelable[] of {@link Intent} or
3165 * {@link android.content.pm.LabeledIntent} objects as set with
3166 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3167 * a the front of the list of choices, when shown to the user with a
3168 * {@link #ACTION_CHOOSER}.
3169 */
3170 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3171
3172 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003173 * A Bundle forming a mapping of potential target package names to different extras Bundles
3174 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3175 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3176 * be currently installed on the device.
3177 *
3178 * <p>An application may choose to provide alternate extras for the case where a user
3179 * selects an activity from a predetermined set of target packages. If the activity
3180 * the user selects from the chooser belongs to a package with its package name as
3181 * a key in this bundle, the corresponding extras for that package will be merged with
3182 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3183 * extra has the same key as an extra already present in the intent it will overwrite
3184 * the extra from the intent.</p>
3185 *
3186 * <p><em>Examples:</em>
3187 * <ul>
3188 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3189 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3190 * parameters for that target.</li>
3191 * <li>An application may offer additional metadata for known targets of a given intent
3192 * to pass along information only relevant to that target such as account or content
3193 * identifiers already known to that application.</li>
3194 * </ul></p>
3195 */
3196 public static final String EXTRA_REPLACEMENT_EXTRAS =
3197 "android.intent.extra.REPLACEMENT_EXTRAS";
3198
3199 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003200 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3201 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3202 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3203 * {@link ComponentName} of the chosen component.
3204 *
3205 * <p>In some situations this callback may never come, for example if the user abandons
3206 * the chooser, switches to another task or any number of other reasons. Apps should not
3207 * be written assuming that this callback will always occur.</p>
3208 */
3209 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3210 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3211
3212 /**
3213 * The {@link ComponentName} chosen by the user to complete an action.
3214 *
3215 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3216 */
3217 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3218
3219 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003220 * A {@link android.view.KeyEvent} object containing the event that
3221 * triggered the creation of the Intent it is in.
3222 */
3223 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3224
3225 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003226 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3227 * before shutting down.
3228 *
3229 * {@hide}
3230 */
3231 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3232
3233 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003234 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3235 * requested by the user.
3236 *
3237 * {@hide}
3238 */
3239 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3240 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3241
3242 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003243 * 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 -07003244 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3245 * of restarting the application.
3246 */
3247 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3248
3249 /**
3250 * A String holding the phone number originally entered in
3251 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3252 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3253 */
3254 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003255
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003256 /**
3257 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3258 * intents to supply the uid the package had been assigned. Also an optional
3259 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3260 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3261 * purpose.
3262 */
3263 public static final String EXTRA_UID = "android.intent.extra.UID";
3264
3265 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003266 * @hide String array of package names.
3267 */
3268 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3269
3270 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003271 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3272 * intents to indicate whether this represents a full uninstall (removing
3273 * both the code and its data) or a partial uninstall (leaving its data,
3274 * implying that this is an update).
3275 */
3276 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003277
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003278 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003279 * @hide
3280 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3281 * intents to indicate that at this point the package has been removed for
3282 * all users on the device.
3283 */
3284 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3285 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3286
3287 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003288 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3289 * intents to indicate that this is a replacement of the package, so this
3290 * broadcast will immediately be followed by an add broadcast for a
3291 * different version of the same package.
3292 */
3293 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003294
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003295 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003296 * Used as an int extra field in {@link android.app.AlarmManager} intents
3297 * to tell the application being invoked how many pending alarms are being
3298 * delievered with the intent. For one-shot alarms this will always be 1.
3299 * For recurring alarms, this might be greater than 1 if the device was
3300 * asleep or powered off at the time an earlier alarm would have been
3301 * delivered.
3302 */
3303 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003304
Jacek Surazski86b6c532009-05-13 14:38:28 +02003305 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003306 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3307 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003308 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3309 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003310 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3311 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3312 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003313 */
3314 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3315
3316 /**
3317 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3318 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003319 */
3320 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3321
3322 /**
3323 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3324 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003325 */
3326 public static final int EXTRA_DOCK_STATE_DESK = 1;
3327
3328 /**
3329 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3330 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003331 */
3332 public static final int EXTRA_DOCK_STATE_CAR = 2;
3333
3334 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003335 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3336 * to represent that the phone is in a analog (low end) dock.
3337 */
3338 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3339
3340 /**
3341 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3342 * to represent that the phone is in a digital (high end) dock.
3343 */
3344 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3345
3346 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003347 * Boolean that can be supplied as meta-data with a dock activity, to
3348 * indicate that the dock should take over the home key when it is active.
3349 */
3350 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003351
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003352 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003353 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3354 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003355 */
3356 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3357
3358 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003359 * Used in the extra field in the remote intent. It's astring token passed with the
3360 * remote intent.
3361 */
3362 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3363 "android.intent.extra.remote_intent_token";
3364
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003365 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003366 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003367 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003368 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003369 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003370 "android.intent.extra.changed_component_name";
3371
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003372 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003373 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003374 * and contains a string array of all of the components that have changed. If
3375 * the state of the overall package has changed, then it will contain an entry
3376 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003377 */
3378 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3379 "android.intent.extra.changed_component_name_list";
3380
3381 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003382 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003383 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3384 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003385 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003386 */
3387 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3388 "android.intent.extra.changed_package_list";
3389
3390 /**
3391 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003392 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3393 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003394 * and contains an integer array of uids of all of the components
3395 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003396 */
3397 public static final String EXTRA_CHANGED_UID_LIST =
3398 "android.intent.extra.changed_uid_list";
3399
3400 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003401 * @hide
3402 * Magic extra system code can use when binding, to give a label for
3403 * who it is that has bound to a service. This is an integer giving
3404 * a framework string resource that can be displayed to the user.
3405 */
3406 public static final String EXTRA_CLIENT_LABEL =
3407 "android.intent.extra.client_label";
3408
3409 /**
3410 * @hide
3411 * Magic extra system code can use when binding, to give a PendingIntent object
3412 * that can be launched for the user to disable the system's use of this
3413 * service.
3414 */
3415 public static final String EXTRA_CLIENT_INTENT =
3416 "android.intent.extra.client_intent";
3417
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003418 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003419 * Extra used to indicate that an intent should only return data that is on
3420 * the local device. This is a boolean extra; the default is false. If true,
3421 * an implementation should only allow the user to select data that is
3422 * already on the device, not requiring it be downloaded from a remote
3423 * service when opened.
3424 *
3425 * @see #ACTION_GET_CONTENT
3426 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003427 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003428 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003429 */
3430 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003431 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003432
Amith Yamasani13593602012-03-22 16:16:17 -07003433 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003434 * Extra used to indicate that an intent can allow the user to select and
3435 * return multiple items. This is a boolean extra; the default is false. If
3436 * true, an implementation is allowed to present the user with a UI where
3437 * they can pick multiple items that are all returned to the caller. When
3438 * this happens, they should be returned as the {@link #getClipData()} part
3439 * of the result Intent.
3440 *
3441 * @see #ACTION_GET_CONTENT
3442 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003443 */
3444 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003445 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003446
3447 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003448 * The integer userHandle carried with broadcast intents related to addition, removal and
3449 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3450 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3451 *
Amith Yamasani13593602012-03-22 16:16:17 -07003452 * @hide
3453 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003454 public static final String EXTRA_USER_HANDLE =
3455 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003456
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003457 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003458 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3459 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3460 */
3461 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01003462 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003463
3464 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003465 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003466 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3467 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003468 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003469 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3470
3471 /**
3472 * Extra sent in the intent to the BroadcastReceiver that handles
3473 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3474 * the restrictions as key/value pairs.
3475 */
3476 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3477 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003478
Amith Yamasani86118ba2013-03-28 14:33:16 -07003479 /**
3480 * Extra used in the response from a BroadcastReceiver that handles
3481 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3482 */
3483 public static final String EXTRA_RESTRICTIONS_INTENT =
3484 "android.intent.extra.restrictions_intent";
3485
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003486 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003487 * Extra used to communicate a set of acceptable MIME types. The type of the
3488 * extra is {@code String[]}. Values may be a combination of concrete MIME
3489 * types (such as "image/png") and/or partial MIME types (such as
3490 * "audio/*").
3491 *
3492 * @see #ACTION_GET_CONTENT
3493 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003494 */
3495 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3496
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003497 /**
3498 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3499 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003500 * When this is true, hardware devices can use this information to determine that
3501 * they shouldn't do a complete shutdown of their device since this is not a
3502 * complete shutdown down to the kernel, but only user space restarting.
3503 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003504 */
3505 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3506 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3507
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003508 /**
3509 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3510 * user has set their time format preferences to the 24 hour format.
3511 *
3512 * @hide for internal use only.
3513 */
3514 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3515 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3516
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003517 /** {@hide} */
3518 public static final String EXTRA_REASON = "android.intent.extra.REASON";
3519
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003520 // ---------------------------------------------------------------------
3521 // ---------------------------------------------------------------------
3522 // Intent flags (see mFlags variable).
3523
Tor Norbyed9273d62013-05-30 15:59:53 -07003524 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003525 @IntDef(flag = true, value = {
3526 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3527 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003528 @Retention(RetentionPolicy.SOURCE)
3529 public @interface GrantUriMode {}
3530
Jeff Sharkey846318a2014-04-04 12:12:41 -07003531 /** @hide */
3532 @IntDef(flag = true, value = {
3533 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3534 @Retention(RetentionPolicy.SOURCE)
3535 public @interface AccessUriMode {}
3536
3537 /**
3538 * Test if given mode flags specify an access mode, which must be at least
3539 * read and/or write.
3540 *
3541 * @hide
3542 */
3543 public static boolean isAccessUriMode(int modeFlags) {
3544 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3545 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3546 }
3547
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003548 /**
3549 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003550 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003551 * specified in its ClipData. When applying to an Intent's ClipData,
3552 * all URIs as well as recursive traversals through data or other ClipData
3553 * in Intent items will be granted; only the grant flags of the top-level
3554 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003555 */
3556 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3557 /**
3558 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003559 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003560 * specified in its ClipData. When applying to an Intent's ClipData,
3561 * all URIs as well as recursive traversals through data or other ClipData
3562 * in Intent items will be granted; only the grant flags of the top-level
3563 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003564 */
3565 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3566 /**
3567 * Can be set by the caller to indicate that this Intent is coming from
3568 * a background operation, not from direct user interaction.
3569 */
3570 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3571 /**
3572 * A flag you can enable for debugging: when set, log messages will be
3573 * printed during the resolution of this intent to show you what has
3574 * been found to create the final resolved list.
3575 */
3576 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003577 /**
3578 * If set, this intent will not match any components in packages that
3579 * are currently stopped. If this is not set, then the default behavior
3580 * is to include such applications in the result.
3581 */
3582 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3583 /**
3584 * If set, this intent will always match any components in packages that
3585 * are currently stopped. This is the default behavior when
3586 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3587 * flags are set, this one wins (it allows overriding of exclude for
3588 * places where the framework may automatically set the exclude flag).
3589 */
3590 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003591
3592 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003593 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003594 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003595 * persisted across device reboots until explicitly revoked with
3596 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3597 * grant for possible persisting; the receiving application must call
3598 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3599 * actually persist.
3600 *
3601 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3602 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3603 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003604 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003605 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003606 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003607
3608 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003609 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3610 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3611 * applies to any URI that is a prefix match against the original granted
3612 * URI. (Without this flag, the URI must match exactly for access to be
3613 * granted.) Another URI is considered a prefix match only when scheme,
3614 * authority, and all path segments defined by the prefix are an exact
3615 * match.
3616 */
3617 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3618
3619 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003620 * If set, the new activity is not kept in the history stack. As soon as
3621 * the user navigates away from it, the activity is finished. This may also
3622 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3623 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07003624 *
3625 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
3626 * is never invoked when the current activity starts a new activity which
3627 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003628 */
3629 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3630 /**
3631 * If set, the activity will not be launched if it is already running
3632 * at the top of the history stack.
3633 */
3634 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3635 /**
3636 * If set, this activity will become the start of a new task on this
3637 * history stack. A task (from the activity that started it to the
3638 * next task activity) defines an atomic group of activities that the
3639 * user can move to. Tasks can be moved to the foreground and background;
3640 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003641 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003642 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3643 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003644 *
3645 * <p>This flag is generally used by activities that want
3646 * to present a "launcher" style behavior: they give the user a list of
3647 * separate things that can be done, which otherwise run completely
3648 * independently of the activity launching them.
3649 *
3650 * <p>When using this flag, if a task is already running for the activity
3651 * you are now starting, then a new activity will not be started; instead,
3652 * the current task will simply be brought to the front of the screen with
3653 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3654 * to disable this behavior.
3655 *
3656 * <p>This flag can not be used when the caller is requesting a result from
3657 * the activity being launched.
3658 */
3659 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3660 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003661 * This flag is used to create a new task and launch an activity into it.
3662 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3663 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3664 * search through existing tasks for ones matching this Intent. Only if no such
3665 * task is found would a new task be created. When paired with
3666 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3667 * the search for a matching task and unconditionally start a new task.
3668 *
3669 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3670 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003671 * top-level application launcher.</strong> Used in conjunction with
3672 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3673 * behavior of bringing an existing task to the foreground. When set,
3674 * a new task is <em>always</em> started to host the Activity for the
3675 * Intent, regardless of whether there is already an existing task running
3676 * the same thing.
3677 *
3678 * <p><strong>Because the default system does not include graphical task management,
3679 * you should not use this flag unless you provide some way for a user to
3680 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003681 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003682 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3683 * creating new document tasks.
3684 *
3685 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07003686 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003687 *
Scott Main7aee61f2011-02-08 11:25:01 -08003688 * <p>See
3689 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3690 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003691 *
3692 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3693 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003694 */
3695 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3696 /**
3697 * If set, and the activity being launched is already running in the
3698 * current task, then instead of launching a new instance of that activity,
3699 * all of the other activities on top of it will be closed and this Intent
3700 * will be delivered to the (now on top) old activity as a new Intent.
3701 *
3702 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3703 * If D calls startActivity() with an Intent that resolves to the component
3704 * of activity B, then C and D will be finished and B receive the given
3705 * Intent, resulting in the stack now being: A, B.
3706 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003707 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003708 * either receive the new intent you are starting here in its
3709 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003710 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003711 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3712 * the same intent, then it will be finished and re-created; for all other
3713 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3714 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003715 *
3716 * <p>This launch mode can also be used to good effect in conjunction with
3717 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3718 * of a task, it will bring any currently running instance of that task
3719 * to the foreground, and then clear it to its root state. This is
3720 * especially useful, for example, when launching an activity from the
3721 * notification manager.
3722 *
Scott Main7aee61f2011-02-08 11:25:01 -08003723 * <p>See
3724 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3725 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003726 */
3727 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3728 /**
3729 * If set and this intent is being used to launch a new activity from an
3730 * existing one, then the reply target of the existing activity will be
3731 * transfered to the new activity. This way the new activity can call
3732 * {@link android.app.Activity#setResult} and have that result sent back to
3733 * the reply target of the original activity.
3734 */
3735 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3736 /**
3737 * If set and this intent is being used to launch a new activity from an
3738 * existing one, the current activity will not be counted as the top
3739 * activity for deciding whether the new intent should be delivered to
3740 * the top instead of starting a new one. The previous activity will
3741 * be used as the top, with the assumption being that the current activity
3742 * will finish itself immediately.
3743 */
3744 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3745 /**
3746 * If set, the new activity is not kept in the list of recently launched
3747 * activities.
3748 */
3749 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3750 /**
3751 * This flag is not normally set by application code, but set for you by
3752 * the system as described in the
3753 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3754 * launchMode} documentation for the singleTask mode.
3755 */
3756 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3757 /**
3758 * If set, and this activity is either being started in a new task or
3759 * bringing to the top an existing task, then it will be launched as
3760 * the front door of the task. This will result in the application of
3761 * any affinities needed to have that task in the proper state (either
3762 * moving activities to or from it), or simply resetting that task to
3763 * its initial state if needed.
3764 */
3765 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3766 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003767 * This flag is not normally set by application code, but set for you by
3768 * the system if this activity is being launched from history
3769 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003770 */
3771 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003772 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003773 * @deprecated As of API 21 this performs identically to
3774 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003775 */
3776 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003777 /**
Craig Mautner026596b2014-05-21 15:35:44 -07003778 * This flag is used to open a document into a new task rooted at the activity launched
3779 * by this Intent. Through the use of this flag, or its equivalent attribute,
3780 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00003781 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003782 *
Craig Mautner026596b2014-05-21 15:35:44 -07003783 * <p>The use of the activity attribute form of this,
3784 * {@link android.R.attr#documentLaunchMode}, is
3785 * preferred over the Intent flag described here. The attribute form allows the
3786 * Activity to specify multiple document behavior for all launchers of the Activity
3787 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003788 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07003789 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
3790 * it is kept after the activity is finished is different than the use of
3791 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
3792 * this flag is being used to create a new recents entry, then by default that entry
3793 * will be removed once the activity is finished. You can modify this behavior with
3794 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
3795 *
Craig Mautner026596b2014-05-21 15:35:44 -07003796 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
3797 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
3798 * equivalent of the Activity manifest specifying {@link
3799 * android.R.attr#documentLaunchMode}="intoExisting". When used with
3800 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
3801 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07003802 *
Craig Mautner026596b2014-05-21 15:35:44 -07003803 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003804 *
Craig Mautner026596b2014-05-21 15:35:44 -07003805 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07003806 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3807 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003808 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07003809 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003810 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003811 * callback from occurring on the current frontmost activity before it is
3812 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003813 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003814 * <p>Typically, an activity can rely on that callback to indicate that an
3815 * explicit user action has caused their activity to be moved out of the
3816 * foreground. The callback marks an appropriate point in the activity's
3817 * lifecycle for it to dismiss any notifications that it intends to display
3818 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003819 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003820 * <p>If an activity is ever started via any non-user-driven events such as
3821 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3822 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003823 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003824 */
3825 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003826 /**
3827 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3828 * this flag will cause the launched activity to be brought to the front of its
3829 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003830 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003831 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3832 * If D calls startActivity() with an Intent that resolves to the component
3833 * of activity B, then B will be brought to the front of the history stack,
3834 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003835 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003836 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003837 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003838 */
3839 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003840 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003841 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3842 * this flag will prevent the system from applying an activity transition
3843 * animation to go to the next activity state. This doesn't mean an
3844 * animation will never run -- if another activity change happens that doesn't
3845 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003846 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003847 * when you are going to do a series of activity operations but the
3848 * animation seen by the user shouldn't be driven by the first activity
3849 * change but rather a later one.
3850 */
3851 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3852 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003853 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3854 * this flag will cause any existing task that would be associated with the
3855 * activity to be cleared before the activity is started. That is, the activity
3856 * becomes the new root of an otherwise empty task, and any old activities
3857 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3858 */
3859 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3860 /**
3861 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3862 * this flag will cause a newly launching task to be placed on top of the current
3863 * home activity task (if there is one). That is, pressing back from the task
3864 * will always return the user to home even if that was not the last activity they
3865 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3866 */
3867 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3868 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07003869 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
3870 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003871 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07003872 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003873 * this flag. When set and the task's activity is finished, the recents
3874 * entry will remain in the interface for the user to re-launch it, like a
3875 * recents entry for a top-level application.
3876 * <p>
3877 * The receiving activity can override this request with
3878 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
3879 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07003880 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07003881 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07003882 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07003883
3884 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003885 * If set, when sending a broadcast only registered receivers will be
3886 * called -- no BroadcastReceiver components will be launched.
3887 */
3888 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003889 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003890 * If set, when sending a broadcast the new broadcast will replace
3891 * any existing pending broadcast that matches it. Matching is defined
3892 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3893 * true for the intents of the two broadcasts. When a match is found,
3894 * the new broadcast (and receivers associated with it) will replace the
3895 * existing one in the pending broadcast list, remaining at the same
3896 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003897 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003898 * <p>This flag is most typically used with sticky broadcasts, which
3899 * only care about delivering the most recent values of the broadcast
3900 * to their receivers.
3901 */
3902 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3903 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003904 * If set, when sending a broadcast the recipient is allowed to run at
3905 * foreground priority, with a shorter timeout interval. During normal
3906 * broadcasts the receivers are not automatically hoisted out of the
3907 * background priority class.
3908 */
3909 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3910 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003911 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3912 * They can still propagate results through to later receivers, but they can not prevent
3913 * later receivers from seeing the broadcast.
3914 */
3915 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3916 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003917 * If set, when sending a broadcast <i>before boot has completed</i> only
3918 * registered receivers will be called -- no BroadcastReceiver components
3919 * will be launched. Sticky intent state will be recorded properly even
3920 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3921 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003922 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003923 * <p>This flag is only for use by system sevices as a convenience to
3924 * avoid having to implement a more complex mechanism around detection
3925 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003926 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003927 * @hide
3928 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003929 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003930 /**
3931 * Set when this broadcast is for a boot upgrade, a special mode that
3932 * allows the broadcast to be sent before the system is ready and launches
3933 * the app process with no providers running in it.
3934 * @hide
3935 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003936 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003937
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003938 /**
3939 * @hide Flags that can't be changed with PendingIntent.
3940 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003941 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
3942 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
3943 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003944
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003945 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003946 // ---------------------------------------------------------------------
3947 // toUri() and parseUri() options.
3948
3949 /**
3950 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3951 * always has the "intent:" scheme. This syntax can be used when you want
3952 * to later disambiguate between URIs that are intended to describe an
3953 * Intent vs. all others that should be treated as raw URIs. When used
3954 * with {@link #parseUri}, any other scheme will result in a generic
3955 * VIEW action for that raw URI.
3956 */
3957 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003958
Dianne Hackborn85d558c2014-11-04 10:31:54 -08003959 /**
3960 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3961 * always has the "android-app:" scheme. This is a variation of
3962 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
3963 * http/https URI being delivered to a specific package name. The format
3964 * is:
3965 *
3966 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08003967 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08003968 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08003969 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
3970 * you must also include a scheme; including a path also requires both a host and a scheme.
3971 * The final #Intent; fragment can be used without a scheme, host, or path.
3972 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08003973 * used with intents that have a {@link #setSelector}, since the base intent
3974 * will always have an explicit package name.</p>
3975 *
3976 * <p>Some examples of how this scheme maps to Intent objects:</p>
3977 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
3978 * <colgroup align="left" />
3979 * <colgroup align="left" />
3980 * <thead>
3981 * <tr><th>URI</th> <th>Intent</th></tr>
3982 * </thead>
3983 *
3984 * <tbody>
3985 * <tr><td><code>android-app://com.example.app</code></td>
3986 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
3987 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
3988 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
3989 * </table></td>
3990 * </tr>
3991 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
3992 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
3993 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
3994 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
3995 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
3996 * </table></td>
3997 * </tr>
3998 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
3999 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4000 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4001 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4002 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4003 * </table></td>
4004 * </tr>
4005 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4006 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4007 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4008 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4009 * </table></td>
4010 * </tr>
4011 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4012 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4013 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4014 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4015 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4016 * </table></td>
4017 * </tr>
4018 * <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>
4019 * <td><table border="" style="margin:0" >
4020 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4021 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4022 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4023 * </table></td>
4024 * </tr>
4025 * </tbody>
4026 * </table>
4027 */
4028 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4029
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004030 /**
4031 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4032 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4033 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4034 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4035 * generated Intent can not cause unexpected data access to happen.
4036 *
4037 * <p>If you do not trust the source of the URI being parsed, you should still do further
4038 * processing to protect yourself from it. In particular, when using it to start an
4039 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4040 * that can handle it.</p>
4041 */
4042 public static final int URI_ALLOW_UNSAFE = 1<<2;
4043
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004044 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004045
4046 private String mAction;
4047 private Uri mData;
4048 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004049 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004050 private ComponentName mComponent;
4051 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004052 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004053 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004054 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004055 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004056 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004057 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004058
4059 // ---------------------------------------------------------------------
4060
4061 /**
4062 * Create an empty intent.
4063 */
4064 public Intent() {
4065 }
4066
4067 /**
4068 * Copy constructor.
4069 */
4070 public Intent(Intent o) {
4071 this.mAction = o.mAction;
4072 this.mData = o.mData;
4073 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004074 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004075 this.mComponent = o.mComponent;
4076 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004077 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004078 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004079 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004080 }
4081 if (o.mExtras != null) {
4082 this.mExtras = new Bundle(o.mExtras);
4083 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004084 if (o.mSourceBounds != null) {
4085 this.mSourceBounds = new Rect(o.mSourceBounds);
4086 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004087 if (o.mSelector != null) {
4088 this.mSelector = new Intent(o.mSelector);
4089 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004090 if (o.mClipData != null) {
4091 this.mClipData = new ClipData(o.mClipData);
4092 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004093 }
4094
4095 @Override
4096 public Object clone() {
4097 return new Intent(this);
4098 }
4099
4100 private Intent(Intent o, boolean all) {
4101 this.mAction = o.mAction;
4102 this.mData = o.mData;
4103 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004104 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004105 this.mComponent = o.mComponent;
4106 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004107 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004108 }
4109 }
4110
4111 /**
4112 * Make a clone of only the parts of the Intent that are relevant for
4113 * filter matching: the action, data, type, component, and categories.
4114 */
4115 public Intent cloneFilter() {
4116 return new Intent(this, false);
4117 }
4118
4119 /**
4120 * Create an intent with a given action. All other fields (data, type,
4121 * class) are null. Note that the action <em>must</em> be in a
4122 * namespace because Intents are used globally in the system -- for
4123 * example the system VIEW action is android.intent.action.VIEW; an
4124 * application's custom action would be something like
4125 * com.google.app.myapp.CUSTOM_ACTION.
4126 *
4127 * @param action The Intent action, such as ACTION_VIEW.
4128 */
4129 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004130 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004131 }
4132
4133 /**
4134 * Create an intent with a given action and for a given data url. Note
4135 * that the action <em>must</em> be in a namespace because Intents are
4136 * used globally in the system -- for example the system VIEW action is
4137 * android.intent.action.VIEW; an application's custom action would be
4138 * something like com.google.app.myapp.CUSTOM_ACTION.
4139 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004140 * <p><em>Note: scheme and host name matching in the Android framework is
4141 * case-sensitive, unlike the formal RFC. As a result,
4142 * you should always ensure that you write your Uri with these elements
4143 * using lower case letters, and normalize any Uris you receive from
4144 * outside of Android to ensure the scheme and host is lower case.</em></p>
4145 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004146 * @param action The Intent action, such as ACTION_VIEW.
4147 * @param uri The Intent data URI.
4148 */
4149 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004150 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004151 mData = uri;
4152 }
4153
4154 /**
4155 * Create an intent for a specific component. All other fields (action, data,
4156 * type, class) are null, though they can be modified later with explicit
4157 * calls. This provides a convenient way to create an intent that is
4158 * intended to execute a hard-coded class name, rather than relying on the
4159 * system to find an appropriate class for you; see {@link #setComponent}
4160 * for more information on the repercussions of this.
4161 *
4162 * @param packageContext A Context of the application package implementing
4163 * this class.
4164 * @param cls The component class that is to be used for the intent.
4165 *
4166 * @see #setClass
4167 * @see #setComponent
4168 * @see #Intent(String, android.net.Uri , Context, Class)
4169 */
4170 public Intent(Context packageContext, Class<?> cls) {
4171 mComponent = new ComponentName(packageContext, cls);
4172 }
4173
4174 /**
4175 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004176 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004177 * construct the Intent and then calling {@link #setClass} to set its
4178 * class.
4179 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004180 * <p><em>Note: scheme and host name matching in the Android framework is
4181 * case-sensitive, unlike the formal RFC. As a result,
4182 * you should always ensure that you write your Uri with these elements
4183 * using lower case letters, and normalize any Uris you receive from
4184 * outside of Android to ensure the scheme and host is lower case.</em></p>
4185 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004186 * @param action The Intent action, such as ACTION_VIEW.
4187 * @param uri The Intent data URI.
4188 * @param packageContext A Context of the application package implementing
4189 * this class.
4190 * @param cls The component class that is to be used for the intent.
4191 *
4192 * @see #Intent(String, android.net.Uri)
4193 * @see #Intent(Context, Class)
4194 * @see #setClass
4195 * @see #setComponent
4196 */
4197 public Intent(String action, Uri uri,
4198 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004199 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004200 mData = uri;
4201 mComponent = new ComponentName(packageContext, cls);
4202 }
4203
4204 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004205 * Create an intent to launch the main (root) activity of a task. This
4206 * is the Intent that is started when the application's is launched from
4207 * Home. For anything else that wants to launch an application in the
4208 * same way, it is important that they use an Intent structured the same
4209 * way, and can use this function to ensure this is the case.
4210 *
4211 * <p>The returned Intent has the given Activity component as its explicit
4212 * component, {@link #ACTION_MAIN} as its action, and includes the
4213 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4214 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4215 * to do that through {@link #addFlags(int)} on the returned Intent.
4216 *
4217 * @param mainActivity The main activity component that this Intent will
4218 * launch.
4219 * @return Returns a newly created Intent that can be used to launch the
4220 * activity as a main application entry.
4221 *
4222 * @see #setClass
4223 * @see #setComponent
4224 */
4225 public static Intent makeMainActivity(ComponentName mainActivity) {
4226 Intent intent = new Intent(ACTION_MAIN);
4227 intent.setComponent(mainActivity);
4228 intent.addCategory(CATEGORY_LAUNCHER);
4229 return intent;
4230 }
4231
4232 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004233 * Make an Intent for the main activity of an application, without
4234 * specifying a specific activity to run but giving a selector to find
4235 * the activity. This results in a final Intent that is structured
4236 * the same as when the application is launched from
4237 * Home. For anything else that wants to launch an application in the
4238 * same way, it is important that they use an Intent structured the same
4239 * way, and can use this function to ensure this is the case.
4240 *
4241 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4242 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4243 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4244 * to do that through {@link #addFlags(int)} on the returned Intent.
4245 *
4246 * @param selectorAction The action name of the Intent's selector.
4247 * @param selectorCategory The name of a category to add to the Intent's
4248 * selector.
4249 * @return Returns a newly created Intent that can be used to launch the
4250 * activity as a main application entry.
4251 *
4252 * @see #setSelector(Intent)
4253 */
4254 public static Intent makeMainSelectorActivity(String selectorAction,
4255 String selectorCategory) {
4256 Intent intent = new Intent(ACTION_MAIN);
4257 intent.addCategory(CATEGORY_LAUNCHER);
4258 Intent selector = new Intent();
4259 selector.setAction(selectorAction);
4260 selector.addCategory(selectorCategory);
4261 intent.setSelector(selector);
4262 return intent;
4263 }
4264
4265 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004266 * Make an Intent that can be used to re-launch an application's task
4267 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4268 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4269 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4270 *
4271 * @param mainActivity The activity component that is the root of the
4272 * task; this is the activity that has been published in the application's
4273 * manifest as the main launcher icon.
4274 *
4275 * @return Returns a newly created Intent that can be used to relaunch the
4276 * activity's task in its root state.
4277 */
4278 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4279 Intent intent = makeMainActivity(mainActivity);
4280 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4281 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4282 return intent;
4283 }
4284
4285 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004286 * Call {@link #parseUri} with 0 flags.
4287 * @deprecated Use {@link #parseUri} instead.
4288 */
4289 @Deprecated
4290 public static Intent getIntent(String uri) throws URISyntaxException {
4291 return parseUri(uri, 0);
4292 }
Tom Taylord4a47292009-12-21 13:59:18 -08004293
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004294 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004295 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004296 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004297 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004298 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004299 *
4300 * <p>The URI given here must not be relative -- that is, it must include
4301 * the scheme and full path.
4302 *
4303 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004304 * @param flags Additional processing flags. Either 0,
4305 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004306 *
4307 * @return Intent The newly created Intent object.
4308 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004309 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4310 * it bad (as parsed by the Uri class) or the Intent data within the
4311 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004312 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004313 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004314 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004315 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004316 int i = 0;
4317 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004318 final boolean androidApp = uri.startsWith("android-app:");
4319
4320 // Validate intent scheme if requested.
4321 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
4322 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004323 Intent intent = new Intent(ACTION_VIEW);
4324 try {
4325 intent.setData(Uri.parse(uri));
4326 } catch (IllegalArgumentException e) {
4327 throw new URISyntaxException(uri, e.getMessage());
4328 }
4329 return intent;
4330 }
4331 }
Tom Taylord4a47292009-12-21 13:59:18 -08004332
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004333 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004334 // simple case
4335 if (i == -1) {
4336 if (!androidApp) {
4337 return new Intent(ACTION_VIEW, Uri.parse(uri));
4338 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004339
4340 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004341 } else if (!uri.startsWith("#Intent;", i)) {
4342 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004343 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004344 } else {
4345 i = -1;
4346 }
4347 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004348
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004349 // new format
4350 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004351 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004352 boolean explicitAction = false;
4353 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004354
4355 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004356 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004357 String data;
4358 if (i >= 0) {
4359 data = uri.substring(0, i);
4360 i += 8; // length of "#Intent;"
4361 } else {
4362 data = uri;
4363 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004364
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004365 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004366 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004367 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004368 if (eq < 0) eq = i-1;
4369 int semi = uri.indexOf(';', i);
4370 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004371
4372 // action
4373 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004374 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004375 if (!inSelector) {
4376 explicitAction = true;
4377 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004378 }
4379
4380 // categories
4381 else if (uri.startsWith("category=", i)) {
4382 intent.addCategory(value);
4383 }
4384
4385 // type
4386 else if (uri.startsWith("type=", i)) {
4387 intent.mType = value;
4388 }
4389
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004390 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004391 else if (uri.startsWith("launchFlags=", i)) {
4392 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004393 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4394 intent.mFlags &= ~IMMUTABLE_FLAGS;
4395 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004396 }
4397
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004398 // package
4399 else if (uri.startsWith("package=", i)) {
4400 intent.mPackage = value;
4401 }
4402
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004403 // component
4404 else if (uri.startsWith("component=", i)) {
4405 intent.mComponent = ComponentName.unflattenFromString(value);
4406 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004407
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004408 // scheme
4409 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004410 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004411 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004412 } else {
4413 scheme = value;
4414 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004415 }
4416
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004417 // source bounds
4418 else if (uri.startsWith("sourceBounds=", i)) {
4419 intent.mSourceBounds = Rect.unflattenFromString(value);
4420 }
4421
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004422 // selector
4423 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4424 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004425 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004426 }
4427
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004428 // extra
4429 else {
4430 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004431 // create Bundle if it doesn't already exist
4432 if (intent.mExtras == null) intent.mExtras = new Bundle();
4433 Bundle b = intent.mExtras;
4434 // add EXTRA
4435 if (uri.startsWith("S.", i)) b.putString(key, value);
4436 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4437 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4438 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4439 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4440 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4441 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4442 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4443 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4444 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4445 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004446
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004447 // move to the next item
4448 i = semi + 1;
4449 }
4450
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004451 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004452 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004453 if (baseIntent.mPackage == null) {
4454 baseIntent.setSelector(intent);
4455 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004456 intent = baseIntent;
4457 }
4458
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004459 if (data != null) {
4460 if (data.startsWith("intent:")) {
4461 data = data.substring(7);
4462 if (scheme != null) {
4463 data = scheme + ':' + data;
4464 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004465 } else if (data.startsWith("android-app:")) {
4466 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
4467 // Correctly formed android-app, first part is package name.
4468 int end = data.indexOf('/', 14);
4469 if (end < 0) {
4470 // All we have is a package name.
4471 intent.mPackage = data.substring(14);
4472 if (!explicitAction) {
4473 intent.setAction(ACTION_MAIN);
4474 }
4475 data = "";
4476 } else {
4477 // Target the Intent at the given package name always.
4478 String authority = null;
4479 intent.mPackage = data.substring(14, end);
4480 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004481 if ((end+1) < data.length()) {
4482 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
4483 // Found a scheme, remember it.
4484 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004485 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004486 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
4487 // Found a authority, remember it.
4488 authority = data.substring(end+1, newEnd);
4489 end = newEnd;
4490 }
4491 } else {
4492 // All we have is a scheme.
4493 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004494 }
4495 }
4496 if (scheme == null) {
4497 // If there was no scheme, then this just targets the package.
4498 if (!explicitAction) {
4499 intent.setAction(ACTION_MAIN);
4500 }
4501 data = "";
4502 } else if (authority == null) {
4503 data = scheme + ":";
4504 } else {
4505 data = scheme + "://" + authority + data.substring(end);
4506 }
4507 }
4508 } else {
4509 data = "";
4510 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004511 }
Tom Taylord4a47292009-12-21 13:59:18 -08004512
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004513 if (data.length() > 0) {
4514 try {
4515 intent.mData = Uri.parse(data);
4516 } catch (IllegalArgumentException e) {
4517 throw new URISyntaxException(uri, e.getMessage());
4518 }
4519 }
4520 }
Tom Taylord4a47292009-12-21 13:59:18 -08004521
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004522 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004523
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004524 } catch (IndexOutOfBoundsException e) {
4525 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4526 }
4527 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004528
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004529 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004530 return getIntentOld(uri, 0);
4531 }
4532
4533 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004534 Intent intent;
4535
4536 int i = uri.lastIndexOf('#');
4537 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004538 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004539 final int intentFragmentStart = i;
4540 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004541
4542 i++;
4543
4544 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004545 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004546 i += 7;
4547 int j = uri.indexOf(')', i);
4548 action = uri.substring(i, j);
4549 i = j + 1;
4550 }
4551
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004552 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004553
4554 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004555 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004556 i += 11;
4557 int j = uri.indexOf(')', i);
4558 while (i < j) {
4559 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07004560 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004561 if (i < sep) {
4562 intent.addCategory(uri.substring(i, sep));
4563 }
4564 i = sep + 1;
4565 }
4566 i = j + 1;
4567 }
4568
4569 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004570 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004571 i += 5;
4572 int j = uri.indexOf(')', i);
4573 intent.mType = uri.substring(i, j);
4574 i = j + 1;
4575 }
4576
4577 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004578 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004579 i += 12;
4580 int j = uri.indexOf(')', i);
4581 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004582 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4583 intent.mFlags &= ~IMMUTABLE_FLAGS;
4584 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004585 i = j + 1;
4586 }
4587
4588 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004589 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004590 i += 10;
4591 int j = uri.indexOf(')', i);
4592 int sep = uri.indexOf('!', i);
4593 if (sep >= 0 && sep < j) {
4594 String pkg = uri.substring(i, sep);
4595 String cls = uri.substring(sep + 1, j);
4596 intent.mComponent = new ComponentName(pkg, cls);
4597 }
4598 i = j + 1;
4599 }
4600
4601 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004602 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004603 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004604
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004605 final int closeParen = uri.indexOf(')', i);
4606 if (closeParen == -1) throw new URISyntaxException(uri,
4607 "EXTRA missing trailing ')'", i);
4608
4609 while (i < closeParen) {
4610 // fetch the key value
4611 int j = uri.indexOf('=', i);
4612 if (j <= i + 1 || i >= closeParen) {
4613 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4614 }
4615 char type = uri.charAt(i);
4616 i++;
4617 String key = uri.substring(i, j);
4618 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004619
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004620 // get type-value
4621 j = uri.indexOf('!', i);
4622 if (j == -1 || j >= closeParen) j = closeParen;
4623 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4624 String value = uri.substring(i, j);
4625 i = j;
4626
4627 // create Bundle if it doesn't already exist
4628 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004630 // add item to bundle
4631 try {
4632 switch (type) {
4633 case 'S':
4634 intent.mExtras.putString(key, Uri.decode(value));
4635 break;
4636 case 'B':
4637 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4638 break;
4639 case 'b':
4640 intent.mExtras.putByte(key, Byte.parseByte(value));
4641 break;
4642 case 'c':
4643 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4644 break;
4645 case 'd':
4646 intent.mExtras.putDouble(key, Double.parseDouble(value));
4647 break;
4648 case 'f':
4649 intent.mExtras.putFloat(key, Float.parseFloat(value));
4650 break;
4651 case 'i':
4652 intent.mExtras.putInt(key, Integer.parseInt(value));
4653 break;
4654 case 'l':
4655 intent.mExtras.putLong(key, Long.parseLong(value));
4656 break;
4657 case 's':
4658 intent.mExtras.putShort(key, Short.parseShort(value));
4659 break;
4660 default:
4661 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4662 }
4663 } catch (NumberFormatException e) {
4664 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4665 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004666
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004667 char ch = uri.charAt(i);
4668 if (ch == ')') break;
4669 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4670 i++;
4671 }
4672 }
4673
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004674 if (isIntentFragment) {
4675 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4676 } else {
4677 intent.mData = Uri.parse(uri);
4678 }
Tom Taylord4a47292009-12-21 13:59:18 -08004679
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004680 if (intent.mAction == null) {
4681 // By default, if no action is specified, then use VIEW.
4682 intent.mAction = ACTION_VIEW;
4683 }
4684
4685 } else {
4686 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4687 }
4688
4689 return intent;
4690 }
4691
4692 /**
4693 * Retrieve the general action to be performed, such as
4694 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4695 * the information in the intent should be interpreted -- most importantly,
4696 * what to do with the data returned by {@link #getData}.
4697 *
4698 * @return The action of this intent or null if none is specified.
4699 *
4700 * @see #setAction
4701 */
4702 public String getAction() {
4703 return mAction;
4704 }
4705
4706 /**
4707 * Retrieve data this intent is operating on. This URI specifies the name
4708 * of the data; often it uses the content: scheme, specifying data in a
4709 * content provider. Other schemes may be handled by specific activities,
4710 * such as http: by the web browser.
4711 *
4712 * @return The URI of the data this intent is targeting or null.
4713 *
4714 * @see #getScheme
4715 * @see #setData
4716 */
4717 public Uri getData() {
4718 return mData;
4719 }
4720
4721 /**
4722 * The same as {@link #getData()}, but returns the URI as an encoded
4723 * String.
4724 */
4725 public String getDataString() {
4726 return mData != null ? mData.toString() : null;
4727 }
4728
4729 /**
4730 * Return the scheme portion of the intent's data. If the data is null or
4731 * does not include a scheme, null is returned. Otherwise, the scheme
4732 * prefix without the final ':' is returned, i.e. "http".
4733 *
4734 * <p>This is the same as calling getData().getScheme() (and checking for
4735 * null data).
4736 *
4737 * @return The scheme of this intent.
4738 *
4739 * @see #getData
4740 */
4741 public String getScheme() {
4742 return mData != null ? mData.getScheme() : null;
4743 }
4744
4745 /**
4746 * Retrieve any explicit MIME type included in the intent. This is usually
4747 * null, as the type is determined by the intent data.
4748 *
4749 * @return If a type was manually set, it is returned; else null is
4750 * returned.
4751 *
4752 * @see #resolveType(ContentResolver)
4753 * @see #setType
4754 */
4755 public String getType() {
4756 return mType;
4757 }
4758
4759 /**
4760 * Return the MIME data type of this intent. If the type field is
4761 * explicitly set, that is simply returned. Otherwise, if the data is set,
4762 * the type of that data is returned. If neither fields are set, a null is
4763 * returned.
4764 *
4765 * @return The MIME type of this intent.
4766 *
4767 * @see #getType
4768 * @see #resolveType(ContentResolver)
4769 */
4770 public String resolveType(Context context) {
4771 return resolveType(context.getContentResolver());
4772 }
4773
4774 /**
4775 * Return the MIME data type of this intent. If the type field is
4776 * explicitly set, that is simply returned. Otherwise, if the data is set,
4777 * the type of that data is returned. If neither fields are set, a null is
4778 * returned.
4779 *
4780 * @param resolver A ContentResolver that can be used to determine the MIME
4781 * type of the intent's data.
4782 *
4783 * @return The MIME type of this intent.
4784 *
4785 * @see #getType
4786 * @see #resolveType(Context)
4787 */
4788 public String resolveType(ContentResolver resolver) {
4789 if (mType != null) {
4790 return mType;
4791 }
4792 if (mData != null) {
4793 if ("content".equals(mData.getScheme())) {
4794 return resolver.getType(mData);
4795 }
4796 }
4797 return null;
4798 }
4799
4800 /**
4801 * Return the MIME data type of this intent, only if it will be needed for
4802 * intent resolution. This is not generally useful for application code;
4803 * it is used by the frameworks for communicating with back-end system
4804 * services.
4805 *
4806 * @param resolver A ContentResolver that can be used to determine the MIME
4807 * type of the intent's data.
4808 *
4809 * @return The MIME type of this intent, or null if it is unknown or not
4810 * needed.
4811 */
4812 public String resolveTypeIfNeeded(ContentResolver resolver) {
4813 if (mComponent != null) {
4814 return mType;
4815 }
4816 return resolveType(resolver);
4817 }
4818
4819 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004820 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004821 *
4822 * @param category The category to check.
4823 *
4824 * @return boolean True if the intent contains the category, else false.
4825 *
4826 * @see #getCategories
4827 * @see #addCategory
4828 */
4829 public boolean hasCategory(String category) {
4830 return mCategories != null && mCategories.contains(category);
4831 }
4832
4833 /**
4834 * Return the set of all categories in the intent. If there are no categories,
4835 * returns NULL.
4836 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004837 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004838 *
4839 * @see #hasCategory
4840 * @see #addCategory
4841 */
4842 public Set<String> getCategories() {
4843 return mCategories;
4844 }
4845
4846 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004847 * Return the specific selector associated with this Intent. If there is
4848 * none, returns null. See {@link #setSelector} for more information.
4849 *
4850 * @see #setSelector
4851 */
4852 public Intent getSelector() {
4853 return mSelector;
4854 }
4855
4856 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004857 * Return the {@link ClipData} associated with this Intent. If there is
4858 * none, returns null. See {@link #setClipData} for more information.
4859 *
John Spurlock125d1332013-11-25 11:58:37 -05004860 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004861 */
4862 public ClipData getClipData() {
4863 return mClipData;
4864 }
4865
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004866 /** @hide */
4867 public int getContentUserHint() {
4868 return mContentUserHint;
4869 }
4870
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004871 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004872 * Sets the ClassLoader that will be used when unmarshalling
4873 * any Parcelable values from the extras of this Intent.
4874 *
4875 * @param loader a ClassLoader, or null to use the default loader
4876 * at the time of unmarshalling.
4877 */
4878 public void setExtrasClassLoader(ClassLoader loader) {
4879 if (mExtras != null) {
4880 mExtras.setClassLoader(loader);
4881 }
4882 }
4883
4884 /**
4885 * Returns true if an extra value is associated with the given name.
4886 * @param name the extra's name
4887 * @return true if the given extra is present.
4888 */
4889 public boolean hasExtra(String name) {
4890 return mExtras != null && mExtras.containsKey(name);
4891 }
4892
4893 /**
4894 * Returns true if the Intent's extras contain a parcelled file descriptor.
4895 * @return true if the Intent contains a parcelled file descriptor.
4896 */
4897 public boolean hasFileDescriptors() {
4898 return mExtras != null && mExtras.hasFileDescriptors();
4899 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004900
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004901 /** @hide */
4902 public void setAllowFds(boolean allowFds) {
4903 if (mExtras != null) {
4904 mExtras.setAllowFds(allowFds);
4905 }
4906 }
4907
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004908 /**
4909 * Retrieve extended data from the intent.
4910 *
4911 * @param name The name of the desired item.
4912 *
4913 * @return the value of an item that previously added with putExtra()
4914 * or null if none was found.
4915 *
4916 * @deprecated
4917 * @hide
4918 */
4919 @Deprecated
4920 public Object getExtra(String name) {
4921 return getExtra(name, null);
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, boolean)
4935 */
4936 public boolean getBooleanExtra(String name, boolean defaultValue) {
4937 return mExtras == null ? defaultValue :
4938 mExtras.getBoolean(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, byte)
4952 */
4953 public byte getByteExtra(String name, byte defaultValue) {
4954 return mExtras == null ? defaultValue :
4955 mExtras.getByte(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, short)
4969 */
4970 public short getShortExtra(String name, short defaultValue) {
4971 return mExtras == null ? defaultValue :
4972 mExtras.getShort(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, char)
4986 */
4987 public char getCharExtra(String name, char defaultValue) {
4988 return mExtras == null ? defaultValue :
4989 mExtras.getChar(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, int)
5003 */
5004 public int getIntExtra(String name, int defaultValue) {
5005 return mExtras == null ? defaultValue :
5006 mExtras.getInt(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 none was found.
5018 *
5019 * @see #putExtra(String, long)
5020 */
5021 public long getLongExtra(String name, long defaultValue) {
5022 return mExtras == null ? defaultValue :
5023 mExtras.getLong(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 no such item is present
5035 *
5036 * @see #putExtra(String, float)
5037 */
5038 public float getFloatExtra(String name, float defaultValue) {
5039 return mExtras == null ? defaultValue :
5040 mExtras.getFloat(name, defaultValue);
5041 }
5042
5043 /**
5044 * Retrieve extended data from the intent.
5045 *
5046 * @param name The name of the desired item.
5047 * @param defaultValue the value to be returned if no value of the desired
5048 * type is stored with the given name.
5049 *
5050 * @return the value of an item that previously added with putExtra()
5051 * or the default value if none was found.
5052 *
5053 * @see #putExtra(String, double)
5054 */
5055 public double getDoubleExtra(String name, double defaultValue) {
5056 return mExtras == null ? defaultValue :
5057 mExtras.getDouble(name, defaultValue);
5058 }
5059
5060 /**
5061 * Retrieve extended data from the intent.
5062 *
5063 * @param name The name of the desired item.
5064 *
5065 * @return the value of an item that previously added with putExtra()
5066 * or null if no String value was found.
5067 *
5068 * @see #putExtra(String, String)
5069 */
5070 public String getStringExtra(String name) {
5071 return mExtras == null ? null : mExtras.getString(name);
5072 }
5073
5074 /**
5075 * Retrieve extended data from the intent.
5076 *
5077 * @param name The name of the desired item.
5078 *
5079 * @return the value of an item that previously added with putExtra()
5080 * or null if no CharSequence value was found.
5081 *
5082 * @see #putExtra(String, CharSequence)
5083 */
5084 public CharSequence getCharSequenceExtra(String name) {
5085 return mExtras == null ? null : mExtras.getCharSequence(name);
5086 }
5087
5088 /**
5089 * Retrieve extended data from the intent.
5090 *
5091 * @param name The name of the desired item.
5092 *
5093 * @return the value of an item that previously added with putExtra()
5094 * or null if no Parcelable value was found.
5095 *
5096 * @see #putExtra(String, Parcelable)
5097 */
5098 public <T extends Parcelable> T getParcelableExtra(String name) {
5099 return mExtras == null ? null : mExtras.<T>getParcelable(name);
5100 }
5101
5102 /**
5103 * Retrieve extended data from the intent.
5104 *
5105 * @param name The name of the desired item.
5106 *
5107 * @return the value of an item that previously added with putExtra()
5108 * or null if no Parcelable[] value was found.
5109 *
5110 * @see #putExtra(String, Parcelable[])
5111 */
5112 public Parcelable[] getParcelableArrayExtra(String name) {
5113 return mExtras == null ? null : mExtras.getParcelableArray(name);
5114 }
5115
5116 /**
5117 * Retrieve extended data from the intent.
5118 *
5119 * @param name The name of the desired item.
5120 *
5121 * @return the value of an item that previously added with putExtra()
5122 * or null if no ArrayList<Parcelable> value was found.
5123 *
5124 * @see #putParcelableArrayListExtra(String, ArrayList)
5125 */
5126 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
5127 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
5128 }
5129
5130 /**
5131 * Retrieve extended data from the intent.
5132 *
5133 * @param name The name of the desired item.
5134 *
5135 * @return the value of an item that previously added with putExtra()
5136 * or null if no Serializable value was found.
5137 *
5138 * @see #putExtra(String, Serializable)
5139 */
5140 public Serializable getSerializableExtra(String name) {
5141 return mExtras == null ? null : mExtras.getSerializable(name);
5142 }
5143
5144 /**
5145 * Retrieve extended data from the intent.
5146 *
5147 * @param name The name of the desired item.
5148 *
5149 * @return the value of an item that previously added with putExtra()
5150 * or null if no ArrayList<Integer> value was found.
5151 *
5152 * @see #putIntegerArrayListExtra(String, ArrayList)
5153 */
5154 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
5155 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
5156 }
5157
5158 /**
5159 * Retrieve extended data from the intent.
5160 *
5161 * @param name The name of the desired item.
5162 *
5163 * @return the value of an item that previously added with putExtra()
5164 * or null if no ArrayList<String> value was found.
5165 *
5166 * @see #putStringArrayListExtra(String, ArrayList)
5167 */
5168 public ArrayList<String> getStringArrayListExtra(String name) {
5169 return mExtras == null ? null : mExtras.getStringArrayList(name);
5170 }
5171
5172 /**
5173 * Retrieve extended data from the intent.
5174 *
5175 * @param name The name of the desired item.
5176 *
5177 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005178 * or null if no ArrayList<CharSequence> value was found.
5179 *
5180 * @see #putCharSequenceArrayListExtra(String, ArrayList)
5181 */
5182 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
5183 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
5184 }
5185
5186 /**
5187 * Retrieve extended data from the intent.
5188 *
5189 * @param name The name of the desired item.
5190 *
5191 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005192 * or null if no boolean array value was found.
5193 *
5194 * @see #putExtra(String, boolean[])
5195 */
5196 public boolean[] getBooleanArrayExtra(String name) {
5197 return mExtras == null ? null : mExtras.getBooleanArray(name);
5198 }
5199
5200 /**
5201 * Retrieve extended data from the intent.
5202 *
5203 * @param name The name of the desired item.
5204 *
5205 * @return the value of an item that previously added with putExtra()
5206 * or null if no byte array value was found.
5207 *
5208 * @see #putExtra(String, byte[])
5209 */
5210 public byte[] getByteArrayExtra(String name) {
5211 return mExtras == null ? null : mExtras.getByteArray(name);
5212 }
5213
5214 /**
5215 * Retrieve extended data from the intent.
5216 *
5217 * @param name The name of the desired item.
5218 *
5219 * @return the value of an item that previously added with putExtra()
5220 * or null if no short array value was found.
5221 *
5222 * @see #putExtra(String, short[])
5223 */
5224 public short[] getShortArrayExtra(String name) {
5225 return mExtras == null ? null : mExtras.getShortArray(name);
5226 }
5227
5228 /**
5229 * Retrieve extended data from the intent.
5230 *
5231 * @param name The name of the desired item.
5232 *
5233 * @return the value of an item that previously added with putExtra()
5234 * or null if no char array value was found.
5235 *
5236 * @see #putExtra(String, char[])
5237 */
5238 public char[] getCharArrayExtra(String name) {
5239 return mExtras == null ? null : mExtras.getCharArray(name);
5240 }
5241
5242 /**
5243 * Retrieve extended data from the intent.
5244 *
5245 * @param name The name of the desired item.
5246 *
5247 * @return the value of an item that previously added with putExtra()
5248 * or null if no int array value was found.
5249 *
5250 * @see #putExtra(String, int[])
5251 */
5252 public int[] getIntArrayExtra(String name) {
5253 return mExtras == null ? null : mExtras.getIntArray(name);
5254 }
5255
5256 /**
5257 * Retrieve extended data from the intent.
5258 *
5259 * @param name The name of the desired item.
5260 *
5261 * @return the value of an item that previously added with putExtra()
5262 * or null if no long array value was found.
5263 *
5264 * @see #putExtra(String, long[])
5265 */
5266 public long[] getLongArrayExtra(String name) {
5267 return mExtras == null ? null : mExtras.getLongArray(name);
5268 }
5269
5270 /**
5271 * Retrieve extended data from the intent.
5272 *
5273 * @param name The name of the desired item.
5274 *
5275 * @return the value of an item that previously added with putExtra()
5276 * or null if no float array value was found.
5277 *
5278 * @see #putExtra(String, float[])
5279 */
5280 public float[] getFloatArrayExtra(String name) {
5281 return mExtras == null ? null : mExtras.getFloatArray(name);
5282 }
5283
5284 /**
5285 * Retrieve extended data from the intent.
5286 *
5287 * @param name The name of the desired item.
5288 *
5289 * @return the value of an item that previously added with putExtra()
5290 * or null if no double array value was found.
5291 *
5292 * @see #putExtra(String, double[])
5293 */
5294 public double[] getDoubleArrayExtra(String name) {
5295 return mExtras == null ? null : mExtras.getDoubleArray(name);
5296 }
5297
5298 /**
5299 * Retrieve extended data from the intent.
5300 *
5301 * @param name The name of the desired item.
5302 *
5303 * @return the value of an item that previously added with putExtra()
5304 * or null if no String array value was found.
5305 *
5306 * @see #putExtra(String, String[])
5307 */
5308 public String[] getStringArrayExtra(String name) {
5309 return mExtras == null ? null : mExtras.getStringArray(name);
5310 }
5311
5312 /**
5313 * Retrieve extended data from the intent.
5314 *
5315 * @param name The name of the desired item.
5316 *
5317 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005318 * or null if no CharSequence array value was found.
5319 *
5320 * @see #putExtra(String, CharSequence[])
5321 */
5322 public CharSequence[] getCharSequenceArrayExtra(String name) {
5323 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5324 }
5325
5326 /**
5327 * Retrieve extended data from the intent.
5328 *
5329 * @param name The name of the desired item.
5330 *
5331 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005332 * or null if no Bundle value was found.
5333 *
5334 * @see #putExtra(String, Bundle)
5335 */
5336 public Bundle getBundleExtra(String name) {
5337 return mExtras == null ? null : mExtras.getBundle(name);
5338 }
5339
5340 /**
5341 * Retrieve extended data from the intent.
5342 *
5343 * @param name The name of the desired item.
5344 *
5345 * @return the value of an item that previously added with putExtra()
5346 * or null if no IBinder value was found.
5347 *
5348 * @see #putExtra(String, IBinder)
5349 *
5350 * @deprecated
5351 * @hide
5352 */
5353 @Deprecated
5354 public IBinder getIBinderExtra(String name) {
5355 return mExtras == null ? null : mExtras.getIBinder(name);
5356 }
5357
5358 /**
5359 * Retrieve extended data from the intent.
5360 *
5361 * @param name The name of the desired item.
5362 * @param defaultValue The default value to return in case no item is
5363 * associated with the key 'name'
5364 *
5365 * @return the value of an item that previously added with putExtra()
5366 * or defaultValue if none was found.
5367 *
5368 * @see #putExtra
5369 *
5370 * @deprecated
5371 * @hide
5372 */
5373 @Deprecated
5374 public Object getExtra(String name, Object defaultValue) {
5375 Object result = defaultValue;
5376 if (mExtras != null) {
5377 Object result2 = mExtras.get(name);
5378 if (result2 != null) {
5379 result = result2;
5380 }
5381 }
5382
5383 return result;
5384 }
5385
5386 /**
5387 * Retrieves a map of extended data from the intent.
5388 *
5389 * @return the map of all extras previously added with putExtra(),
5390 * or null if none have been added.
5391 */
5392 public Bundle getExtras() {
5393 return (mExtras != null)
5394 ? new Bundle(mExtras)
5395 : null;
5396 }
5397
5398 /**
5399 * Retrieve any special flags associated with this intent. You will
5400 * normally just set them with {@link #setFlags} and let the system
5401 * take the appropriate action with them.
5402 *
5403 * @return int The currently set flags.
5404 *
5405 * @see #setFlags
5406 */
5407 public int getFlags() {
5408 return mFlags;
5409 }
5410
Dianne Hackborne7f97212011-02-24 14:40:20 -08005411 /** @hide */
5412 public boolean isExcludingStopped() {
5413 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5414 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5415 }
5416
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005417 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005418 * Retrieve the application package name this Intent is limited to. When
5419 * resolving an Intent, if non-null this limits the resolution to only
5420 * components in the given application package.
5421 *
5422 * @return The name of the application package for the Intent.
5423 *
5424 * @see #resolveActivity
5425 * @see #setPackage
5426 */
5427 public String getPackage() {
5428 return mPackage;
5429 }
5430
5431 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005432 * Retrieve the concrete component associated with the intent. When receiving
5433 * an intent, this is the component that was found to best handle it (that is,
5434 * yourself) and will always be non-null; in all other cases it will be
5435 * null unless explicitly set.
5436 *
5437 * @return The name of the application component to handle the intent.
5438 *
5439 * @see #resolveActivity
5440 * @see #setComponent
5441 */
5442 public ComponentName getComponent() {
5443 return mComponent;
5444 }
5445
5446 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005447 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5448 * used as a hint to the receiver for animations and the like. Null means that there
5449 * is no source bounds.
5450 */
5451 public Rect getSourceBounds() {
5452 return mSourceBounds;
5453 }
5454
5455 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005456 * Return the Activity component that should be used to handle this intent.
5457 * The appropriate component is determined based on the information in the
5458 * intent, evaluated as follows:
5459 *
5460 * <p>If {@link #getComponent} returns an explicit class, that is returned
5461 * without any further consideration.
5462 *
5463 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5464 * category to be considered.
5465 *
5466 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5467 * action.
5468 *
5469 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5470 * this type.
5471 *
5472 * <p>If {@link #addCategory} has added any categories, the activity must
5473 * handle ALL of the categories specified.
5474 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005475 * <p>If {@link #getPackage} is non-NULL, only activity components in
5476 * that application package will be considered.
5477 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005478 * <p>If there are no activities that satisfy all of these conditions, a
5479 * null string is returned.
5480 *
5481 * <p>If multiple activities are found to satisfy the intent, the one with
5482 * the highest priority will be used. If there are multiple activities
5483 * with the same priority, the system will either pick the best activity
5484 * based on user preference, or resolve to a system class that will allow
5485 * the user to pick an activity and forward from there.
5486 *
5487 * <p>This method is implemented simply by calling
5488 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5489 * true.</p>
5490 * <p> This API is called for you as part of starting an activity from an
5491 * intent. You do not normally need to call it yourself.</p>
5492 *
5493 * @param pm The package manager with which to resolve the Intent.
5494 *
5495 * @return Name of the component implementing an activity that can
5496 * display the intent.
5497 *
5498 * @see #setComponent
5499 * @see #getComponent
5500 * @see #resolveActivityInfo
5501 */
5502 public ComponentName resolveActivity(PackageManager pm) {
5503 if (mComponent != null) {
5504 return mComponent;
5505 }
5506
5507 ResolveInfo info = pm.resolveActivity(
5508 this, PackageManager.MATCH_DEFAULT_ONLY);
5509 if (info != null) {
5510 return new ComponentName(
5511 info.activityInfo.applicationInfo.packageName,
5512 info.activityInfo.name);
5513 }
5514
5515 return null;
5516 }
5517
5518 /**
5519 * Resolve the Intent into an {@link ActivityInfo}
5520 * describing the activity that should execute the intent. Resolution
5521 * follows the same rules as described for {@link #resolveActivity}, but
5522 * you get back the completely information about the resolved activity
5523 * instead of just its class name.
5524 *
5525 * @param pm The package manager with which to resolve the Intent.
5526 * @param flags Addition information to retrieve as per
5527 * {@link PackageManager#getActivityInfo(ComponentName, int)
5528 * PackageManager.getActivityInfo()}.
5529 *
5530 * @return PackageManager.ActivityInfo
5531 *
5532 * @see #resolveActivity
5533 */
5534 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5535 ActivityInfo ai = null;
5536 if (mComponent != null) {
5537 try {
5538 ai = pm.getActivityInfo(mComponent, flags);
5539 } catch (PackageManager.NameNotFoundException e) {
5540 // ignore
5541 }
5542 } else {
5543 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005544 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005545 if (info != null) {
5546 ai = info.activityInfo;
5547 }
5548 }
5549
5550 return ai;
5551 }
5552
5553 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005554 * Special function for use by the system to resolve service
5555 * intents to system apps. Throws an exception if there are
5556 * multiple potential matches to the Intent. Returns null if
5557 * there are no matches.
5558 * @hide
5559 */
5560 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5561 if (mComponent != null) {
5562 return mComponent;
5563 }
5564
5565 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5566 if (results == null) {
5567 return null;
5568 }
5569 ComponentName comp = null;
5570 for (int i=0; i<results.size(); i++) {
5571 ResolveInfo ri = results.get(i);
5572 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5573 continue;
5574 }
5575 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5576 ri.serviceInfo.name);
5577 if (comp != null) {
5578 throw new IllegalStateException("Multiple system services handle " + this
5579 + ": " + comp + ", " + foundComp);
5580 }
5581 comp = foundComp;
5582 }
5583 return comp;
5584 }
5585
5586 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005587 * Set the general action to be performed.
5588 *
5589 * @param action An action name, such as ACTION_VIEW. Application-specific
5590 * actions should be prefixed with the vendor's package name.
5591 *
5592 * @return Returns the same Intent object, for chaining multiple calls
5593 * into a single statement.
5594 *
5595 * @see #getAction
5596 */
5597 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005598 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005599 return this;
5600 }
5601
5602 /**
5603 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005604 * clears any type that was previously set by {@link #setType} or
5605 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005606 *
Nick Pellyccae4122012-01-09 14:12:58 -08005607 * <p><em>Note: scheme matching in the Android framework is
5608 * case-sensitive, unlike the formal RFC. As a result,
5609 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005610 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005611 * {@link #setDataAndNormalize}
5612 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005613 *
Nick Pellyccae4122012-01-09 14:12:58 -08005614 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005615 *
5616 * @return Returns the same Intent object, for chaining multiple calls
5617 * into a single statement.
5618 *
5619 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005620 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005621 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005622 */
5623 public Intent setData(Uri data) {
5624 mData = data;
5625 mType = null;
5626 return this;
5627 }
5628
5629 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005630 * Normalize and set the data this intent is operating on.
5631 *
5632 * <p>This method automatically clears any type that was
5633 * previously set (for example, by {@link #setType}).
5634 *
5635 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005636 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005637 * so really this is just a convenience method for
5638 * <pre>
5639 * setData(data.normalize())
5640 * </pre>
5641 *
5642 * @param data The Uri of the data this intent is now targeting.
5643 *
5644 * @return Returns the same Intent object, for chaining multiple calls
5645 * into a single statement.
5646 *
5647 * @see #getData
5648 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005649 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005650 */
5651 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005652 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005653 }
5654
5655 /**
5656 * Set an explicit MIME data type.
5657 *
5658 * <p>This is used to create intents that only specify a type and not data,
5659 * for example to indicate the type of data to return.
5660 *
5661 * <p>This method automatically clears any data that was
5662 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005663 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005664 * <p><em>Note: MIME type matching in the Android framework is
5665 * case-sensitive, unlike formal RFC MIME types. As a result,
5666 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005667 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5668 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005669 *
5670 * @param type The MIME type of the data being handled by this intent.
5671 *
5672 * @return Returns the same Intent object, for chaining multiple calls
5673 * into a single statement.
5674 *
5675 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005676 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005677 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005678 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005679 */
5680 public Intent setType(String type) {
5681 mData = null;
5682 mType = type;
5683 return this;
5684 }
5685
5686 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005687 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005688 *
Nick Pellyccae4122012-01-09 14:12:58 -08005689 * <p>This is used to create intents that only specify a type and not data,
5690 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005691 *
Nick Pellyccae4122012-01-09 14:12:58 -08005692 * <p>This method automatically clears any data that was
5693 * previously set (for example by {@link #setData}).
5694 *
5695 * <p>The MIME type is normalized using
5696 * {@link #normalizeMimeType} before it is set,
5697 * so really this is just a convenience method for
5698 * <pre>
5699 * setType(Intent.normalizeMimeType(type))
5700 * </pre>
5701 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005702 * @param type The MIME type of the data being handled by this intent.
5703 *
5704 * @return Returns the same Intent object, for chaining multiple calls
5705 * into a single statement.
5706 *
Nick Pellyccae4122012-01-09 14:12:58 -08005707 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005708 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005709 * @see #normalizeMimeType
5710 */
5711 public Intent setTypeAndNormalize(String type) {
5712 return setType(normalizeMimeType(type));
5713 }
5714
5715 /**
5716 * (Usually optional) Set the data for the intent along with an explicit
5717 * MIME data type. This method should very rarely be used -- it allows you
5718 * to override the MIME type that would ordinarily be inferred from the
5719 * data with your own type given here.
5720 *
5721 * <p><em>Note: MIME type and Uri scheme matching in the
5722 * Android framework is case-sensitive, unlike the formal RFC definitions.
5723 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005724 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005725 * {@link #setDataAndTypeAndNormalize}
5726 * to ensure that they are converted to lower case.</em>
5727 *
5728 * @param data The Uri of the data this intent is now targeting.
5729 * @param type The MIME type of the data being handled by this intent.
5730 *
5731 * @return Returns the same Intent object, for chaining multiple calls
5732 * into a single statement.
5733 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005734 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005735 * @see #setData
5736 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005737 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005738 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005739 */
5740 public Intent setDataAndType(Uri data, String type) {
5741 mData = data;
5742 mType = type;
5743 return this;
5744 }
5745
5746 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005747 * (Usually optional) Normalize and set both the data Uri and an explicit
5748 * MIME data type. This method should very rarely be used -- it allows you
5749 * to override the MIME type that would ordinarily be inferred from the
5750 * data with your own type given here.
5751 *
5752 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005753 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005754 * before they are set, so really this is just a convenience method for
5755 * <pre>
5756 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5757 * </pre>
5758 *
5759 * @param data The Uri of the data this intent is now targeting.
5760 * @param type The MIME type of the data being handled by this intent.
5761 *
5762 * @return Returns the same Intent object, for chaining multiple calls
5763 * into a single statement.
5764 *
5765 * @see #setType
5766 * @see #setData
5767 * @see #setDataAndType
5768 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005769 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005770 */
5771 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005772 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005773 }
5774
5775 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005776 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005777 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005778 * activities that provide <em>all</em> of the requested categories will be
5779 * used.
5780 *
5781 * @param category The desired category. This can be either one of the
5782 * predefined Intent categories, or a custom category in your own
5783 * namespace.
5784 *
5785 * @return Returns the same Intent object, for chaining multiple calls
5786 * into a single statement.
5787 *
5788 * @see #hasCategory
5789 * @see #removeCategory
5790 */
5791 public Intent addCategory(String category) {
5792 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005793 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005794 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005795 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005796 return this;
5797 }
5798
5799 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005800 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005801 *
5802 * @param category The category to remove.
5803 *
5804 * @see #addCategory
5805 */
5806 public void removeCategory(String category) {
5807 if (mCategories != null) {
5808 mCategories.remove(category);
5809 if (mCategories.size() == 0) {
5810 mCategories = null;
5811 }
5812 }
5813 }
5814
5815 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005816 * Set a selector for this Intent. This is a modification to the kinds of
5817 * things the Intent will match. If the selector is set, it will be used
5818 * when trying to find entities that can handle the Intent, instead of the
5819 * main contents of the Intent. This allows you build an Intent containing
5820 * a generic protocol while targeting it more specifically.
5821 *
5822 * <p>An example of where this may be used is with things like
5823 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5824 * Intent that will launch the Browser application. However, the correct
5825 * main entry point of an application is actually {@link #ACTION_MAIN}
5826 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5827 * used to specify the actual Activity to launch. If you launch the browser
5828 * with something different, undesired behavior may happen if the user has
5829 * previously or later launches it the normal way, since they do not match.
5830 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5831 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5832 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5833 *
5834 * <p>Setting a selector does not impact the behavior of
5835 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5836 * desired behavior of a selector -- it does not impact the base meaning
5837 * of the Intent, just what kinds of things will be matched against it
5838 * when determining who can handle it.</p>
5839 *
5840 * <p>You can not use both a selector and {@link #setPackage(String)} on
5841 * the same base Intent.</p>
5842 *
5843 * @param selector The desired selector Intent; set to null to not use
5844 * a special selector.
5845 */
5846 public void setSelector(Intent selector) {
5847 if (selector == this) {
5848 throw new IllegalArgumentException(
5849 "Intent being set as a selector of itself");
5850 }
5851 if (selector != null && mPackage != null) {
5852 throw new IllegalArgumentException(
5853 "Can't set selector when package name is already set");
5854 }
5855 mSelector = selector;
5856 }
5857
5858 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005859 * Set a {@link ClipData} associated with this Intent. This replaces any
5860 * previously set ClipData.
5861 *
5862 * <p>The ClipData in an intent is not used for Intent matching or other
5863 * such operations. Semantically it is like extras, used to transmit
5864 * additional data with the Intent. The main feature of using this over
5865 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5866 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5867 * items included in the clip data. This is useful, in particular, if
5868 * you want to transmit an Intent containing multiple <code>content:</code>
5869 * URIs for which the recipient may not have global permission to access the
5870 * content provider.
5871 *
5872 * <p>If the ClipData contains items that are themselves Intents, any
5873 * grant flags in those Intents will be ignored. Only the top-level flags
5874 * of the main Intent are respected, and will be applied to all Uri or
5875 * Intent items in the clip (or sub-items of the clip).
5876 *
5877 * <p>The MIME type, label, and icon in the ClipData object are not
5878 * directly used by Intent. Applications should generally rely on the
5879 * MIME type of the Intent itself, not what it may find in the ClipData.
5880 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005881 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005882 *
5883 * @param clip The new clip to set. May be null to clear the current clip.
5884 */
5885 public void setClipData(ClipData clip) {
5886 mClipData = clip;
5887 }
5888
5889 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005890 * This is NOT a secure mechanism to identify the user who sent the intent.
5891 * When the intent is sent to a different user, it is used to fix uris by adding the userId
5892 * who sent the intent.
5893 * @hide
5894 */
5895 public void setContentUserHint(int contentUserHint) {
5896 mContentUserHint = contentUserHint;
5897 }
5898
5899 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005900 * Add extended data to the intent. The name must include a package
5901 * prefix, for example the app com.android.contacts would use names
5902 * like "com.android.contacts.ShowAll".
5903 *
5904 * @param name The name of the extra data, with package prefix.
5905 * @param value The boolean data value.
5906 *
5907 * @return Returns the same Intent object, for chaining multiple calls
5908 * into a single statement.
5909 *
5910 * @see #putExtras
5911 * @see #removeExtra
5912 * @see #getBooleanExtra(String, boolean)
5913 */
5914 public Intent putExtra(String name, boolean value) {
5915 if (mExtras == null) {
5916 mExtras = new Bundle();
5917 }
5918 mExtras.putBoolean(name, value);
5919 return this;
5920 }
5921
5922 /**
5923 * Add extended data to the intent. The name must include a package
5924 * prefix, for example the app com.android.contacts would use names
5925 * like "com.android.contacts.ShowAll".
5926 *
5927 * @param name The name of the extra data, with package prefix.
5928 * @param value The byte data value.
5929 *
5930 * @return Returns the same Intent object, for chaining multiple calls
5931 * into a single statement.
5932 *
5933 * @see #putExtras
5934 * @see #removeExtra
5935 * @see #getByteExtra(String, byte)
5936 */
5937 public Intent putExtra(String name, byte value) {
5938 if (mExtras == null) {
5939 mExtras = new Bundle();
5940 }
5941 mExtras.putByte(name, value);
5942 return this;
5943 }
5944
5945 /**
5946 * Add extended data to the intent. The name must include a package
5947 * prefix, for example the app com.android.contacts would use names
5948 * like "com.android.contacts.ShowAll".
5949 *
5950 * @param name The name of the extra data, with package prefix.
5951 * @param value The char data value.
5952 *
5953 * @return Returns the same Intent object, for chaining multiple calls
5954 * into a single statement.
5955 *
5956 * @see #putExtras
5957 * @see #removeExtra
5958 * @see #getCharExtra(String, char)
5959 */
5960 public Intent putExtra(String name, char value) {
5961 if (mExtras == null) {
5962 mExtras = new Bundle();
5963 }
5964 mExtras.putChar(name, value);
5965 return this;
5966 }
5967
5968 /**
5969 * Add extended data to the intent. The name must include a package
5970 * prefix, for example the app com.android.contacts would use names
5971 * like "com.android.contacts.ShowAll".
5972 *
5973 * @param name The name of the extra data, with package prefix.
5974 * @param value The short data value.
5975 *
5976 * @return Returns the same Intent object, for chaining multiple calls
5977 * into a single statement.
5978 *
5979 * @see #putExtras
5980 * @see #removeExtra
5981 * @see #getShortExtra(String, short)
5982 */
5983 public Intent putExtra(String name, short value) {
5984 if (mExtras == null) {
5985 mExtras = new Bundle();
5986 }
5987 mExtras.putShort(name, value);
5988 return this;
5989 }
5990
5991 /**
5992 * Add extended data to the intent. The name must include a package
5993 * prefix, for example the app com.android.contacts would use names
5994 * like "com.android.contacts.ShowAll".
5995 *
5996 * @param name The name of the extra data, with package prefix.
5997 * @param value The integer data value.
5998 *
5999 * @return Returns the same Intent object, for chaining multiple calls
6000 * into a single statement.
6001 *
6002 * @see #putExtras
6003 * @see #removeExtra
6004 * @see #getIntExtra(String, int)
6005 */
6006 public Intent putExtra(String name, int value) {
6007 if (mExtras == null) {
6008 mExtras = new Bundle();
6009 }
6010 mExtras.putInt(name, value);
6011 return this;
6012 }
6013
6014 /**
6015 * Add extended data to the intent. The name must include a package
6016 * prefix, for example the app com.android.contacts would use names
6017 * like "com.android.contacts.ShowAll".
6018 *
6019 * @param name The name of the extra data, with package prefix.
6020 * @param value The long data value.
6021 *
6022 * @return Returns the same Intent object, for chaining multiple calls
6023 * into a single statement.
6024 *
6025 * @see #putExtras
6026 * @see #removeExtra
6027 * @see #getLongExtra(String, long)
6028 */
6029 public Intent putExtra(String name, long value) {
6030 if (mExtras == null) {
6031 mExtras = new Bundle();
6032 }
6033 mExtras.putLong(name, value);
6034 return this;
6035 }
6036
6037 /**
6038 * Add extended data to the intent. The name must include a package
6039 * prefix, for example the app com.android.contacts would use names
6040 * like "com.android.contacts.ShowAll".
6041 *
6042 * @param name The name of the extra data, with package prefix.
6043 * @param value The float data value.
6044 *
6045 * @return Returns the same Intent object, for chaining multiple calls
6046 * into a single statement.
6047 *
6048 * @see #putExtras
6049 * @see #removeExtra
6050 * @see #getFloatExtra(String, float)
6051 */
6052 public Intent putExtra(String name, float value) {
6053 if (mExtras == null) {
6054 mExtras = new Bundle();
6055 }
6056 mExtras.putFloat(name, value);
6057 return this;
6058 }
6059
6060 /**
6061 * Add extended data to the intent. The name must include a package
6062 * prefix, for example the app com.android.contacts would use names
6063 * like "com.android.contacts.ShowAll".
6064 *
6065 * @param name The name of the extra data, with package prefix.
6066 * @param value The double data value.
6067 *
6068 * @return Returns the same Intent object, for chaining multiple calls
6069 * into a single statement.
6070 *
6071 * @see #putExtras
6072 * @see #removeExtra
6073 * @see #getDoubleExtra(String, double)
6074 */
6075 public Intent putExtra(String name, double value) {
6076 if (mExtras == null) {
6077 mExtras = new Bundle();
6078 }
6079 mExtras.putDouble(name, value);
6080 return this;
6081 }
6082
6083 /**
6084 * Add extended data to the intent. The name must include a package
6085 * prefix, for example the app com.android.contacts would use names
6086 * like "com.android.contacts.ShowAll".
6087 *
6088 * @param name The name of the extra data, with package prefix.
6089 * @param value The String data value.
6090 *
6091 * @return Returns the same Intent object, for chaining multiple calls
6092 * into a single statement.
6093 *
6094 * @see #putExtras
6095 * @see #removeExtra
6096 * @see #getStringExtra(String)
6097 */
6098 public Intent putExtra(String name, String value) {
6099 if (mExtras == null) {
6100 mExtras = new Bundle();
6101 }
6102 mExtras.putString(name, value);
6103 return this;
6104 }
6105
6106 /**
6107 * Add extended data to the intent. The name must include a package
6108 * prefix, for example the app com.android.contacts would use names
6109 * like "com.android.contacts.ShowAll".
6110 *
6111 * @param name The name of the extra data, with package prefix.
6112 * @param value The CharSequence data value.
6113 *
6114 * @return Returns the same Intent object, for chaining multiple calls
6115 * into a single statement.
6116 *
6117 * @see #putExtras
6118 * @see #removeExtra
6119 * @see #getCharSequenceExtra(String)
6120 */
6121 public Intent putExtra(String name, CharSequence value) {
6122 if (mExtras == null) {
6123 mExtras = new Bundle();
6124 }
6125 mExtras.putCharSequence(name, value);
6126 return this;
6127 }
6128
6129 /**
6130 * Add extended data to the intent. The name must include a package
6131 * prefix, for example the app com.android.contacts would use names
6132 * like "com.android.contacts.ShowAll".
6133 *
6134 * @param name The name of the extra data, with package prefix.
6135 * @param value The Parcelable data value.
6136 *
6137 * @return Returns the same Intent object, for chaining multiple calls
6138 * into a single statement.
6139 *
6140 * @see #putExtras
6141 * @see #removeExtra
6142 * @see #getParcelableExtra(String)
6143 */
6144 public Intent putExtra(String name, Parcelable value) {
6145 if (mExtras == null) {
6146 mExtras = new Bundle();
6147 }
6148 mExtras.putParcelable(name, value);
6149 return this;
6150 }
6151
6152 /**
6153 * Add extended data to the intent. The name must include a package
6154 * prefix, for example the app com.android.contacts would use names
6155 * like "com.android.contacts.ShowAll".
6156 *
6157 * @param name The name of the extra data, with package prefix.
6158 * @param value The Parcelable[] data value.
6159 *
6160 * @return Returns the same Intent object, for chaining multiple calls
6161 * into a single statement.
6162 *
6163 * @see #putExtras
6164 * @see #removeExtra
6165 * @see #getParcelableArrayExtra(String)
6166 */
6167 public Intent putExtra(String name, Parcelable[] value) {
6168 if (mExtras == null) {
6169 mExtras = new Bundle();
6170 }
6171 mExtras.putParcelableArray(name, value);
6172 return this;
6173 }
6174
6175 /**
6176 * Add extended data to the intent. The name must include a package
6177 * prefix, for example the app com.android.contacts would use names
6178 * like "com.android.contacts.ShowAll".
6179 *
6180 * @param name The name of the extra data, with package prefix.
6181 * @param value The ArrayList<Parcelable> data value.
6182 *
6183 * @return Returns the same Intent object, for chaining multiple calls
6184 * into a single statement.
6185 *
6186 * @see #putExtras
6187 * @see #removeExtra
6188 * @see #getParcelableArrayListExtra(String)
6189 */
6190 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
6191 if (mExtras == null) {
6192 mExtras = new Bundle();
6193 }
6194 mExtras.putParcelableArrayList(name, value);
6195 return this;
6196 }
6197
6198 /**
6199 * Add extended data to the intent. The name must include a package
6200 * prefix, for example the app com.android.contacts would use names
6201 * like "com.android.contacts.ShowAll".
6202 *
6203 * @param name The name of the extra data, with package prefix.
6204 * @param value The ArrayList<Integer> data value.
6205 *
6206 * @return Returns the same Intent object, for chaining multiple calls
6207 * into a single statement.
6208 *
6209 * @see #putExtras
6210 * @see #removeExtra
6211 * @see #getIntegerArrayListExtra(String)
6212 */
6213 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
6214 if (mExtras == null) {
6215 mExtras = new Bundle();
6216 }
6217 mExtras.putIntegerArrayList(name, value);
6218 return this;
6219 }
6220
6221 /**
6222 * Add extended data to the intent. The name must include a package
6223 * prefix, for example the app com.android.contacts would use names
6224 * like "com.android.contacts.ShowAll".
6225 *
6226 * @param name The name of the extra data, with package prefix.
6227 * @param value The ArrayList<String> data value.
6228 *
6229 * @return Returns the same Intent object, for chaining multiple calls
6230 * into a single statement.
6231 *
6232 * @see #putExtras
6233 * @see #removeExtra
6234 * @see #getStringArrayListExtra(String)
6235 */
6236 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
6237 if (mExtras == null) {
6238 mExtras = new Bundle();
6239 }
6240 mExtras.putStringArrayList(name, value);
6241 return this;
6242 }
6243
6244 /**
6245 * Add extended data to the intent. The name must include a package
6246 * prefix, for example the app com.android.contacts would use names
6247 * like "com.android.contacts.ShowAll".
6248 *
6249 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006250 * @param value The ArrayList<CharSequence> data value.
6251 *
6252 * @return Returns the same Intent object, for chaining multiple calls
6253 * into a single statement.
6254 *
6255 * @see #putExtras
6256 * @see #removeExtra
6257 * @see #getCharSequenceArrayListExtra(String)
6258 */
6259 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6260 if (mExtras == null) {
6261 mExtras = new Bundle();
6262 }
6263 mExtras.putCharSequenceArrayList(name, value);
6264 return this;
6265 }
6266
6267 /**
6268 * Add extended data to the intent. The name must include a package
6269 * prefix, for example the app com.android.contacts would use names
6270 * like "com.android.contacts.ShowAll".
6271 *
6272 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006273 * @param value The Serializable data value.
6274 *
6275 * @return Returns the same Intent object, for chaining multiple calls
6276 * into a single statement.
6277 *
6278 * @see #putExtras
6279 * @see #removeExtra
6280 * @see #getSerializableExtra(String)
6281 */
6282 public Intent putExtra(String name, Serializable value) {
6283 if (mExtras == null) {
6284 mExtras = new Bundle();
6285 }
6286 mExtras.putSerializable(name, value);
6287 return this;
6288 }
6289
6290 /**
6291 * Add extended data to the intent. The name must include a package
6292 * prefix, for example the app com.android.contacts would use names
6293 * like "com.android.contacts.ShowAll".
6294 *
6295 * @param name The name of the extra data, with package prefix.
6296 * @param value The boolean array data value.
6297 *
6298 * @return Returns the same Intent object, for chaining multiple calls
6299 * into a single statement.
6300 *
6301 * @see #putExtras
6302 * @see #removeExtra
6303 * @see #getBooleanArrayExtra(String)
6304 */
6305 public Intent putExtra(String name, boolean[] value) {
6306 if (mExtras == null) {
6307 mExtras = new Bundle();
6308 }
6309 mExtras.putBooleanArray(name, value);
6310 return this;
6311 }
6312
6313 /**
6314 * Add extended data to the intent. The name must include a package
6315 * prefix, for example the app com.android.contacts would use names
6316 * like "com.android.contacts.ShowAll".
6317 *
6318 * @param name The name of the extra data, with package prefix.
6319 * @param value The byte array data value.
6320 *
6321 * @return Returns the same Intent object, for chaining multiple calls
6322 * into a single statement.
6323 *
6324 * @see #putExtras
6325 * @see #removeExtra
6326 * @see #getByteArrayExtra(String)
6327 */
6328 public Intent putExtra(String name, byte[] value) {
6329 if (mExtras == null) {
6330 mExtras = new Bundle();
6331 }
6332 mExtras.putByteArray(name, value);
6333 return this;
6334 }
6335
6336 /**
6337 * Add extended data to the intent. The name must include a package
6338 * prefix, for example the app com.android.contacts would use names
6339 * like "com.android.contacts.ShowAll".
6340 *
6341 * @param name The name of the extra data, with package prefix.
6342 * @param value The short array data value.
6343 *
6344 * @return Returns the same Intent object, for chaining multiple calls
6345 * into a single statement.
6346 *
6347 * @see #putExtras
6348 * @see #removeExtra
6349 * @see #getShortArrayExtra(String)
6350 */
6351 public Intent putExtra(String name, short[] value) {
6352 if (mExtras == null) {
6353 mExtras = new Bundle();
6354 }
6355 mExtras.putShortArray(name, value);
6356 return this;
6357 }
6358
6359 /**
6360 * Add extended data to the intent. The name must include a package
6361 * prefix, for example the app com.android.contacts would use names
6362 * like "com.android.contacts.ShowAll".
6363 *
6364 * @param name The name of the extra data, with package prefix.
6365 * @param value The char array data value.
6366 *
6367 * @return Returns the same Intent object, for chaining multiple calls
6368 * into a single statement.
6369 *
6370 * @see #putExtras
6371 * @see #removeExtra
6372 * @see #getCharArrayExtra(String)
6373 */
6374 public Intent putExtra(String name, char[] value) {
6375 if (mExtras == null) {
6376 mExtras = new Bundle();
6377 }
6378 mExtras.putCharArray(name, value);
6379 return this;
6380 }
6381
6382 /**
6383 * Add extended data to the intent. The name must include a package
6384 * prefix, for example the app com.android.contacts would use names
6385 * like "com.android.contacts.ShowAll".
6386 *
6387 * @param name The name of the extra data, with package prefix.
6388 * @param value The int array data value.
6389 *
6390 * @return Returns the same Intent object, for chaining multiple calls
6391 * into a single statement.
6392 *
6393 * @see #putExtras
6394 * @see #removeExtra
6395 * @see #getIntArrayExtra(String)
6396 */
6397 public Intent putExtra(String name, int[] value) {
6398 if (mExtras == null) {
6399 mExtras = new Bundle();
6400 }
6401 mExtras.putIntArray(name, value);
6402 return this;
6403 }
6404
6405 /**
6406 * Add extended data to the intent. The name must include a package
6407 * prefix, for example the app com.android.contacts would use names
6408 * like "com.android.contacts.ShowAll".
6409 *
6410 * @param name The name of the extra data, with package prefix.
6411 * @param value The byte array data value.
6412 *
6413 * @return Returns the same Intent object, for chaining multiple calls
6414 * into a single statement.
6415 *
6416 * @see #putExtras
6417 * @see #removeExtra
6418 * @see #getLongArrayExtra(String)
6419 */
6420 public Intent putExtra(String name, long[] value) {
6421 if (mExtras == null) {
6422 mExtras = new Bundle();
6423 }
6424 mExtras.putLongArray(name, value);
6425 return this;
6426 }
6427
6428 /**
6429 * Add extended data to the intent. The name must include a package
6430 * prefix, for example the app com.android.contacts would use names
6431 * like "com.android.contacts.ShowAll".
6432 *
6433 * @param name The name of the extra data, with package prefix.
6434 * @param value The float array data value.
6435 *
6436 * @return Returns the same Intent object, for chaining multiple calls
6437 * into a single statement.
6438 *
6439 * @see #putExtras
6440 * @see #removeExtra
6441 * @see #getFloatArrayExtra(String)
6442 */
6443 public Intent putExtra(String name, float[] value) {
6444 if (mExtras == null) {
6445 mExtras = new Bundle();
6446 }
6447 mExtras.putFloatArray(name, value);
6448 return this;
6449 }
6450
6451 /**
6452 * Add extended data to the intent. The name must include a package
6453 * prefix, for example the app com.android.contacts would use names
6454 * like "com.android.contacts.ShowAll".
6455 *
6456 * @param name The name of the extra data, with package prefix.
6457 * @param value The double array data value.
6458 *
6459 * @return Returns the same Intent object, for chaining multiple calls
6460 * into a single statement.
6461 *
6462 * @see #putExtras
6463 * @see #removeExtra
6464 * @see #getDoubleArrayExtra(String)
6465 */
6466 public Intent putExtra(String name, double[] value) {
6467 if (mExtras == null) {
6468 mExtras = new Bundle();
6469 }
6470 mExtras.putDoubleArray(name, value);
6471 return this;
6472 }
6473
6474 /**
6475 * Add extended data to the intent. The name must include a package
6476 * prefix, for example the app com.android.contacts would use names
6477 * like "com.android.contacts.ShowAll".
6478 *
6479 * @param name The name of the extra data, with package prefix.
6480 * @param value The String array data value.
6481 *
6482 * @return Returns the same Intent object, for chaining multiple calls
6483 * into a single statement.
6484 *
6485 * @see #putExtras
6486 * @see #removeExtra
6487 * @see #getStringArrayExtra(String)
6488 */
6489 public Intent putExtra(String name, String[] value) {
6490 if (mExtras == null) {
6491 mExtras = new Bundle();
6492 }
6493 mExtras.putStringArray(name, value);
6494 return this;
6495 }
6496
6497 /**
6498 * Add extended data to the intent. The name must include a package
6499 * prefix, for example the app com.android.contacts would use names
6500 * like "com.android.contacts.ShowAll".
6501 *
6502 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006503 * @param value The CharSequence array data value.
6504 *
6505 * @return Returns the same Intent object, for chaining multiple calls
6506 * into a single statement.
6507 *
6508 * @see #putExtras
6509 * @see #removeExtra
6510 * @see #getCharSequenceArrayExtra(String)
6511 */
6512 public Intent putExtra(String name, CharSequence[] value) {
6513 if (mExtras == null) {
6514 mExtras = new Bundle();
6515 }
6516 mExtras.putCharSequenceArray(name, value);
6517 return this;
6518 }
6519
6520 /**
6521 * Add extended data to the intent. The name must include a package
6522 * prefix, for example the app com.android.contacts would use names
6523 * like "com.android.contacts.ShowAll".
6524 *
6525 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006526 * @param value The Bundle data value.
6527 *
6528 * @return Returns the same Intent object, for chaining multiple calls
6529 * into a single statement.
6530 *
6531 * @see #putExtras
6532 * @see #removeExtra
6533 * @see #getBundleExtra(String)
6534 */
6535 public Intent putExtra(String name, Bundle value) {
6536 if (mExtras == null) {
6537 mExtras = new Bundle();
6538 }
6539 mExtras.putBundle(name, value);
6540 return this;
6541 }
6542
6543 /**
6544 * Add extended data to the intent. The name must include a package
6545 * prefix, for example the app com.android.contacts would use names
6546 * like "com.android.contacts.ShowAll".
6547 *
6548 * @param name The name of the extra data, with package prefix.
6549 * @param value The IBinder data value.
6550 *
6551 * @return Returns the same Intent object, for chaining multiple calls
6552 * into a single statement.
6553 *
6554 * @see #putExtras
6555 * @see #removeExtra
6556 * @see #getIBinderExtra(String)
6557 *
6558 * @deprecated
6559 * @hide
6560 */
6561 @Deprecated
6562 public Intent putExtra(String name, IBinder value) {
6563 if (mExtras == null) {
6564 mExtras = new Bundle();
6565 }
6566 mExtras.putIBinder(name, value);
6567 return this;
6568 }
6569
6570 /**
6571 * Copy all extras in 'src' in to this intent.
6572 *
6573 * @param src Contains the extras to copy.
6574 *
6575 * @see #putExtra
6576 */
6577 public Intent putExtras(Intent src) {
6578 if (src.mExtras != null) {
6579 if (mExtras == null) {
6580 mExtras = new Bundle(src.mExtras);
6581 } else {
6582 mExtras.putAll(src.mExtras);
6583 }
6584 }
6585 return this;
6586 }
6587
6588 /**
6589 * Add a set of extended data to the intent. The keys must include a package
6590 * prefix, for example the app com.android.contacts would use names
6591 * like "com.android.contacts.ShowAll".
6592 *
6593 * @param extras The Bundle of extras to add to this intent.
6594 *
6595 * @see #putExtra
6596 * @see #removeExtra
6597 */
6598 public Intent putExtras(Bundle extras) {
6599 if (mExtras == null) {
6600 mExtras = new Bundle();
6601 }
6602 mExtras.putAll(extras);
6603 return this;
6604 }
6605
6606 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006607 * Completely replace the extras in the Intent with the extras in the
6608 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006609 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006610 * @param src The exact extras contained in this Intent are copied
6611 * into the target intent, replacing any that were previously there.
6612 */
6613 public Intent replaceExtras(Intent src) {
6614 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6615 return this;
6616 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006617
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006618 /**
6619 * Completely replace the extras in the Intent with the given Bundle of
6620 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006621 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006622 * @param extras The new set of extras in the Intent, or null to erase
6623 * all extras.
6624 */
6625 public Intent replaceExtras(Bundle extras) {
6626 mExtras = extras != null ? new Bundle(extras) : null;
6627 return this;
6628 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006629
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006630 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006631 * Remove extended data from the intent.
6632 *
6633 * @see #putExtra
6634 */
6635 public void removeExtra(String name) {
6636 if (mExtras != null) {
6637 mExtras.remove(name);
6638 if (mExtras.size() == 0) {
6639 mExtras = null;
6640 }
6641 }
6642 }
6643
6644 /**
6645 * Set special flags controlling how this intent is handled. Most values
6646 * here depend on the type of component being executed by the Intent,
6647 * specifically the FLAG_ACTIVITY_* flags are all for use with
6648 * {@link Context#startActivity Context.startActivity()} and the
6649 * FLAG_RECEIVER_* flags are all for use with
6650 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6651 *
Scott Main7aee61f2011-02-08 11:25:01 -08006652 * <p>See the
6653 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6654 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006655 * the behavior of your application.
6656 *
6657 * @param flags The desired flags.
6658 *
6659 * @return Returns the same Intent object, for chaining multiple calls
6660 * into a single statement.
6661 *
6662 * @see #getFlags
6663 * @see #addFlags
6664 *
6665 * @see #FLAG_GRANT_READ_URI_PERMISSION
6666 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006667 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6668 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006669 * @see #FLAG_DEBUG_LOG_RESOLUTION
6670 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006671 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006672 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006673 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006674 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006675 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6676 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006677 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006678 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006679 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006680 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006681 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006682 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006683 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006684 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6685 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006686 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006687 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006688 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006689 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6690 */
6691 public Intent setFlags(int flags) {
6692 mFlags = flags;
6693 return this;
6694 }
6695
6696 /**
6697 * Add additional flags to the intent (or with existing flags
6698 * value).
6699 *
6700 * @param flags The new flags to set.
6701 *
6702 * @return Returns the same Intent object, for chaining multiple calls
6703 * into a single statement.
6704 *
6705 * @see #setFlags
6706 */
6707 public Intent addFlags(int flags) {
6708 mFlags |= flags;
6709 return this;
6710 }
6711
6712 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006713 * (Usually optional) Set an explicit application package name that limits
6714 * the components this Intent will resolve to. If left to the default
6715 * value of null, all components in all applications will considered.
6716 * If non-null, the Intent can only match the components in the given
6717 * application package.
6718 *
6719 * @param packageName The name of the application package to handle the
6720 * intent, or null to allow any application package.
6721 *
6722 * @return Returns the same Intent object, for chaining multiple calls
6723 * into a single statement.
6724 *
6725 * @see #getPackage
6726 * @see #resolveActivity
6727 */
6728 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006729 if (packageName != null && mSelector != null) {
6730 throw new IllegalArgumentException(
6731 "Can't set package name when selector is already set");
6732 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006733 mPackage = packageName;
6734 return this;
6735 }
6736
6737 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006738 * (Usually optional) Explicitly set the component to handle the intent.
6739 * If left with the default value of null, the system will determine the
6740 * appropriate class to use based on the other fields (action, data,
6741 * type, categories) in the Intent. If this class is defined, the
6742 * specified class will always be used regardless of the other fields. You
6743 * should only set this value when you know you absolutely want a specific
6744 * class to be used; otherwise it is better to let the system find the
6745 * appropriate class so that you will respect the installed applications
6746 * and user preferences.
6747 *
6748 * @param component The name of the application component to handle the
6749 * intent, or null to let the system find one for you.
6750 *
6751 * @return Returns the same Intent object, for chaining multiple calls
6752 * into a single statement.
6753 *
6754 * @see #setClass
6755 * @see #setClassName(Context, String)
6756 * @see #setClassName(String, String)
6757 * @see #getComponent
6758 * @see #resolveActivity
6759 */
6760 public Intent setComponent(ComponentName component) {
6761 mComponent = component;
6762 return this;
6763 }
6764
6765 /**
6766 * Convenience for calling {@link #setComponent} with an
6767 * explicit class name.
6768 *
6769 * @param packageContext A Context of the application package implementing
6770 * this class.
6771 * @param className The name of a class inside of the application package
6772 * that will be used as the component for this Intent.
6773 *
6774 * @return Returns the same Intent object, for chaining multiple calls
6775 * into a single statement.
6776 *
6777 * @see #setComponent
6778 * @see #setClass
6779 */
6780 public Intent setClassName(Context packageContext, String className) {
6781 mComponent = new ComponentName(packageContext, className);
6782 return this;
6783 }
6784
6785 /**
6786 * Convenience for calling {@link #setComponent} with an
6787 * explicit application package name and class name.
6788 *
6789 * @param packageName The name of the package implementing the desired
6790 * component.
6791 * @param className The name of a class inside of the application package
6792 * that will be used as the component for this Intent.
6793 *
6794 * @return Returns the same Intent object, for chaining multiple calls
6795 * into a single statement.
6796 *
6797 * @see #setComponent
6798 * @see #setClass
6799 */
6800 public Intent setClassName(String packageName, String className) {
6801 mComponent = new ComponentName(packageName, className);
6802 return this;
6803 }
6804
6805 /**
6806 * Convenience for calling {@link #setComponent(ComponentName)} with the
6807 * name returned by a {@link Class} object.
6808 *
6809 * @param packageContext A Context of the application package implementing
6810 * this class.
6811 * @param cls The class name to set, equivalent to
6812 * <code>setClassName(context, cls.getName())</code>.
6813 *
6814 * @return Returns the same Intent object, for chaining multiple calls
6815 * into a single statement.
6816 *
6817 * @see #setComponent
6818 */
6819 public Intent setClass(Context packageContext, Class<?> cls) {
6820 mComponent = new ComponentName(packageContext, cls);
6821 return this;
6822 }
6823
6824 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006825 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6826 * used as a hint to the receiver for animations and the like. Null means that there
6827 * is no source bounds.
6828 */
6829 public void setSourceBounds(Rect r) {
6830 if (r != null) {
6831 mSourceBounds = new Rect(r);
6832 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006833 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006834 }
6835 }
6836
Tor Norbyed9273d62013-05-30 15:59:53 -07006837 /** @hide */
6838 @IntDef(flag = true,
6839 value = {
6840 FILL_IN_ACTION,
6841 FILL_IN_DATA,
6842 FILL_IN_CATEGORIES,
6843 FILL_IN_COMPONENT,
6844 FILL_IN_PACKAGE,
6845 FILL_IN_SOURCE_BOUNDS,
6846 FILL_IN_SELECTOR,
6847 FILL_IN_CLIP_DATA
6848 })
6849 @Retention(RetentionPolicy.SOURCE)
6850 public @interface FillInFlags {}
6851
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006852 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006853 * Use with {@link #fillIn} to allow the current action value to be
6854 * overwritten, even if it is already set.
6855 */
6856 public static final int FILL_IN_ACTION = 1<<0;
6857
6858 /**
6859 * Use with {@link #fillIn} to allow the current data or type value
6860 * overwritten, even if it is already set.
6861 */
6862 public static final int FILL_IN_DATA = 1<<1;
6863
6864 /**
6865 * Use with {@link #fillIn} to allow the current categories to be
6866 * overwritten, even if they are already set.
6867 */
6868 public static final int FILL_IN_CATEGORIES = 1<<2;
6869
6870 /**
6871 * Use with {@link #fillIn} to allow the current component value to be
6872 * overwritten, even if it is already set.
6873 */
6874 public static final int FILL_IN_COMPONENT = 1<<3;
6875
6876 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006877 * Use with {@link #fillIn} to allow the current package value to be
6878 * overwritten, even if it is already set.
6879 */
6880 public static final int FILL_IN_PACKAGE = 1<<4;
6881
6882 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006883 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006884 * overwritten, even if it is already set.
6885 */
6886 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6887
6888 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006889 * Use with {@link #fillIn} to allow the current selector to be
6890 * overwritten, even if it is already set.
6891 */
6892 public static final int FILL_IN_SELECTOR = 1<<6;
6893
6894 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006895 * Use with {@link #fillIn} to allow the current ClipData to be
6896 * overwritten, even if it is already set.
6897 */
6898 public static final int FILL_IN_CLIP_DATA = 1<<7;
6899
6900 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006901 * Copy the contents of <var>other</var> in to this object, but only
6902 * where fields are not defined by this object. For purposes of a field
6903 * being defined, the following pieces of data in the Intent are
6904 * considered to be separate fields:
6905 *
6906 * <ul>
6907 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006908 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006909 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6910 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006911 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006912 * <li> component, as set by {@link #setComponent(ComponentName)} or
6913 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006914 * <li> source bounds, as set by {@link #setSourceBounds}.
6915 * <li> selector, as set by {@link #setSelector(Intent)}.
6916 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006917 * <li> each top-level name in the associated extras.
6918 * </ul>
6919 *
6920 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006921 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006922 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6923 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6924 * the restriction where the corresponding field will not be replaced if
6925 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006926 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006927 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6928 * is explicitly specified. The selector will only be copied if
6929 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006930 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006931 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6932 * and Intent B with {action="gotit", data-type="some/thing",
6933 * categories="one","two"}.
6934 *
6935 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6936 * containing: {action="gotit", data-type="some/thing",
6937 * categories="bar"}.
6938 *
6939 * @param other Another Intent whose values are to be used to fill in
6940 * the current one.
6941 * @param flags Options to control which fields can be filled in.
6942 *
6943 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006944 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006945 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6946 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6947 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006948 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006949 @FillInFlags
6950 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006951 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006952 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006953 if (other.mAction != null
6954 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006955 mAction = other.mAction;
6956 changes |= FILL_IN_ACTION;
6957 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006958 if ((other.mData != null || other.mType != null)
6959 && ((mData == null && mType == null)
6960 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006961 mData = other.mData;
6962 mType = other.mType;
6963 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006964 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006965 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006966 if (other.mCategories != null
6967 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006968 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006969 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006970 }
6971 changes |= FILL_IN_CATEGORIES;
6972 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006973 if (other.mPackage != null
6974 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006975 // Only do this if mSelector is not set.
6976 if (mSelector == null) {
6977 mPackage = other.mPackage;
6978 changes |= FILL_IN_PACKAGE;
6979 }
6980 }
6981 // Selector is special: it can only be set if explicitly allowed,
6982 // for the same reason as the component name.
6983 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6984 if (mPackage == null) {
6985 mSelector = new Intent(other.mSelector);
6986 mPackage = null;
6987 changes |= FILL_IN_SELECTOR;
6988 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006989 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006990 if (other.mClipData != null
6991 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6992 mClipData = other.mClipData;
6993 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006994 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006995 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006996 // Component is special: it can -only- be set if explicitly allowed,
6997 // since otherwise the sender could force the intent somewhere the
6998 // originator didn't intend.
6999 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007000 mComponent = other.mComponent;
7001 changes |= FILL_IN_COMPONENT;
7002 }
7003 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007004 if (other.mSourceBounds != null
7005 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
7006 mSourceBounds = new Rect(other.mSourceBounds);
7007 changes |= FILL_IN_SOURCE_BOUNDS;
7008 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007009 if (mExtras == null) {
7010 if (other.mExtras != null) {
7011 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007012 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007013 }
7014 } else if (other.mExtras != null) {
7015 try {
7016 Bundle newb = new Bundle(other.mExtras);
7017 newb.putAll(mExtras);
7018 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007019 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007020 } catch (RuntimeException e) {
7021 // Modifying the extras can cause us to unparcel the contents
7022 // of the bundle, and if we do this in the system process that
7023 // may fail. We really should handle this (i.e., the Bundle
7024 // impl shouldn't be on top of a plain map), but for now just
7025 // ignore it and keep the original contents. :(
7026 Log.w("Intent", "Failure filling in extras", e);
7027 }
7028 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007029 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
7030 && other.mContentUserHint != UserHandle.USER_CURRENT) {
7031 mContentUserHint = other.mContentUserHint;
7032 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007033 return changes;
7034 }
7035
7036 /**
7037 * Wrapper class holding an Intent and implementing comparisons on it for
7038 * the purpose of filtering. The class implements its
7039 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
7040 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
7041 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
7042 * on the wrapped Intent.
7043 */
7044 public static final class FilterComparison {
7045 private final Intent mIntent;
7046 private final int mHashCode;
7047
7048 public FilterComparison(Intent intent) {
7049 mIntent = intent;
7050 mHashCode = intent.filterHashCode();
7051 }
7052
7053 /**
7054 * Return the Intent that this FilterComparison represents.
7055 * @return Returns the Intent held by the FilterComparison. Do
7056 * not modify!
7057 */
7058 public Intent getIntent() {
7059 return mIntent;
7060 }
7061
7062 @Override
7063 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007064 if (obj instanceof FilterComparison) {
7065 Intent other = ((FilterComparison)obj).mIntent;
7066 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007067 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007068 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007069 }
7070
7071 @Override
7072 public int hashCode() {
7073 return mHashCode;
7074 }
7075 }
7076
7077 /**
7078 * Determine if two intents are the same for the purposes of intent
7079 * resolution (filtering). That is, if their action, data, type,
7080 * class, and categories are the same. This does <em>not</em> compare
7081 * any extra data included in the intents.
7082 *
7083 * @param other The other Intent to compare against.
7084 *
7085 * @return Returns true if action, data, type, class, and categories
7086 * are the same.
7087 */
7088 public boolean filterEquals(Intent other) {
7089 if (other == null) {
7090 return false;
7091 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07007092 if (!Objects.equals(this.mAction, other.mAction)) return false;
7093 if (!Objects.equals(this.mData, other.mData)) return false;
7094 if (!Objects.equals(this.mType, other.mType)) return false;
7095 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
7096 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
7097 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007098
7099 return true;
7100 }
7101
7102 /**
7103 * Generate hash code that matches semantics of filterEquals().
7104 *
7105 * @return Returns the hash value of the action, data, type, class, and
7106 * categories.
7107 *
7108 * @see #filterEquals
7109 */
7110 public int filterHashCode() {
7111 int code = 0;
7112 if (mAction != null) {
7113 code += mAction.hashCode();
7114 }
7115 if (mData != null) {
7116 code += mData.hashCode();
7117 }
7118 if (mType != null) {
7119 code += mType.hashCode();
7120 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007121 if (mPackage != null) {
7122 code += mPackage.hashCode();
7123 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007124 if (mComponent != null) {
7125 code += mComponent.hashCode();
7126 }
7127 if (mCategories != null) {
7128 code += mCategories.hashCode();
7129 }
7130 return code;
7131 }
7132
7133 @Override
7134 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007135 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007136
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007137 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007138 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007139 b.append(" }");
7140
7141 return b.toString();
7142 }
7143
7144 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007145 public String toInsecureString() {
7146 StringBuilder b = new StringBuilder(128);
7147
7148 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007149 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007150 b.append(" }");
7151
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007152 return b.toString();
7153 }
Romain Guy4969af72009-06-17 10:53:19 -07007154
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007155 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007156 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007157 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007158
7159 b.append("Intent { ");
7160 toShortString(b, false, true, true, true);
7161 b.append(" }");
7162
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007163 return b.toString();
7164 }
7165
7166 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007167 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
7168 StringBuilder b = new StringBuilder(128);
7169 toShortString(b, secure, comp, extras, clip);
7170 return b.toString();
7171 }
7172
7173 /** @hide */
7174 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
7175 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007176 boolean first = true;
7177 if (mAction != null) {
7178 b.append("act=").append(mAction);
7179 first = false;
7180 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007181 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007182 if (!first) {
7183 b.append(' ');
7184 }
7185 first = false;
7186 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007187 for (int i=0; i<mCategories.size(); i++) {
7188 if (i > 0) b.append(',');
7189 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007190 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007191 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007192 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007193 if (mData != null) {
7194 if (!first) {
7195 b.append(' ');
7196 }
7197 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07007198 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007199 if (secure) {
7200 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07007201 } else {
7202 b.append(mData);
7203 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007204 }
7205 if (mType != null) {
7206 if (!first) {
7207 b.append(' ');
7208 }
7209 first = false;
7210 b.append("typ=").append(mType);
7211 }
7212 if (mFlags != 0) {
7213 if (!first) {
7214 b.append(' ');
7215 }
7216 first = false;
7217 b.append("flg=0x").append(Integer.toHexString(mFlags));
7218 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007219 if (mPackage != null) {
7220 if (!first) {
7221 b.append(' ');
7222 }
7223 first = false;
7224 b.append("pkg=").append(mPackage);
7225 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007226 if (comp && mComponent != null) {
7227 if (!first) {
7228 b.append(' ');
7229 }
7230 first = false;
7231 b.append("cmp=").append(mComponent.flattenToShortString());
7232 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007233 if (mSourceBounds != null) {
7234 if (!first) {
7235 b.append(' ');
7236 }
7237 first = false;
7238 b.append("bnds=").append(mSourceBounds.toShortString());
7239 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007240 if (mClipData != null) {
7241 if (!first) {
7242 b.append(' ');
7243 }
7244 first = false;
7245 if (clip) {
7246 b.append("clip={");
7247 mClipData.toShortString(b);
7248 b.append('}');
7249 } else {
7250 b.append("(has clip)");
7251 }
7252 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007253 if (extras && mExtras != null) {
7254 if (!first) {
7255 b.append(' ');
7256 }
7257 first = false;
7258 b.append("(has extras)");
7259 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007260 if (mContentUserHint != UserHandle.USER_CURRENT) {
7261 if (!first) {
7262 b.append(' ');
7263 }
7264 first = false;
7265 b.append("u=").append(mContentUserHint);
7266 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007267 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007268 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007269 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007270 b.append("}");
7271 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007272 }
7273
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007274 /**
7275 * Call {@link #toUri} with 0 flags.
7276 * @deprecated Use {@link #toUri} instead.
7277 */
7278 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007279 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007280 return toUri(0);
7281 }
7282
7283 /**
7284 * Convert this Intent into a String holding a URI representation of it.
7285 * The returned URI string has been properly URI encoded, so it can be
7286 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7287 * Intent's data as the base URI, with an additional fragment describing
7288 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007289 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007290 * <p>You can convert the returned string back to an Intent with
7291 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007292 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007293 * @param flags Additional operating flags. Either 0,
7294 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007295 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007296 * @return Returns a URI encoding URI string describing the entire contents
7297 * of the Intent.
7298 */
7299 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007300 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007301 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
7302 if (mPackage == null) {
7303 throw new IllegalArgumentException(
7304 "Intent must include an explicit package name to build an android-app: "
7305 + this);
7306 }
7307 uri.append("android-app://");
7308 uri.append(mPackage);
7309 String scheme = null;
7310 if (mData != null) {
7311 scheme = mData.getScheme();
7312 if (scheme != null) {
7313 uri.append('/');
7314 uri.append(scheme);
7315 String authority = mData.getEncodedAuthority();
7316 if (authority != null) {
7317 uri.append('/');
7318 uri.append(authority);
7319 String path = mData.getEncodedPath();
7320 if (path != null) {
7321 uri.append(path);
7322 }
7323 String queryParams = mData.getEncodedQuery();
7324 if (queryParams != null) {
7325 uri.append('?');
7326 uri.append(queryParams);
7327 }
7328 String fragment = mData.getEncodedFragment();
7329 if (fragment != null) {
7330 uri.append('#');
7331 uri.append(fragment);
7332 }
7333 }
7334 }
7335 }
7336 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
7337 mPackage, flags);
7338 return uri.toString();
7339 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007340 String scheme = null;
7341 if (mData != null) {
7342 String data = mData.toString();
7343 if ((flags&URI_INTENT_SCHEME) != 0) {
7344 final int N = data.length();
7345 for (int i=0; i<N; i++) {
7346 char c = data.charAt(i);
7347 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7348 || c == '.' || c == '-') {
7349 continue;
7350 }
7351 if (c == ':' && i > 0) {
7352 // Valid scheme.
7353 scheme = data.substring(0, i);
7354 uri.append("intent:");
7355 data = data.substring(i+1);
7356 break;
7357 }
Tom Taylord4a47292009-12-21 13:59:18 -08007358
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007359 // No scheme.
7360 break;
7361 }
7362 }
7363 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007364
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007365 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7366 uri.append("intent:");
7367 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007368
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007369 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007370
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007371 return uri.toString();
7372 }
7373
7374 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
7375 String defPackage, int flags) {
7376 StringBuilder frag = new StringBuilder(128);
7377
7378 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007379 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08007380 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007381 // Note that for now we are not going to try to handle the
7382 // data part; not clear how to represent this as a URI, and
7383 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007384 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
7385 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007386 }
7387
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007388 if (frag.length() > 0) {
7389 uri.append("#Intent;");
7390 uri.append(frag);
7391 uri.append("end");
7392 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007393 }
7394
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007395 private void toUriInner(StringBuilder uri, String scheme, String defAction,
7396 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007397 if (scheme != null) {
7398 uri.append("scheme=").append(scheme).append(';');
7399 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007400 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007401 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007402 }
7403 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007404 for (int i=0; i<mCategories.size(); i++) {
7405 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007406 }
7407 }
7408 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007409 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007410 }
7411 if (mFlags != 0) {
7412 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7413 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007414 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007415 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7416 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007417 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007418 uri.append("component=").append(Uri.encode(
7419 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007420 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007421 if (mSourceBounds != null) {
7422 uri.append("sourceBounds=")
7423 .append(Uri.encode(mSourceBounds.flattenToString()))
7424 .append(';');
7425 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007426 if (mExtras != null) {
7427 for (String key : mExtras.keySet()) {
7428 final Object value = mExtras.get(key);
7429 char entryType =
7430 value instanceof String ? 'S' :
7431 value instanceof Boolean ? 'B' :
7432 value instanceof Byte ? 'b' :
7433 value instanceof Character ? 'c' :
7434 value instanceof Double ? 'd' :
7435 value instanceof Float ? 'f' :
7436 value instanceof Integer ? 'i' :
7437 value instanceof Long ? 'l' :
7438 value instanceof Short ? 's' :
7439 '\0';
7440
7441 if (entryType != '\0') {
7442 uri.append(entryType);
7443 uri.append('.');
7444 uri.append(Uri.encode(key));
7445 uri.append('=');
7446 uri.append(Uri.encode(value.toString()));
7447 uri.append(';');
7448 }
7449 }
7450 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007451 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007452
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007453 public int describeContents() {
7454 return (mExtras != null) ? mExtras.describeContents() : 0;
7455 }
7456
7457 public void writeToParcel(Parcel out, int flags) {
7458 out.writeString(mAction);
7459 Uri.writeToParcel(out, mData);
7460 out.writeString(mType);
7461 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007462 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007463 ComponentName.writeToParcel(mComponent, out);
7464
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007465 if (mSourceBounds != null) {
7466 out.writeInt(1);
7467 mSourceBounds.writeToParcel(out, flags);
7468 } else {
7469 out.writeInt(0);
7470 }
7471
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007472 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007473 final int N = mCategories.size();
7474 out.writeInt(N);
7475 for (int i=0; i<N; i++) {
7476 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007477 }
7478 } else {
7479 out.writeInt(0);
7480 }
7481
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007482 if (mSelector != null) {
7483 out.writeInt(1);
7484 mSelector.writeToParcel(out, flags);
7485 } else {
7486 out.writeInt(0);
7487 }
7488
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007489 if (mClipData != null) {
7490 out.writeInt(1);
7491 mClipData.writeToParcel(out, flags);
7492 } else {
7493 out.writeInt(0);
7494 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007495 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007496 out.writeBundle(mExtras);
7497 }
7498
7499 public static final Parcelable.Creator<Intent> CREATOR
7500 = new Parcelable.Creator<Intent>() {
7501 public Intent createFromParcel(Parcel in) {
7502 return new Intent(in);
7503 }
7504 public Intent[] newArray(int size) {
7505 return new Intent[size];
7506 }
7507 };
7508
Dianne Hackborneb034652009-09-07 00:49:58 -07007509 /** @hide */
7510 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007511 readFromParcel(in);
7512 }
7513
7514 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007515 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007516 mData = Uri.CREATOR.createFromParcel(in);
7517 mType = in.readString();
7518 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007519 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007520 mComponent = ComponentName.readFromParcel(in);
7521
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007522 if (in.readInt() != 0) {
7523 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7524 }
7525
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007526 int N = in.readInt();
7527 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007528 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007529 int i;
7530 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007531 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007532 }
7533 } else {
7534 mCategories = null;
7535 }
7536
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007537 if (in.readInt() != 0) {
7538 mSelector = new Intent(in);
7539 }
7540
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007541 if (in.readInt() != 0) {
7542 mClipData = new ClipData(in);
7543 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007544 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007545 mExtras = in.readBundle();
7546 }
7547
7548 /**
7549 * Parses the "intent" element (and its children) from XML and instantiates
7550 * an Intent object. The given XML parser should be located at the tag
7551 * where parsing should start (often named "intent"), from which the
7552 * basic action, data, type, and package and class name will be
7553 * retrieved. The function will then parse in to any child elements,
7554 * looking for <category android:name="xxx"> tags to add categories and
7555 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7556 * to the intent.
7557 *
7558 * @param resources The Resources to use when inflating resources.
7559 * @param parser The XML parser pointing at an "intent" tag.
7560 * @param attrs The AttributeSet interface for retrieving extended
7561 * attribute data at the current <var>parser</var> location.
7562 * @return An Intent object matching the XML data.
7563 * @throws XmlPullParserException If there was an XML parsing error.
7564 * @throws IOException If there was an I/O error.
7565 */
7566 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7567 throws XmlPullParserException, IOException {
7568 Intent intent = new Intent();
7569
7570 TypedArray sa = resources.obtainAttributes(attrs,
7571 com.android.internal.R.styleable.Intent);
7572
7573 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7574
7575 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7576 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7577 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7578
7579 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7580 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7581 if (packageName != null && className != null) {
7582 intent.setComponent(new ComponentName(packageName, className));
7583 }
7584
7585 sa.recycle();
7586
7587 int outerDepth = parser.getDepth();
7588 int type;
7589 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7590 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7591 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7592 continue;
7593 }
7594
7595 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007596 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007597 sa = resources.obtainAttributes(attrs,
7598 com.android.internal.R.styleable.IntentCategory);
7599 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7600 sa.recycle();
7601
7602 if (cat != null) {
7603 intent.addCategory(cat);
7604 }
7605 XmlUtils.skipCurrentTag(parser);
7606
Craig Mautner21d24a22014-04-23 11:45:37 -07007607 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007608 if (intent.mExtras == null) {
7609 intent.mExtras = new Bundle();
7610 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007611 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007612 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007613
7614 } else {
7615 XmlUtils.skipCurrentTag(parser);
7616 }
7617 }
7618
7619 return intent;
7620 }
Nick Pellyccae4122012-01-09 14:12:58 -08007621
Craig Mautner21d24a22014-04-23 11:45:37 -07007622 /** @hide */
7623 public void saveToXml(XmlSerializer out) throws IOException {
7624 if (mAction != null) {
7625 out.attribute(null, ATTR_ACTION, mAction);
7626 }
7627 if (mData != null) {
7628 out.attribute(null, ATTR_DATA, mData.toString());
7629 }
7630 if (mType != null) {
7631 out.attribute(null, ATTR_TYPE, mType);
7632 }
7633 if (mComponent != null) {
7634 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7635 }
7636 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7637
7638 if (mCategories != null) {
7639 out.startTag(null, TAG_CATEGORIES);
7640 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7641 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7642 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007643 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007644 }
7645 }
7646
7647 /** @hide */
7648 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7649 XmlPullParserException {
7650 Intent intent = new Intent();
7651 final int outerDepth = in.getDepth();
7652
7653 int attrCount = in.getAttributeCount();
7654 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7655 final String attrName = in.getAttributeName(attrNdx);
7656 final String attrValue = in.getAttributeValue(attrNdx);
7657 if (ATTR_ACTION.equals(attrName)) {
7658 intent.setAction(attrValue);
7659 } else if (ATTR_DATA.equals(attrName)) {
7660 intent.setData(Uri.parse(attrValue));
7661 } else if (ATTR_TYPE.equals(attrName)) {
7662 intent.setType(attrValue);
7663 } else if (ATTR_COMPONENT.equals(attrName)) {
7664 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7665 } else if (ATTR_FLAGS.equals(attrName)) {
7666 intent.setFlags(Integer.valueOf(attrValue, 16));
7667 } else {
7668 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7669 }
7670 }
7671
7672 int event;
7673 String name;
7674 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7675 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7676 if (event == XmlPullParser.START_TAG) {
7677 name = in.getName();
7678 if (TAG_CATEGORIES.equals(name)) {
7679 attrCount = in.getAttributeCount();
7680 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7681 intent.addCategory(in.getAttributeValue(attrNdx));
7682 }
7683 } else {
7684 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7685 XmlUtils.skipCurrentTag(in);
7686 }
7687 }
7688 }
7689
7690 return intent;
7691 }
7692
Nick Pellyccae4122012-01-09 14:12:58 -08007693 /**
7694 * Normalize a MIME data type.
7695 *
7696 * <p>A normalized MIME type has white-space trimmed,
7697 * content-type parameters removed, and is lower-case.
7698 * This aligns the type with Android best practices for
7699 * intent filtering.
7700 *
7701 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7702 * "text/x-vCard" becomes "text/x-vcard".
7703 *
7704 * <p>All MIME types received from outside Android (such as user input,
7705 * or external sources like Bluetooth, NFC, or the Internet) should
7706 * be normalized before they are used to create an Intent.
7707 *
7708 * @param type MIME data type to normalize
7709 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007710 * @see #setType
7711 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007712 */
7713 public static String normalizeMimeType(String type) {
7714 if (type == null) {
7715 return null;
7716 }
7717
Elliott Hughescb64d432013-08-02 10:00:44 -07007718 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007719
7720 final int semicolonIndex = type.indexOf(';');
7721 if (semicolonIndex != -1) {
7722 type = type.substring(0, semicolonIndex);
7723 }
7724 return type;
7725 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007726
7727 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007728 * Prepare this {@link Intent} to leave an app process.
7729 *
7730 * @hide
7731 */
7732 public void prepareToLeaveProcess() {
7733 setAllowFds(false);
7734
7735 if (mSelector != null) {
7736 mSelector.prepareToLeaveProcess();
7737 }
7738 if (mClipData != null) {
7739 mClipData.prepareToLeaveProcess();
7740 }
7741
7742 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7743 // There are several ACTION_MEDIA_* broadcasts that send file://
7744 // Uris, so only check common actions.
7745 if (ACTION_VIEW.equals(mAction) ||
7746 ACTION_EDIT.equals(mAction) ||
7747 ACTION_ATTACH_DATA.equals(mAction)) {
7748 mData.checkFileUriExposed("Intent.getData()");
7749 }
7750 }
7751 }
7752
7753 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007754 * @hide
7755 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007756 public void prepareToEnterProcess() {
7757 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00007758 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
7759 fixUris(mContentUserHint);
7760 mContentUserHint = UserHandle.USER_CURRENT;
7761 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007762 }
7763 }
7764
7765 /**
7766 * @hide
7767 */
7768 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007769 Uri data = getData();
7770 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007771 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007772 }
7773 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007774 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007775 }
7776 String action = getAction();
7777 if (ACTION_SEND.equals(action)) {
7778 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7779 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007780 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007781 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007782 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007783 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7784 if (streams != null) {
7785 ArrayList<Uri> newStreams = new ArrayList<Uri>();
7786 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007787 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007788 }
7789 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
7790 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007791 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7792 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7793 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7794 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7795 if (output != null) {
7796 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
7797 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007798 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007799 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007800
7801 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007802 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007803 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7804 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007805 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007806 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007807 * @hide
7808 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007809 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007810 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007811 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007812
7813 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007814 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007815
7816 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007817 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007818 // Inspect contained intents to see if we need to migrate extras. We
7819 // don't promote ClipData to the parent, since ChooserActivity will
7820 // already start the picked item as the caller, and we can't combine
7821 // the flags in a safe way.
7822
7823 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07007824 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007825 final Intent intent = getParcelableExtra(EXTRA_INTENT);
7826 if (intent != null) {
7827 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07007828 }
7829 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007830 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007831 try {
7832 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
7833 if (intents != null) {
7834 for (int i = 0; i < intents.length; i++) {
7835 final Intent intent = (Intent) intents[i];
7836 if (intent != null) {
7837 migrated |= intent.migrateExtraStreamToClipData();
7838 }
7839 }
7840 }
7841 } catch (ClassCastException e) {
7842 }
7843 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007844
7845 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007846 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007847 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7848 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7849 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7850 if (stream != null || text != null || htmlText != null) {
7851 final ClipData clipData = new ClipData(
7852 null, new String[] { getType() },
7853 new ClipData.Item(text, htmlText, null, stream));
7854 setClipData(clipData);
7855 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007856 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007857 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007858 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007859 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007860
7861 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007862 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007863 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7864 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7865 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7866 int num = -1;
7867 if (streams != null) {
7868 num = streams.size();
7869 }
7870 if (texts != null) {
7871 if (num >= 0 && num != texts.size()) {
7872 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007873 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007874 }
7875 num = texts.size();
7876 }
7877 if (htmlTexts != null) {
7878 if (num >= 0 && num != htmlTexts.size()) {
7879 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007880 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007881 }
7882 num = htmlTexts.size();
7883 }
7884 if (num > 0) {
7885 final ClipData clipData = new ClipData(
7886 null, new String[] { getType() },
7887 makeClipItem(streams, texts, htmlTexts, 0));
7888
7889 for (int i = 1; i < num; i++) {
7890 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7891 }
7892
7893 setClipData(clipData);
7894 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007895 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007896 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007897 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007898 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007899 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7900 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7901 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7902 final Uri output;
7903 try {
7904 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7905 } catch (ClassCastException e) {
7906 return false;
7907 }
7908 if (output != null) {
7909 setClipData(ClipData.newRawUri("", output));
7910 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
7911 return true;
7912 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007913 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007914
7915 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007916 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007917
7918 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7919 ArrayList<String> htmlTexts, int which) {
7920 Uri uri = streams != null ? streams.get(which) : null;
7921 CharSequence text = texts != null ? texts.get(which) : null;
7922 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7923 return new ClipData.Item(text, htmlText, null, uri);
7924 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007925
7926 /** @hide */
7927 public boolean isDocument() {
7928 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7929 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007930}