blob: 68b77fe78673b289b566834682039a1eb6ecde97 [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;
Adam Powell2ed547e2015-04-29 18:45:04 -070020import android.os.ResultReceiver;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010021import android.provider.MediaStore;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070022import android.util.ArraySet;
Jeff Sharkey846318a2014-04-04 12:12:41 -070023
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070024import org.xmlpull.v1.XmlPullParser;
25import org.xmlpull.v1.XmlPullParserException;
26
Tor Norbye7b9c9122013-05-30 16:48:33 -070027import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070028import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070029import android.annotation.SdkConstant;
Jose Lima73915cf2014-07-29 17:16:31 -070030import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070031import android.annotation.SdkConstant.SdkConstantType;
32import android.content.pm.ActivityInfo;
Jose Lima73915cf2014-07-29 17:16:31 -070033
Nicolas Prevotd85fc722014-04-16 19:52:08 +010034import static android.content.ContentProvider.maybeAddUserId;
Jose Lima73915cf2014-07-29 17:16:31 -070035
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070036import android.content.pm.PackageManager;
37import android.content.pm.ResolveInfo;
38import android.content.res.Resources;
39import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080040import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070041import android.net.Uri;
42import android.os.Bundle;
43import android.os.IBinder;
44import android.os.Parcel;
45import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000046import android.os.Process;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070047import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010048import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070049import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070050import android.provider.DocumentsProvider;
51import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070052import android.util.AttributeSet;
53import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080054
55import com.android.internal.util.XmlUtils;
Jose Lima73915cf2014-07-29 17:16:31 -070056
Craig Mautner21d24a22014-04-23 11:45:37 -070057import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070058
59import java.io.IOException;
60import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070061import java.lang.annotation.Retention;
62import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070063import java.net.URISyntaxException;
64import java.util.ArrayList;
Dianne Hackborn221ea892013-08-04 16:50:16 -070065import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080066import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070067import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070068import java.util.Set;
69
70/**
71 * An intent is an abstract description of an operation to be performed. It
72 * can be used with {@link Context#startActivity(Intent) startActivity} to
73 * launch an {@link android.app.Activity},
74 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
75 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
76 * and {@link android.content.Context#startService} or
77 * {@link android.content.Context#bindService} to communicate with a
78 * background {@link android.app.Service}.
79 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070080 * <p>An Intent provides a facility for performing late runtime binding between the code in
81 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070082 * can be thought of as the glue between activities. It is basically a passive data structure
83 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070084 *
85 * <div class="special reference">
86 * <h3>Developer Guides</h3>
87 * <p>For information about how to create and resolve intents, read the
88 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
89 * developer guide.</p>
90 * </div>
91 *
92 * <a name="IntentStructure"></a>
93 * <h3>Intent Structure</h3>
94 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070095 *
96 * <ul>
97 * <li> <p><b>action</b> -- The general action to be performed, such as
98 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
99 * etc.</p>
100 * </li>
101 * <li> <p><b>data</b> -- The data to operate on, such as a person record
102 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
103 * </li>
104 * </ul>
105 *
106 *
107 * <p>Some examples of action/data pairs are:</p>
108 *
109 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700110 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700111 * information about the person whose identifier is "1".</p>
112 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700113 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700114 * the phone dialer with the person filled in.</p>
115 * </li>
116 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
117 * the phone dialer with the given number filled in. Note how the
118 * VIEW action does what what is considered the most reasonable thing for
119 * a particular URI.</p>
120 * </li>
121 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
122 * the phone dialer with the given number filled in.</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * information about the person whose identifier is "1".</p>
126 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700127 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700128 * a list of people, which the user can browse through. This example is a
129 * typical top-level entry into the Contacts application, showing you the
130 * list of people. Selecting a particular person to view would result in a
131 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
132 * being used to start an activity to display that person.</p>
133 * </li>
134 * </ul>
135 *
136 * <p>In addition to these primary attributes, there are a number of secondary
137 * attributes that you can also include with an intent:</p>
138 *
139 * <ul>
140 * <li> <p><b>category</b> -- Gives additional information about the action
141 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
142 * appear in the Launcher as a top-level application, while
143 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
144 * of alternative actions the user can perform on a piece of data.</p>
145 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
146 * intent data. Normally the type is inferred from the data itself.
147 * By setting this attribute, you disable that evaluation and force
148 * an explicit type.</p>
149 * <li> <p><b>component</b> -- Specifies an explicit name of a component
150 * class to use for the intent. Normally this is determined by looking
151 * at the other information in the intent (the action, data/type, and
152 * categories) and matching that with a component that can handle it.
153 * If this attribute is set then none of the evaluation is performed,
154 * and this component is used exactly as is. By specifying this attribute,
155 * all of the other Intent attributes become optional.</p>
156 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
157 * This can be used to provide extended information to the component.
158 * For example, if we have a action to send an e-mail message, we could
159 * also include extra pieces of data here to supply a subject, body,
160 * etc.</p>
161 * </ul>
162 *
163 * <p>Here are some examples of other operations you can specify as intents
164 * using these additional parameters:</p>
165 *
166 * <ul>
167 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
168 * Launch the home screen.</p>
169 * </li>
170 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
171 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
172 * vnd.android.cursor.item/phone}</i></b>
173 * -- Display the list of people's phone numbers, allowing the user to
174 * browse through them and pick one and return it to the parent activity.</p>
175 * </li>
176 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
177 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
178 * -- Display all pickers for data that can be opened with
179 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
180 * allowing the user to pick one of them and then some data inside of it
181 * and returning the resulting URI to the caller. This can be used,
182 * for example, in an e-mail application to allow the user to pick some
183 * data to include as an attachment.</p>
184 * </li>
185 * </ul>
186 *
187 * <p>There are a variety of standard Intent action and category constants
188 * defined in the Intent class, but applications can also define their own.
189 * These strings use java style scoping, to ensure they are unique -- for
190 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700191 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700192 *
193 * <p>Put together, the set of actions, data types, categories, and extra data
194 * defines a language for the system allowing for the expression of phrases
195 * such as "call john smith's cell". As applications are added to the system,
196 * they can extend this language by adding new actions, types, and categories, or
197 * they can modify the behavior of existing phrases by supplying their own
198 * activities that handle them.</p>
199 *
200 * <a name="IntentResolution"></a>
201 * <h3>Intent Resolution</h3>
202 *
203 * <p>There are two primary forms of intents you will use.
204 *
205 * <ul>
206 * <li> <p><b>Explicit Intents</b> have specified a component (via
207 * {@link #setComponent} or {@link #setClass}), which provides the exact
208 * class to be run. Often these will not include any other information,
209 * simply being a way for an application to launch various internal
210 * activities it has as the user interacts with the application.
211 *
212 * <li> <p><b>Implicit Intents</b> have not specified a component;
213 * instead, they must include enough information for the system to
214 * determine which of the available components is best to run for that
215 * intent.
216 * </ul>
217 *
218 * <p>When using implicit intents, given such an arbitrary intent we need to
219 * know what to do with it. This is handled by the process of <em>Intent
220 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
221 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
222 * more activities/receivers) that can handle it.</p>
223 *
224 * <p>The intent resolution mechanism basically revolves around matching an
225 * Intent against all of the &lt;intent-filter&gt; descriptions in the
226 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
227 * objects explicitly registered with {@link Context#registerReceiver}.) More
228 * details on this can be found in the documentation on the {@link
229 * IntentFilter} class.</p>
230 *
231 * <p>There are three pieces of information in the Intent that are used for
232 * resolution: the action, type, and category. Using this information, a query
233 * is done on the {@link PackageManager} for a component that can handle the
234 * intent. The appropriate component is determined based on the intent
235 * information supplied in the <code>AndroidManifest.xml</code> file as
236 * follows:</p>
237 *
238 * <ul>
239 * <li> <p>The <b>action</b>, if given, must be listed by the component as
240 * one it handles.</p>
241 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
242 * already supplied in the Intent. Like the action, if a type is
243 * included in the intent (either explicitly or implicitly in its
244 * data), then this must be listed by the component as one it handles.</p>
245 * <li> For data that is not a <code>content:</code> URI and where no explicit
246 * type is included in the Intent, instead the <b>scheme</b> of the
247 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
248 * considered. Again like the action, if we are matching a scheme it
249 * must be listed by the component as one it can handle.
250 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
251 * by the activity as categories it handles. That is, if you include
252 * the categories {@link #CATEGORY_LAUNCHER} and
253 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
254 * with an intent that lists <em>both</em> of those categories.
255 * Activities will very often need to support the
256 * {@link #CATEGORY_DEFAULT} so that they can be found by
257 * {@link Context#startActivity Context.startActivity()}.</p>
258 * </ul>
259 *
260 * <p>For example, consider the Note Pad sample application that
261 * allows user to browse through a list of notes data and view details about
262 * individual items. Text in italics indicate places were you would replace a
263 * name with one specific to your own package.</p>
264 *
265 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
266 * package="<i>com.android.notepad</i>"&gt;
267 * &lt;application android:icon="@drawable/app_notes"
268 * android:label="@string/app_name"&gt;
269 *
270 * &lt;provider class=".NotePadProvider"
271 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
272 *
273 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
274 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700275 * &lt;action android:name="android.intent.action.MAIN" /&gt;
276 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="android.intent.action.VIEW" /&gt;
280 * &lt;action android:name="android.intent.action.EDIT" /&gt;
281 * &lt;action android:name="android.intent.action.PICK" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700286 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
287 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
288 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700289 * &lt;/intent-filter&gt;
290 * &lt;/activity&gt;
291 *
292 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
293 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700294 * &lt;action android:name="android.intent.action.VIEW" /&gt;
295 * &lt;action android:name="android.intent.action.EDIT" /&gt;
296 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
297 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700298 * &lt;/intent-filter&gt;
299 *
300 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700301 * &lt;action android:name="android.intent.action.INSERT" /&gt;
302 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
303 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700304 * &lt;/intent-filter&gt;
305 *
306 * &lt;/activity&gt;
307 *
308 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
309 * android:theme="@android:style/Theme.Dialog"&gt;
310 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700311 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
312 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
313 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
314 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
315 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700316 * &lt;/intent-filter&gt;
317 * &lt;/activity&gt;
318 *
319 * &lt;/application&gt;
320 * &lt;/manifest&gt;</pre>
321 *
322 * <p>The first activity,
323 * <code>com.android.notepad.NotesList</code>, serves as our main
324 * entry into the app. It can do three things as described by its three intent
325 * templates:
326 * <ol>
327 * <li><pre>
328 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700329 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
330 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700331 * &lt;/intent-filter&gt;</pre>
332 * <p>This provides a top-level entry into the NotePad application: the standard
333 * MAIN action is a main entry point (not requiring any other information in
334 * the Intent), and the LAUNCHER category says that this entry point should be
335 * listed in the application launcher.</p>
336 * <li><pre>
337 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700338 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
339 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
340 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
341 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
342 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700343 * &lt;/intent-filter&gt;</pre>
344 * <p>This declares the things that the activity can do on a directory of
345 * notes. The type being supported is given with the &lt;type&gt; tag, where
346 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
347 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
348 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
349 * The activity allows the user to view or edit the directory of data (via
350 * the VIEW and EDIT actions), or to pick a particular note and return it
351 * to the caller (via the PICK action). Note also the DEFAULT category
352 * supplied here: this is <em>required</em> for the
353 * {@link Context#startActivity Context.startActivity} method to resolve your
354 * activity when its component name is not explicitly specified.</p>
355 * <li><pre>
356 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700357 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
358 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
359 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700360 * &lt;/intent-filter&gt;</pre>
361 * <p>This filter describes the ability return to the caller a note selected by
362 * the user without needing to know where it came from. The data type
363 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
364 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
365 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
366 * The GET_CONTENT action is similar to the PICK action, where the activity
367 * will return to its caller a piece of data selected by the user. Here,
368 * however, the caller specifies the type of data they desire instead of
369 * the type of data the user will be picking from.</p>
370 * </ol>
371 *
372 * <p>Given these capabilities, the following intents will resolve to the
373 * NotesList activity:</p>
374 *
375 * <ul>
376 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
377 * activities that can be used as top-level entry points into an
378 * application.</p>
379 * <li> <p><b>{ action=android.app.action.MAIN,
380 * category=android.app.category.LAUNCHER }</b> is the actual intent
381 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700382 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700383 * data=content://com.google.provider.NotePad/notes }</b>
384 * displays a list of all the notes under
385 * "content://com.google.provider.NotePad/notes", which
386 * the user can browse through and see the details on.</p>
387 * <li> <p><b>{ action=android.app.action.PICK
388 * data=content://com.google.provider.NotePad/notes }</b>
389 * provides a list of the notes under
390 * "content://com.google.provider.NotePad/notes", from which
391 * the user can pick a note whose data URL is returned back to the caller.</p>
392 * <li> <p><b>{ action=android.app.action.GET_CONTENT
393 * type=vnd.android.cursor.item/vnd.google.note }</b>
394 * is similar to the pick action, but allows the caller to specify the
395 * kind of data they want back so that the system can find the appropriate
396 * activity to pick something of that data type.</p>
397 * </ul>
398 *
399 * <p>The second activity,
400 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
401 * note entry and allows them to edit it. It can do two things as described
402 * by its two intent templates:
403 * <ol>
404 * <li><pre>
405 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700406 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
407 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
408 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
409 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700410 * &lt;/intent-filter&gt;</pre>
411 * <p>The first, primary, purpose of this activity is to let the user interact
412 * with a single note, as decribed by the MIME type
413 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
414 * either VIEW a note or allow the user to EDIT it. Again we support the
415 * DEFAULT category to allow the activity to be launched without explicitly
416 * specifying its component.</p>
417 * <li><pre>
418 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700419 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
420 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
421 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700422 * &lt;/intent-filter&gt;</pre>
423 * <p>The secondary use of this activity is to insert a new note entry into
424 * an existing directory of notes. This is used when the user creates a new
425 * note: the INSERT action is executed on the directory of notes, causing
426 * this activity to run and have the user create the new note data which
427 * it then adds to the content provider.</p>
428 * </ol>
429 *
430 * <p>Given these capabilities, the following intents will resolve to the
431 * NoteEditor activity:</p>
432 *
433 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700434 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700435 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
436 * shows the user the content of note <var>{ID}</var>.</p>
437 * <li> <p><b>{ action=android.app.action.EDIT
438 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
439 * allows the user to edit the content of note <var>{ID}</var>.</p>
440 * <li> <p><b>{ action=android.app.action.INSERT
441 * data=content://com.google.provider.NotePad/notes }</b>
442 * creates a new, empty note in the notes list at
443 * "content://com.google.provider.NotePad/notes"
444 * and allows the user to edit it. If they keep their changes, the URI
445 * of the newly created note is returned to the caller.</p>
446 * </ul>
447 *
448 * <p>The last activity,
449 * <code>com.android.notepad.TitleEditor</code>, allows the user to
450 * edit the title of a note. This could be implemented as a class that the
451 * application directly invokes (by explicitly setting its component in
452 * the Intent), but here we show a way you can publish alternative
453 * operations on existing data:</p>
454 *
455 * <pre>
456 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700457 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
458 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
459 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
460 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
461 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700462 * &lt;/intent-filter&gt;</pre>
463 *
464 * <p>In the single intent template here, we
465 * have created our own private action called
466 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
467 * edit the title of a note. It must be invoked on a specific note
468 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
469 * view and edit actions, but here displays and edits the title contained
470 * in the note data.
471 *
472 * <p>In addition to supporting the default category as usual, our title editor
473 * also supports two other standard categories: ALTERNATIVE and
474 * SELECTED_ALTERNATIVE. Implementing
475 * these categories allows others to find the special action it provides
476 * without directly knowing about it, through the
477 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
478 * more often to build dynamic menu items with
479 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
480 * template here was also supply an explicit name for the template
481 * (via <code>android:label="@string/resolve_title"</code>) to better control
482 * what the user sees when presented with this activity as an alternative
483 * action to the data they are viewing.
484 *
485 * <p>Given these capabilities, the following intent will resolve to the
486 * TitleEditor activity:</p>
487 *
488 * <ul>
489 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
490 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
491 * displays and allows the user to edit the title associated
492 * with note <var>{ID}</var>.</p>
493 * </ul>
494 *
495 * <h3>Standard Activity Actions</h3>
496 *
497 * <p>These are the current standard actions that Intent defines for launching
498 * activities (usually through {@link Context#startActivity}. The most
499 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
500 * {@link #ACTION_EDIT}.
501 *
502 * <ul>
503 * <li> {@link #ACTION_MAIN}
504 * <li> {@link #ACTION_VIEW}
505 * <li> {@link #ACTION_ATTACH_DATA}
506 * <li> {@link #ACTION_EDIT}
507 * <li> {@link #ACTION_PICK}
508 * <li> {@link #ACTION_CHOOSER}
509 * <li> {@link #ACTION_GET_CONTENT}
510 * <li> {@link #ACTION_DIAL}
511 * <li> {@link #ACTION_CALL}
512 * <li> {@link #ACTION_SEND}
513 * <li> {@link #ACTION_SENDTO}
514 * <li> {@link #ACTION_ANSWER}
515 * <li> {@link #ACTION_INSERT}
516 * <li> {@link #ACTION_DELETE}
517 * <li> {@link #ACTION_RUN}
518 * <li> {@link #ACTION_SYNC}
519 * <li> {@link #ACTION_PICK_ACTIVITY}
520 * <li> {@link #ACTION_SEARCH}
521 * <li> {@link #ACTION_WEB_SEARCH}
522 * <li> {@link #ACTION_FACTORY_TEST}
523 * </ul>
524 *
525 * <h3>Standard Broadcast Actions</h3>
526 *
527 * <p>These are the current standard actions that Intent defines for receiving
528 * broadcasts (usually through {@link Context#registerReceiver} or a
529 * &lt;receiver&gt; tag in a manifest).
530 *
531 * <ul>
532 * <li> {@link #ACTION_TIME_TICK}
533 * <li> {@link #ACTION_TIME_CHANGED}
534 * <li> {@link #ACTION_TIMEZONE_CHANGED}
535 * <li> {@link #ACTION_BOOT_COMPLETED}
536 * <li> {@link #ACTION_PACKAGE_ADDED}
537 * <li> {@link #ACTION_PACKAGE_CHANGED}
538 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #ACTION_PACKAGE_RESTARTED}
540 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700541 * <li> {@link #ACTION_UID_REMOVED}
542 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700543 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700544 * <li> {@link #ACTION_POWER_DISCONNECTED}
545 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700546 * </ul>
547 *
548 * <h3>Standard Categories</h3>
549 *
550 * <p>These are the current standard categories that can be used to further
551 * clarify an Intent via {@link #addCategory}.
552 *
553 * <ul>
554 * <li> {@link #CATEGORY_DEFAULT}
555 * <li> {@link #CATEGORY_BROWSABLE}
556 * <li> {@link #CATEGORY_TAB}
557 * <li> {@link #CATEGORY_ALTERNATIVE}
558 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
559 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800560 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700561 * <li> {@link #CATEGORY_HOME}
562 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700563 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400564 * <li> {@link #CATEGORY_CAR_DOCK}
565 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500566 * <li> {@link #CATEGORY_LE_DESK_DOCK}
567 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200568 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700569 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700570 * </ul>
571 *
572 * <h3>Standard Extra Data</h3>
573 *
574 * <p>These are the current standard fields that can be used as extra data via
575 * {@link #putExtra}.
576 *
577 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800578 * <li> {@link #EXTRA_ALARM_COUNT}
579 * <li> {@link #EXTRA_BCC}
580 * <li> {@link #EXTRA_CC}
581 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
582 * <li> {@link #EXTRA_DATA_REMOVED}
583 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500584 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
585 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800586 * <li> {@link #EXTRA_DOCK_STATE_CAR}
587 * <li> {@link #EXTRA_DOCK_STATE_DESK}
588 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
589 * <li> {@link #EXTRA_DONT_KILL_APP}
590 * <li> {@link #EXTRA_EMAIL}
591 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700592 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800593 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700594 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700596 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800597 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
598 * <li> {@link #EXTRA_REPLACING}
599 * <li> {@link #EXTRA_SHORTCUT_ICON}
600 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
601 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700602 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800603 * <li> {@link #EXTRA_SHORTCUT_NAME}
604 * <li> {@link #EXTRA_SUBJECT}
605 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700606 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800607 * <li> {@link #EXTRA_TITLE}
608 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700609 * </ul>
610 *
611 * <h3>Flags</h3>
612 *
613 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800614 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
615 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700616 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800617public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700618 private static final String ATTR_ACTION = "action";
619 private static final String TAG_CATEGORIES = "categories";
620 private static final String ATTR_CATEGORY = "category";
621 private static final String TAG_EXTRA = "extra";
622 private static final String ATTR_TYPE = "type";
623 private static final String ATTR_COMPONENT = "component";
624 private static final String ATTR_DATA = "data";
625 private static final String ATTR_FLAGS = "flags";
626
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700627 // ---------------------------------------------------------------------
628 // ---------------------------------------------------------------------
629 // Standard intent activity actions (see action variable).
630
631 /**
632 * Activity Action: Start as a main entry point, does not expect to
633 * receive data.
634 * <p>Input: nothing
635 * <p>Output: nothing
636 */
637 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
638 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800639
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700640 /**
641 * Activity Action: Display the data to the user. This is the most common
642 * action performed on data -- it is the generic action you can use on
643 * a piece of data to get the most reasonable thing to occur. For example,
644 * when used on a contacts entry it will view the entry; when used on a
645 * mailto: URI it will bring up a compose window filled with the information
646 * supplied by the URI; when used with a tel: URI it will invoke the
647 * dialer.
648 * <p>Input: {@link #getData} is URI from which to retrieve data.
649 * <p>Output: nothing.
650 */
651 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
652 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800653
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700654 /**
655 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
656 * performed on a piece of data.
657 */
658 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700660 /**
Steve McKayc78bcb82015-07-31 14:35:22 -0700661 * Activity Action: Quick view the data.
662 * <p>Input: {@link #getData} is URI from which to retrieve data.
663 * <p>Output: nothing.
664 * @hide
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
668
669 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700670 * Used to indicate that some piece of data should be attached to some other
671 * place. For example, image data could be attached to a contact. It is up
672 * to the recipient to decide where the data should be attached; the intent
673 * does not specify the ultimate destination.
674 * <p>Input: {@link #getData} is URI of data to be attached.
675 * <p>Output: nothing.
676 */
677 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
678 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800679
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700680 /**
681 * Activity Action: Provide explicit editable access to the given data.
682 * <p>Input: {@link #getData} is URI of data to be edited.
683 * <p>Output: nothing.
684 */
685 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
686 public static final String ACTION_EDIT = "android.intent.action.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 existing item, or insert a new item, and then edit it.
690 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
691 * The extras can contain type specific data to pass through to the editing/creating
692 * activity.
693 * <p>Output: The URI of the item that was picked. This must be a content:
694 * URI so that any receiver can access it.
695 */
696 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
697 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800698
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700699 /**
700 * Activity Action: Pick an item from the data, returning what was selected.
701 * <p>Input: {@link #getData} is URI containing a directory of data
702 * (vnd.android.cursor.dir/*) from which to pick an item.
703 * <p>Output: The URI of the item that was picked.
704 */
705 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
706 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800707
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700708 /**
709 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800710 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700711 * <p>Output: An Intent representing the shortcut. The intent must contain three
712 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
713 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714 * (value: ShortcutIconResource).</p>
715 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700716 * @see #EXTRA_SHORTCUT_INTENT
717 * @see #EXTRA_SHORTCUT_NAME
718 * @see #EXTRA_SHORTCUT_ICON
719 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
720 * @see android.content.Intent.ShortcutIconResource
721 */
722 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
723 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
724
725 /**
726 * The name of the extra used to define the Intent of a shortcut.
727 *
728 * @see #ACTION_CREATE_SHORTCUT
729 */
730 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
731 /**
732 * The name of the extra used to define the name of a shortcut.
733 *
734 * @see #ACTION_CREATE_SHORTCUT
735 */
736 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
737 /**
738 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
739 *
740 * @see #ACTION_CREATE_SHORTCUT
741 */
742 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
743 /**
744 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
745 *
746 * @see #ACTION_CREATE_SHORTCUT
747 * @see android.content.Intent.ShortcutIconResource
748 */
749 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
750 "android.intent.extra.shortcut.ICON_RESOURCE";
751
752 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800753 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700754 *
755 * @see Intent#ACTION_CREATE_SHORTCUT
756 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800757 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
758 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700759 */
760 public static class ShortcutIconResource implements Parcelable {
761 /**
762 * The package name of the application containing the icon.
763 */
764 public String packageName;
765
766 /**
767 * The resource name of the icon, including package, name and type.
768 */
769 public String resourceName;
770
771 /**
772 * Creates a new ShortcutIconResource for the specified context and resource
773 * identifier.
774 *
775 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700776 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700777 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700778 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700779 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700780 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700781 ShortcutIconResource icon = new ShortcutIconResource();
782 icon.packageName = context.getPackageName();
783 icon.resourceName = context.getResources().getResourceName(resourceId);
784 return icon;
785 }
786
787 /**
788 * Used to read a ShortcutIconResource from a Parcel.
789 */
790 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
791 new Parcelable.Creator<ShortcutIconResource>() {
792
793 public ShortcutIconResource createFromParcel(Parcel source) {
794 ShortcutIconResource icon = new ShortcutIconResource();
795 icon.packageName = source.readString();
796 icon.resourceName = source.readString();
797 return icon;
798 }
799
800 public ShortcutIconResource[] newArray(int size) {
801 return new ShortcutIconResource[size];
802 }
803 };
804
805 /**
806 * No special parcel contents.
807 */
808 public int describeContents() {
809 return 0;
810 }
811
812 public void writeToParcel(Parcel dest, int flags) {
813 dest.writeString(packageName);
814 dest.writeString(resourceName);
815 }
816
817 @Override
818 public String toString() {
819 return resourceName;
820 }
821 }
822
823 /**
824 * Activity Action: Display an activity chooser, allowing the user to pick
825 * what they want to before proceeding. This can be used as an alternative
826 * to the standard activity picker that is displayed by the system when
827 * you try to start an activity with multiple possible matches, with these
828 * differences in behavior:
829 * <ul>
830 * <li>You can specify the title that will appear in the activity chooser.
831 * <li>The user does not have the option to make one of the matching
832 * activities a preferred activity, and all possible activities will
833 * always be shown even if one of them is currently marked as the
834 * preferred activity.
835 * </ul>
836 * <p>
837 * This action should be used when the user will naturally expect to
838 * select an activity in order to proceed. An example if when not to use
839 * it is when the user clicks on a "mailto:" link. They would naturally
840 * expect to go directly to their mail app, so startActivity() should be
841 * called directly: it will
842 * either launch the current preferred app, or put up a dialog allowing the
843 * user to pick an app to use and optionally marking that as preferred.
844 * <p>
845 * In contrast, if the user is selecting a menu item to send a picture
846 * they are viewing to someone else, there are many different things they
847 * may want to do at this point: send it through e-mail, upload it to a
848 * web service, etc. In this case the CHOOSER action should be used, to
849 * always present to the user a list of the things they can do, with a
850 * nice title given by the caller such as "Send this photo with:".
851 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700852 * If you need to grant URI permissions through a chooser, you must specify
853 * the permissions to be granted on the ACTION_CHOOSER Intent
854 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
855 * {@link #setClipData} to specify the URIs to be granted as well as
856 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
857 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
858 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700859 * As a convenience, an Intent of this form can be created with the
860 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700861 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700862 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700863 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
864 * and can optionally have a {@link #EXTRA_TITLE} field containing the
865 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700866 * <p>
867 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700868 */
869 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
870 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
871
872 /**
873 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
874 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700875 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
876 * target intent, also optionally supplying a title. If the target
877 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
878 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
879 * set in the returned chooser intent, with its ClipData set appropriately:
880 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500881 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700882 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700883 * @param target The Intent that the user will be selecting an activity
884 * to perform.
885 * @param title Optional title that will be displayed in the chooser.
886 * @return Return a new Intent object that you can hand to
887 * {@link Context#startActivity(Intent) Context.startActivity()} and
888 * related methods.
889 */
890 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700891 return createChooser(target, title, null);
892 }
893
894 /**
895 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
896 *
897 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
898 * target intent, also optionally supplying a title. If the target
899 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
900 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
901 * set in the returned chooser intent, with its ClipData set appropriately:
902 * either a direct reflection of {@link #getClipData()} if that is non-null,
903 * or a new ClipData built from {@link #getData()}.</p>
904 *
905 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
906 * when the user makes a choice. This can be useful if the calling application wants
907 * to remember the last chosen target and surface it as a more prominent or one-touch
908 * affordance elsewhere in the UI for next time.</p>
909 *
910 * @param target The Intent that the user will be selecting an activity
911 * to perform.
912 * @param title Optional title that will be displayed in the chooser.
913 * @param sender Optional IntentSender to be called when a choice is made.
914 * @return Return a new Intent object that you can hand to
915 * {@link Context#startActivity(Intent) Context.startActivity()} and
916 * related methods.
917 */
918 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700919 Intent intent = new Intent(ACTION_CHOOSER);
920 intent.putExtra(EXTRA_INTENT, target);
921 if (title != null) {
922 intent.putExtra(EXTRA_TITLE, title);
923 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700924
Adam Powell0b3c1122014-10-09 12:50:14 -0700925 if (sender != null) {
926 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
927 }
928
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700929 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700930 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
931 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
932 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700933 if (permFlags != 0) {
934 ClipData targetClipData = target.getClipData();
935 if (targetClipData == null && target.getData() != null) {
936 ClipData.Item item = new ClipData.Item(target.getData());
937 String[] mimeTypes;
938 if (target.getType() != null) {
939 mimeTypes = new String[] { target.getType() };
940 } else {
941 mimeTypes = new String[] { };
942 }
943 targetClipData = new ClipData(null, mimeTypes, item);
944 }
945 if (targetClipData != null) {
946 intent.setClipData(targetClipData);
947 intent.addFlags(permFlags);
948 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700949 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700950
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700951 return intent;
952 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700953
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700954 /**
955 * Activity Action: Allow the user to select a particular kind of data and
956 * return it. This is different than {@link #ACTION_PICK} in that here we
957 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800958 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700959 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900960 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700961 * etc.
962 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900963 * 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 -0700964 * of data, such as a person contact, you set the MIME type to the kind of
965 * data you want and launch it with {@link Context#startActivity(Intent)}.
966 * The system will then launch the best application to select that kind
967 * of data for you.
968 * <p>
969 * You may also be interested in any of a set of types of content the user
970 * can pick. For example, an e-mail application that wants to allow the
971 * user to add an attachment to an e-mail message can use this action to
972 * bring up a list of all of the types of content the user can attach.
973 * <p>
974 * In this case, you should wrap the GET_CONTENT intent with a chooser
975 * (through {@link #createChooser}), which will give the proper interface
976 * for the user to pick how to send your data and allow you to specify
977 * a prompt indicating what they are doing. You will usually specify a
978 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
979 * broad range of content types the user can select from.
980 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900981 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700982 * only pick from data that can be represented as a stream. This is
983 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
984 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800985 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900986 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800987 * is locally available on the device. For example, if this extra is set
988 * to true then an image picker should not show any pictures that are available
989 * from a remote server but not already on the local device (thus requiring
990 * they be downloaded when opened).
991 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800992 * If the caller can handle multiple returned items (the user performing
993 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
994 * to indicate this.
995 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700996 * Input: {@link #getType} is the desired MIME type to retrieve. Note
997 * that no URI is supplied in the intent, as there are no constraints on
998 * where the returned data originally comes from. You may also include the
999 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001000 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001001 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1002 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001003 * <p>
1004 * Output: The URI of the item that was picked. This must be a content:
1005 * URI so that any receiver can access it.
1006 */
1007 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1008 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1009 /**
1010 * Activity Action: Dial a number as specified by the data. This shows a
1011 * UI with the number being dialed, allowing the user to explicitly
1012 * initiate the call.
1013 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1014 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1015 * number.
1016 * <p>Output: nothing.
1017 */
1018 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1019 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1020 /**
1021 * Activity Action: Perform a call to someone specified by the data.
1022 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1023 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1024 * number.
1025 * <p>Output: nothing.
1026 *
1027 * <p>Note: there will be restrictions on which applications can initiate a
1028 * call; most applications should use the {@link #ACTION_DIAL}.
1029 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1030 * numbers. Applications can <strong>dial</strong> emergency numbers using
1031 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001032 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001033 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001034 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001035 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001036 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001037 */
1038 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1039 public static final String ACTION_CALL = "android.intent.action.CALL";
1040 /**
1041 * Activity Action: Perform a call to an emergency number specified by the
1042 * data.
1043 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1044 * tel: URI of an explicit phone number.
1045 * <p>Output: nothing.
1046 * @hide
1047 */
1048 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1049 /**
1050 * Activity action: Perform a call to any number (emergency or not)
1051 * specified by the data.
1052 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1053 * tel: URI of an explicit phone number.
1054 * <p>Output: nothing.
1055 * @hide
1056 */
1057 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1058 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001059 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1060 * sending this intent is a no-op.
1061 * <p>Input: No data should be specified. get*Extra may have an optional
1062 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1063 * send the activation result.
1064 * <p>Output: nothing.
1065 * @hide
1066 */
1067 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1068 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1069 "android.intent.action.SIM_ACTIVATION_REQUEST";
1070 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001071 * Activity Action: Send a message to someone specified by the data.
1072 * <p>Input: {@link #getData} is URI describing the target.
1073 * <p>Output: nothing.
1074 */
1075 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1076 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1077 /**
1078 * Activity Action: Deliver some data to someone else. Who the data is
1079 * being delivered to is not specified; it is up to the receiver of this
1080 * action to ask the user where the data should be sent.
1081 * <p>
1082 * When launching a SEND intent, you should usually wrap it in a chooser
1083 * (through {@link #createChooser}), which will give the proper interface
1084 * for the user to pick how to send your data and allow you to specify
1085 * a prompt indicating what they are doing.
1086 * <p>
1087 * Input: {@link #getType} is the MIME type of the data being sent.
1088 * get*Extra can have either a {@link #EXTRA_TEXT}
1089 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1090 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1091 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1092 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001093 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1094 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1095 * your text with HTML formatting.
1096 * <p>
1097 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1098 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1099 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1100 * content: URIs and other advanced features of {@link ClipData}. If
1101 * using this approach, you still must supply the same data through the
1102 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1103 * for compatibility with old applications. If you don't set a ClipData,
1104 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001105 * <p>
1106 * Optional standard extras, which may be interpreted by some recipients as
1107 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1108 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1109 * <p>
1110 * Output: nothing.
1111 */
1112 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1113 public static final String ACTION_SEND = "android.intent.action.SEND";
1114 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001115 * Activity Action: Deliver multiple data to someone else.
1116 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001117 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001118 * <p>
1119 * Input: {@link #getType} is the MIME type of the data being sent.
1120 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001121 * #EXTRA_STREAM} field, containing the data to be sent. If using
1122 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1123 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001124 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001125 * Multiple types are supported, and receivers should handle mixed types
1126 * whenever possible. The right way for the receiver to check them is to
1127 * use the content resolver on each URI. The intent sender should try to
1128 * put the most concrete mime type in the intent type, but it can fall
1129 * back to {@literal <type>/*} or {@literal *}/* as needed.
1130 * <p>
1131 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1132 * be image/jpg, but if you are sending image/jpg and image/png, then the
1133 * intent's type should be image/*.
1134 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001135 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1136 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1137 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1138 * content: URIs and other advanced features of {@link ClipData}. If
1139 * using this approach, you still must supply the same data through the
1140 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1141 * for compatibility with old applications. If you don't set a ClipData,
1142 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1143 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001144 * Optional standard extras, which may be interpreted by some recipients as
1145 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1146 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1147 * <p>
1148 * Output: nothing.
1149 */
1150 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1151 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1152 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001153 * Activity Action: Handle an incoming phone call.
1154 * <p>Input: nothing.
1155 * <p>Output: nothing.
1156 */
1157 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1158 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1159 /**
1160 * Activity Action: Insert an empty item into the given container.
1161 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1162 * in which to place the data.
1163 * <p>Output: URI of the new data that was created.
1164 */
1165 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1166 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1167 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001168 * Activity Action: Create a new item in the given container, initializing it
1169 * from the current contents of the clipboard.
1170 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1171 * in which to place the data.
1172 * <p>Output: URI of the new data that was created.
1173 */
1174 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1175 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1176 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001177 * Activity Action: Delete the given data from its container.
1178 * <p>Input: {@link #getData} is URI of data to be deleted.
1179 * <p>Output: nothing.
1180 */
1181 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1182 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1183 /**
1184 * Activity Action: Run the data, whatever that means.
1185 * <p>Input: ? (Note: this is currently specific to the test harness.)
1186 * <p>Output: nothing.
1187 */
1188 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1189 public static final String ACTION_RUN = "android.intent.action.RUN";
1190 /**
1191 * Activity Action: Perform a data synchronization.
1192 * <p>Input: ?
1193 * <p>Output: ?
1194 */
1195 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1196 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1197 /**
1198 * Activity Action: Pick an activity given an intent, returning the class
1199 * selected.
1200 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1201 * used with {@link PackageManager#queryIntentActivities} to determine the
1202 * set of activities from which to pick.
1203 * <p>Output: Class name of the activity that was selected.
1204 */
1205 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1206 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1207 /**
1208 * Activity Action: Perform a search.
1209 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1210 * is the text to search for. If empty, simply
1211 * enter your search results Activity with the search UI activated.
1212 * <p>Output: nothing.
1213 */
1214 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1215 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1216 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001217 * Activity Action: Start the platform-defined tutorial
1218 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1219 * is the text to search for. If empty, simply
1220 * enter your search results Activity with the search UI activated.
1221 * <p>Output: nothing.
1222 */
1223 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1224 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1225 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001226 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001227 * <p>
1228 * Input: {@link android.app.SearchManager#QUERY
1229 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1230 * a url starts with http or https, the site will be opened. If it is plain
1231 * text, Google search will be applied.
1232 * <p>
1233 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001234 */
1235 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1236 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001237
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001238 /**
Jim Miller07994402012-05-02 14:22:27 -07001239 * Activity Action: Perform assist action.
1240 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001241 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1242 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001243 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1244 * information.
Jim Miller07994402012-05-02 14:22:27 -07001245 * Output: nothing.
1246 */
1247 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1248 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001249
1250 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001251 * Activity Action: Perform voice assist action.
1252 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001253 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1254 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001255 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001256 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001257 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001258 */
1259 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1260 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1261
1262 /**
Adam Skory7140a252013-09-11 12:04:58 +01001263 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1264 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001265 */
1266 public static final String EXTRA_ASSIST_PACKAGE
1267 = "android.intent.extra.ASSIST_PACKAGE";
1268
1269 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001270 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1271 * application package at the time the assist was invoked.
1272 */
1273 public static final String EXTRA_ASSIST_UID
1274 = "android.intent.extra.ASSIST_UID";
1275
1276 /**
Adam Skory7140a252013-09-11 12:04:58 +01001277 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1278 * information supplied by the current foreground app at the time of the assist request.
1279 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001280 */
1281 public static final String EXTRA_ASSIST_CONTEXT
1282 = "android.intent.extra.ASSIST_CONTEXT";
1283
Jim Miller07994402012-05-02 14:22:27 -07001284 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001285 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1286 * keyboard as the primary input device for assistance.
1287 */
1288 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1289 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1290
1291 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001292 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1293 * that was used to invoke the assist.
1294 */
1295 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1296 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1297
1298 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001299 * Activity Action: List all available applications
1300 * <p>Input: Nothing.
1301 * <p>Output: nothing.
1302 */
1303 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1304 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1305 /**
1306 * Activity Action: Show settings for choosing wallpaper
1307 * <p>Input: Nothing.
1308 * <p>Output: Nothing.
1309 */
1310 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1311 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1312
1313 /**
1314 * Activity Action: Show activity for reporting a bug.
1315 * <p>Input: Nothing.
1316 * <p>Output: Nothing.
1317 */
1318 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1319 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1320
1321 /**
1322 * Activity Action: Main entry point for factory tests. Only used when
1323 * the device is booting in factory test node. The implementing package
1324 * must be installed in the system image.
1325 * <p>Input: nothing
1326 * <p>Output: nothing
1327 */
1328 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1329
1330 /**
1331 * Activity Action: The user pressed the "call" button to go to the dialer
1332 * or other appropriate UI for placing a call.
1333 * <p>Input: Nothing.
1334 * <p>Output: Nothing.
1335 */
1336 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1337 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1338
1339 /**
1340 * Activity Action: Start Voice Command.
1341 * <p>Input: Nothing.
1342 * <p>Output: Nothing.
1343 */
1344 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1345 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001346
1347 /**
1348 * Activity Action: Start action associated with long pressing on the
1349 * search key.
1350 * <p>Input: Nothing.
1351 * <p>Output: Nothing.
1352 */
1353 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1354 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001355
Jacek Surazski86b6c532009-05-13 14:38:28 +02001356 /**
1357 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1358 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001359 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001360 * <p>Input: No data is specified. The bug report is passed in using
1361 * an {@link #EXTRA_BUG_REPORT} field.
1362 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001363 *
1364 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001365 */
1366 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1367 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001368
1369 /**
1370 * Activity Action: Show power usage information to the user.
1371 * <p>Input: Nothing.
1372 * <p>Output: Nothing.
1373 */
1374 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1375 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001376
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001377 /**
1378 * Activity Action: Setup wizard to launch after a platform update. This
1379 * activity should have a string meta-data field associated with it,
1380 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1381 * the platform for setup. The activity will be launched only if
1382 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1383 * same value.
1384 * <p>Input: Nothing.
1385 * <p>Output: Nothing.
1386 * @hide
1387 */
1388 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1389 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001390
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001391 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001392 * Activity Action: Show settings for managing network data usage of a
1393 * specific application. Applications should define an activity that offers
1394 * options to control data usage.
1395 */
1396 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1397 public static final String ACTION_MANAGE_NETWORK_USAGE =
1398 "android.intent.action.MANAGE_NETWORK_USAGE";
1399
1400 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001401 * Activity Action: Launch application installer.
1402 * <p>
1403 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001404 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1405 * you can also use "package:<package-name>" to install an application for the
1406 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001407 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1408 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1409 * <p>
1410 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1411 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001412 * <p>
1413 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1414 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1415 * in order to launch the application installer.
1416 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001417 *
1418 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1419 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1420 * @see #EXTRA_RETURN_RESULT
1421 */
1422 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1423 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1424
1425 /**
1426 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1427 * package. Specifies the installer package name; this package will receive the
1428 * {@link #ACTION_APP_ERROR} intent.
1429 */
1430 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1431 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1432
1433 /**
1434 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1435 * package. Specifies that the application being installed should not be
1436 * treated as coming from an unknown source, but as coming from the app
1437 * invoking the Intent. For this to work you must start the installer with
1438 * startActivityForResult().
1439 */
1440 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1441 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1442
1443 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001444 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1445 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001446 * data field originated from.
1447 */
rich cannings706e8ba2012-08-20 13:20:14 -07001448 public static final String EXTRA_ORIGINATING_URI
1449 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001450
1451 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001452 * This extra can be used with any Intent used to launch an activity, supplying information
1453 * about who is launching that activity. This field contains a {@link android.net.Uri}
1454 * object, typically an http: or https: URI of the web site that the referral came from;
1455 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1456 * a native application that it came from.
1457 *
1458 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1459 * instead of directly retrieving the extra. It is also valid for applications to
1460 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1461 * a string, not a Uri; the field here, if supplied, will always take precedence,
1462 * however.</p>
1463 *
1464 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001465 */
1466 public static final String EXTRA_REFERRER
1467 = "android.intent.extra.REFERRER";
1468
1469 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001470 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1471 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1472 * not be created, in particular when Intent extras are supplied through the
1473 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1474 * schemes.
1475 *
1476 * @see #EXTRA_REFERRER
1477 */
1478 public static final String EXTRA_REFERRER_NAME
1479 = "android.intent.extra.REFERRER_NAME";
1480
1481 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001482 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1483 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1484 * @hide
1485 */
1486 public static final String EXTRA_ORIGINATING_UID
1487 = "android.intent.extra.ORIGINATING_UID";
1488
1489 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001490 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1491 * package. Tells the installer UI to skip the confirmation with the user
1492 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001493 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1494 * will no longer show an interstitial message about updating existing
1495 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001496 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001497 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001498 public static final String EXTRA_ALLOW_REPLACE
1499 = "android.intent.extra.ALLOW_REPLACE";
1500
1501 /**
1502 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1503 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1504 * return to the application the result code of the install/uninstall. The returned result
1505 * code will be {@link android.app.Activity#RESULT_OK} on success or
1506 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1507 */
1508 public static final String EXTRA_RETURN_RESULT
1509 = "android.intent.extra.RETURN_RESULT";
1510
1511 /**
1512 * Package manager install result code. @hide because result codes are not
1513 * yet ready to be exposed.
1514 */
1515 public static final String EXTRA_INSTALL_RESULT
1516 = "android.intent.extra.INSTALL_RESULT";
1517
1518 /**
1519 * Activity Action: Launch application uninstaller.
1520 * <p>
1521 * Input: The data must be a package: URI whose scheme specific part is
1522 * the package name of the current installed package to be uninstalled.
1523 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1524 * <p>
1525 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1526 * succeeded.
1527 */
1528 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1529 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1530
1531 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001532 * Specify whether the package should be uninstalled for all users.
1533 * @hide because these should not be part of normal application flow.
1534 */
1535 public static final String EXTRA_UNINSTALL_ALL_USERS
1536 = "android.intent.extra.UNINSTALL_ALL_USERS";
1537
1538 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001539 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1540 * describing the last run version of the platform that was setup.
1541 * @hide
1542 */
1543 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1544
Svet Ganov3695b8a2015-03-24 16:30:25 -07001545 /**
1546 * Activity action: Launch UI to manage the permissions of an app.
1547 * <p>
1548 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1549 * will be managed by the launched UI.
1550 * </p>
1551 * <p>
1552 * Output: Nothing.
1553 * </p>
1554 *
1555 * @see #EXTRA_PACKAGE_NAME
1556 *
1557 * @hide
1558 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001559 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1560 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1561 "android.intent.action.MANAGE_APP_PERMISSIONS";
1562
1563 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001564 * Activity action: Launch UI to manage permissions.
1565 * <p>
1566 * Input: Nothing.
1567 * </p>
1568 * <p>
1569 * Output: Nothing.
1570 * </p>
1571 *
1572 * @hide
1573 */
Svet Ganov321f0152015-05-16 22:51:50 -07001574 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1575 public static final String ACTION_MANAGE_PERMISSIONS =
1576 "android.intent.action.MANAGE_PERMISSIONS";
1577
1578 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001579 * Intent extra: An app package name.
1580 * <p>
1581 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001582 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001583 *
1584 * @hide
1585 */
1586 @SystemApi
1587 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1588
1589 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001590 * Broadcast action that requests current permission granted information. It will respond
1591 * to the request by sending a broadcast with action defined by
1592 * {@link #EXTRA_GET_PERMISSIONS_RESPONSE_INTENT}. The response will contain
Makoto Onukibbb912a2015-06-05 16:27:23 -07001593 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}, as well as
1594 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}, with contents described below or
1595 * a null upon failure.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001596 *
Makoto Onukibbb912a2015-06-05 16:27:23 -07001597 * <p>If {@link #EXTRA_PACKAGE_NAME} is included then the number of permissions granted, the
1598 * number of permissions requested and the number of granted additional permissions
1599 * by that package will be calculated and included as the first
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001600 * and second elements respectively of an int[] in the response as
Makoto Onukibbb912a2015-06-05 16:27:23 -07001601 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}. The response will also deliver the list
1602 * of localized permission group names that are granted in
1603 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001604 *
1605 * <p>If {@link #EXTRA_PACKAGE_NAME} is not included then the number of apps granted any runtime
1606 * permissions and the total number of apps requesting runtime permissions will be the first
1607 * and second elements respectively of an int[] in the response as
1608 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1609 *
1610 * @hide
1611 */
1612 public static final String ACTION_GET_PERMISSIONS_COUNT
1613 = "android.intent.action.GET_PERMISSIONS_COUNT";
1614
1615 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001616 * Broadcast action that requests list of all apps that have runtime permissions. It will
1617 * respond to the request by sending a broadcast with action defined by
1618 * {@link #EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT}. The response will contain
1619 * {@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT}, as well as
1620 * {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}, with contents described below or
1621 * a null upon failure.
1622 *
1623 * <p>{@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT} will contain a list of package names of
1624 * apps that have runtime permissions. {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}
1625 * will contain the list of app labels corresponding ot the apps in the first list.
1626 *
1627 * @hide
1628 */
1629 public static final String ACTION_GET_PERMISSIONS_PACKAGES
1630 = "android.intent.action.GET_PERMISSIONS_PACKAGES";
1631
1632 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001633 * Extra included in response to {@link #ACTION_GET_PERMISSIONS_COUNT}.
1634 * @hide
1635 */
1636 public static final String EXTRA_GET_PERMISSIONS_COUNT_RESULT
1637 = "android.intent.extra.GET_PERMISSIONS_COUNT_RESULT";
1638
1639 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001640 * List of CharSequence of localized permission group labels.
1641 * @hide
1642 */
1643 public static final String EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT
1644 = "android.intent.extra.GET_PERMISSIONS_GROUP_LIST_RESULT";
1645
1646 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001647 * String list of apps that have one or more runtime permissions.
1648 * @hide
1649 */
1650 public static final String EXTRA_GET_PERMISSIONS_APP_LIST_RESULT
1651 = "android.intent.extra.GET_PERMISSIONS_APP_LIST_RESULT";
1652
1653 /**
1654 * String list of app labels for apps that have one or more runtime permissions.
1655 * @hide
1656 */
1657 public static final String EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT
1658 = "android.intent.extra.GET_PERMISSIONS_APP_LABEL_LIST_RESULT";
1659
1660 /**
Anthony Hugh3575a402015-10-26 17:47:05 -07001661 * Boolean list describing if the app is a system app for apps that have one or more runtime
1662 * permissions.
1663 * @hide
1664 */
1665 public static final String EXTRA_GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT
1666 = "android.intent.extra.GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT";
1667
1668 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001669 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_COUNT} broadcasts.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001670 * @hide
1671 */
1672 public static final String EXTRA_GET_PERMISSIONS_RESPONSE_INTENT
1673 = "android.intent.extra.GET_PERMISSIONS_RESONSE_INTENT";
1674
1675 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001676 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_PACKAGES} broadcasts.
1677 * @hide
1678 */
1679 public static final String EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT
1680 = "android.intent.extra.GET_PERMISSIONS_PACKAGES_RESONSE_INTENT";
1681
1682 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001683 * Activity action: Launch UI to manage which apps have a given permission.
1684 * <p>
1685 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1686 * to which will be managed by the launched UI.
1687 * </p>
1688 * <p>
1689 * Output: Nothing.
1690 * </p>
1691 *
1692 * @see #EXTRA_PERMISSION_NAME
1693 *
1694 * @hide
1695 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001696 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1697 public static final String ACTION_MANAGE_PERMISSION_APPS =
1698 "android.intent.action.MANAGE_PERMISSION_APPS";
1699
1700 /**
1701 * Intent extra: The name of a permission.
1702 * <p>
1703 * Type: String
1704 * </p>
1705 *
1706 * @hide
1707 */
1708 @SystemApi
1709 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1710
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001711 // ---------------------------------------------------------------------
1712 // ---------------------------------------------------------------------
1713 // Standard intent broadcast actions (see action variable).
1714
1715 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001716 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1717 * <p>
1718 * For historical reasons, the name of this broadcast action refers to the power
1719 * state of the screen but it is actually sent in response to changes in the
1720 * overall interactive state of the device.
1721 * </p><p>
1722 * This broadcast is sent when the device becomes non-interactive which may have
1723 * nothing to do with the screen turning off. To determine the
1724 * actual state of the screen, use {@link android.view.Display#getState}.
1725 * </p><p>
1726 * See {@link android.os.PowerManager#isInteractive} for details.
1727 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001728 * You <em>cannot</em> receive this through components declared in
1729 * manifests, only by explicitly registering for it with
1730 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1731 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001732 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001733 * <p class="note">This is a protected intent that can only be sent
1734 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001735 */
1736 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1737 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001738
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001739 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001740 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1741 * <p>
1742 * For historical reasons, the name of this broadcast action refers to the power
1743 * state of the screen but it is actually sent in response to changes in the
1744 * overall interactive state of the device.
1745 * </p><p>
1746 * This broadcast is sent when the device becomes interactive which may have
1747 * nothing to do with the screen turning on. To determine the
1748 * actual state of the screen, use {@link android.view.Display#getState}.
1749 * </p><p>
1750 * See {@link android.os.PowerManager#isInteractive} for details.
1751 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001752 * You <em>cannot</em> receive this through components declared in
1753 * manifests, only by explicitly registering for it with
1754 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1755 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001756 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001757 * <p class="note">This is a protected intent that can only be sent
1758 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001759 */
1760 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1761 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001762
1763 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001764 * Broadcast Action: Sent after the system stops dreaming.
1765 *
1766 * <p class="note">This is a protected intent that can only be sent by the system.
1767 * It is only sent to registered receivers.</p>
1768 */
1769 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1770 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1771
1772 /**
1773 * Broadcast Action: Sent after the system starts dreaming.
1774 *
1775 * <p class="note">This is a protected intent that can only be sent by the system.
1776 * It is only sent to registered receivers.</p>
1777 */
1778 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1779 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1780
1781 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001782 * 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 -07001783 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001784 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001785 * <p class="note">This is a protected intent that can only be sent
1786 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001787 */
1788 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001789 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001790
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001791 /**
1792 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001793 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001794 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001795 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1796 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001797 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001798 * <p class="note">This is a protected intent that can only be sent
1799 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001800 */
1801 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1802 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1803 /**
1804 * Broadcast Action: The time was set.
1805 */
1806 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1807 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1808 /**
1809 * Broadcast Action: The date has changed.
1810 */
1811 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1812 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1813 /**
1814 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1815 * <ul>
1816 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1817 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001818 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001819 * <p class="note">This is a protected intent that can only be sent
1820 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001821 */
1822 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1823 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1824 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001825 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1826 * DNS entries should be tossed.
1827 * @hide
1828 */
1829 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1830 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1831 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001832 * Alarm Changed Action: This is broadcast when the AlarmClock
1833 * application's alarm is set or unset. It is used by the
1834 * AlarmClock application and the StatusBar service.
1835 * @hide
1836 */
1837 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1838 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1839 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001840 * Broadcast Action: This is broadcast once, after the system has finished
1841 * booting. It can be used to perform application-specific initialization,
1842 * such as installing alarms. You must hold the
1843 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1844 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001845 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001846 * <p class="note">This is a protected intent that can only be sent
1847 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001848 */
1849 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1850 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1851 /**
1852 * Broadcast Action: This is broadcast when a user action should request a
1853 * temporary system dialog to dismiss. Some examples of temporary system
1854 * dialogs are the notification window-shade and the recent tasks dialog.
1855 */
1856 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1857 /**
1858 * Broadcast Action: Trigger the download and eventual installation
1859 * of a package.
1860 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001861 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001862 * <p class="note">This is a protected intent that can only be sent
1863 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001864 *
1865 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001866 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001867 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001868 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1869 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1870 /**
1871 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001872 * device. The data contains the name of the package. Note that the
1873 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001874 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001875 * <ul>
1876 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1877 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1878 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1879 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001880 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001881 * <p class="note">This is a protected intent that can only be sent
1882 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001883 */
1884 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1885 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1886 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001887 * Broadcast Action: A new version of an application package has been
1888 * installed, replacing an existing version that was previously installed.
1889 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001890 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001891 * <ul>
1892 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1893 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001894 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001895 * <p class="note">This is a protected intent that can only be sent
1896 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001897 */
1898 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1899 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1900 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001901 * Broadcast Action: A new version of your application has been installed
1902 * over an existing one. This is only sent to the application that was
1903 * replaced. It does not contain any additional data; to receive it, just
1904 * use an intent filter for this action.
1905 *
1906 * <p class="note">This is a protected intent that can only be sent
1907 * by the system.
1908 */
1909 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1910 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1911 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001912 * Broadcast Action: An existing application package has been removed from
1913 * the device. The data contains the name of the package. The package
1914 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001915 * <ul>
1916 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1917 * to the package.
1918 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1919 * application -- data and code -- is being removed.
1920 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1921 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1922 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001923 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001924 * <p class="note">This is a protected intent that can only be sent
1925 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1929 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001930 * Broadcast Action: An existing application package has been completely
1931 * removed from the device. The data contains the name of the package.
1932 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1933 * {@link #EXTRA_DATA_REMOVED} is true and
1934 * {@link #EXTRA_REPLACING} is false of that broadcast.
1935 *
1936 * <ul>
1937 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1938 * to the package.
1939 * </ul>
1940 *
1941 * <p class="note">This is a protected intent that can only be sent
1942 * by the system.
1943 */
1944 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1945 public static final String ACTION_PACKAGE_FULLY_REMOVED
1946 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1947 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001948 * Broadcast Action: An existing application package has been changed (e.g.
1949 * a component has been enabled or disabled). The data contains the name of
1950 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001951 * <ul>
1952 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001953 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001954 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001955 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1956 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001957 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001958 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001959 * <p class="note">This is a protected intent that can only be sent
1960 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001961 */
1962 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1963 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1964 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001965 * @hide
1966 * Broadcast Action: Ask system services if there is any reason to
1967 * restart the given package. The data contains the name of the
1968 * package.
1969 * <ul>
1970 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1971 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1972 * </ul>
1973 *
1974 * <p class="note">This is a protected intent that can only be sent
1975 * by the system.
1976 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08001977 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001978 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1979 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1980 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001981 * Broadcast Action: The user has restarted a package, and all of its
1982 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001983 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001984 * be removed. Note that the restarted package does <em>not</em>
1985 * receive this broadcast.
1986 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001987 * <ul>
1988 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1989 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001990 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001991 * <p class="note">This is a protected intent that can only be sent
1992 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001993 */
1994 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1995 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1996 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001997 * Broadcast Action: The user has cleared the data of a package. This should
1998 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001999 * its persistent data is erased and this broadcast sent.
2000 * Note that the cleared package does <em>not</em>
2001 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002002 * <ul>
2003 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2004 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002005 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002006 * <p class="note">This is a protected intent that can only be sent
2007 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002008 */
2009 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2010 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2011 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002012 * Broadcast Action: A user ID has been removed from the system. The user
2013 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002014 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002015 * <p class="note">This is a protected intent that can only be sent
2016 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002017 */
2018 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2019 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002020
2021 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002022 * Broadcast Action: Sent to the installer package of an application
2023 * when that application is first launched (that is the first time it
2024 * is moved out of the stopped state). The data contains the name of the package.
2025 *
2026 * <p class="note">This is a protected intent that can only be sent
2027 * by the system.
2028 */
2029 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2030 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2031
2032 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002033 * Broadcast Action: Sent to the system package verifier when a package
2034 * needs to be verified. The data contains the package URI.
2035 * <p class="note">
2036 * This is a protected intent that can only be sent by the system.
2037 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002038 */
2039 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2040 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2041
2042 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002043 * Broadcast Action: Sent to the system package verifier when a package is
2044 * verified. The data contains the package URI.
2045 * <p class="note">
2046 * This is a protected intent that can only be sent by the system.
2047 */
2048 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2049 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2050
2051 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002052 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
2053 * needs to be verified. The data contains the filter data hosts to be verified against.
2054 * <p class="note">
2055 * This is a protected intent that can only be sent by the system.
2056 * </p>
2057 *
2058 * @hide
2059 */
2060 @SystemApi
2061 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2062 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2063
2064 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002065 * Broadcast Action: Resources for a set of packages (which were
2066 * previously unavailable) are currently
2067 * available since the media on which they exist is available.
2068 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2069 * list of packages whose availability changed.
2070 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2071 * list of uids of packages whose availability changed.
2072 * Note that the
2073 * packages in this list do <em>not</em> receive this broadcast.
2074 * The specified set of packages are now available on the system.
2075 * <p>Includes the following extras:
2076 * <ul>
2077 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2078 * whose resources(were previously unavailable) are currently available.
2079 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2080 * packages whose resources(were previously unavailable)
2081 * are currently available.
2082 * </ul>
2083 *
2084 * <p class="note">This is a protected intent that can only be sent
2085 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002086 */
2087 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002088 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2089 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002090
2091 /**
2092 * Broadcast Action: Resources for a set of packages are currently
2093 * unavailable since the media on which they exist is unavailable.
2094 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2095 * list of packages whose availability changed.
2096 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2097 * list of uids of packages whose availability changed.
2098 * The specified set of packages can no longer be
2099 * launched and are practically unavailable on the system.
2100 * <p>Inclues the following extras:
2101 * <ul>
2102 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2103 * whose resources are no longer available.
2104 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2105 * whose resources are no longer available.
2106 * </ul>
2107 *
2108 * <p class="note">This is a protected intent that can only be sent
2109 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002110 */
2111 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002112 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002113 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002114
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002115 /**
2116 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002117 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002118 * This should <em>only</em> be used to determine when the wallpaper
2119 * has changed to show the new wallpaper to the user. You should certainly
2120 * never, in response to this, change the wallpaper or other attributes of
2121 * it such as the suggested size. That would be crazy, right? You'd cause
2122 * all kinds of loops, especially if other apps are doing similar things,
2123 * right? Of course. So please don't do this.
2124 *
2125 * @deprecated Modern applications should use
2126 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2127 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2128 * shown behind their UI, rather than watching for this broadcast and
2129 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002130 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002131 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002132 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2133 /**
2134 * Broadcast Action: The current device {@link android.content.res.Configuration}
2135 * (orientation, locale, etc) has changed. When such a change happens, the
2136 * UIs (view hierarchy) will need to be rebuilt based on this new
2137 * information; for the most part, applications don't need to worry about
2138 * this, because the system will take care of stopping and restarting the
2139 * application to make sure it sees the new changes. Some system code that
2140 * can not be restarted will need to watch for this action and handle it
2141 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002142 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002143 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002144 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002145 * in manifests, only by explicitly registering for it with
2146 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2147 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002148 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002149 * <p class="note">This is a protected intent that can only be sent
2150 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002151 *
2152 * @see android.content.res.Configuration
2153 */
2154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2155 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2156 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002157 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002158 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002159 * <p class="note">This is a protected intent that can only be sent
2160 * by the system.
2161 */
2162 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2163 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2164 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002165 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2166 * charging state, level, and other information about the battery.
2167 * See {@link android.os.BatteryManager} for documentation on the
2168 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002169 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002170 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002171 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002172 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002173 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002174 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2175 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2176 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2177 * broadcasts that are sent and can be received through manifest
2178 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002179 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002180 * <p class="note">This is a protected intent that can only be sent
2181 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002182 */
2183 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2184 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2185 /**
2186 * Broadcast Action: Indicates low battery condition on the device.
2187 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002188 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002189 * <p class="note">This is a protected intent that can only be sent
2190 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002191 */
2192 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2193 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2194 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002195 * Broadcast Action: Indicates the battery is now okay after being low.
2196 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2197 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002198 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002199 * <p class="note">This is a protected intent that can only be sent
2200 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002201 */
2202 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2203 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2204 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002205 * Broadcast Action: External power has been connected to the device.
2206 * This is intended for applications that wish to register specifically to this notification.
2207 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2208 * stay active to receive this notification. This action can be used to implement actions
2209 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002210 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002211 * <p class="note">This is a protected intent that can only be sent
2212 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002213 */
2214 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002215 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002216 /**
2217 * Broadcast Action: External power has been removed from the device.
2218 * This is intended for applications that wish to register specifically to this notification.
2219 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2220 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002221 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002222 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002223 * <p class="note">This is a protected intent that can only be sent
2224 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002225 */
2226 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002227 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002228 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002229 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002230 * Broadcast Action: Device is shutting down.
2231 * This is broadcast when the device is being shut down (completely turned
2232 * off, not sleeping). Once the broadcast is complete, the final shutdown
2233 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002234 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002235 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002236 * <p class="note">This is a protected intent that can only be sent
2237 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002238 * <p>May include the following extras:
2239 * <ul>
2240 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2241 * shutdown is only for userspace processes. If not set, assumed to be false.
2242 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002243 */
2244 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002245 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002246 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002247 * Activity Action: Start this activity to request system shutdown.
2248 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002249 * to request confirmation from the user before shutting down. The optional boolean
2250 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2251 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002252 *
2253 * <p class="note">This is a protected intent that can only be sent
2254 * by the system.
2255 *
2256 * {@hide}
2257 */
2258 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2259 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002260 * Broadcast Action: A sticky broadcast that indicates low memory
2261 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002262 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002263 * <p class="note">This is a protected intent that can only be sent
2264 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002265 */
2266 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2267 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2268 /**
2269 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002270 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002271 * <p class="note">This is a protected intent that can only be sent
2272 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002273 */
2274 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2275 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2276 /**
Jake Hambybb371632010-08-23 18:16:48 -07002277 * Broadcast Action: A sticky broadcast that indicates a memory full
2278 * condition on the device. This is intended for activities that want
2279 * to be able to fill the data partition completely, leaving only
2280 * enough free space to prevent system-wide SQLite failures.
2281 *
2282 * <p class="note">This is a protected intent that can only be sent
2283 * by the system.
2284 *
2285 * {@hide}
2286 */
2287 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2288 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2289 /**
2290 * Broadcast Action: Indicates memory full condition on the device
2291 * no longer exists.
2292 *
2293 * <p class="note">This is a protected intent that can only be sent
2294 * by the system.
2295 *
2296 * {@hide}
2297 */
2298 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2299 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2300 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002301 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2302 * and package management should be started.
2303 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2304 * notification.
2305 */
2306 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2307 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2308 /**
2309 * Broadcast Action: The device has entered USB Mass Storage mode.
2310 * This is used mainly for the USB Settings panel.
2311 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2312 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002313 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002314 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002315 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002316 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2317
2318 /**
2319 * Broadcast Action: The device has exited USB Mass Storage mode.
2320 * This is used mainly for the USB Settings panel.
2321 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2322 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002323 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002324 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002325 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002326 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2327
2328 /**
2329 * Broadcast Action: External media has been removed.
2330 * The path to the mount point for the removed media is contained in the Intent.mData field.
2331 */
2332 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2333 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2334
2335 /**
2336 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002337 * 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 -07002338 */
2339 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2340 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2341
2342 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002343 * Broadcast Action: External media is present, and being disk-checked
2344 * 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 -08002345 */
2346 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2347 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2348
2349 /**
2350 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2351 * 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 -08002352 */
2353 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2354 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2355
2356 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002357 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002358 * 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 -07002359 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2360 * media was mounted read only.
2361 */
2362 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2363 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2364
2365 /**
2366 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002367 * 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 -07002368 */
2369 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2370 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2371
2372 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002373 * Broadcast Action: External media is no longer being shared via USB mass storage.
2374 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2375 *
2376 * @hide
2377 */
2378 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2379
2380 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002381 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2382 * The path to the mount point for the removed media is contained in the Intent.mData field.
2383 */
2384 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2385 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2386
2387 /**
2388 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002389 * 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 -07002390 */
2391 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2392 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2393
2394 /**
2395 * Broadcast Action: User has expressed the desire to remove the external storage media.
2396 * Applications should close all files they have open within the mount point when they receive this intent.
2397 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2398 */
2399 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2400 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2401
2402 /**
2403 * Broadcast Action: The media scanner has started scanning a directory.
2404 * The path to the directory being scanned is contained in the Intent.mData field.
2405 */
2406 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2407 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2408
2409 /**
2410 * Broadcast Action: The media scanner has finished scanning a directory.
2411 * The path to the scanned directory is contained in the Intent.mData field.
2412 */
2413 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2414 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2415
2416 /**
2417 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2418 * The path to the file is contained in the Intent.mData field.
2419 */
2420 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2421 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2422
2423 /**
2424 * Broadcast Action: The "Media Button" was pressed. Includes a single
2425 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2426 * caused the broadcast.
2427 */
2428 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2429 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2430
2431 /**
2432 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2433 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2434 * caused the broadcast.
2435 */
2436 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2437 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2438
2439 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2440 // location; they are not general-purpose actions.
2441
2442 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002443 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002444 */
2445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2446 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2447 "android.intent.action.GTALK_CONNECTED";
2448
2449 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002450 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002451 */
2452 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2453 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2454 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002455
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002456 /**
2457 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002458 */
2459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2460 public static final String ACTION_INPUT_METHOD_CHANGED =
2461 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002462
2463 /**
2464 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2465 * more radios have been turned off or on. The intent will have the following extra value:</p>
2466 * <ul>
2467 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2468 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2469 * turned off</li>
2470 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002471 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002472 * <p class="note">This is a protected intent that can only be sent
2473 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002474 */
2475 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2476 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2477
2478 /**
2479 * Broadcast Action: Some content providers have parts of their namespace
2480 * where they publish new events or items that the user may be especially
2481 * interested in. For these things, they may broadcast this action when the
2482 * set of interesting items change.
2483 *
2484 * For example, GmailProvider sends this notification when the set of unread
2485 * mail in the inbox changes.
2486 *
2487 * <p>The data of the intent identifies which part of which provider
2488 * changed. When queried through the content resolver, the data URI will
2489 * return the data set in question.
2490 *
2491 * <p>The intent will have the following extra values:
2492 * <ul>
2493 * <li><em>count</em> - The number of items in the data set. This is the
2494 * same as the number of items in the cursor returned by querying the
2495 * data URI. </li>
2496 * </ul>
2497 *
2498 * This intent will be sent at boot (if the count is non-zero) and when the
2499 * data set changes. It is possible for the data set to change without the
2500 * count changing (for example, if a new unread message arrives in the same
2501 * sync operation in which a message is archived). The phone should still
2502 * ring/vibrate/etc as normal in this case.
2503 */
2504 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2505 public static final String ACTION_PROVIDER_CHANGED =
2506 "android.intent.action.PROVIDER_CHANGED";
2507
2508 /**
2509 * Broadcast Action: Wired Headset plugged in or unplugged.
2510 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002511 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2512 * and documentation.
2513 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002514 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002515 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002516 */
2517 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002518 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002519
2520 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002521 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2522 * <ul>
2523 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2524 * </ul>
2525 *
2526 * <p class="note">This is a protected intent that can only be sent
2527 * by the system.
2528 *
2529 * @hide
2530 */
2531 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2532 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2533 = "android.intent.action.ADVANCED_SETTINGS";
2534
2535 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002536 * Broadcast Action: Sent after application restrictions are changed.
2537 *
2538 * <p class="note">This is a protected intent that can only be sent
2539 * by the system.</p>
2540 */
2541 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2542 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2543 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2544
2545 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002546 * Broadcast Action: An outgoing call is about to be placed.
2547 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002548 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002549 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002550 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002551 * the phone number originally intended to be dialed.</li>
2552 * </ul>
2553 * <p>Once the broadcast is finished, the resultData is used as the actual
2554 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002555 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002556 * outgoing call in turn: for example, a parental control application
2557 * might verify that the user is authorized to place the call at that
2558 * time, then a number-rewriting application might add an area code if
2559 * one was not specified.</p>
2560 * <p>For consistency, any receiver whose purpose is to prohibit phone
2561 * calls should have a priority of 0, to ensure it will see the final
2562 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002563 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002564 * should have a positive priority.
2565 * Negative priorities are reserved for the system for this broadcast;
2566 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002567 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2568 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002569 * <p>Emergency calls cannot be intercepted using this mechanism, and
2570 * other calls cannot be modified to call emergency numbers using this
2571 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002572 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2573 * call to use their own service instead. Those apps should first prevent
2574 * the call from being placed by setting resultData to <code>null</code>
2575 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002576 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002577 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2578 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002579 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002580 * <p class="note">This is a protected intent that can only be sent
2581 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002582 */
2583 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2584 public static final String ACTION_NEW_OUTGOING_CALL =
2585 "android.intent.action.NEW_OUTGOING_CALL";
2586
2587 /**
2588 * Broadcast Action: Have the device reboot. This is only for use by
2589 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002590 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002591 * <p class="note">This is a protected intent that can only be sent
2592 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002593 */
2594 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2595 public static final String ACTION_REBOOT =
2596 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002597
Wei Huang97ecc9c2009-05-11 17:44:20 -07002598 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002599 * Broadcast Action: A sticky broadcast for changes in the physical
2600 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002601 *
2602 * <p>The intent will have the following extra values:
2603 * <ul>
2604 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002605 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002606 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002607 * <p>This is intended for monitoring the current physical dock state.
2608 * See {@link android.app.UiModeManager} for the normal API dealing with
2609 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002610 */
2611 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2612 public static final String ACTION_DOCK_EVENT =
2613 "android.intent.action.DOCK_EVENT";
2614
2615 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002616 * Broadcast Action: A broadcast when idle maintenance can be started.
2617 * This means that the user is not interacting with the device and is
2618 * not expected to do so soon. Typical use of the idle maintenance is
2619 * to perform somehow expensive tasks that can be postponed at a moment
2620 * when they will not degrade user experience.
2621 * <p>
2622 * <p class="note">In order to keep the device responsive in case of an
2623 * unexpected user interaction, implementations of a maintenance task
2624 * should be interruptible. In such a scenario a broadcast with action
2625 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2626 * should not do the maintenance work in
2627 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2628 * maintenance service by {@link Context#startService(Intent)}. Also
2629 * you should hold a wake lock while your maintenance service is running
2630 * to prevent the device going to sleep.
2631 * </p>
2632 * <p>
2633 * <p class="note">This is a protected intent that can only be sent by
2634 * the system.
2635 * </p>
2636 *
2637 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002638 *
2639 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002640 */
2641 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2642 public static final String ACTION_IDLE_MAINTENANCE_START =
2643 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2644
2645 /**
2646 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2647 * This means that the user was not interacting with the device as a result
2648 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2649 * was sent and now the user started interacting with the device. Typical
2650 * use of the idle maintenance is to perform somehow expensive tasks that
2651 * can be postponed at a moment when they will not degrade user experience.
2652 * <p>
2653 * <p class="note">In order to keep the device responsive in case of an
2654 * unexpected user interaction, implementations of a maintenance task
2655 * should be interruptible. Hence, on receiving a broadcast with this
2656 * action, the maintenance task should be interrupted as soon as possible.
2657 * In other words, you should not do the maintenance work in
2658 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2659 * maintenance service that was started on receiving of
2660 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2661 * lock you acquired when your maintenance service started.
2662 * </p>
2663 * <p class="note">This is a protected intent that can only be sent
2664 * by the system.
2665 *
2666 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002667 *
2668 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002669 */
2670 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2671 public static final String ACTION_IDLE_MAINTENANCE_END =
2672 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2673
2674 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002675 * Broadcast Action: a remote intent is to be broadcasted.
2676 *
2677 * A remote intent is used for remote RPC between devices. The remote intent
2678 * is serialized and sent from one device to another device. The receiving
2679 * device parses the remote intent and broadcasts it. Note that anyone can
2680 * broadcast a remote intent. However, if the intent receiver of the remote intent
2681 * does not trust intent broadcasts from arbitrary intent senders, it should require
2682 * the sender to hold certain permissions so only trusted sender's broadcast will be
2683 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002684 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002685 */
2686 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002687 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002688
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002689 /**
2690 * Broadcast Action: hook for permforming cleanup after a system update.
2691 *
2692 * The broadcast is sent when the system is booting, before the
2693 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2694 * image. A receiver for this should do its work and then disable itself
2695 * so that it does not get run again at the next boot.
2696 * @hide
2697 */
2698 public static final String ACTION_PRE_BOOT_COMPLETED =
2699 "android.intent.action.PRE_BOOT_COMPLETED";
2700
Amith Yamasani13593602012-03-22 16:16:17 -07002701 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002702 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002703 * on restricted users. The broadcast intent contains an extra
2704 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2705 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2706 * String[] depending on the restriction type.<p/>
2707 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002708 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2709 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2710 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002711 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2712 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002713 * @see RestrictionEntry
2714 */
2715 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2716 "android.intent.action.GET_RESTRICTION_ENTRIES";
2717
2718 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002719 * Sent the first time a user is starting, to allow system apps to
2720 * perform one time initialization. (This will not be seen by third
2721 * party applications because a newly initialized user does not have any
2722 * third party applications installed for it.) This is sent early in
2723 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002724 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2725 * broadcast, since it is part of a visible user interaction; be as quick
2726 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002727 */
2728 public static final String ACTION_USER_INITIALIZE =
2729 "android.intent.action.USER_INITIALIZE";
2730
2731 /**
2732 * Sent when a user switch is happening, causing the process's user to be
2733 * brought to the foreground. This is only sent to receivers registered
2734 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2735 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002736 * foreground. This is sent as a foreground
2737 * broadcast, since it is part of a visible user interaction; be as quick
2738 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002739 */
2740 public static final String ACTION_USER_FOREGROUND =
2741 "android.intent.action.USER_FOREGROUND";
2742
2743 /**
2744 * Sent when a user switch is happening, causing the process's user to be
2745 * sent to the background. This is only sent to receivers registered
2746 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2747 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002748 * background. This is sent as a foreground
2749 * broadcast, since it is part of a visible user interaction; be as quick
2750 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002751 */
2752 public static final String ACTION_USER_BACKGROUND =
2753 "android.intent.action.USER_BACKGROUND";
2754
2755 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002756 * Broadcast sent to the system when a user is added. Carries an extra
2757 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2758 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002759 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002760 * @hide
2761 */
2762 public static final String ACTION_USER_ADDED =
2763 "android.intent.action.USER_ADDED";
2764
2765 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002766 * Broadcast sent by the system when a user is started. Carries an extra
2767 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002768 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002769 * that has been started. This is sent as a foreground
2770 * broadcast, since it is part of a visible user interaction; be as quick
2771 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002772 * @hide
2773 */
2774 public static final String ACTION_USER_STARTED =
2775 "android.intent.action.USER_STARTED";
2776
2777 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002778 * Broadcast sent when a user is in the process of starting. Carries an extra
2779 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2780 * sent to registered receivers, not manifest receivers. It is sent to all
2781 * users (including the one that is being started). You must hold
2782 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2783 * this broadcast. This is sent as a background broadcast, since
2784 * its result is not part of the primary UX flow; to safely keep track of
2785 * started/stopped state of a user you can use this in conjunction with
2786 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2787 * other user state broadcasts since those are foreground broadcasts so can
2788 * execute in a different order.
2789 * @hide
2790 */
2791 public static final String ACTION_USER_STARTING =
2792 "android.intent.action.USER_STARTING";
2793
2794 /**
2795 * Broadcast sent when a user is going to be stopped. Carries an extra
2796 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2797 * sent to registered receivers, not manifest receivers. It is sent to all
2798 * users (including the one that is being stopped). You must hold
2799 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2800 * this broadcast. The user will not stop until all receivers have
2801 * handled the broadcast. This is sent as a background broadcast, since
2802 * its result is not part of the primary UX flow; to safely keep track of
2803 * started/stopped state of a user you can use this in conjunction with
2804 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2805 * other user state broadcasts since those are foreground broadcasts so can
2806 * execute in a different order.
2807 * @hide
2808 */
2809 public static final String ACTION_USER_STOPPING =
2810 "android.intent.action.USER_STOPPING";
2811
2812 /**
2813 * Broadcast sent to the system when a user is stopped. Carries an extra
2814 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2815 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2816 * specific package. This is only sent to registered receivers, not manifest
2817 * receivers. It is sent to all running users <em>except</em> the one that
2818 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002819 * @hide
2820 */
2821 public static final String ACTION_USER_STOPPED =
2822 "android.intent.action.USER_STOPPED";
2823
2824 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002825 * 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 -07002826 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002827 * one that has been removed. The user will not be completely removed until all receivers have
2828 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002829 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002830 * @hide
2831 */
2832 public static final String ACTION_USER_REMOVED =
2833 "android.intent.action.USER_REMOVED";
2834
2835 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002836 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002837 * the userHandle of the user to become the current one. This is only sent to
2838 * registered receivers, not manifest receivers. It is sent to all running users.
2839 * You must hold
2840 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002841 * @hide
2842 */
2843 public static final String ACTION_USER_SWITCHED =
2844 "android.intent.action.USER_SWITCHED";
2845
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002846 /**
2847 * Broadcast sent to the system when a user's information changes. Carries an extra
2848 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002849 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002850 * @hide
2851 */
2852 public static final String ACTION_USER_INFO_CHANGED =
2853 "android.intent.action.USER_INFO_CHANGED";
2854
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002855 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002856 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2857 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002858 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2859 * that need to display merged content across both primary and managed profiles need to
2860 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002861 * not manifest receivers.
2862 */
2863 public static final String ACTION_MANAGED_PROFILE_ADDED =
2864 "android.intent.action.MANAGED_PROFILE_ADDED";
2865
2866 /**
2867 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002868 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2869 * Only applications (for example Launchers) that need to display merged content across both
2870 * primary and managed profiles need to worry about this broadcast. This is only sent to
2871 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002872 */
2873 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2874 "android.intent.action.MANAGED_PROFILE_REMOVED";
2875
2876 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002877 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2878 */
2879 public static final String ACTION_QUICK_CLOCK =
2880 "android.intent.action.QUICK_CLOCK";
2881
Michael Wright0087a142013-02-05 16:29:39 -08002882 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002883 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002884 * @hide
2885 */
2886 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2887 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2888
Justin Kohd378ad72013-04-01 12:18:26 -07002889 /**
2890 * Broadcast Action: A global button was pressed. Includes a single
2891 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2892 * caused the broadcast.
2893 * @hide
2894 */
2895 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2896
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002897 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002898 * Activity Action: Allow the user to select and return one or more existing
2899 * documents. When invoked, the system will display the various
2900 * {@link DocumentsProvider} instances installed on the device, letting the
2901 * user interactively navigate through them. These documents include local
2902 * media, such as photos and video, and documents provided by installed
2903 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002904 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002905 * Each document is represented as a {@code content://} URI backed by a
2906 * {@link DocumentsProvider}, which can be opened as a stream with
2907 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2908 * {@link android.provider.DocumentsContract.Document} metadata.
2909 * <p>
2910 * All selected documents are returned to the calling application with
2911 * persistable read and write permission grants. If you want to maintain
2912 * access to the documents across device reboots, you need to explicitly
2913 * take the persistable permissions using
2914 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2915 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002916 * Callers must indicate the acceptable document MIME types through
2917 * {@link #setType(String)}. For example, to select photos, use
2918 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2919 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2920 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002921 * <p>
2922 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002923 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2924 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002925 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002926 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2927 * returned URIs can be opened with
2928 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002929 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002930 * Output: The URI of the item that was picked, returned in
2931 * {@link #getData()}. This must be a {@code content://} URI so that any
2932 * receiver can access it. If multiple documents were selected, they are
2933 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002934 *
2935 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002936 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002937 * @see #ACTION_CREATE_DOCUMENT
2938 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002939 */
2940 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2941 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2942
2943 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002944 * Activity Action: Allow the user to create a new document. When invoked,
2945 * the system will display the various {@link DocumentsProvider} instances
2946 * installed on the device, letting the user navigate through them. The
2947 * returned document may be a newly created document with no content, or it
2948 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002949 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002950 * Each document is represented as a {@code content://} URI backed by a
2951 * {@link DocumentsProvider}, which can be opened as a stream with
2952 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2953 * {@link android.provider.DocumentsContract.Document} metadata.
2954 * <p>
2955 * Callers must indicate the concrete MIME type of the document being
2956 * created by setting {@link #setType(String)}. This MIME type cannot be
2957 * changed after the document is created.
2958 * <p>
2959 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2960 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002961 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002962 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2963 * returned URIs can be opened with
2964 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002965 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002966 * Output: The URI of the item that was created. This must be a
2967 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002968 *
2969 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002970 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002971 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002972 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002973 */
2974 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2975 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2976
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002977 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002978 * Activity Action: Allow the user to pick a directory subtree. When
2979 * invoked, the system will display the various {@link DocumentsProvider}
2980 * instances installed on the device, letting the user navigate through
2981 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002982 * <p>
2983 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002984 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2985 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2986 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002987 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002988 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002989 *
2990 * @see DocumentsContract
2991 */
2992 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002993 public static final String
2994 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002995
Jeff Sharkey004a4b22014-09-24 11:45:24 -07002996 /** {@hide} */
2997 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
2998
Christopher Tate6597e342015-02-17 12:15:25 -08002999 /**
3000 * Broadcast action: report that a settings element is being restored from backup. The intent
3001 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3002 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3003 * is the value of that settings entry prior to the restore operation. All of these values are
3004 * represented as strings.
3005 *
3006 * <p>This broadcast is sent only for settings provider entries known to require special handling
3007 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3008 * the provider's backup agent implementation.
3009 *
3010 * @see #EXTRA_SETTING_NAME
3011 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3012 * @see #EXTRA_SETTING_NEW_VALUE
3013 * {@hide}
3014 */
3015 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3016
3017 /** {@hide} */
3018 public static final String EXTRA_SETTING_NAME = "setting_name";
3019 /** {@hide} */
3020 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3021 /** {@hide} */
3022 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3023
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003024 /**
3025 * Activity Action: Process a piece of text.
3026 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3027 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3028 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3029 */
3030 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3031 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3032 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003033 * The name of the extra used to define the text to be processed, as a
3034 * CharSequence. Note that this may be a styled CharSequence, so you must use
3035 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003036 */
3037 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3038 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003039 * The name of the boolean extra used to define if the processed text will be used as read-only.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003040 */
3041 public static final String EXTRA_PROCESS_TEXT_READONLY =
3042 "android.intent.extra.PROCESS_TEXT_READONLY";
3043
Bryce Leebc58f592015-09-25 16:43:01 -07003044 /**
3045 * Broadcast action: reports when a new thermal event has been reached. When the device
3046 * is reaching its maximum temperatue, the thermal level reported
3047 * {@hide}
3048 */
3049 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3050 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3051
3052 /** {@hide} */
3053 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3054
3055 /**
3056 * Thermal state when the device is normal. This state is sent in the
3057 * {@link ACTION_THERMAL_EVENT} broadcast as {@link EXTRA_THERMAL_STATE}.
3058 * {@hide}
3059 */
3060 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3061
3062 /**
3063 * Thermal state where the device is approaching its maximum threshold. This state is sent in
3064 * the {@link ACTION_THERMAL_EVENT} broadcast as {@link EXTRA_THERMAL_STATE}.
3065 * {@hide}
3066 */
3067 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3068
3069 /**
3070 * Thermal state where the device has reached its maximum threshold. This state is sent in the
3071 * {@link ACTION_THERMAL_EVENT} broadcast as {@link EXTRA_THERMAL_STATE}.
3072 * {@hide}
3073 */
3074 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3075
3076
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003077 // ---------------------------------------------------------------------
3078 // ---------------------------------------------------------------------
3079 // Standard intent categories (see addCategory()).
3080
3081 /**
3082 * Set if the activity should be an option for the default action
3083 * (center press) to perform on a piece of data. Setting this will
3084 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003085 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003086 * Intent when initiating an action -- it is for use in intent filters
3087 * specified in packages.
3088 */
3089 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3090 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3091 /**
3092 * Activities that can be safely invoked from a browser must support this
3093 * category. For example, if the user is viewing a web page or an e-mail
3094 * and clicks on a link in the text, the Intent generated execute that
3095 * link will require the BROWSABLE category, so that only activities
3096 * supporting this category will be considered as possible actions. By
3097 * supporting this category, you are promising that there is nothing
3098 * damaging (without user intervention) that can happen by invoking any
3099 * matching Intent.
3100 */
3101 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3102 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3103 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003104 * Categories for activities that can participate in voice interaction.
3105 * An activity that supports this category must be prepared to run with
3106 * no UI shown at all (though in some case it may have a UI shown), and
3107 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3108 */
3109 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3110 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3111 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003112 * Set if the activity should be considered as an alternative action to
3113 * the data the user is currently viewing. See also
3114 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3115 * applies to the selection in a list of items.
3116 *
3117 * <p>Supporting this category means that you would like your activity to be
3118 * displayed in the set of alternative things the user can do, usually as
3119 * part of the current activity's options menu. You will usually want to
3120 * include a specific label in the &lt;intent-filter&gt; of this action
3121 * describing to the user what it does.
3122 *
3123 * <p>The action of IntentFilter with this category is important in that it
3124 * describes the specific action the target will perform. This generally
3125 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3126 * a specific name such as "com.android.camera.action.CROP. Only one
3127 * alternative of any particular action will be shown to the user, so using
3128 * a specific action like this makes sure that your alternative will be
3129 * displayed while also allowing other applications to provide their own
3130 * overrides of that particular action.
3131 */
3132 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3133 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3134 /**
3135 * Set if the activity should be considered as an alternative selection
3136 * action to the data the user has currently selected. This is like
3137 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3138 * of items from which the user can select, giving them alternatives to the
3139 * default action that will be performed on it.
3140 */
3141 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3142 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3143 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003144 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003145 */
3146 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3147 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3148 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003149 * Should be displayed in the top-level launcher.
3150 */
3151 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3152 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3153 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003154 * Indicates an activity optimized for Leanback mode, and that should
3155 * be displayed in the Leanback launcher.
3156 */
3157 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3158 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3159 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003160 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3161 * @hide
3162 */
3163 @SystemApi
3164 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3165 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003166 * Provides information about the package it is in; typically used if
3167 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3168 * a front-door to the user without having to be shown in the all apps list.
3169 */
3170 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3171 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3172 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003173 * This is the home activity, that is the first activity that is displayed
3174 * when the device boots.
3175 */
3176 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3177 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3178 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003179 * This is the home activity that is displayed when the device is finished setting up and ready
3180 * for use.
3181 * @hide
3182 */
3183 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3184 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3185 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003186 * This is the setup wizard activity, that is the first activity that is displayed
3187 * when the user sets up the device for the first time.
3188 * @hide
3189 */
3190 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3191 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3192 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003193 * This activity is a preference panel.
3194 */
3195 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3196 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3197 /**
3198 * This activity is a development preference panel.
3199 */
3200 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3201 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3202 /**
3203 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003204 */
3205 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3206 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3207 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003208 * This activity allows the user to browse and download new applications.
3209 */
3210 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3211 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3212 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003213 * This activity may be exercised by the monkey or other automated test tools.
3214 */
3215 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3216 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3217 /**
3218 * To be used as a test (not part of the normal user experience).
3219 */
3220 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3221 /**
3222 * To be used as a unit test (run through the Test Harness).
3223 */
3224 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3225 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003226 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003227 * experience).
3228 */
3229 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003230
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003231 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003232 * Used to indicate that an intent only wants URIs that can be opened with
3233 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3234 * must support at least the columns defined in {@link OpenableColumns} when
3235 * queried.
3236 *
3237 * @see #ACTION_GET_CONTENT
3238 * @see #ACTION_OPEN_DOCUMENT
3239 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003240 */
3241 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3242 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3243
3244 /**
3245 * To be used as code under test for framework instrumentation tests.
3246 */
3247 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3248 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003249 /**
3250 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003251 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3252 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003253 */
3254 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3255 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3256 /**
3257 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003258 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3259 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003260 */
3261 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3262 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003263 /**
3264 * An activity to run when device is inserted into a analog (low end) dock.
3265 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3266 * information, see {@link android.app.UiModeManager}.
3267 */
3268 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3269 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3270
3271 /**
3272 * An activity to run when device is inserted into a digital (high end) dock.
3273 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3274 * information, see {@link android.app.UiModeManager}.
3275 */
3276 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3277 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003278
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003279 /**
3280 * Used to indicate that the activity can be used in a car environment.
3281 */
3282 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3283 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3284
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003285 // ---------------------------------------------------------------------
3286 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003287 // Application launch intent categories (see addCategory()).
3288
3289 /**
3290 * Used with {@link #ACTION_MAIN} to launch the browser application.
3291 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003292 * <p>NOTE: This should not be used as the primary key of an Intent,
3293 * since it will not result in the app launching with the correct
3294 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003295 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003296 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003297 */
3298 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3299 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3300
3301 /**
3302 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3303 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003304 * <p>NOTE: This should not be used as the primary key of an Intent,
3305 * since it will not result in the app launching with the correct
3306 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003307 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003308 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003309 */
3310 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3311 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3312
3313 /**
3314 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3315 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003316 * <p>NOTE: This should not be used as the primary key of an Intent,
3317 * since it will not result in the app launching with the correct
3318 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003319 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003320 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003321 */
3322 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3323 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3324
3325 /**
3326 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3327 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003328 * <p>NOTE: This should not be used as the primary key of an Intent,
3329 * since it will not result in the app launching with the correct
3330 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003331 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003332 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003333 */
3334 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3335 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3336
3337 /**
3338 * Used with {@link #ACTION_MAIN} to launch the email application.
3339 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003340 * <p>NOTE: This should not be used as the primary key of an Intent,
3341 * since it will not result in the app launching with the correct
3342 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003343 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003344 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003345 */
3346 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3347 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3348
3349 /**
3350 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3351 * The activity should be able to view and manipulate image and video files
3352 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003353 * <p>NOTE: This should not be used as the primary key of an Intent,
3354 * since it will not result in the app launching with the correct
3355 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003356 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003357 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003358 */
3359 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3360 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3361
3362 /**
3363 * Used with {@link #ACTION_MAIN} to launch the maps application.
3364 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003365 * <p>NOTE: This should not be used as the primary key of an Intent,
3366 * since it will not result in the app launching with the correct
3367 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003368 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003369 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003370 */
3371 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3372 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3373
3374 /**
3375 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3376 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003377 * <p>NOTE: This should not be used as the primary key of an Intent,
3378 * since it will not result in the app launching with the correct
3379 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003380 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003381 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003382 */
3383 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3384 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3385
3386 /**
3387 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003388 * The activity should be able to play, browse, or manipulate music files
3389 * stored on the device.
3390 * <p>NOTE: This should not be used as the primary key of an Intent,
3391 * since it will not result in the app launching with the correct
3392 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003393 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003394 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003395 */
3396 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3397 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3398
3399 // ---------------------------------------------------------------------
3400 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003401 // Standard extra data keys.
3402
3403 /**
3404 * The initial data to place in a newly created record. Use with
3405 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3406 * fields as would be given to the underlying ContentProvider.insert()
3407 * call.
3408 */
3409 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3410
3411 /**
3412 * A constant CharSequence that is associated with the Intent, used with
3413 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3414 * this may be a styled CharSequence, so you must use
3415 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3416 * retrieve it.
3417 */
3418 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3419
3420 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003421 * A constant String that is associated with the Intent, used with
3422 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3423 * as HTML formatted text. Note that you <em>must</em> also supply
3424 * {@link #EXTRA_TEXT}.
3425 */
3426 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3427
3428 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003429 * A content: URI holding a stream of data associated with the Intent,
3430 * used with {@link #ACTION_SEND} to supply the data being sent.
3431 */
3432 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3433
3434 /**
3435 * A String[] holding e-mail addresses that should be delivered to.
3436 */
3437 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3438
3439 /**
3440 * A String[] holding e-mail addresses that should be carbon copied.
3441 */
3442 public static final String EXTRA_CC = "android.intent.extra.CC";
3443
3444 /**
3445 * A String[] holding e-mail addresses that should be blind carbon copied.
3446 */
3447 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3448
3449 /**
3450 * A constant string holding the desired subject line of a message.
3451 */
3452 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3453
3454 /**
3455 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003456 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003457 */
3458 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3459
3460 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003461 * An int representing the user id to be used.
3462 *
3463 * @hide
3464 */
3465 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3466
3467 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003468 * An Intent[] describing additional, alternate choices you would like shown with
3469 * {@link #ACTION_CHOOSER}.
3470 *
3471 * <p>An app may be capable of providing several different payload types to complete a
3472 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3473 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3474 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3475 * photo data or a hosted link where the photos can be viewed.</p>
3476 *
3477 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3478 * first/primary/preferred intent in the set. Additional intents specified in
3479 * this extra are ordered; by default intents that appear earlier in the array will be
3480 * preferred over intents that appear later in the array as matches for the same
3481 * target component. To alter this preference, a calling app may also supply
3482 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3483 */
3484 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3485
3486 /**
3487 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3488 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3489 *
3490 * <p>An app preparing an action for another app to complete may wish to allow the user to
3491 * disambiguate between several options for completing the action based on the chosen target
3492 * or otherwise refine the action before it is invoked.
3493 * </p>
3494 *
3495 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3496 * <ul>
3497 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3498 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3499 * chosen target beyond the first</li>
3500 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3501 * should fill in and send once the disambiguation is complete</li>
3502 * </ul>
3503 */
3504 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3505 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3506
3507 /**
3508 * A {@link ResultReceiver} used to return data back to the sender.
3509 *
3510 * <p>Used to complete an app-specific
3511 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3512 *
3513 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3514 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3515 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3516 * when the user selects a target component from the chooser. It is up to the recipient
3517 * to send a result to this ResultReceiver to signal that disambiguation is complete
3518 * and that the chooser should invoke the user's choice.</p>
3519 *
3520 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3521 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3522 * to match and fill in the final Intent or ChooserTarget before starting it.
3523 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3524 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3525 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3526 *
3527 * <p>The result code passed to the ResultReceiver should be
3528 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3529 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3530 * the chooser should finish without starting a target.</p>
3531 */
3532 public static final String EXTRA_RESULT_RECEIVER
3533 = "android.intent.extra.RESULT_RECEIVER";
3534
3535 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003536 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003537 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003538 */
3539 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3540
3541 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003542 * A Parcelable[] of {@link Intent} or
3543 * {@link android.content.pm.LabeledIntent} objects as set with
3544 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3545 * a the front of the list of choices, when shown to the user with a
3546 * {@link #ACTION_CHOOSER}.
3547 */
3548 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3549
3550 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003551 * A Bundle forming a mapping of potential target package names to different extras Bundles
3552 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3553 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3554 * be currently installed on the device.
3555 *
3556 * <p>An application may choose to provide alternate extras for the case where a user
3557 * selects an activity from a predetermined set of target packages. If the activity
3558 * the user selects from the chooser belongs to a package with its package name as
3559 * a key in this bundle, the corresponding extras for that package will be merged with
3560 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3561 * extra has the same key as an extra already present in the intent it will overwrite
3562 * the extra from the intent.</p>
3563 *
3564 * <p><em>Examples:</em>
3565 * <ul>
3566 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3567 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3568 * parameters for that target.</li>
3569 * <li>An application may offer additional metadata for known targets of a given intent
3570 * to pass along information only relevant to that target such as account or content
3571 * identifiers already known to that application.</li>
3572 * </ul></p>
3573 */
3574 public static final String EXTRA_REPLACEMENT_EXTRAS =
3575 "android.intent.extra.REPLACEMENT_EXTRAS";
3576
3577 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003578 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3579 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3580 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3581 * {@link ComponentName} of the chosen component.
3582 *
3583 * <p>In some situations this callback may never come, for example if the user abandons
3584 * the chooser, switches to another task or any number of other reasons. Apps should not
3585 * be written assuming that this callback will always occur.</p>
3586 */
3587 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3588 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3589
3590 /**
3591 * The {@link ComponentName} chosen by the user to complete an action.
3592 *
3593 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3594 */
3595 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3596
3597 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003598 * A {@link android.view.KeyEvent} object containing the event that
3599 * triggered the creation of the Intent it is in.
3600 */
3601 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3602
3603 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003604 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3605 * before shutting down.
3606 *
3607 * {@hide}
3608 */
3609 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3610
3611 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003612 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3613 * requested by the user.
3614 *
3615 * {@hide}
3616 */
3617 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3618 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3619
3620 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003621 * 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 -07003622 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3623 * of restarting the application.
3624 */
3625 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3626
3627 /**
3628 * A String holding the phone number originally entered in
3629 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3630 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3631 */
3632 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003633
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003634 /**
3635 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3636 * intents to supply the uid the package had been assigned. Also an optional
3637 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3638 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3639 * purpose.
3640 */
3641 public static final String EXTRA_UID = "android.intent.extra.UID";
3642
3643 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003644 * @hide String array of package names.
3645 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003646 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003647 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3648
3649 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003650 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3651 * intents to indicate whether this represents a full uninstall (removing
3652 * both the code and its data) or a partial uninstall (leaving its data,
3653 * implying that this is an update).
3654 */
3655 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003656
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003657 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003658 * @hide
3659 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3660 * intents to indicate that at this point the package has been removed for
3661 * all users on the device.
3662 */
3663 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3664 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3665
3666 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003667 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3668 * intents to indicate that this is a replacement of the package, so this
3669 * broadcast will immediately be followed by an add broadcast for a
3670 * different version of the same package.
3671 */
3672 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003673
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003674 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003675 * Used as an int extra field in {@link android.app.AlarmManager} intents
3676 * to tell the application being invoked how many pending alarms are being
3677 * delievered with the intent. For one-shot alarms this will always be 1.
3678 * For recurring alarms, this might be greater than 1 if the device was
3679 * asleep or powered off at the time an earlier alarm would have been
3680 * delivered.
3681 */
3682 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003683
Jacek Surazski86b6c532009-05-13 14:38:28 +02003684 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003685 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3686 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003687 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3688 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003689 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3690 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3691 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003692 */
3693 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3694
3695 /**
3696 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3697 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003698 */
3699 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3700
3701 /**
3702 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3703 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003704 */
3705 public static final int EXTRA_DOCK_STATE_DESK = 1;
3706
3707 /**
3708 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3709 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003710 */
3711 public static final int EXTRA_DOCK_STATE_CAR = 2;
3712
3713 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003714 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3715 * to represent that the phone is in a analog (low end) dock.
3716 */
3717 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3718
3719 /**
3720 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3721 * to represent that the phone is in a digital (high end) dock.
3722 */
3723 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3724
3725 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003726 * Boolean that can be supplied as meta-data with a dock activity, to
3727 * indicate that the dock should take over the home key when it is active.
3728 */
3729 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003730
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003731 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003732 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3733 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003734 */
3735 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3736
3737 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003738 * Used in the extra field in the remote intent. It's astring token passed with the
3739 * remote intent.
3740 */
3741 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3742 "android.intent.extra.remote_intent_token";
3743
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003744 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003745 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003746 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003747 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003748 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003749 "android.intent.extra.changed_component_name";
3750
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003751 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003752 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003753 * and contains a string array of all of the components that have changed. If
3754 * the state of the overall package has changed, then it will contain an entry
3755 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003756 */
3757 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3758 "android.intent.extra.changed_component_name_list";
3759
3760 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003761 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003762 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3763 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003764 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003765 */
3766 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3767 "android.intent.extra.changed_package_list";
3768
3769 /**
3770 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003771 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3772 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003773 * and contains an integer array of uids of all of the components
3774 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003775 */
3776 public static final String EXTRA_CHANGED_UID_LIST =
3777 "android.intent.extra.changed_uid_list";
3778
3779 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003780 * @hide
3781 * Magic extra system code can use when binding, to give a label for
3782 * who it is that has bound to a service. This is an integer giving
3783 * a framework string resource that can be displayed to the user.
3784 */
3785 public static final String EXTRA_CLIENT_LABEL =
3786 "android.intent.extra.client_label";
3787
3788 /**
3789 * @hide
3790 * Magic extra system code can use when binding, to give a PendingIntent object
3791 * that can be launched for the user to disable the system's use of this
3792 * service.
3793 */
3794 public static final String EXTRA_CLIENT_INTENT =
3795 "android.intent.extra.client_intent";
3796
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003797 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003798 * Extra used to indicate that an intent should only return data that is on
3799 * the local device. This is a boolean extra; the default is false. If true,
3800 * an implementation should only allow the user to select data that is
3801 * already on the device, not requiring it be downloaded from a remote
3802 * service when opened.
3803 *
3804 * @see #ACTION_GET_CONTENT
3805 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003806 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003807 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003808 */
3809 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003810 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003811
Amith Yamasani13593602012-03-22 16:16:17 -07003812 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003813 * Extra used to indicate that an intent can allow the user to select and
3814 * return multiple items. This is a boolean extra; the default is false. If
3815 * true, an implementation is allowed to present the user with a UI where
3816 * they can pick multiple items that are all returned to the caller. When
3817 * this happens, they should be returned as the {@link #getClipData()} part
3818 * of the result Intent.
3819 *
3820 * @see #ACTION_GET_CONTENT
3821 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003822 */
3823 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003824 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003825
3826 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003827 * The integer userHandle carried with broadcast intents related to addition, removal and
3828 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3829 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3830 *
Amith Yamasani13593602012-03-22 16:16:17 -07003831 * @hide
3832 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003833 public static final String EXTRA_USER_HANDLE =
3834 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003835
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003836 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003837 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3838 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3839 */
3840 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01003841 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003842
3843 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003844 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003845 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3846 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003847 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003848 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3849
3850 /**
3851 * Extra sent in the intent to the BroadcastReceiver that handles
3852 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3853 * the restrictions as key/value pairs.
3854 */
3855 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3856 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003857
Amith Yamasani86118ba2013-03-28 14:33:16 -07003858 /**
3859 * Extra used in the response from a BroadcastReceiver that handles
3860 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3861 */
3862 public static final String EXTRA_RESTRICTIONS_INTENT =
3863 "android.intent.extra.restrictions_intent";
3864
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003865 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003866 * Extra used to communicate a set of acceptable MIME types. The type of the
3867 * extra is {@code String[]}. Values may be a combination of concrete MIME
3868 * types (such as "image/png") and/or partial MIME types (such as
3869 * "audio/*").
3870 *
3871 * @see #ACTION_GET_CONTENT
3872 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003873 */
3874 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3875
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003876 /**
3877 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3878 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003879 * When this is true, hardware devices can use this information to determine that
3880 * they shouldn't do a complete shutdown of their device since this is not a
3881 * complete shutdown down to the kernel, but only user space restarting.
3882 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003883 */
3884 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3885 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3886
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003887 /**
3888 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3889 * user has set their time format preferences to the 24 hour format.
3890 *
3891 * @hide for internal use only.
3892 */
3893 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3894 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3895
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003896 /** {@hide} */
3897 public static final String EXTRA_REASON = "android.intent.extra.REASON";
3898
Rubin Xue8490f12015-06-25 12:17:48 +01003899 /** {@hide} */
3900 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
3901
Santos Cordon15a13782015-03-31 18:32:31 -07003902 /**
3903 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
3904 * activation request.
3905 * TODO: Add information about the structure and response data used with the pending intent.
3906 * @hide
3907 */
3908 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
3909 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
3910
Steve McKay6eaf38632015-08-04 10:11:01 -07003911 /** {@hide} */
3912 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
3913
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003914 // ---------------------------------------------------------------------
3915 // ---------------------------------------------------------------------
3916 // Intent flags (see mFlags variable).
3917
Tor Norbyed9273d62013-05-30 15:59:53 -07003918 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003919 @IntDef(flag = true, value = {
3920 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3921 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003922 @Retention(RetentionPolicy.SOURCE)
3923 public @interface GrantUriMode {}
3924
Jeff Sharkey846318a2014-04-04 12:12:41 -07003925 /** @hide */
3926 @IntDef(flag = true, value = {
3927 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3928 @Retention(RetentionPolicy.SOURCE)
3929 public @interface AccessUriMode {}
3930
3931 /**
3932 * Test if given mode flags specify an access mode, which must be at least
3933 * read and/or write.
3934 *
3935 * @hide
3936 */
3937 public static boolean isAccessUriMode(int modeFlags) {
3938 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3939 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3940 }
3941
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003942 /**
3943 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003944 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003945 * specified in its ClipData. When applying to an Intent's ClipData,
3946 * all URIs as well as recursive traversals through data or other ClipData
3947 * in Intent items will be granted; only the grant flags of the top-level
3948 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003949 */
3950 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3951 /**
3952 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003953 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003954 * specified in its ClipData. When applying to an Intent's ClipData,
3955 * all URIs as well as recursive traversals through data or other ClipData
3956 * in Intent items will be granted; only the grant flags of the top-level
3957 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003958 */
3959 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3960 /**
3961 * Can be set by the caller to indicate that this Intent is coming from
3962 * a background operation, not from direct user interaction.
3963 */
3964 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3965 /**
3966 * A flag you can enable for debugging: when set, log messages will be
3967 * printed during the resolution of this intent to show you what has
3968 * been found to create the final resolved list.
3969 */
3970 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003971 /**
3972 * If set, this intent will not match any components in packages that
3973 * are currently stopped. If this is not set, then the default behavior
3974 * is to include such applications in the result.
3975 */
3976 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3977 /**
3978 * If set, this intent will always match any components in packages that
3979 * are currently stopped. This is the default behavior when
3980 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3981 * flags are set, this one wins (it allows overriding of exclude for
3982 * places where the framework may automatically set the exclude flag).
3983 */
3984 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003985
3986 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003987 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003988 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003989 * persisted across device reboots until explicitly revoked with
3990 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3991 * grant for possible persisting; the receiving application must call
3992 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3993 * actually persist.
3994 *
3995 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3996 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3997 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003998 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003999 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004000 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004001
4002 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004003 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4004 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4005 * applies to any URI that is a prefix match against the original granted
4006 * URI. (Without this flag, the URI must match exactly for access to be
4007 * granted.) Another URI is considered a prefix match only when scheme,
4008 * authority, and all path segments defined by the prefix are an exact
4009 * match.
4010 */
4011 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4012
4013 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004014 * If set, the new activity is not kept in the history stack. As soon as
4015 * the user navigates away from it, the activity is finished. This may also
4016 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4017 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004018 *
4019 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4020 * is never invoked when the current activity starts a new activity which
4021 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004022 */
4023 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4024 /**
4025 * If set, the activity will not be launched if it is already running
4026 * at the top of the history stack.
4027 */
4028 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4029 /**
4030 * If set, this activity will become the start of a new task on this
4031 * history stack. A task (from the activity that started it to the
4032 * next task activity) defines an atomic group of activities that the
4033 * user can move to. Tasks can be moved to the foreground and background;
4034 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004035 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004036 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4037 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004038 *
4039 * <p>This flag is generally used by activities that want
4040 * to present a "launcher" style behavior: they give the user a list of
4041 * separate things that can be done, which otherwise run completely
4042 * independently of the activity launching them.
4043 *
4044 * <p>When using this flag, if a task is already running for the activity
4045 * you are now starting, then a new activity will not be started; instead,
4046 * the current task will simply be brought to the front of the screen with
4047 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4048 * to disable this behavior.
4049 *
4050 * <p>This flag can not be used when the caller is requesting a result from
4051 * the activity being launched.
4052 */
4053 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4054 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004055 * This flag is used to create a new task and launch an activity into it.
4056 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4057 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4058 * search through existing tasks for ones matching this Intent. Only if no such
4059 * task is found would a new task be created. When paired with
4060 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4061 * the search for a matching task and unconditionally start a new task.
4062 *
4063 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4064 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004065 * top-level application launcher.</strong> Used in conjunction with
4066 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4067 * behavior of bringing an existing task to the foreground. When set,
4068 * a new task is <em>always</em> started to host the Activity for the
4069 * Intent, regardless of whether there is already an existing task running
4070 * the same thing.
4071 *
4072 * <p><strong>Because the default system does not include graphical task management,
4073 * you should not use this flag unless you provide some way for a user to
4074 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004075 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004076 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4077 * creating new document tasks.
4078 *
4079 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004080 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004081 *
Scott Main7aee61f2011-02-08 11:25:01 -08004082 * <p>See
4083 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4084 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004085 *
4086 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4087 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004088 */
4089 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4090 /**
4091 * If set, and the activity being launched is already running in the
4092 * current task, then instead of launching a new instance of that activity,
4093 * all of the other activities on top of it will be closed and this Intent
4094 * will be delivered to the (now on top) old activity as a new Intent.
4095 *
4096 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4097 * If D calls startActivity() with an Intent that resolves to the component
4098 * of activity B, then C and D will be finished and B receive the given
4099 * Intent, resulting in the stack now being: A, B.
4100 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004101 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004102 * either receive the new intent you are starting here in its
4103 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004104 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004105 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4106 * the same intent, then it will be finished and re-created; for all other
4107 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4108 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004109 *
4110 * <p>This launch mode can also be used to good effect in conjunction with
4111 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4112 * of a task, it will bring any currently running instance of that task
4113 * to the foreground, and then clear it to its root state. This is
4114 * especially useful, for example, when launching an activity from the
4115 * notification manager.
4116 *
Scott Main7aee61f2011-02-08 11:25:01 -08004117 * <p>See
4118 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4119 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004120 */
4121 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4122 /**
4123 * If set and this intent is being used to launch a new activity from an
4124 * existing one, then the reply target of the existing activity will be
4125 * transfered to the new activity. This way the new activity can call
4126 * {@link android.app.Activity#setResult} and have that result sent back to
4127 * the reply target of the original activity.
4128 */
4129 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4130 /**
4131 * If set and this intent is being used to launch a new activity from an
4132 * existing one, the current activity will not be counted as the top
4133 * activity for deciding whether the new intent should be delivered to
4134 * the top instead of starting a new one. The previous activity will
4135 * be used as the top, with the assumption being that the current activity
4136 * will finish itself immediately.
4137 */
4138 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4139 /**
4140 * If set, the new activity is not kept in the list of recently launched
4141 * activities.
4142 */
4143 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4144 /**
4145 * This flag is not normally set by application code, but set for you by
4146 * the system as described in the
4147 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4148 * launchMode} documentation for the singleTask mode.
4149 */
4150 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4151 /**
4152 * If set, and this activity is either being started in a new task or
4153 * bringing to the top an existing task, then it will be launched as
4154 * the front door of the task. This will result in the application of
4155 * any affinities needed to have that task in the proper state (either
4156 * moving activities to or from it), or simply resetting that task to
4157 * its initial state if needed.
4158 */
4159 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4160 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004161 * This flag is not normally set by application code, but set for you by
4162 * the system if this activity is being launched from history
4163 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004164 */
4165 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004166 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004167 * @deprecated As of API 21 this performs identically to
4168 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004169 */
4170 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004171 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004172 * This flag is used to open a document into a new task rooted at the activity launched
4173 * by this Intent. Through the use of this flag, or its equivalent attribute,
4174 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004175 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004176 *
Craig Mautner026596b2014-05-21 15:35:44 -07004177 * <p>The use of the activity attribute form of this,
4178 * {@link android.R.attr#documentLaunchMode}, is
4179 * preferred over the Intent flag described here. The attribute form allows the
4180 * Activity to specify multiple document behavior for all launchers of the Activity
4181 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004182 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004183 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4184 * it is kept after the activity is finished is different than the use of
4185 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4186 * this flag is being used to create a new recents entry, then by default that entry
4187 * will be removed once the activity is finished. You can modify this behavior with
4188 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4189 *
Craig Mautner026596b2014-05-21 15:35:44 -07004190 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4191 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4192 * equivalent of the Activity manifest specifying {@link
4193 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4194 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4195 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004196 *
Craig Mautner026596b2014-05-21 15:35:44 -07004197 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004198 *
Craig Mautner026596b2014-05-21 15:35:44 -07004199 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004200 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4201 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004202 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004203 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004204 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004205 * callback from occurring on the current frontmost activity before it is
4206 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004207 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004208 * <p>Typically, an activity can rely on that callback to indicate that an
4209 * explicit user action has caused their activity to be moved out of the
4210 * foreground. The callback marks an appropriate point in the activity's
4211 * lifecycle for it to dismiss any notifications that it intends to display
4212 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004213 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004214 * <p>If an activity is ever started via any non-user-driven events such as
4215 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4216 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004217 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004218 */
4219 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004220 /**
4221 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4222 * this flag will cause the launched activity to be brought to the front of its
4223 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004224 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004225 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4226 * If D calls startActivity() with an Intent that resolves to the component
4227 * of activity B, then B will be brought to the front of the history stack,
4228 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004229 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004230 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004231 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004232 */
4233 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004234 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004235 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4236 * this flag will prevent the system from applying an activity transition
4237 * animation to go to the next activity state. This doesn't mean an
4238 * animation will never run -- if another activity change happens that doesn't
4239 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004240 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004241 * when you are going to do a series of activity operations but the
4242 * animation seen by the user shouldn't be driven by the first activity
4243 * change but rather a later one.
4244 */
4245 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4246 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004247 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4248 * this flag will cause any existing task that would be associated with the
4249 * activity to be cleared before the activity is started. That is, the activity
4250 * becomes the new root of an otherwise empty task, and any old activities
4251 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4252 */
4253 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4254 /**
4255 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4256 * this flag will cause a newly launching task to be placed on top of the current
4257 * home activity task (if there is one). That is, pressing back from the task
4258 * will always return the user to home even if that was not the last activity they
4259 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4260 */
4261 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4262 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004263 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4264 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004265 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004266 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004267 * this flag. When set and the task's activity is finished, the recents
4268 * entry will remain in the interface for the user to re-launch it, like a
4269 * recents entry for a top-level application.
4270 * <p>
4271 * The receiving activity can override this request with
4272 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4273 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004274 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004275 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004276 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004277
4278 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004279 * If set, when sending a broadcast only registered receivers will be
4280 * called -- no BroadcastReceiver components will be launched.
4281 */
4282 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004283 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004284 * If set, when sending a broadcast the new broadcast will replace
4285 * any existing pending broadcast that matches it. Matching is defined
4286 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4287 * true for the intents of the two broadcasts. When a match is found,
4288 * the new broadcast (and receivers associated with it) will replace the
4289 * existing one in the pending broadcast list, remaining at the same
4290 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004291 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004292 * <p>This flag is most typically used with sticky broadcasts, which
4293 * only care about delivering the most recent values of the broadcast
4294 * to their receivers.
4295 */
4296 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4297 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004298 * If set, when sending a broadcast the recipient is allowed to run at
4299 * foreground priority, with a shorter timeout interval. During normal
4300 * broadcasts the receivers are not automatically hoisted out of the
4301 * background priority class.
4302 */
4303 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4304 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004305 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4306 * They can still propagate results through to later receivers, but they can not prevent
4307 * later receivers from seeing the broadcast.
4308 */
4309 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4310 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004311 * If set, when sending a broadcast <i>before boot has completed</i> only
4312 * registered receivers will be called -- no BroadcastReceiver components
4313 * will be launched. Sticky intent state will be recorded properly even
4314 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4315 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004316 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004317 * <p>This flag is only for use by system sevices as a convenience to
4318 * avoid having to implement a more complex mechanism around detection
4319 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004320 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004321 * @hide
4322 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004323 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004324 /**
4325 * Set when this broadcast is for a boot upgrade, a special mode that
4326 * allows the broadcast to be sent before the system is ready and launches
4327 * the app process with no providers running in it.
4328 * @hide
4329 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004330 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004331
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004332 /**
4333 * @hide Flags that can't be changed with PendingIntent.
4334 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004335 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4336 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4337 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004338
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004339 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004340 // ---------------------------------------------------------------------
4341 // toUri() and parseUri() options.
4342
4343 /**
4344 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4345 * always has the "intent:" scheme. This syntax can be used when you want
4346 * to later disambiguate between URIs that are intended to describe an
4347 * Intent vs. all others that should be treated as raw URIs. When used
4348 * with {@link #parseUri}, any other scheme will result in a generic
4349 * VIEW action for that raw URI.
4350 */
4351 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004352
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004353 /**
4354 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4355 * always has the "android-app:" scheme. This is a variation of
4356 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4357 * http/https URI being delivered to a specific package name. The format
4358 * is:
4359 *
4360 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004361 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004362 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004363 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4364 * you must also include a scheme; including a path also requires both a host and a scheme.
4365 * The final #Intent; fragment can be used without a scheme, host, or path.
4366 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004367 * used with intents that have a {@link #setSelector}, since the base intent
4368 * will always have an explicit package name.</p>
4369 *
4370 * <p>Some examples of how this scheme maps to Intent objects:</p>
4371 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4372 * <colgroup align="left" />
4373 * <colgroup align="left" />
4374 * <thead>
4375 * <tr><th>URI</th> <th>Intent</th></tr>
4376 * </thead>
4377 *
4378 * <tbody>
4379 * <tr><td><code>android-app://com.example.app</code></td>
4380 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4381 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4382 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4383 * </table></td>
4384 * </tr>
4385 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4386 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4387 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4388 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4389 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4390 * </table></td>
4391 * </tr>
4392 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4393 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4394 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4395 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4396 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4397 * </table></td>
4398 * </tr>
4399 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4400 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4401 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4402 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4403 * </table></td>
4404 * </tr>
4405 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4406 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4407 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4408 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4409 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4410 * </table></td>
4411 * </tr>
4412 * <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>
4413 * <td><table border="" style="margin:0" >
4414 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4415 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4416 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4417 * </table></td>
4418 * </tr>
4419 * </tbody>
4420 * </table>
4421 */
4422 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4423
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004424 /**
4425 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4426 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4427 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4428 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4429 * generated Intent can not cause unexpected data access to happen.
4430 *
4431 * <p>If you do not trust the source of the URI being parsed, you should still do further
4432 * processing to protect yourself from it. In particular, when using it to start an
4433 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4434 * that can handle it.</p>
4435 */
4436 public static final int URI_ALLOW_UNSAFE = 1<<2;
4437
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004438 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004439
4440 private String mAction;
4441 private Uri mData;
4442 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004443 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004444 private ComponentName mComponent;
4445 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004446 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004447 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004448 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004449 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004450 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004451 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004452
4453 // ---------------------------------------------------------------------
4454
4455 /**
4456 * Create an empty intent.
4457 */
4458 public Intent() {
4459 }
4460
4461 /**
4462 * Copy constructor.
4463 */
4464 public Intent(Intent o) {
4465 this.mAction = o.mAction;
4466 this.mData = o.mData;
4467 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004468 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004469 this.mComponent = o.mComponent;
4470 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004471 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004472 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004473 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004474 }
4475 if (o.mExtras != null) {
4476 this.mExtras = new Bundle(o.mExtras);
4477 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004478 if (o.mSourceBounds != null) {
4479 this.mSourceBounds = new Rect(o.mSourceBounds);
4480 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004481 if (o.mSelector != null) {
4482 this.mSelector = new Intent(o.mSelector);
4483 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004484 if (o.mClipData != null) {
4485 this.mClipData = new ClipData(o.mClipData);
4486 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004487 }
4488
4489 @Override
4490 public Object clone() {
4491 return new Intent(this);
4492 }
4493
4494 private Intent(Intent o, boolean all) {
4495 this.mAction = o.mAction;
4496 this.mData = o.mData;
4497 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004498 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004499 this.mComponent = o.mComponent;
4500 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004501 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004502 }
4503 }
4504
4505 /**
4506 * Make a clone of only the parts of the Intent that are relevant for
4507 * filter matching: the action, data, type, component, and categories.
4508 */
4509 public Intent cloneFilter() {
4510 return new Intent(this, false);
4511 }
4512
4513 /**
4514 * Create an intent with a given action. All other fields (data, type,
4515 * class) are null. Note that the action <em>must</em> be in a
4516 * namespace because Intents are used globally in the system -- for
4517 * example the system VIEW action is android.intent.action.VIEW; an
4518 * application's custom action would be something like
4519 * com.google.app.myapp.CUSTOM_ACTION.
4520 *
4521 * @param action The Intent action, such as ACTION_VIEW.
4522 */
4523 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004524 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004525 }
4526
4527 /**
4528 * Create an intent with a given action and for a given data url. Note
4529 * that the action <em>must</em> be in a namespace because Intents are
4530 * used globally in the system -- for example the system VIEW action is
4531 * android.intent.action.VIEW; an application's custom action would be
4532 * something like com.google.app.myapp.CUSTOM_ACTION.
4533 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004534 * <p><em>Note: scheme and host name matching in the Android framework is
4535 * case-sensitive, unlike the formal RFC. As a result,
4536 * you should always ensure that you write your Uri with these elements
4537 * using lower case letters, and normalize any Uris you receive from
4538 * outside of Android to ensure the scheme and host is lower case.</em></p>
4539 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004540 * @param action The Intent action, such as ACTION_VIEW.
4541 * @param uri The Intent data URI.
4542 */
4543 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004544 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004545 mData = uri;
4546 }
4547
4548 /**
4549 * Create an intent for a specific component. All other fields (action, data,
4550 * type, class) are null, though they can be modified later with explicit
4551 * calls. This provides a convenient way to create an intent that is
4552 * intended to execute a hard-coded class name, rather than relying on the
4553 * system to find an appropriate class for you; see {@link #setComponent}
4554 * for more information on the repercussions of this.
4555 *
4556 * @param packageContext A Context of the application package implementing
4557 * this class.
4558 * @param cls The component class that is to be used for the intent.
4559 *
4560 * @see #setClass
4561 * @see #setComponent
4562 * @see #Intent(String, android.net.Uri , Context, Class)
4563 */
4564 public Intent(Context packageContext, Class<?> cls) {
4565 mComponent = new ComponentName(packageContext, cls);
4566 }
4567
4568 /**
4569 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004570 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004571 * construct the Intent and then calling {@link #setClass} to set its
4572 * class.
4573 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004574 * <p><em>Note: scheme and host name matching in the Android framework is
4575 * case-sensitive, unlike the formal RFC. As a result,
4576 * you should always ensure that you write your Uri with these elements
4577 * using lower case letters, and normalize any Uris you receive from
4578 * outside of Android to ensure the scheme and host is lower case.</em></p>
4579 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004580 * @param action The Intent action, such as ACTION_VIEW.
4581 * @param uri The Intent data URI.
4582 * @param packageContext A Context of the application package implementing
4583 * this class.
4584 * @param cls The component class that is to be used for the intent.
4585 *
4586 * @see #Intent(String, android.net.Uri)
4587 * @see #Intent(Context, Class)
4588 * @see #setClass
4589 * @see #setComponent
4590 */
4591 public Intent(String action, Uri uri,
4592 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004593 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004594 mData = uri;
4595 mComponent = new ComponentName(packageContext, cls);
4596 }
4597
4598 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004599 * Create an intent to launch the main (root) activity of a task. This
4600 * is the Intent that is started when the application's is launched from
4601 * Home. For anything else that wants to launch an application in the
4602 * same way, it is important that they use an Intent structured the same
4603 * way, and can use this function to ensure this is the case.
4604 *
4605 * <p>The returned Intent has the given Activity component as its explicit
4606 * component, {@link #ACTION_MAIN} as its action, and includes the
4607 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4608 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4609 * to do that through {@link #addFlags(int)} on the returned Intent.
4610 *
4611 * @param mainActivity The main activity component that this Intent will
4612 * launch.
4613 * @return Returns a newly created Intent that can be used to launch the
4614 * activity as a main application entry.
4615 *
4616 * @see #setClass
4617 * @see #setComponent
4618 */
4619 public static Intent makeMainActivity(ComponentName mainActivity) {
4620 Intent intent = new Intent(ACTION_MAIN);
4621 intent.setComponent(mainActivity);
4622 intent.addCategory(CATEGORY_LAUNCHER);
4623 return intent;
4624 }
4625
4626 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004627 * Make an Intent for the main activity of an application, without
4628 * specifying a specific activity to run but giving a selector to find
4629 * the activity. This results in a final Intent that is structured
4630 * the same as when the application is launched from
4631 * Home. For anything else that wants to launch an application in the
4632 * same way, it is important that they use an Intent structured the same
4633 * way, and can use this function to ensure this is the case.
4634 *
4635 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4636 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4637 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4638 * to do that through {@link #addFlags(int)} on the returned Intent.
4639 *
4640 * @param selectorAction The action name of the Intent's selector.
4641 * @param selectorCategory The name of a category to add to the Intent's
4642 * selector.
4643 * @return Returns a newly created Intent that can be used to launch the
4644 * activity as a main application entry.
4645 *
4646 * @see #setSelector(Intent)
4647 */
4648 public static Intent makeMainSelectorActivity(String selectorAction,
4649 String selectorCategory) {
4650 Intent intent = new Intent(ACTION_MAIN);
4651 intent.addCategory(CATEGORY_LAUNCHER);
4652 Intent selector = new Intent();
4653 selector.setAction(selectorAction);
4654 selector.addCategory(selectorCategory);
4655 intent.setSelector(selector);
4656 return intent;
4657 }
4658
4659 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004660 * Make an Intent that can be used to re-launch an application's task
4661 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4662 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4663 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4664 *
4665 * @param mainActivity The activity component that is the root of the
4666 * task; this is the activity that has been published in the application's
4667 * manifest as the main launcher icon.
4668 *
4669 * @return Returns a newly created Intent that can be used to relaunch the
4670 * activity's task in its root state.
4671 */
4672 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4673 Intent intent = makeMainActivity(mainActivity);
4674 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4675 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4676 return intent;
4677 }
4678
4679 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004680 * Call {@link #parseUri} with 0 flags.
4681 * @deprecated Use {@link #parseUri} instead.
4682 */
4683 @Deprecated
4684 public static Intent getIntent(String uri) throws URISyntaxException {
4685 return parseUri(uri, 0);
4686 }
Tom Taylord4a47292009-12-21 13:59:18 -08004687
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004688 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004689 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004690 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004691 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004692 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004693 *
4694 * <p>The URI given here must not be relative -- that is, it must include
4695 * the scheme and full path.
4696 *
4697 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004698 * @param flags Additional processing flags. Either 0,
4699 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004700 *
4701 * @return Intent The newly created Intent object.
4702 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004703 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4704 * it bad (as parsed by the Uri class) or the Intent data within the
4705 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004706 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004707 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004708 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004709 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004710 int i = 0;
4711 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004712 final boolean androidApp = uri.startsWith("android-app:");
4713
4714 // Validate intent scheme if requested.
4715 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
4716 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004717 Intent intent = new Intent(ACTION_VIEW);
4718 try {
4719 intent.setData(Uri.parse(uri));
4720 } catch (IllegalArgumentException e) {
4721 throw new URISyntaxException(uri, e.getMessage());
4722 }
4723 return intent;
4724 }
4725 }
Tom Taylord4a47292009-12-21 13:59:18 -08004726
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004727 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004728 // simple case
4729 if (i == -1) {
4730 if (!androidApp) {
4731 return new Intent(ACTION_VIEW, Uri.parse(uri));
4732 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004733
4734 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004735 } else if (!uri.startsWith("#Intent;", i)) {
4736 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004737 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004738 } else {
4739 i = -1;
4740 }
4741 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004742
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004743 // new format
4744 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004745 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004746 boolean explicitAction = false;
4747 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004748
4749 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004750 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004751 String data;
4752 if (i >= 0) {
4753 data = uri.substring(0, i);
4754 i += 8; // length of "#Intent;"
4755 } else {
4756 data = uri;
4757 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004758
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004759 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004760 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004761 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004762 if (eq < 0) eq = i-1;
4763 int semi = uri.indexOf(';', i);
4764 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004765
4766 // action
4767 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004768 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004769 if (!inSelector) {
4770 explicitAction = true;
4771 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004772 }
4773
4774 // categories
4775 else if (uri.startsWith("category=", i)) {
4776 intent.addCategory(value);
4777 }
4778
4779 // type
4780 else if (uri.startsWith("type=", i)) {
4781 intent.mType = value;
4782 }
4783
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004784 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004785 else if (uri.startsWith("launchFlags=", i)) {
4786 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004787 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4788 intent.mFlags &= ~IMMUTABLE_FLAGS;
4789 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004790 }
4791
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004792 // package
4793 else if (uri.startsWith("package=", i)) {
4794 intent.mPackage = value;
4795 }
4796
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004797 // component
4798 else if (uri.startsWith("component=", i)) {
4799 intent.mComponent = ComponentName.unflattenFromString(value);
4800 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004801
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004802 // scheme
4803 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004804 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004805 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004806 } else {
4807 scheme = value;
4808 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004809 }
4810
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004811 // source bounds
4812 else if (uri.startsWith("sourceBounds=", i)) {
4813 intent.mSourceBounds = Rect.unflattenFromString(value);
4814 }
4815
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004816 // selector
4817 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4818 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004819 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004820 }
4821
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004822 // extra
4823 else {
4824 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004825 // create Bundle if it doesn't already exist
4826 if (intent.mExtras == null) intent.mExtras = new Bundle();
4827 Bundle b = intent.mExtras;
4828 // add EXTRA
4829 if (uri.startsWith("S.", i)) b.putString(key, value);
4830 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4831 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4832 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4833 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4834 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4835 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4836 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4837 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4838 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4839 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004840
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004841 // move to the next item
4842 i = semi + 1;
4843 }
4844
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004845 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004846 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004847 if (baseIntent.mPackage == null) {
4848 baseIntent.setSelector(intent);
4849 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004850 intent = baseIntent;
4851 }
4852
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004853 if (data != null) {
4854 if (data.startsWith("intent:")) {
4855 data = data.substring(7);
4856 if (scheme != null) {
4857 data = scheme + ':' + data;
4858 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004859 } else if (data.startsWith("android-app:")) {
4860 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
4861 // Correctly formed android-app, first part is package name.
4862 int end = data.indexOf('/', 14);
4863 if (end < 0) {
4864 // All we have is a package name.
4865 intent.mPackage = data.substring(14);
4866 if (!explicitAction) {
4867 intent.setAction(ACTION_MAIN);
4868 }
4869 data = "";
4870 } else {
4871 // Target the Intent at the given package name always.
4872 String authority = null;
4873 intent.mPackage = data.substring(14, end);
4874 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004875 if ((end+1) < data.length()) {
4876 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
4877 // Found a scheme, remember it.
4878 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004879 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08004880 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
4881 // Found a authority, remember it.
4882 authority = data.substring(end+1, newEnd);
4883 end = newEnd;
4884 }
4885 } else {
4886 // All we have is a scheme.
4887 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004888 }
4889 }
4890 if (scheme == null) {
4891 // If there was no scheme, then this just targets the package.
4892 if (!explicitAction) {
4893 intent.setAction(ACTION_MAIN);
4894 }
4895 data = "";
4896 } else if (authority == null) {
4897 data = scheme + ":";
4898 } else {
4899 data = scheme + "://" + authority + data.substring(end);
4900 }
4901 }
4902 } else {
4903 data = "";
4904 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004905 }
Tom Taylord4a47292009-12-21 13:59:18 -08004906
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004907 if (data.length() > 0) {
4908 try {
4909 intent.mData = Uri.parse(data);
4910 } catch (IllegalArgumentException e) {
4911 throw new URISyntaxException(uri, e.getMessage());
4912 }
4913 }
4914 }
Tom Taylord4a47292009-12-21 13:59:18 -08004915
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004916 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004917
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004918 } catch (IndexOutOfBoundsException e) {
4919 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4920 }
4921 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004922
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004923 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004924 return getIntentOld(uri, 0);
4925 }
4926
4927 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004928 Intent intent;
4929
4930 int i = uri.lastIndexOf('#');
4931 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004932 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004933 final int intentFragmentStart = i;
4934 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004935
4936 i++;
4937
4938 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004939 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004940 i += 7;
4941 int j = uri.indexOf(')', i);
4942 action = uri.substring(i, j);
4943 i = j + 1;
4944 }
4945
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004946 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004947
4948 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004949 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004950 i += 11;
4951 int j = uri.indexOf(')', i);
4952 while (i < j) {
4953 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07004954 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004955 if (i < sep) {
4956 intent.addCategory(uri.substring(i, sep));
4957 }
4958 i = sep + 1;
4959 }
4960 i = j + 1;
4961 }
4962
4963 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004964 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004965 i += 5;
4966 int j = uri.indexOf(')', i);
4967 intent.mType = uri.substring(i, j);
4968 i = j + 1;
4969 }
4970
4971 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004972 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004973 i += 12;
4974 int j = uri.indexOf(')', i);
4975 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004976 if ((flags& URI_ALLOW_UNSAFE) == 0) {
4977 intent.mFlags &= ~IMMUTABLE_FLAGS;
4978 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004979 i = j + 1;
4980 }
4981
4982 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004983 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004984 i += 10;
4985 int j = uri.indexOf(')', i);
4986 int sep = uri.indexOf('!', i);
4987 if (sep >= 0 && sep < j) {
4988 String pkg = uri.substring(i, sep);
4989 String cls = uri.substring(sep + 1, j);
4990 intent.mComponent = new ComponentName(pkg, cls);
4991 }
4992 i = j + 1;
4993 }
4994
4995 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004996 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004997 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004998
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004999 final int closeParen = uri.indexOf(')', i);
5000 if (closeParen == -1) throw new URISyntaxException(uri,
5001 "EXTRA missing trailing ')'", i);
5002
5003 while (i < closeParen) {
5004 // fetch the key value
5005 int j = uri.indexOf('=', i);
5006 if (j <= i + 1 || i >= closeParen) {
5007 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5008 }
5009 char type = uri.charAt(i);
5010 i++;
5011 String key = uri.substring(i, j);
5012 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005013
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005014 // get type-value
5015 j = uri.indexOf('!', i);
5016 if (j == -1 || j >= closeParen) j = closeParen;
5017 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5018 String value = uri.substring(i, j);
5019 i = j;
5020
5021 // create Bundle if it doesn't already exist
5022 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005023
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005024 // add item to bundle
5025 try {
5026 switch (type) {
5027 case 'S':
5028 intent.mExtras.putString(key, Uri.decode(value));
5029 break;
5030 case 'B':
5031 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5032 break;
5033 case 'b':
5034 intent.mExtras.putByte(key, Byte.parseByte(value));
5035 break;
5036 case 'c':
5037 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5038 break;
5039 case 'd':
5040 intent.mExtras.putDouble(key, Double.parseDouble(value));
5041 break;
5042 case 'f':
5043 intent.mExtras.putFloat(key, Float.parseFloat(value));
5044 break;
5045 case 'i':
5046 intent.mExtras.putInt(key, Integer.parseInt(value));
5047 break;
5048 case 'l':
5049 intent.mExtras.putLong(key, Long.parseLong(value));
5050 break;
5051 case 's':
5052 intent.mExtras.putShort(key, Short.parseShort(value));
5053 break;
5054 default:
5055 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5056 }
5057 } catch (NumberFormatException e) {
5058 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5059 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005060
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005061 char ch = uri.charAt(i);
5062 if (ch == ')') break;
5063 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5064 i++;
5065 }
5066 }
5067
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005068 if (isIntentFragment) {
5069 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5070 } else {
5071 intent.mData = Uri.parse(uri);
5072 }
Tom Taylord4a47292009-12-21 13:59:18 -08005073
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005074 if (intent.mAction == null) {
5075 // By default, if no action is specified, then use VIEW.
5076 intent.mAction = ACTION_VIEW;
5077 }
5078
5079 } else {
5080 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5081 }
5082
5083 return intent;
5084 }
5085
5086 /**
5087 * Retrieve the general action to be performed, such as
5088 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5089 * the information in the intent should be interpreted -- most importantly,
5090 * what to do with the data returned by {@link #getData}.
5091 *
5092 * @return The action of this intent or null if none is specified.
5093 *
5094 * @see #setAction
5095 */
5096 public String getAction() {
5097 return mAction;
5098 }
5099
5100 /**
5101 * Retrieve data this intent is operating on. This URI specifies the name
5102 * of the data; often it uses the content: scheme, specifying data in a
5103 * content provider. Other schemes may be handled by specific activities,
5104 * such as http: by the web browser.
5105 *
5106 * @return The URI of the data this intent is targeting or null.
5107 *
5108 * @see #getScheme
5109 * @see #setData
5110 */
5111 public Uri getData() {
5112 return mData;
5113 }
5114
5115 /**
5116 * The same as {@link #getData()}, but returns the URI as an encoded
5117 * String.
5118 */
5119 public String getDataString() {
5120 return mData != null ? mData.toString() : null;
5121 }
5122
5123 /**
5124 * Return the scheme portion of the intent's data. If the data is null or
5125 * does not include a scheme, null is returned. Otherwise, the scheme
5126 * prefix without the final ':' is returned, i.e. "http".
5127 *
5128 * <p>This is the same as calling getData().getScheme() (and checking for
5129 * null data).
5130 *
5131 * @return The scheme of this intent.
5132 *
5133 * @see #getData
5134 */
5135 public String getScheme() {
5136 return mData != null ? mData.getScheme() : null;
5137 }
5138
5139 /**
5140 * Retrieve any explicit MIME type included in the intent. This is usually
5141 * null, as the type is determined by the intent data.
5142 *
5143 * @return If a type was manually set, it is returned; else null is
5144 * returned.
5145 *
5146 * @see #resolveType(ContentResolver)
5147 * @see #setType
5148 */
5149 public String getType() {
5150 return mType;
5151 }
5152
5153 /**
5154 * Return the MIME data type of this intent. If the type field is
5155 * explicitly set, that is simply returned. Otherwise, if the data is set,
5156 * the type of that data is returned. If neither fields are set, a null is
5157 * returned.
5158 *
5159 * @return The MIME type of this intent.
5160 *
5161 * @see #getType
5162 * @see #resolveType(ContentResolver)
5163 */
5164 public String resolveType(Context context) {
5165 return resolveType(context.getContentResolver());
5166 }
5167
5168 /**
5169 * Return the MIME data type of this intent. If the type field is
5170 * explicitly set, that is simply returned. Otherwise, if the data is set,
5171 * the type of that data is returned. If neither fields are set, a null is
5172 * returned.
5173 *
5174 * @param resolver A ContentResolver that can be used to determine the MIME
5175 * type of the intent's data.
5176 *
5177 * @return The MIME type of this intent.
5178 *
5179 * @see #getType
5180 * @see #resolveType(Context)
5181 */
5182 public String resolveType(ContentResolver resolver) {
5183 if (mType != null) {
5184 return mType;
5185 }
5186 if (mData != null) {
5187 if ("content".equals(mData.getScheme())) {
5188 return resolver.getType(mData);
5189 }
5190 }
5191 return null;
5192 }
5193
5194 /**
5195 * Return the MIME data type of this intent, only if it will be needed for
5196 * intent resolution. This is not generally useful for application code;
5197 * it is used by the frameworks for communicating with back-end system
5198 * services.
5199 *
5200 * @param resolver A ContentResolver that can be used to determine the MIME
5201 * type of the intent's data.
5202 *
5203 * @return The MIME type of this intent, or null if it is unknown or not
5204 * needed.
5205 */
5206 public String resolveTypeIfNeeded(ContentResolver resolver) {
5207 if (mComponent != null) {
5208 return mType;
5209 }
5210 return resolveType(resolver);
5211 }
5212
5213 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005214 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005215 *
5216 * @param category The category to check.
5217 *
5218 * @return boolean True if the intent contains the category, else false.
5219 *
5220 * @see #getCategories
5221 * @see #addCategory
5222 */
5223 public boolean hasCategory(String category) {
5224 return mCategories != null && mCategories.contains(category);
5225 }
5226
5227 /**
5228 * Return the set of all categories in the intent. If there are no categories,
5229 * returns NULL.
5230 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005231 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005232 *
5233 * @see #hasCategory
5234 * @see #addCategory
5235 */
5236 public Set<String> getCategories() {
5237 return mCategories;
5238 }
5239
5240 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005241 * Return the specific selector associated with this Intent. If there is
5242 * none, returns null. See {@link #setSelector} for more information.
5243 *
5244 * @see #setSelector
5245 */
5246 public Intent getSelector() {
5247 return mSelector;
5248 }
5249
5250 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005251 * Return the {@link ClipData} associated with this Intent. If there is
5252 * none, returns null. See {@link #setClipData} for more information.
5253 *
John Spurlock125d1332013-11-25 11:58:37 -05005254 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005255 */
5256 public ClipData getClipData() {
5257 return mClipData;
5258 }
5259
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005260 /** @hide */
5261 public int getContentUserHint() {
5262 return mContentUserHint;
5263 }
5264
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005265 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005266 * Sets the ClassLoader that will be used when unmarshalling
5267 * any Parcelable values from the extras of this Intent.
5268 *
5269 * @param loader a ClassLoader, or null to use the default loader
5270 * at the time of unmarshalling.
5271 */
5272 public void setExtrasClassLoader(ClassLoader loader) {
5273 if (mExtras != null) {
5274 mExtras.setClassLoader(loader);
5275 }
5276 }
5277
5278 /**
5279 * Returns true if an extra value is associated with the given name.
5280 * @param name the extra's name
5281 * @return true if the given extra is present.
5282 */
5283 public boolean hasExtra(String name) {
5284 return mExtras != null && mExtras.containsKey(name);
5285 }
5286
5287 /**
5288 * Returns true if the Intent's extras contain a parcelled file descriptor.
5289 * @return true if the Intent contains a parcelled file descriptor.
5290 */
5291 public boolean hasFileDescriptors() {
5292 return mExtras != null && mExtras.hasFileDescriptors();
5293 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005294
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04005295 /** @hide */
5296 public void setAllowFds(boolean allowFds) {
5297 if (mExtras != null) {
5298 mExtras.setAllowFds(allowFds);
5299 }
5300 }
5301
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005302 /**
5303 * Retrieve extended data from the intent.
5304 *
5305 * @param name The name of the desired item.
5306 *
5307 * @return the value of an item that previously added with putExtra()
5308 * or null if none was found.
5309 *
5310 * @deprecated
5311 * @hide
5312 */
5313 @Deprecated
5314 public Object getExtra(String name) {
5315 return getExtra(name, null);
5316 }
5317
5318 /**
5319 * Retrieve extended data from the intent.
5320 *
5321 * @param name The name of the desired item.
5322 * @param defaultValue the value to be returned if no value of the desired
5323 * type is stored with the given name.
5324 *
5325 * @return the value of an item that previously added with putExtra()
5326 * or the default value if none was found.
5327 *
5328 * @see #putExtra(String, boolean)
5329 */
5330 public boolean getBooleanExtra(String name, boolean defaultValue) {
5331 return mExtras == null ? defaultValue :
5332 mExtras.getBoolean(name, defaultValue);
5333 }
5334
5335 /**
5336 * Retrieve extended data from the intent.
5337 *
5338 * @param name The name of the desired item.
5339 * @param defaultValue the value to be returned if no value of the desired
5340 * type is stored with the given name.
5341 *
5342 * @return the value of an item that previously added with putExtra()
5343 * or the default value if none was found.
5344 *
5345 * @see #putExtra(String, byte)
5346 */
5347 public byte getByteExtra(String name, byte defaultValue) {
5348 return mExtras == null ? defaultValue :
5349 mExtras.getByte(name, defaultValue);
5350 }
5351
5352 /**
5353 * Retrieve extended data from the intent.
5354 *
5355 * @param name The name of the desired item.
5356 * @param defaultValue the value to be returned if no value of the desired
5357 * type is stored with the given name.
5358 *
5359 * @return the value of an item that previously added with putExtra()
5360 * or the default value if none was found.
5361 *
5362 * @see #putExtra(String, short)
5363 */
5364 public short getShortExtra(String name, short defaultValue) {
5365 return mExtras == null ? defaultValue :
5366 mExtras.getShort(name, defaultValue);
5367 }
5368
5369 /**
5370 * Retrieve extended data from the intent.
5371 *
5372 * @param name The name of the desired item.
5373 * @param defaultValue the value to be returned if no value of the desired
5374 * type is stored with the given name.
5375 *
5376 * @return the value of an item that previously added with putExtra()
5377 * or the default value if none was found.
5378 *
5379 * @see #putExtra(String, char)
5380 */
5381 public char getCharExtra(String name, char defaultValue) {
5382 return mExtras == null ? defaultValue :
5383 mExtras.getChar(name, defaultValue);
5384 }
5385
5386 /**
5387 * Retrieve extended data from the intent.
5388 *
5389 * @param name The name of the desired item.
5390 * @param defaultValue the value to be returned if no value of the desired
5391 * type is stored with the given name.
5392 *
5393 * @return the value of an item that previously added with putExtra()
5394 * or the default value if none was found.
5395 *
5396 * @see #putExtra(String, int)
5397 */
5398 public int getIntExtra(String name, int defaultValue) {
5399 return mExtras == null ? defaultValue :
5400 mExtras.getInt(name, defaultValue);
5401 }
5402
5403 /**
5404 * Retrieve extended data from the intent.
5405 *
5406 * @param name The name of the desired item.
5407 * @param defaultValue the value to be returned if no value of the desired
5408 * type is stored with the given name.
5409 *
5410 * @return the value of an item that previously added with putExtra()
5411 * or the default value if none was found.
5412 *
5413 * @see #putExtra(String, long)
5414 */
5415 public long getLongExtra(String name, long defaultValue) {
5416 return mExtras == null ? defaultValue :
5417 mExtras.getLong(name, defaultValue);
5418 }
5419
5420 /**
5421 * Retrieve extended data from the intent.
5422 *
5423 * @param name The name of the desired item.
5424 * @param defaultValue the value to be returned if no value of the desired
5425 * type is stored with the given name.
5426 *
5427 * @return the value of an item that previously added with putExtra(),
5428 * or the default value if no such item is present
5429 *
5430 * @see #putExtra(String, float)
5431 */
5432 public float getFloatExtra(String name, float defaultValue) {
5433 return mExtras == null ? defaultValue :
5434 mExtras.getFloat(name, defaultValue);
5435 }
5436
5437 /**
5438 * Retrieve extended data from the intent.
5439 *
5440 * @param name The name of the desired item.
5441 * @param defaultValue the value to be returned if no value of the desired
5442 * type is stored with the given name.
5443 *
5444 * @return the value of an item that previously added with putExtra()
5445 * or the default value if none was found.
5446 *
5447 * @see #putExtra(String, double)
5448 */
5449 public double getDoubleExtra(String name, double defaultValue) {
5450 return mExtras == null ? defaultValue :
5451 mExtras.getDouble(name, defaultValue);
5452 }
5453
5454 /**
5455 * Retrieve extended data from the intent.
5456 *
5457 * @param name The name of the desired item.
5458 *
5459 * @return the value of an item that previously added with putExtra()
5460 * or null if no String value was found.
5461 *
5462 * @see #putExtra(String, String)
5463 */
5464 public String getStringExtra(String name) {
5465 return mExtras == null ? null : mExtras.getString(name);
5466 }
5467
5468 /**
5469 * Retrieve extended data from the intent.
5470 *
5471 * @param name The name of the desired item.
5472 *
5473 * @return the value of an item that previously added with putExtra()
5474 * or null if no CharSequence value was found.
5475 *
5476 * @see #putExtra(String, CharSequence)
5477 */
5478 public CharSequence getCharSequenceExtra(String name) {
5479 return mExtras == null ? null : mExtras.getCharSequence(name);
5480 }
5481
5482 /**
5483 * Retrieve extended data from the intent.
5484 *
5485 * @param name The name of the desired item.
5486 *
5487 * @return the value of an item that previously added with putExtra()
5488 * or null if no Parcelable value was found.
5489 *
5490 * @see #putExtra(String, Parcelable)
5491 */
5492 public <T extends Parcelable> T getParcelableExtra(String name) {
5493 return mExtras == null ? null : mExtras.<T>getParcelable(name);
5494 }
5495
5496 /**
5497 * Retrieve extended data from the intent.
5498 *
5499 * @param name The name of the desired item.
5500 *
5501 * @return the value of an item that previously added with putExtra()
5502 * or null if no Parcelable[] value was found.
5503 *
5504 * @see #putExtra(String, Parcelable[])
5505 */
5506 public Parcelable[] getParcelableArrayExtra(String name) {
5507 return mExtras == null ? null : mExtras.getParcelableArray(name);
5508 }
5509
5510 /**
5511 * Retrieve extended data from the intent.
5512 *
5513 * @param name The name of the desired item.
5514 *
5515 * @return the value of an item that previously added with putExtra()
5516 * or null if no ArrayList<Parcelable> value was found.
5517 *
5518 * @see #putParcelableArrayListExtra(String, ArrayList)
5519 */
5520 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
5521 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
5522 }
5523
5524 /**
5525 * Retrieve extended data from the intent.
5526 *
5527 * @param name The name of the desired item.
5528 *
5529 * @return the value of an item that previously added with putExtra()
5530 * or null if no Serializable value was found.
5531 *
5532 * @see #putExtra(String, Serializable)
5533 */
5534 public Serializable getSerializableExtra(String name) {
5535 return mExtras == null ? null : mExtras.getSerializable(name);
5536 }
5537
5538 /**
5539 * Retrieve extended data from the intent.
5540 *
5541 * @param name The name of the desired item.
5542 *
5543 * @return the value of an item that previously added with putExtra()
5544 * or null if no ArrayList<Integer> value was found.
5545 *
5546 * @see #putIntegerArrayListExtra(String, ArrayList)
5547 */
5548 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
5549 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
5550 }
5551
5552 /**
5553 * Retrieve extended data from the intent.
5554 *
5555 * @param name The name of the desired item.
5556 *
5557 * @return the value of an item that previously added with putExtra()
5558 * or null if no ArrayList<String> value was found.
5559 *
5560 * @see #putStringArrayListExtra(String, ArrayList)
5561 */
5562 public ArrayList<String> getStringArrayListExtra(String name) {
5563 return mExtras == null ? null : mExtras.getStringArrayList(name);
5564 }
5565
5566 /**
5567 * Retrieve extended data from the intent.
5568 *
5569 * @param name The name of the desired item.
5570 *
5571 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005572 * or null if no ArrayList<CharSequence> value was found.
5573 *
5574 * @see #putCharSequenceArrayListExtra(String, ArrayList)
5575 */
5576 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
5577 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
5578 }
5579
5580 /**
5581 * Retrieve extended data from the intent.
5582 *
5583 * @param name The name of the desired item.
5584 *
5585 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005586 * or null if no boolean array value was found.
5587 *
5588 * @see #putExtra(String, boolean[])
5589 */
5590 public boolean[] getBooleanArrayExtra(String name) {
5591 return mExtras == null ? null : mExtras.getBooleanArray(name);
5592 }
5593
5594 /**
5595 * Retrieve extended data from the intent.
5596 *
5597 * @param name The name of the desired item.
5598 *
5599 * @return the value of an item that previously added with putExtra()
5600 * or null if no byte array value was found.
5601 *
5602 * @see #putExtra(String, byte[])
5603 */
5604 public byte[] getByteArrayExtra(String name) {
5605 return mExtras == null ? null : mExtras.getByteArray(name);
5606 }
5607
5608 /**
5609 * Retrieve extended data from the intent.
5610 *
5611 * @param name The name of the desired item.
5612 *
5613 * @return the value of an item that previously added with putExtra()
5614 * or null if no short array value was found.
5615 *
5616 * @see #putExtra(String, short[])
5617 */
5618 public short[] getShortArrayExtra(String name) {
5619 return mExtras == null ? null : mExtras.getShortArray(name);
5620 }
5621
5622 /**
5623 * Retrieve extended data from the intent.
5624 *
5625 * @param name The name of the desired item.
5626 *
5627 * @return the value of an item that previously added with putExtra()
5628 * or null if no char array value was found.
5629 *
5630 * @see #putExtra(String, char[])
5631 */
5632 public char[] getCharArrayExtra(String name) {
5633 return mExtras == null ? null : mExtras.getCharArray(name);
5634 }
5635
5636 /**
5637 * Retrieve extended data from the intent.
5638 *
5639 * @param name The name of the desired item.
5640 *
5641 * @return the value of an item that previously added with putExtra()
5642 * or null if no int array value was found.
5643 *
5644 * @see #putExtra(String, int[])
5645 */
5646 public int[] getIntArrayExtra(String name) {
5647 return mExtras == null ? null : mExtras.getIntArray(name);
5648 }
5649
5650 /**
5651 * Retrieve extended data from the intent.
5652 *
5653 * @param name The name of the desired item.
5654 *
5655 * @return the value of an item that previously added with putExtra()
5656 * or null if no long array value was found.
5657 *
5658 * @see #putExtra(String, long[])
5659 */
5660 public long[] getLongArrayExtra(String name) {
5661 return mExtras == null ? null : mExtras.getLongArray(name);
5662 }
5663
5664 /**
5665 * Retrieve extended data from the intent.
5666 *
5667 * @param name The name of the desired item.
5668 *
5669 * @return the value of an item that previously added with putExtra()
5670 * or null if no float array value was found.
5671 *
5672 * @see #putExtra(String, float[])
5673 */
5674 public float[] getFloatArrayExtra(String name) {
5675 return mExtras == null ? null : mExtras.getFloatArray(name);
5676 }
5677
5678 /**
5679 * Retrieve extended data from the intent.
5680 *
5681 * @param name The name of the desired item.
5682 *
5683 * @return the value of an item that previously added with putExtra()
5684 * or null if no double array value was found.
5685 *
5686 * @see #putExtra(String, double[])
5687 */
5688 public double[] getDoubleArrayExtra(String name) {
5689 return mExtras == null ? null : mExtras.getDoubleArray(name);
5690 }
5691
5692 /**
5693 * Retrieve extended data from the intent.
5694 *
5695 * @param name The name of the desired item.
5696 *
5697 * @return the value of an item that previously added with putExtra()
5698 * or null if no String array value was found.
5699 *
5700 * @see #putExtra(String, String[])
5701 */
5702 public String[] getStringArrayExtra(String name) {
5703 return mExtras == null ? null : mExtras.getStringArray(name);
5704 }
5705
5706 /**
5707 * Retrieve extended data from the intent.
5708 *
5709 * @param name The name of the desired item.
5710 *
5711 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005712 * or null if no CharSequence array value was found.
5713 *
5714 * @see #putExtra(String, CharSequence[])
5715 */
5716 public CharSequence[] getCharSequenceArrayExtra(String name) {
5717 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5718 }
5719
5720 /**
5721 * Retrieve extended data from the intent.
5722 *
5723 * @param name The name of the desired item.
5724 *
5725 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005726 * or null if no Bundle value was found.
5727 *
5728 * @see #putExtra(String, Bundle)
5729 */
5730 public Bundle getBundleExtra(String name) {
5731 return mExtras == null ? null : mExtras.getBundle(name);
5732 }
5733
5734 /**
5735 * Retrieve extended data from the intent.
5736 *
5737 * @param name The name of the desired item.
5738 *
5739 * @return the value of an item that previously added with putExtra()
5740 * or null if no IBinder value was found.
5741 *
5742 * @see #putExtra(String, IBinder)
5743 *
5744 * @deprecated
5745 * @hide
5746 */
5747 @Deprecated
5748 public IBinder getIBinderExtra(String name) {
5749 return mExtras == null ? null : mExtras.getIBinder(name);
5750 }
5751
5752 /**
5753 * Retrieve extended data from the intent.
5754 *
5755 * @param name The name of the desired item.
5756 * @param defaultValue The default value to return in case no item is
5757 * associated with the key 'name'
5758 *
5759 * @return the value of an item that previously added with putExtra()
5760 * or defaultValue if none was found.
5761 *
5762 * @see #putExtra
5763 *
5764 * @deprecated
5765 * @hide
5766 */
5767 @Deprecated
5768 public Object getExtra(String name, Object defaultValue) {
5769 Object result = defaultValue;
5770 if (mExtras != null) {
5771 Object result2 = mExtras.get(name);
5772 if (result2 != null) {
5773 result = result2;
5774 }
5775 }
5776
5777 return result;
5778 }
5779
5780 /**
5781 * Retrieves a map of extended data from the intent.
5782 *
5783 * @return the map of all extras previously added with putExtra(),
5784 * or null if none have been added.
5785 */
5786 public Bundle getExtras() {
5787 return (mExtras != null)
5788 ? new Bundle(mExtras)
5789 : null;
5790 }
5791
5792 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07005793 * Filter extras to only basic types.
5794 * @hide
5795 */
5796 public void removeUnsafeExtras() {
5797 if (mExtras != null) {
5798 mExtras.filterValues();
5799 }
5800 }
5801
5802 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005803 * Retrieve any special flags associated with this intent. You will
5804 * normally just set them with {@link #setFlags} and let the system
5805 * take the appropriate action with them.
5806 *
5807 * @return int The currently set flags.
5808 *
5809 * @see #setFlags
5810 */
5811 public int getFlags() {
5812 return mFlags;
5813 }
5814
Dianne Hackborne7f97212011-02-24 14:40:20 -08005815 /** @hide */
5816 public boolean isExcludingStopped() {
5817 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5818 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5819 }
5820
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005821 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005822 * Retrieve the application package name this Intent is limited to. When
5823 * resolving an Intent, if non-null this limits the resolution to only
5824 * components in the given application package.
5825 *
5826 * @return The name of the application package for the Intent.
5827 *
5828 * @see #resolveActivity
5829 * @see #setPackage
5830 */
5831 public String getPackage() {
5832 return mPackage;
5833 }
5834
5835 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005836 * Retrieve the concrete component associated with the intent. When receiving
5837 * an intent, this is the component that was found to best handle it (that is,
5838 * yourself) and will always be non-null; in all other cases it will be
5839 * null unless explicitly set.
5840 *
5841 * @return The name of the application component to handle the intent.
5842 *
5843 * @see #resolveActivity
5844 * @see #setComponent
5845 */
5846 public ComponentName getComponent() {
5847 return mComponent;
5848 }
5849
5850 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005851 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5852 * used as a hint to the receiver for animations and the like. Null means that there
5853 * is no source bounds.
5854 */
5855 public Rect getSourceBounds() {
5856 return mSourceBounds;
5857 }
5858
5859 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005860 * Return the Activity component that should be used to handle this intent.
5861 * The appropriate component is determined based on the information in the
5862 * intent, evaluated as follows:
5863 *
5864 * <p>If {@link #getComponent} returns an explicit class, that is returned
5865 * without any further consideration.
5866 *
5867 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5868 * category to be considered.
5869 *
5870 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5871 * action.
5872 *
5873 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5874 * this type.
5875 *
5876 * <p>If {@link #addCategory} has added any categories, the activity must
5877 * handle ALL of the categories specified.
5878 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005879 * <p>If {@link #getPackage} is non-NULL, only activity components in
5880 * that application package will be considered.
5881 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005882 * <p>If there are no activities that satisfy all of these conditions, a
5883 * null string is returned.
5884 *
5885 * <p>If multiple activities are found to satisfy the intent, the one with
5886 * the highest priority will be used. If there are multiple activities
5887 * with the same priority, the system will either pick the best activity
5888 * based on user preference, or resolve to a system class that will allow
5889 * the user to pick an activity and forward from there.
5890 *
5891 * <p>This method is implemented simply by calling
5892 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5893 * true.</p>
5894 * <p> This API is called for you as part of starting an activity from an
5895 * intent. You do not normally need to call it yourself.</p>
5896 *
5897 * @param pm The package manager with which to resolve the Intent.
5898 *
5899 * @return Name of the component implementing an activity that can
5900 * display the intent.
5901 *
5902 * @see #setComponent
5903 * @see #getComponent
5904 * @see #resolveActivityInfo
5905 */
5906 public ComponentName resolveActivity(PackageManager pm) {
5907 if (mComponent != null) {
5908 return mComponent;
5909 }
5910
5911 ResolveInfo info = pm.resolveActivity(
5912 this, PackageManager.MATCH_DEFAULT_ONLY);
5913 if (info != null) {
5914 return new ComponentName(
5915 info.activityInfo.applicationInfo.packageName,
5916 info.activityInfo.name);
5917 }
5918
5919 return null;
5920 }
5921
5922 /**
5923 * Resolve the Intent into an {@link ActivityInfo}
5924 * describing the activity that should execute the intent. Resolution
5925 * follows the same rules as described for {@link #resolveActivity}, but
5926 * you get back the completely information about the resolved activity
5927 * instead of just its class name.
5928 *
5929 * @param pm The package manager with which to resolve the Intent.
5930 * @param flags Addition information to retrieve as per
5931 * {@link PackageManager#getActivityInfo(ComponentName, int)
5932 * PackageManager.getActivityInfo()}.
5933 *
5934 * @return PackageManager.ActivityInfo
5935 *
5936 * @see #resolveActivity
5937 */
5938 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5939 ActivityInfo ai = null;
5940 if (mComponent != null) {
5941 try {
5942 ai = pm.getActivityInfo(mComponent, flags);
5943 } catch (PackageManager.NameNotFoundException e) {
5944 // ignore
5945 }
5946 } else {
5947 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005948 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005949 if (info != null) {
5950 ai = info.activityInfo;
5951 }
5952 }
5953
5954 return ai;
5955 }
5956
5957 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005958 * Special function for use by the system to resolve service
5959 * intents to system apps. Throws an exception if there are
5960 * multiple potential matches to the Intent. Returns null if
5961 * there are no matches.
5962 * @hide
5963 */
5964 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5965 if (mComponent != null) {
5966 return mComponent;
5967 }
5968
5969 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5970 if (results == null) {
5971 return null;
5972 }
5973 ComponentName comp = null;
5974 for (int i=0; i<results.size(); i++) {
5975 ResolveInfo ri = results.get(i);
5976 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5977 continue;
5978 }
5979 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5980 ri.serviceInfo.name);
5981 if (comp != null) {
5982 throw new IllegalStateException("Multiple system services handle " + this
5983 + ": " + comp + ", " + foundComp);
5984 }
5985 comp = foundComp;
5986 }
5987 return comp;
5988 }
5989
5990 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005991 * Set the general action to be performed.
5992 *
5993 * @param action An action name, such as ACTION_VIEW. Application-specific
5994 * actions should be prefixed with the vendor's package name.
5995 *
5996 * @return Returns the same Intent object, for chaining multiple calls
5997 * into a single statement.
5998 *
5999 * @see #getAction
6000 */
6001 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006002 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006003 return this;
6004 }
6005
6006 /**
6007 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006008 * clears any type that was previously set by {@link #setType} or
6009 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006010 *
Nick Pellyccae4122012-01-09 14:12:58 -08006011 * <p><em>Note: scheme matching in the Android framework is
6012 * case-sensitive, unlike the formal RFC. As a result,
6013 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006014 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006015 * {@link #setDataAndNormalize}
6016 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006017 *
Nick Pellyccae4122012-01-09 14:12:58 -08006018 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006019 *
6020 * @return Returns the same Intent object, for chaining multiple calls
6021 * into a single statement.
6022 *
6023 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006024 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006025 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006026 */
6027 public Intent setData(Uri data) {
6028 mData = data;
6029 mType = null;
6030 return this;
6031 }
6032
6033 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006034 * Normalize and set the data this intent is operating on.
6035 *
6036 * <p>This method automatically clears any type that was
6037 * previously set (for example, by {@link #setType}).
6038 *
6039 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006040 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006041 * so really this is just a convenience method for
6042 * <pre>
6043 * setData(data.normalize())
6044 * </pre>
6045 *
6046 * @param data The Uri of the data this intent is now targeting.
6047 *
6048 * @return Returns the same Intent object, for chaining multiple calls
6049 * into a single statement.
6050 *
6051 * @see #getData
6052 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006053 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006054 */
6055 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006056 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006057 }
6058
6059 /**
6060 * Set an explicit MIME data type.
6061 *
6062 * <p>This is used to create intents that only specify a type and not data,
6063 * for example to indicate the type of data to return.
6064 *
6065 * <p>This method automatically clears any data that was
6066 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006067 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006068 * <p><em>Note: MIME type matching in the Android framework is
6069 * case-sensitive, unlike formal RFC MIME types. As a result,
6070 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006071 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6072 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006073 *
6074 * @param type The MIME type of the data being handled by this intent.
6075 *
6076 * @return Returns the same Intent object, for chaining multiple calls
6077 * into a single statement.
6078 *
6079 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006080 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006081 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006082 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006083 */
6084 public Intent setType(String type) {
6085 mData = null;
6086 mType = type;
6087 return this;
6088 }
6089
6090 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006091 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006092 *
Nick Pellyccae4122012-01-09 14:12:58 -08006093 * <p>This is used to create intents that only specify a type and not data,
6094 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006095 *
Nick Pellyccae4122012-01-09 14:12:58 -08006096 * <p>This method automatically clears any data that was
6097 * previously set (for example by {@link #setData}).
6098 *
6099 * <p>The MIME type is normalized using
6100 * {@link #normalizeMimeType} before it is set,
6101 * so really this is just a convenience method for
6102 * <pre>
6103 * setType(Intent.normalizeMimeType(type))
6104 * </pre>
6105 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006106 * @param type The MIME type of the data being handled by this intent.
6107 *
6108 * @return Returns the same Intent object, for chaining multiple calls
6109 * into a single statement.
6110 *
Nick Pellyccae4122012-01-09 14:12:58 -08006111 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006112 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006113 * @see #normalizeMimeType
6114 */
6115 public Intent setTypeAndNormalize(String type) {
6116 return setType(normalizeMimeType(type));
6117 }
6118
6119 /**
6120 * (Usually optional) Set the data for the intent along with an explicit
6121 * MIME data type. This method should very rarely be used -- it allows you
6122 * to override the MIME type that would ordinarily be inferred from the
6123 * data with your own type given here.
6124 *
6125 * <p><em>Note: MIME type and Uri scheme matching in the
6126 * Android framework is case-sensitive, unlike the formal RFC definitions.
6127 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006128 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006129 * {@link #setDataAndTypeAndNormalize}
6130 * to ensure that they are converted to lower case.</em>
6131 *
6132 * @param data The Uri of the data this intent is now targeting.
6133 * @param type The MIME type of the data being handled by this intent.
6134 *
6135 * @return Returns the same Intent object, for chaining multiple calls
6136 * into a single statement.
6137 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006138 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006139 * @see #setData
6140 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006141 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006142 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006143 */
6144 public Intent setDataAndType(Uri data, String type) {
6145 mData = data;
6146 mType = type;
6147 return this;
6148 }
6149
6150 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006151 * (Usually optional) Normalize and set both the data Uri and an explicit
6152 * MIME data type. This method should very rarely be used -- it allows you
6153 * to override the MIME type that would ordinarily be inferred from the
6154 * data with your own type given here.
6155 *
6156 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006157 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006158 * before they are set, so really this is just a convenience method for
6159 * <pre>
6160 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6161 * </pre>
6162 *
6163 * @param data The Uri of the data this intent is now targeting.
6164 * @param type The MIME type of the data being handled by this intent.
6165 *
6166 * @return Returns the same Intent object, for chaining multiple calls
6167 * into a single statement.
6168 *
6169 * @see #setType
6170 * @see #setData
6171 * @see #setDataAndType
6172 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006173 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006174 */
6175 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006176 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006177 }
6178
6179 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006180 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006181 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006182 * activities that provide <em>all</em> of the requested categories will be
6183 * used.
6184 *
6185 * @param category The desired category. This can be either one of the
6186 * predefined Intent categories, or a custom category in your own
6187 * namespace.
6188 *
6189 * @return Returns the same Intent object, for chaining multiple calls
6190 * into a single statement.
6191 *
6192 * @see #hasCategory
6193 * @see #removeCategory
6194 */
6195 public Intent addCategory(String category) {
6196 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006197 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006198 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006199 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006200 return this;
6201 }
6202
6203 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006204 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006205 *
6206 * @param category The category to remove.
6207 *
6208 * @see #addCategory
6209 */
6210 public void removeCategory(String category) {
6211 if (mCategories != null) {
6212 mCategories.remove(category);
6213 if (mCategories.size() == 0) {
6214 mCategories = null;
6215 }
6216 }
6217 }
6218
6219 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006220 * Set a selector for this Intent. This is a modification to the kinds of
6221 * things the Intent will match. If the selector is set, it will be used
6222 * when trying to find entities that can handle the Intent, instead of the
6223 * main contents of the Intent. This allows you build an Intent containing
6224 * a generic protocol while targeting it more specifically.
6225 *
6226 * <p>An example of where this may be used is with things like
6227 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6228 * Intent that will launch the Browser application. However, the correct
6229 * main entry point of an application is actually {@link #ACTION_MAIN}
6230 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
6231 * used to specify the actual Activity to launch. If you launch the browser
6232 * with something different, undesired behavior may happen if the user has
6233 * previously or later launches it the normal way, since they do not match.
6234 * Instead, you can build an Intent with the MAIN action (but no ComponentName
6235 * yet specified) and set a selector with {@link #ACTION_MAIN} and
6236 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
6237 *
6238 * <p>Setting a selector does not impact the behavior of
6239 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
6240 * desired behavior of a selector -- it does not impact the base meaning
6241 * of the Intent, just what kinds of things will be matched against it
6242 * when determining who can handle it.</p>
6243 *
6244 * <p>You can not use both a selector and {@link #setPackage(String)} on
6245 * the same base Intent.</p>
6246 *
6247 * @param selector The desired selector Intent; set to null to not use
6248 * a special selector.
6249 */
6250 public void setSelector(Intent selector) {
6251 if (selector == this) {
6252 throw new IllegalArgumentException(
6253 "Intent being set as a selector of itself");
6254 }
6255 if (selector != null && mPackage != null) {
6256 throw new IllegalArgumentException(
6257 "Can't set selector when package name is already set");
6258 }
6259 mSelector = selector;
6260 }
6261
6262 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006263 * Set a {@link ClipData} associated with this Intent. This replaces any
6264 * previously set ClipData.
6265 *
6266 * <p>The ClipData in an intent is not used for Intent matching or other
6267 * such operations. Semantically it is like extras, used to transmit
6268 * additional data with the Intent. The main feature of using this over
6269 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
6270 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
6271 * items included in the clip data. This is useful, in particular, if
6272 * you want to transmit an Intent containing multiple <code>content:</code>
6273 * URIs for which the recipient may not have global permission to access the
6274 * content provider.
6275 *
6276 * <p>If the ClipData contains items that are themselves Intents, any
6277 * grant flags in those Intents will be ignored. Only the top-level flags
6278 * of the main Intent are respected, and will be applied to all Uri or
6279 * Intent items in the clip (or sub-items of the clip).
6280 *
6281 * <p>The MIME type, label, and icon in the ClipData object are not
6282 * directly used by Intent. Applications should generally rely on the
6283 * MIME type of the Intent itself, not what it may find in the ClipData.
6284 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05006285 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006286 *
6287 * @param clip The new clip to set. May be null to clear the current clip.
6288 */
6289 public void setClipData(ClipData clip) {
6290 mClipData = clip;
6291 }
6292
6293 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006294 * This is NOT a secure mechanism to identify the user who sent the intent.
6295 * When the intent is sent to a different user, it is used to fix uris by adding the userId
6296 * who sent the intent.
6297 * @hide
6298 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01006299 public void prepareToLeaveUser(int userId) {
6300 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
6301 // We want mContentUserHint to refer to the original user, so don't do anything.
6302 if (mContentUserHint == UserHandle.USER_CURRENT) {
6303 mContentUserHint = userId;
6304 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006305 }
6306
6307 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006308 * Add extended data to the intent. The name must include a package
6309 * prefix, for example the app com.android.contacts would use names
6310 * like "com.android.contacts.ShowAll".
6311 *
6312 * @param name The name of the extra data, with package prefix.
6313 * @param value The boolean data value.
6314 *
6315 * @return Returns the same Intent object, for chaining multiple calls
6316 * into a single statement.
6317 *
6318 * @see #putExtras
6319 * @see #removeExtra
6320 * @see #getBooleanExtra(String, boolean)
6321 */
6322 public Intent putExtra(String name, boolean value) {
6323 if (mExtras == null) {
6324 mExtras = new Bundle();
6325 }
6326 mExtras.putBoolean(name, value);
6327 return this;
6328 }
6329
6330 /**
6331 * Add extended data to the intent. The name must include a package
6332 * prefix, for example the app com.android.contacts would use names
6333 * like "com.android.contacts.ShowAll".
6334 *
6335 * @param name The name of the extra data, with package prefix.
6336 * @param value The byte data value.
6337 *
6338 * @return Returns the same Intent object, for chaining multiple calls
6339 * into a single statement.
6340 *
6341 * @see #putExtras
6342 * @see #removeExtra
6343 * @see #getByteExtra(String, byte)
6344 */
6345 public Intent putExtra(String name, byte value) {
6346 if (mExtras == null) {
6347 mExtras = new Bundle();
6348 }
6349 mExtras.putByte(name, value);
6350 return this;
6351 }
6352
6353 /**
6354 * Add extended data to the intent. The name must include a package
6355 * prefix, for example the app com.android.contacts would use names
6356 * like "com.android.contacts.ShowAll".
6357 *
6358 * @param name The name of the extra data, with package prefix.
6359 * @param value The char data value.
6360 *
6361 * @return Returns the same Intent object, for chaining multiple calls
6362 * into a single statement.
6363 *
6364 * @see #putExtras
6365 * @see #removeExtra
6366 * @see #getCharExtra(String, char)
6367 */
6368 public Intent putExtra(String name, char value) {
6369 if (mExtras == null) {
6370 mExtras = new Bundle();
6371 }
6372 mExtras.putChar(name, value);
6373 return this;
6374 }
6375
6376 /**
6377 * Add extended data to the intent. The name must include a package
6378 * prefix, for example the app com.android.contacts would use names
6379 * like "com.android.contacts.ShowAll".
6380 *
6381 * @param name The name of the extra data, with package prefix.
6382 * @param value The short data value.
6383 *
6384 * @return Returns the same Intent object, for chaining multiple calls
6385 * into a single statement.
6386 *
6387 * @see #putExtras
6388 * @see #removeExtra
6389 * @see #getShortExtra(String, short)
6390 */
6391 public Intent putExtra(String name, short value) {
6392 if (mExtras == null) {
6393 mExtras = new Bundle();
6394 }
6395 mExtras.putShort(name, value);
6396 return this;
6397 }
6398
6399 /**
6400 * Add extended data to the intent. The name must include a package
6401 * prefix, for example the app com.android.contacts would use names
6402 * like "com.android.contacts.ShowAll".
6403 *
6404 * @param name The name of the extra data, with package prefix.
6405 * @param value The integer data value.
6406 *
6407 * @return Returns the same Intent object, for chaining multiple calls
6408 * into a single statement.
6409 *
6410 * @see #putExtras
6411 * @see #removeExtra
6412 * @see #getIntExtra(String, int)
6413 */
6414 public Intent putExtra(String name, int value) {
6415 if (mExtras == null) {
6416 mExtras = new Bundle();
6417 }
6418 mExtras.putInt(name, value);
6419 return this;
6420 }
6421
6422 /**
6423 * Add extended data to the intent. The name must include a package
6424 * prefix, for example the app com.android.contacts would use names
6425 * like "com.android.contacts.ShowAll".
6426 *
6427 * @param name The name of the extra data, with package prefix.
6428 * @param value The long data value.
6429 *
6430 * @return Returns the same Intent object, for chaining multiple calls
6431 * into a single statement.
6432 *
6433 * @see #putExtras
6434 * @see #removeExtra
6435 * @see #getLongExtra(String, long)
6436 */
6437 public Intent putExtra(String name, long value) {
6438 if (mExtras == null) {
6439 mExtras = new Bundle();
6440 }
6441 mExtras.putLong(name, value);
6442 return this;
6443 }
6444
6445 /**
6446 * Add extended data to the intent. The name must include a package
6447 * prefix, for example the app com.android.contacts would use names
6448 * like "com.android.contacts.ShowAll".
6449 *
6450 * @param name The name of the extra data, with package prefix.
6451 * @param value The float data value.
6452 *
6453 * @return Returns the same Intent object, for chaining multiple calls
6454 * into a single statement.
6455 *
6456 * @see #putExtras
6457 * @see #removeExtra
6458 * @see #getFloatExtra(String, float)
6459 */
6460 public Intent putExtra(String name, float value) {
6461 if (mExtras == null) {
6462 mExtras = new Bundle();
6463 }
6464 mExtras.putFloat(name, value);
6465 return this;
6466 }
6467
6468 /**
6469 * Add extended data to the intent. The name must include a package
6470 * prefix, for example the app com.android.contacts would use names
6471 * like "com.android.contacts.ShowAll".
6472 *
6473 * @param name The name of the extra data, with package prefix.
6474 * @param value The double data value.
6475 *
6476 * @return Returns the same Intent object, for chaining multiple calls
6477 * into a single statement.
6478 *
6479 * @see #putExtras
6480 * @see #removeExtra
6481 * @see #getDoubleExtra(String, double)
6482 */
6483 public Intent putExtra(String name, double value) {
6484 if (mExtras == null) {
6485 mExtras = new Bundle();
6486 }
6487 mExtras.putDouble(name, value);
6488 return this;
6489 }
6490
6491 /**
6492 * Add extended data to the intent. The name must include a package
6493 * prefix, for example the app com.android.contacts would use names
6494 * like "com.android.contacts.ShowAll".
6495 *
6496 * @param name The name of the extra data, with package prefix.
6497 * @param value The String data value.
6498 *
6499 * @return Returns the same Intent object, for chaining multiple calls
6500 * into a single statement.
6501 *
6502 * @see #putExtras
6503 * @see #removeExtra
6504 * @see #getStringExtra(String)
6505 */
6506 public Intent putExtra(String name, String value) {
6507 if (mExtras == null) {
6508 mExtras = new Bundle();
6509 }
6510 mExtras.putString(name, value);
6511 return this;
6512 }
6513
6514 /**
6515 * Add extended data to the intent. The name must include a package
6516 * prefix, for example the app com.android.contacts would use names
6517 * like "com.android.contacts.ShowAll".
6518 *
6519 * @param name The name of the extra data, with package prefix.
6520 * @param value The CharSequence data value.
6521 *
6522 * @return Returns the same Intent object, for chaining multiple calls
6523 * into a single statement.
6524 *
6525 * @see #putExtras
6526 * @see #removeExtra
6527 * @see #getCharSequenceExtra(String)
6528 */
6529 public Intent putExtra(String name, CharSequence value) {
6530 if (mExtras == null) {
6531 mExtras = new Bundle();
6532 }
6533 mExtras.putCharSequence(name, value);
6534 return this;
6535 }
6536
6537 /**
6538 * Add extended data to the intent. The name must include a package
6539 * prefix, for example the app com.android.contacts would use names
6540 * like "com.android.contacts.ShowAll".
6541 *
6542 * @param name The name of the extra data, with package prefix.
6543 * @param value The Parcelable data value.
6544 *
6545 * @return Returns the same Intent object, for chaining multiple calls
6546 * into a single statement.
6547 *
6548 * @see #putExtras
6549 * @see #removeExtra
6550 * @see #getParcelableExtra(String)
6551 */
6552 public Intent putExtra(String name, Parcelable value) {
6553 if (mExtras == null) {
6554 mExtras = new Bundle();
6555 }
6556 mExtras.putParcelable(name, value);
6557 return this;
6558 }
6559
6560 /**
6561 * Add extended data to the intent. The name must include a package
6562 * prefix, for example the app com.android.contacts would use names
6563 * like "com.android.contacts.ShowAll".
6564 *
6565 * @param name The name of the extra data, with package prefix.
6566 * @param value The Parcelable[] data value.
6567 *
6568 * @return Returns the same Intent object, for chaining multiple calls
6569 * into a single statement.
6570 *
6571 * @see #putExtras
6572 * @see #removeExtra
6573 * @see #getParcelableArrayExtra(String)
6574 */
6575 public Intent putExtra(String name, Parcelable[] value) {
6576 if (mExtras == null) {
6577 mExtras = new Bundle();
6578 }
6579 mExtras.putParcelableArray(name, value);
6580 return this;
6581 }
6582
6583 /**
6584 * Add extended data to the intent. The name must include a package
6585 * prefix, for example the app com.android.contacts would use names
6586 * like "com.android.contacts.ShowAll".
6587 *
6588 * @param name The name of the extra data, with package prefix.
6589 * @param value The ArrayList<Parcelable> data value.
6590 *
6591 * @return Returns the same Intent object, for chaining multiple calls
6592 * into a single statement.
6593 *
6594 * @see #putExtras
6595 * @see #removeExtra
6596 * @see #getParcelableArrayListExtra(String)
6597 */
6598 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
6599 if (mExtras == null) {
6600 mExtras = new Bundle();
6601 }
6602 mExtras.putParcelableArrayList(name, value);
6603 return this;
6604 }
6605
6606 /**
6607 * Add extended data to the intent. The name must include a package
6608 * prefix, for example the app com.android.contacts would use names
6609 * like "com.android.contacts.ShowAll".
6610 *
6611 * @param name The name of the extra data, with package prefix.
6612 * @param value The ArrayList<Integer> data value.
6613 *
6614 * @return Returns the same Intent object, for chaining multiple calls
6615 * into a single statement.
6616 *
6617 * @see #putExtras
6618 * @see #removeExtra
6619 * @see #getIntegerArrayListExtra(String)
6620 */
6621 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
6622 if (mExtras == null) {
6623 mExtras = new Bundle();
6624 }
6625 mExtras.putIntegerArrayList(name, value);
6626 return this;
6627 }
6628
6629 /**
6630 * Add extended data to the intent. The name must include a package
6631 * prefix, for example the app com.android.contacts would use names
6632 * like "com.android.contacts.ShowAll".
6633 *
6634 * @param name The name of the extra data, with package prefix.
6635 * @param value The ArrayList<String> data value.
6636 *
6637 * @return Returns the same Intent object, for chaining multiple calls
6638 * into a single statement.
6639 *
6640 * @see #putExtras
6641 * @see #removeExtra
6642 * @see #getStringArrayListExtra(String)
6643 */
6644 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
6645 if (mExtras == null) {
6646 mExtras = new Bundle();
6647 }
6648 mExtras.putStringArrayList(name, value);
6649 return this;
6650 }
6651
6652 /**
6653 * Add extended data to the intent. The name must include a package
6654 * prefix, for example the app com.android.contacts would use names
6655 * like "com.android.contacts.ShowAll".
6656 *
6657 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006658 * @param value The ArrayList<CharSequence> data value.
6659 *
6660 * @return Returns the same Intent object, for chaining multiple calls
6661 * into a single statement.
6662 *
6663 * @see #putExtras
6664 * @see #removeExtra
6665 * @see #getCharSequenceArrayListExtra(String)
6666 */
6667 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6668 if (mExtras == null) {
6669 mExtras = new Bundle();
6670 }
6671 mExtras.putCharSequenceArrayList(name, value);
6672 return this;
6673 }
6674
6675 /**
6676 * Add extended data to the intent. The name must include a package
6677 * prefix, for example the app com.android.contacts would use names
6678 * like "com.android.contacts.ShowAll".
6679 *
6680 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006681 * @param value The Serializable data value.
6682 *
6683 * @return Returns the same Intent object, for chaining multiple calls
6684 * into a single statement.
6685 *
6686 * @see #putExtras
6687 * @see #removeExtra
6688 * @see #getSerializableExtra(String)
6689 */
6690 public Intent putExtra(String name, Serializable value) {
6691 if (mExtras == null) {
6692 mExtras = new Bundle();
6693 }
6694 mExtras.putSerializable(name, value);
6695 return this;
6696 }
6697
6698 /**
6699 * Add extended data to the intent. The name must include a package
6700 * prefix, for example the app com.android.contacts would use names
6701 * like "com.android.contacts.ShowAll".
6702 *
6703 * @param name The name of the extra data, with package prefix.
6704 * @param value The boolean array data value.
6705 *
6706 * @return Returns the same Intent object, for chaining multiple calls
6707 * into a single statement.
6708 *
6709 * @see #putExtras
6710 * @see #removeExtra
6711 * @see #getBooleanArrayExtra(String)
6712 */
6713 public Intent putExtra(String name, boolean[] value) {
6714 if (mExtras == null) {
6715 mExtras = new Bundle();
6716 }
6717 mExtras.putBooleanArray(name, value);
6718 return this;
6719 }
6720
6721 /**
6722 * Add extended data to the intent. The name must include a package
6723 * prefix, for example the app com.android.contacts would use names
6724 * like "com.android.contacts.ShowAll".
6725 *
6726 * @param name The name of the extra data, with package prefix.
6727 * @param value The byte array data value.
6728 *
6729 * @return Returns the same Intent object, for chaining multiple calls
6730 * into a single statement.
6731 *
6732 * @see #putExtras
6733 * @see #removeExtra
6734 * @see #getByteArrayExtra(String)
6735 */
6736 public Intent putExtra(String name, byte[] value) {
6737 if (mExtras == null) {
6738 mExtras = new Bundle();
6739 }
6740 mExtras.putByteArray(name, value);
6741 return this;
6742 }
6743
6744 /**
6745 * Add extended data to the intent. The name must include a package
6746 * prefix, for example the app com.android.contacts would use names
6747 * like "com.android.contacts.ShowAll".
6748 *
6749 * @param name The name of the extra data, with package prefix.
6750 * @param value The short array data value.
6751 *
6752 * @return Returns the same Intent object, for chaining multiple calls
6753 * into a single statement.
6754 *
6755 * @see #putExtras
6756 * @see #removeExtra
6757 * @see #getShortArrayExtra(String)
6758 */
6759 public Intent putExtra(String name, short[] value) {
6760 if (mExtras == null) {
6761 mExtras = new Bundle();
6762 }
6763 mExtras.putShortArray(name, value);
6764 return this;
6765 }
6766
6767 /**
6768 * Add extended data to the intent. The name must include a package
6769 * prefix, for example the app com.android.contacts would use names
6770 * like "com.android.contacts.ShowAll".
6771 *
6772 * @param name The name of the extra data, with package prefix.
6773 * @param value The char array data value.
6774 *
6775 * @return Returns the same Intent object, for chaining multiple calls
6776 * into a single statement.
6777 *
6778 * @see #putExtras
6779 * @see #removeExtra
6780 * @see #getCharArrayExtra(String)
6781 */
6782 public Intent putExtra(String name, char[] value) {
6783 if (mExtras == null) {
6784 mExtras = new Bundle();
6785 }
6786 mExtras.putCharArray(name, value);
6787 return this;
6788 }
6789
6790 /**
6791 * Add extended data to the intent. The name must include a package
6792 * prefix, for example the app com.android.contacts would use names
6793 * like "com.android.contacts.ShowAll".
6794 *
6795 * @param name The name of the extra data, with package prefix.
6796 * @param value The int array data value.
6797 *
6798 * @return Returns the same Intent object, for chaining multiple calls
6799 * into a single statement.
6800 *
6801 * @see #putExtras
6802 * @see #removeExtra
6803 * @see #getIntArrayExtra(String)
6804 */
6805 public Intent putExtra(String name, int[] value) {
6806 if (mExtras == null) {
6807 mExtras = new Bundle();
6808 }
6809 mExtras.putIntArray(name, value);
6810 return this;
6811 }
6812
6813 /**
6814 * Add extended data to the intent. The name must include a package
6815 * prefix, for example the app com.android.contacts would use names
6816 * like "com.android.contacts.ShowAll".
6817 *
6818 * @param name The name of the extra data, with package prefix.
6819 * @param value The byte array data value.
6820 *
6821 * @return Returns the same Intent object, for chaining multiple calls
6822 * into a single statement.
6823 *
6824 * @see #putExtras
6825 * @see #removeExtra
6826 * @see #getLongArrayExtra(String)
6827 */
6828 public Intent putExtra(String name, long[] value) {
6829 if (mExtras == null) {
6830 mExtras = new Bundle();
6831 }
6832 mExtras.putLongArray(name, value);
6833 return this;
6834 }
6835
6836 /**
6837 * Add extended data to the intent. The name must include a package
6838 * prefix, for example the app com.android.contacts would use names
6839 * like "com.android.contacts.ShowAll".
6840 *
6841 * @param name The name of the extra data, with package prefix.
6842 * @param value The float array data value.
6843 *
6844 * @return Returns the same Intent object, for chaining multiple calls
6845 * into a single statement.
6846 *
6847 * @see #putExtras
6848 * @see #removeExtra
6849 * @see #getFloatArrayExtra(String)
6850 */
6851 public Intent putExtra(String name, float[] value) {
6852 if (mExtras == null) {
6853 mExtras = new Bundle();
6854 }
6855 mExtras.putFloatArray(name, value);
6856 return this;
6857 }
6858
6859 /**
6860 * Add extended data to the intent. The name must include a package
6861 * prefix, for example the app com.android.contacts would use names
6862 * like "com.android.contacts.ShowAll".
6863 *
6864 * @param name The name of the extra data, with package prefix.
6865 * @param value The double array data value.
6866 *
6867 * @return Returns the same Intent object, for chaining multiple calls
6868 * into a single statement.
6869 *
6870 * @see #putExtras
6871 * @see #removeExtra
6872 * @see #getDoubleArrayExtra(String)
6873 */
6874 public Intent putExtra(String name, double[] value) {
6875 if (mExtras == null) {
6876 mExtras = new Bundle();
6877 }
6878 mExtras.putDoubleArray(name, value);
6879 return this;
6880 }
6881
6882 /**
6883 * Add extended data to the intent. The name must include a package
6884 * prefix, for example the app com.android.contacts would use names
6885 * like "com.android.contacts.ShowAll".
6886 *
6887 * @param name The name of the extra data, with package prefix.
6888 * @param value The String array data value.
6889 *
6890 * @return Returns the same Intent object, for chaining multiple calls
6891 * into a single statement.
6892 *
6893 * @see #putExtras
6894 * @see #removeExtra
6895 * @see #getStringArrayExtra(String)
6896 */
6897 public Intent putExtra(String name, String[] value) {
6898 if (mExtras == null) {
6899 mExtras = new Bundle();
6900 }
6901 mExtras.putStringArray(name, value);
6902 return this;
6903 }
6904
6905 /**
6906 * Add extended data to the intent. The name must include a package
6907 * prefix, for example the app com.android.contacts would use names
6908 * like "com.android.contacts.ShowAll".
6909 *
6910 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006911 * @param value The CharSequence array data value.
6912 *
6913 * @return Returns the same Intent object, for chaining multiple calls
6914 * into a single statement.
6915 *
6916 * @see #putExtras
6917 * @see #removeExtra
6918 * @see #getCharSequenceArrayExtra(String)
6919 */
6920 public Intent putExtra(String name, CharSequence[] value) {
6921 if (mExtras == null) {
6922 mExtras = new Bundle();
6923 }
6924 mExtras.putCharSequenceArray(name, value);
6925 return this;
6926 }
6927
6928 /**
6929 * Add extended data to the intent. The name must include a package
6930 * prefix, for example the app com.android.contacts would use names
6931 * like "com.android.contacts.ShowAll".
6932 *
6933 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006934 * @param value The Bundle data value.
6935 *
6936 * @return Returns the same Intent object, for chaining multiple calls
6937 * into a single statement.
6938 *
6939 * @see #putExtras
6940 * @see #removeExtra
6941 * @see #getBundleExtra(String)
6942 */
6943 public Intent putExtra(String name, Bundle value) {
6944 if (mExtras == null) {
6945 mExtras = new Bundle();
6946 }
6947 mExtras.putBundle(name, value);
6948 return this;
6949 }
6950
6951 /**
6952 * Add extended data to the intent. The name must include a package
6953 * prefix, for example the app com.android.contacts would use names
6954 * like "com.android.contacts.ShowAll".
6955 *
6956 * @param name The name of the extra data, with package prefix.
6957 * @param value The IBinder data value.
6958 *
6959 * @return Returns the same Intent object, for chaining multiple calls
6960 * into a single statement.
6961 *
6962 * @see #putExtras
6963 * @see #removeExtra
6964 * @see #getIBinderExtra(String)
6965 *
6966 * @deprecated
6967 * @hide
6968 */
6969 @Deprecated
6970 public Intent putExtra(String name, IBinder value) {
6971 if (mExtras == null) {
6972 mExtras = new Bundle();
6973 }
6974 mExtras.putIBinder(name, value);
6975 return this;
6976 }
6977
6978 /**
6979 * Copy all extras in 'src' in to this intent.
6980 *
6981 * @param src Contains the extras to copy.
6982 *
6983 * @see #putExtra
6984 */
6985 public Intent putExtras(Intent src) {
6986 if (src.mExtras != null) {
6987 if (mExtras == null) {
6988 mExtras = new Bundle(src.mExtras);
6989 } else {
6990 mExtras.putAll(src.mExtras);
6991 }
6992 }
6993 return this;
6994 }
6995
6996 /**
6997 * Add a set of extended data to the intent. The keys must include a package
6998 * prefix, for example the app com.android.contacts would use names
6999 * like "com.android.contacts.ShowAll".
7000 *
7001 * @param extras The Bundle of extras to add to this intent.
7002 *
7003 * @see #putExtra
7004 * @see #removeExtra
7005 */
7006 public Intent putExtras(Bundle extras) {
7007 if (mExtras == null) {
7008 mExtras = new Bundle();
7009 }
7010 mExtras.putAll(extras);
7011 return this;
7012 }
7013
7014 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007015 * Completely replace the extras in the Intent with the extras in the
7016 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007017 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007018 * @param src The exact extras contained in this Intent are copied
7019 * into the target intent, replacing any that were previously there.
7020 */
7021 public Intent replaceExtras(Intent src) {
7022 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7023 return this;
7024 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007025
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007026 /**
7027 * Completely replace the extras in the Intent with the given Bundle of
7028 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007029 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007030 * @param extras The new set of extras in the Intent, or null to erase
7031 * all extras.
7032 */
7033 public Intent replaceExtras(Bundle extras) {
7034 mExtras = extras != null ? new Bundle(extras) : null;
7035 return this;
7036 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007037
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007038 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007039 * Remove extended data from the intent.
7040 *
7041 * @see #putExtra
7042 */
7043 public void removeExtra(String name) {
7044 if (mExtras != null) {
7045 mExtras.remove(name);
7046 if (mExtras.size() == 0) {
7047 mExtras = null;
7048 }
7049 }
7050 }
7051
7052 /**
7053 * Set special flags controlling how this intent is handled. Most values
7054 * here depend on the type of component being executed by the Intent,
7055 * specifically the FLAG_ACTIVITY_* flags are all for use with
7056 * {@link Context#startActivity Context.startActivity()} and the
7057 * FLAG_RECEIVER_* flags are all for use with
7058 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7059 *
Scott Main7aee61f2011-02-08 11:25:01 -08007060 * <p>See the
7061 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7062 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007063 * the behavior of your application.
7064 *
7065 * @param flags The desired flags.
7066 *
7067 * @return Returns the same Intent object, for chaining multiple calls
7068 * into a single statement.
7069 *
7070 * @see #getFlags
7071 * @see #addFlags
7072 *
7073 * @see #FLAG_GRANT_READ_URI_PERMISSION
7074 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007075 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7076 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007077 * @see #FLAG_DEBUG_LOG_RESOLUTION
7078 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007079 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007080 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007081 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007082 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007083 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7084 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007085 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007086 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007087 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007088 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007089 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007090 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007091 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007092 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7093 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007094 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007095 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007096 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007097 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7098 */
7099 public Intent setFlags(int flags) {
7100 mFlags = flags;
7101 return this;
7102 }
7103
7104 /**
7105 * Add additional flags to the intent (or with existing flags
7106 * value).
7107 *
7108 * @param flags The new flags to set.
7109 *
7110 * @return Returns the same Intent object, for chaining multiple calls
7111 * into a single statement.
7112 *
7113 * @see #setFlags
7114 */
7115 public Intent addFlags(int flags) {
7116 mFlags |= flags;
7117 return this;
7118 }
7119
7120 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007121 * (Usually optional) Set an explicit application package name that limits
7122 * the components this Intent will resolve to. If left to the default
7123 * value of null, all components in all applications will considered.
7124 * If non-null, the Intent can only match the components in the given
7125 * application package.
7126 *
7127 * @param packageName The name of the application package to handle the
7128 * intent, or null to allow any application package.
7129 *
7130 * @return Returns the same Intent object, for chaining multiple calls
7131 * into a single statement.
7132 *
7133 * @see #getPackage
7134 * @see #resolveActivity
7135 */
7136 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007137 if (packageName != null && mSelector != null) {
7138 throw new IllegalArgumentException(
7139 "Can't set package name when selector is already set");
7140 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007141 mPackage = packageName;
7142 return this;
7143 }
7144
7145 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007146 * (Usually optional) Explicitly set the component to handle the intent.
7147 * If left with the default value of null, the system will determine the
7148 * appropriate class to use based on the other fields (action, data,
7149 * type, categories) in the Intent. If this class is defined, the
7150 * specified class will always be used regardless of the other fields. You
7151 * should only set this value when you know you absolutely want a specific
7152 * class to be used; otherwise it is better to let the system find the
7153 * appropriate class so that you will respect the installed applications
7154 * and user preferences.
7155 *
7156 * @param component The name of the application component to handle the
7157 * intent, or null to let the system find one for you.
7158 *
7159 * @return Returns the same Intent object, for chaining multiple calls
7160 * into a single statement.
7161 *
7162 * @see #setClass
7163 * @see #setClassName(Context, String)
7164 * @see #setClassName(String, String)
7165 * @see #getComponent
7166 * @see #resolveActivity
7167 */
7168 public Intent setComponent(ComponentName component) {
7169 mComponent = component;
7170 return this;
7171 }
7172
7173 /**
7174 * Convenience for calling {@link #setComponent} with an
7175 * explicit class name.
7176 *
7177 * @param packageContext A Context of the application package implementing
7178 * this class.
7179 * @param className The name of a class inside of the application package
7180 * that will be used as the component for this Intent.
7181 *
7182 * @return Returns the same Intent object, for chaining multiple calls
7183 * into a single statement.
7184 *
7185 * @see #setComponent
7186 * @see #setClass
7187 */
7188 public Intent setClassName(Context packageContext, String className) {
7189 mComponent = new ComponentName(packageContext, className);
7190 return this;
7191 }
7192
7193 /**
7194 * Convenience for calling {@link #setComponent} with an
7195 * explicit application package name and class name.
7196 *
7197 * @param packageName The name of the package implementing the desired
7198 * component.
7199 * @param className The name of a class inside of the application package
7200 * that will be used as the component for this Intent.
7201 *
7202 * @return Returns the same Intent object, for chaining multiple calls
7203 * into a single statement.
7204 *
7205 * @see #setComponent
7206 * @see #setClass
7207 */
7208 public Intent setClassName(String packageName, String className) {
7209 mComponent = new ComponentName(packageName, className);
7210 return this;
7211 }
7212
7213 /**
7214 * Convenience for calling {@link #setComponent(ComponentName)} with the
7215 * name returned by a {@link Class} object.
7216 *
7217 * @param packageContext A Context of the application package implementing
7218 * this class.
7219 * @param cls The class name to set, equivalent to
7220 * <code>setClassName(context, cls.getName())</code>.
7221 *
7222 * @return Returns the same Intent object, for chaining multiple calls
7223 * into a single statement.
7224 *
7225 * @see #setComponent
7226 */
7227 public Intent setClass(Context packageContext, Class<?> cls) {
7228 mComponent = new ComponentName(packageContext, cls);
7229 return this;
7230 }
7231
7232 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007233 * Set the bounds of the sender of this intent, in screen coordinates. This can be
7234 * used as a hint to the receiver for animations and the like. Null means that there
7235 * is no source bounds.
7236 */
7237 public void setSourceBounds(Rect r) {
7238 if (r != null) {
7239 mSourceBounds = new Rect(r);
7240 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07007241 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007242 }
7243 }
7244
Tor Norbyed9273d62013-05-30 15:59:53 -07007245 /** @hide */
7246 @IntDef(flag = true,
7247 value = {
7248 FILL_IN_ACTION,
7249 FILL_IN_DATA,
7250 FILL_IN_CATEGORIES,
7251 FILL_IN_COMPONENT,
7252 FILL_IN_PACKAGE,
7253 FILL_IN_SOURCE_BOUNDS,
7254 FILL_IN_SELECTOR,
7255 FILL_IN_CLIP_DATA
7256 })
7257 @Retention(RetentionPolicy.SOURCE)
7258 public @interface FillInFlags {}
7259
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007260 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007261 * Use with {@link #fillIn} to allow the current action value to be
7262 * overwritten, even if it is already set.
7263 */
7264 public static final int FILL_IN_ACTION = 1<<0;
7265
7266 /**
7267 * Use with {@link #fillIn} to allow the current data or type value
7268 * overwritten, even if it is already set.
7269 */
7270 public static final int FILL_IN_DATA = 1<<1;
7271
7272 /**
7273 * Use with {@link #fillIn} to allow the current categories to be
7274 * overwritten, even if they are already set.
7275 */
7276 public static final int FILL_IN_CATEGORIES = 1<<2;
7277
7278 /**
7279 * Use with {@link #fillIn} to allow the current component value to be
7280 * overwritten, even if it is already set.
7281 */
7282 public static final int FILL_IN_COMPONENT = 1<<3;
7283
7284 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007285 * Use with {@link #fillIn} to allow the current package value to be
7286 * overwritten, even if it is already set.
7287 */
7288 public static final int FILL_IN_PACKAGE = 1<<4;
7289
7290 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007291 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007292 * overwritten, even if it is already set.
7293 */
7294 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
7295
7296 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007297 * Use with {@link #fillIn} to allow the current selector to be
7298 * overwritten, even if it is already set.
7299 */
7300 public static final int FILL_IN_SELECTOR = 1<<6;
7301
7302 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007303 * Use with {@link #fillIn} to allow the current ClipData to be
7304 * overwritten, even if it is already set.
7305 */
7306 public static final int FILL_IN_CLIP_DATA = 1<<7;
7307
7308 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007309 * Copy the contents of <var>other</var> in to this object, but only
7310 * where fields are not defined by this object. For purposes of a field
7311 * being defined, the following pieces of data in the Intent are
7312 * considered to be separate fields:
7313 *
7314 * <ul>
7315 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08007316 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007317 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
7318 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007319 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007320 * <li> component, as set by {@link #setComponent(ComponentName)} or
7321 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007322 * <li> source bounds, as set by {@link #setSourceBounds}.
7323 * <li> selector, as set by {@link #setSelector(Intent)}.
7324 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007325 * <li> each top-level name in the associated extras.
7326 * </ul>
7327 *
7328 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007329 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007330 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7331 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
7332 * the restriction where the corresponding field will not be replaced if
7333 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007334 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007335 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
7336 * is explicitly specified. The selector will only be copied if
7337 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07007338 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007339 * <p>For example, consider Intent A with {data="foo", categories="bar"}
7340 * and Intent B with {action="gotit", data-type="some/thing",
7341 * categories="one","two"}.
7342 *
7343 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
7344 * containing: {action="gotit", data-type="some/thing",
7345 * categories="bar"}.
7346 *
7347 * @param other Another Intent whose values are to be used to fill in
7348 * the current one.
7349 * @param flags Options to control which fields can be filled in.
7350 *
7351 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007352 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07007353 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
7354 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
7355 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007356 */
Tor Norbyed9273d62013-05-30 15:59:53 -07007357 @FillInFlags
7358 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007359 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007360 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007361 if (other.mAction != null
7362 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007363 mAction = other.mAction;
7364 changes |= FILL_IN_ACTION;
7365 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007366 if ((other.mData != null || other.mType != null)
7367 && ((mData == null && mType == null)
7368 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007369 mData = other.mData;
7370 mType = other.mType;
7371 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007372 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007373 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007374 if (other.mCategories != null
7375 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007376 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007377 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007378 }
7379 changes |= FILL_IN_CATEGORIES;
7380 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007381 if (other.mPackage != null
7382 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007383 // Only do this if mSelector is not set.
7384 if (mSelector == null) {
7385 mPackage = other.mPackage;
7386 changes |= FILL_IN_PACKAGE;
7387 }
7388 }
7389 // Selector is special: it can only be set if explicitly allowed,
7390 // for the same reason as the component name.
7391 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
7392 if (mPackage == null) {
7393 mSelector = new Intent(other.mSelector);
7394 mPackage = null;
7395 changes |= FILL_IN_SELECTOR;
7396 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007397 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007398 if (other.mClipData != null
7399 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
7400 mClipData = other.mClipData;
7401 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007402 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007403 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007404 // Component is special: it can -only- be set if explicitly allowed,
7405 // since otherwise the sender could force the intent somewhere the
7406 // originator didn't intend.
7407 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007408 mComponent = other.mComponent;
7409 changes |= FILL_IN_COMPONENT;
7410 }
7411 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007412 if (other.mSourceBounds != null
7413 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
7414 mSourceBounds = new Rect(other.mSourceBounds);
7415 changes |= FILL_IN_SOURCE_BOUNDS;
7416 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007417 if (mExtras == null) {
7418 if (other.mExtras != null) {
7419 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007420 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007421 }
7422 } else if (other.mExtras != null) {
7423 try {
7424 Bundle newb = new Bundle(other.mExtras);
7425 newb.putAll(mExtras);
7426 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007427 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007428 } catch (RuntimeException e) {
7429 // Modifying the extras can cause us to unparcel the contents
7430 // of the bundle, and if we do this in the system process that
7431 // may fail. We really should handle this (i.e., the Bundle
7432 // impl shouldn't be on top of a plain map), but for now just
7433 // ignore it and keep the original contents. :(
7434 Log.w("Intent", "Failure filling in extras", e);
7435 }
7436 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007437 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
7438 && other.mContentUserHint != UserHandle.USER_CURRENT) {
7439 mContentUserHint = other.mContentUserHint;
7440 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007441 return changes;
7442 }
7443
7444 /**
7445 * Wrapper class holding an Intent and implementing comparisons on it for
7446 * the purpose of filtering. The class implements its
7447 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
7448 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
7449 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
7450 * on the wrapped Intent.
7451 */
7452 public static final class FilterComparison {
7453 private final Intent mIntent;
7454 private final int mHashCode;
7455
7456 public FilterComparison(Intent intent) {
7457 mIntent = intent;
7458 mHashCode = intent.filterHashCode();
7459 }
7460
7461 /**
7462 * Return the Intent that this FilterComparison represents.
7463 * @return Returns the Intent held by the FilterComparison. Do
7464 * not modify!
7465 */
7466 public Intent getIntent() {
7467 return mIntent;
7468 }
7469
7470 @Override
7471 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007472 if (obj instanceof FilterComparison) {
7473 Intent other = ((FilterComparison)obj).mIntent;
7474 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007475 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007476 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007477 }
7478
7479 @Override
7480 public int hashCode() {
7481 return mHashCode;
7482 }
7483 }
7484
7485 /**
7486 * Determine if two intents are the same for the purposes of intent
7487 * resolution (filtering). That is, if their action, data, type,
7488 * class, and categories are the same. This does <em>not</em> compare
7489 * any extra data included in the intents.
7490 *
7491 * @param other The other Intent to compare against.
7492 *
7493 * @return Returns true if action, data, type, class, and categories
7494 * are the same.
7495 */
7496 public boolean filterEquals(Intent other) {
7497 if (other == null) {
7498 return false;
7499 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07007500 if (!Objects.equals(this.mAction, other.mAction)) return false;
7501 if (!Objects.equals(this.mData, other.mData)) return false;
7502 if (!Objects.equals(this.mType, other.mType)) return false;
7503 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
7504 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
7505 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007506
7507 return true;
7508 }
7509
7510 /**
7511 * Generate hash code that matches semantics of filterEquals().
7512 *
7513 * @return Returns the hash value of the action, data, type, class, and
7514 * categories.
7515 *
7516 * @see #filterEquals
7517 */
7518 public int filterHashCode() {
7519 int code = 0;
7520 if (mAction != null) {
7521 code += mAction.hashCode();
7522 }
7523 if (mData != null) {
7524 code += mData.hashCode();
7525 }
7526 if (mType != null) {
7527 code += mType.hashCode();
7528 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007529 if (mPackage != null) {
7530 code += mPackage.hashCode();
7531 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007532 if (mComponent != null) {
7533 code += mComponent.hashCode();
7534 }
7535 if (mCategories != null) {
7536 code += mCategories.hashCode();
7537 }
7538 return code;
7539 }
7540
7541 @Override
7542 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007543 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007544
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007545 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007546 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007547 b.append(" }");
7548
7549 return b.toString();
7550 }
7551
7552 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007553 public String toInsecureString() {
7554 StringBuilder b = new StringBuilder(128);
7555
7556 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007557 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007558 b.append(" }");
7559
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007560 return b.toString();
7561 }
Romain Guy4969af72009-06-17 10:53:19 -07007562
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007563 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007564 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007565 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007566
7567 b.append("Intent { ");
7568 toShortString(b, false, true, true, true);
7569 b.append(" }");
7570
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007571 return b.toString();
7572 }
7573
7574 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007575 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
7576 StringBuilder b = new StringBuilder(128);
7577 toShortString(b, secure, comp, extras, clip);
7578 return b.toString();
7579 }
7580
7581 /** @hide */
7582 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
7583 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007584 boolean first = true;
7585 if (mAction != null) {
7586 b.append("act=").append(mAction);
7587 first = false;
7588 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007589 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007590 if (!first) {
7591 b.append(' ');
7592 }
7593 first = false;
7594 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007595 for (int i=0; i<mCategories.size(); i++) {
7596 if (i > 0) b.append(',');
7597 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007598 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007599 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007600 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007601 if (mData != null) {
7602 if (!first) {
7603 b.append(' ');
7604 }
7605 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07007606 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007607 if (secure) {
7608 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07007609 } else {
7610 b.append(mData);
7611 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007612 }
7613 if (mType != null) {
7614 if (!first) {
7615 b.append(' ');
7616 }
7617 first = false;
7618 b.append("typ=").append(mType);
7619 }
7620 if (mFlags != 0) {
7621 if (!first) {
7622 b.append(' ');
7623 }
7624 first = false;
7625 b.append("flg=0x").append(Integer.toHexString(mFlags));
7626 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007627 if (mPackage != null) {
7628 if (!first) {
7629 b.append(' ');
7630 }
7631 first = false;
7632 b.append("pkg=").append(mPackage);
7633 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007634 if (comp && mComponent != null) {
7635 if (!first) {
7636 b.append(' ');
7637 }
7638 first = false;
7639 b.append("cmp=").append(mComponent.flattenToShortString());
7640 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007641 if (mSourceBounds != null) {
7642 if (!first) {
7643 b.append(' ');
7644 }
7645 first = false;
7646 b.append("bnds=").append(mSourceBounds.toShortString());
7647 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007648 if (mClipData != null) {
7649 if (!first) {
7650 b.append(' ');
7651 }
Dianne Hackbornae498722015-08-14 13:29:47 -07007652 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007653 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007654 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007655 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07007656 if (mClipData.getDescription() != null) {
7657 first = !mClipData.getDescription().toShortStringTypesOnly(b);
7658 } else {
7659 first = true;
7660 }
7661 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007662 }
Dianne Hackbornae498722015-08-14 13:29:47 -07007663 first = false;
7664 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007665 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007666 if (extras && mExtras != null) {
7667 if (!first) {
7668 b.append(' ');
7669 }
7670 first = false;
7671 b.append("(has extras)");
7672 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007673 if (mContentUserHint != UserHandle.USER_CURRENT) {
7674 if (!first) {
7675 b.append(' ');
7676 }
7677 first = false;
7678 b.append("u=").append(mContentUserHint);
7679 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007680 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007681 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007682 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007683 b.append("}");
7684 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007685 }
7686
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007687 /**
7688 * Call {@link #toUri} with 0 flags.
7689 * @deprecated Use {@link #toUri} instead.
7690 */
7691 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007692 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007693 return toUri(0);
7694 }
7695
7696 /**
7697 * Convert this Intent into a String holding a URI representation of it.
7698 * The returned URI string has been properly URI encoded, so it can be
7699 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7700 * Intent's data as the base URI, with an additional fragment describing
7701 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007702 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007703 * <p>You can convert the returned string back to an Intent with
7704 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007705 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007706 * @param flags Additional operating flags. Either 0,
7707 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007708 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007709 * @return Returns a URI encoding URI string describing the entire contents
7710 * of the Intent.
7711 */
7712 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007713 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007714 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
7715 if (mPackage == null) {
7716 throw new IllegalArgumentException(
7717 "Intent must include an explicit package name to build an android-app: "
7718 + this);
7719 }
7720 uri.append("android-app://");
7721 uri.append(mPackage);
7722 String scheme = null;
7723 if (mData != null) {
7724 scheme = mData.getScheme();
7725 if (scheme != null) {
7726 uri.append('/');
7727 uri.append(scheme);
7728 String authority = mData.getEncodedAuthority();
7729 if (authority != null) {
7730 uri.append('/');
7731 uri.append(authority);
7732 String path = mData.getEncodedPath();
7733 if (path != null) {
7734 uri.append(path);
7735 }
7736 String queryParams = mData.getEncodedQuery();
7737 if (queryParams != null) {
7738 uri.append('?');
7739 uri.append(queryParams);
7740 }
7741 String fragment = mData.getEncodedFragment();
7742 if (fragment != null) {
7743 uri.append('#');
7744 uri.append(fragment);
7745 }
7746 }
7747 }
7748 }
7749 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
7750 mPackage, flags);
7751 return uri.toString();
7752 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007753 String scheme = null;
7754 if (mData != null) {
7755 String data = mData.toString();
7756 if ((flags&URI_INTENT_SCHEME) != 0) {
7757 final int N = data.length();
7758 for (int i=0; i<N; i++) {
7759 char c = data.charAt(i);
7760 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7761 || c == '.' || c == '-') {
7762 continue;
7763 }
7764 if (c == ':' && i > 0) {
7765 // Valid scheme.
7766 scheme = data.substring(0, i);
7767 uri.append("intent:");
7768 data = data.substring(i+1);
7769 break;
7770 }
Tom Taylord4a47292009-12-21 13:59:18 -08007771
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007772 // No scheme.
7773 break;
7774 }
7775 }
7776 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007777
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007778 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7779 uri.append("intent:");
7780 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007781
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007782 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007783
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007784 return uri.toString();
7785 }
7786
7787 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
7788 String defPackage, int flags) {
7789 StringBuilder frag = new StringBuilder(128);
7790
7791 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007792 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08007793 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007794 // Note that for now we are not going to try to handle the
7795 // data part; not clear how to represent this as a URI, and
7796 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007797 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
7798 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007799 }
7800
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007801 if (frag.length() > 0) {
7802 uri.append("#Intent;");
7803 uri.append(frag);
7804 uri.append("end");
7805 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007806 }
7807
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007808 private void toUriInner(StringBuilder uri, String scheme, String defAction,
7809 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007810 if (scheme != null) {
7811 uri.append("scheme=").append(scheme).append(';');
7812 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007813 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007814 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007815 }
7816 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007817 for (int i=0; i<mCategories.size(); i++) {
7818 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007819 }
7820 }
7821 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007822 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007823 }
7824 if (mFlags != 0) {
7825 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7826 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08007827 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007828 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7829 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007830 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007831 uri.append("component=").append(Uri.encode(
7832 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007833 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007834 if (mSourceBounds != null) {
7835 uri.append("sourceBounds=")
7836 .append(Uri.encode(mSourceBounds.flattenToString()))
7837 .append(';');
7838 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007839 if (mExtras != null) {
7840 for (String key : mExtras.keySet()) {
7841 final Object value = mExtras.get(key);
7842 char entryType =
7843 value instanceof String ? 'S' :
7844 value instanceof Boolean ? 'B' :
7845 value instanceof Byte ? 'b' :
7846 value instanceof Character ? 'c' :
7847 value instanceof Double ? 'd' :
7848 value instanceof Float ? 'f' :
7849 value instanceof Integer ? 'i' :
7850 value instanceof Long ? 'l' :
7851 value instanceof Short ? 's' :
7852 '\0';
7853
7854 if (entryType != '\0') {
7855 uri.append(entryType);
7856 uri.append('.');
7857 uri.append(Uri.encode(key));
7858 uri.append('=');
7859 uri.append(Uri.encode(value.toString()));
7860 uri.append(';');
7861 }
7862 }
7863 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007864 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007865
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007866 public int describeContents() {
7867 return (mExtras != null) ? mExtras.describeContents() : 0;
7868 }
7869
7870 public void writeToParcel(Parcel out, int flags) {
7871 out.writeString(mAction);
7872 Uri.writeToParcel(out, mData);
7873 out.writeString(mType);
7874 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007875 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007876 ComponentName.writeToParcel(mComponent, out);
7877
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007878 if (mSourceBounds != null) {
7879 out.writeInt(1);
7880 mSourceBounds.writeToParcel(out, flags);
7881 } else {
7882 out.writeInt(0);
7883 }
7884
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007885 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007886 final int N = mCategories.size();
7887 out.writeInt(N);
7888 for (int i=0; i<N; i++) {
7889 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007890 }
7891 } else {
7892 out.writeInt(0);
7893 }
7894
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007895 if (mSelector != null) {
7896 out.writeInt(1);
7897 mSelector.writeToParcel(out, flags);
7898 } else {
7899 out.writeInt(0);
7900 }
7901
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007902 if (mClipData != null) {
7903 out.writeInt(1);
7904 mClipData.writeToParcel(out, flags);
7905 } else {
7906 out.writeInt(0);
7907 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007908 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007909 out.writeBundle(mExtras);
7910 }
7911
7912 public static final Parcelable.Creator<Intent> CREATOR
7913 = new Parcelable.Creator<Intent>() {
7914 public Intent createFromParcel(Parcel in) {
7915 return new Intent(in);
7916 }
7917 public Intent[] newArray(int size) {
7918 return new Intent[size];
7919 }
7920 };
7921
Dianne Hackborneb034652009-09-07 00:49:58 -07007922 /** @hide */
7923 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007924 readFromParcel(in);
7925 }
7926
7927 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007928 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007929 mData = Uri.CREATOR.createFromParcel(in);
7930 mType = in.readString();
7931 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007932 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007933 mComponent = ComponentName.readFromParcel(in);
7934
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007935 if (in.readInt() != 0) {
7936 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7937 }
7938
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007939 int N = in.readInt();
7940 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007941 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007942 int i;
7943 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007944 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007945 }
7946 } else {
7947 mCategories = null;
7948 }
7949
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007950 if (in.readInt() != 0) {
7951 mSelector = new Intent(in);
7952 }
7953
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007954 if (in.readInt() != 0) {
7955 mClipData = new ClipData(in);
7956 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007957 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007958 mExtras = in.readBundle();
7959 }
7960
7961 /**
7962 * Parses the "intent" element (and its children) from XML and instantiates
7963 * an Intent object. The given XML parser should be located at the tag
7964 * where parsing should start (often named "intent"), from which the
7965 * basic action, data, type, and package and class name will be
7966 * retrieved. The function will then parse in to any child elements,
7967 * looking for <category android:name="xxx"> tags to add categories and
7968 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7969 * to the intent.
7970 *
7971 * @param resources The Resources to use when inflating resources.
7972 * @param parser The XML parser pointing at an "intent" tag.
7973 * @param attrs The AttributeSet interface for retrieving extended
7974 * attribute data at the current <var>parser</var> location.
7975 * @return An Intent object matching the XML data.
7976 * @throws XmlPullParserException If there was an XML parsing error.
7977 * @throws IOException If there was an I/O error.
7978 */
7979 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7980 throws XmlPullParserException, IOException {
7981 Intent intent = new Intent();
7982
7983 TypedArray sa = resources.obtainAttributes(attrs,
7984 com.android.internal.R.styleable.Intent);
7985
7986 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7987
7988 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7989 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7990 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7991
7992 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7993 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7994 if (packageName != null && className != null) {
7995 intent.setComponent(new ComponentName(packageName, className));
7996 }
7997
7998 sa.recycle();
7999
8000 int outerDepth = parser.getDepth();
8001 int type;
8002 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8003 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8004 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8005 continue;
8006 }
8007
8008 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008009 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008010 sa = resources.obtainAttributes(attrs,
8011 com.android.internal.R.styleable.IntentCategory);
8012 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8013 sa.recycle();
8014
8015 if (cat != null) {
8016 intent.addCategory(cat);
8017 }
8018 XmlUtils.skipCurrentTag(parser);
8019
Craig Mautner21d24a22014-04-23 11:45:37 -07008020 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008021 if (intent.mExtras == null) {
8022 intent.mExtras = new Bundle();
8023 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008024 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008025 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008026
8027 } else {
8028 XmlUtils.skipCurrentTag(parser);
8029 }
8030 }
8031
8032 return intent;
8033 }
Nick Pellyccae4122012-01-09 14:12:58 -08008034
Craig Mautner21d24a22014-04-23 11:45:37 -07008035 /** @hide */
8036 public void saveToXml(XmlSerializer out) throws IOException {
8037 if (mAction != null) {
8038 out.attribute(null, ATTR_ACTION, mAction);
8039 }
8040 if (mData != null) {
8041 out.attribute(null, ATTR_DATA, mData.toString());
8042 }
8043 if (mType != null) {
8044 out.attribute(null, ATTR_TYPE, mType);
8045 }
8046 if (mComponent != null) {
8047 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8048 }
8049 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8050
8051 if (mCategories != null) {
8052 out.startTag(null, TAG_CATEGORIES);
8053 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8054 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8055 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008056 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008057 }
8058 }
8059
8060 /** @hide */
8061 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8062 XmlPullParserException {
8063 Intent intent = new Intent();
8064 final int outerDepth = in.getDepth();
8065
8066 int attrCount = in.getAttributeCount();
8067 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8068 final String attrName = in.getAttributeName(attrNdx);
8069 final String attrValue = in.getAttributeValue(attrNdx);
8070 if (ATTR_ACTION.equals(attrName)) {
8071 intent.setAction(attrValue);
8072 } else if (ATTR_DATA.equals(attrName)) {
8073 intent.setData(Uri.parse(attrValue));
8074 } else if (ATTR_TYPE.equals(attrName)) {
8075 intent.setType(attrValue);
8076 } else if (ATTR_COMPONENT.equals(attrName)) {
8077 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8078 } else if (ATTR_FLAGS.equals(attrName)) {
8079 intent.setFlags(Integer.valueOf(attrValue, 16));
8080 } else {
8081 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8082 }
8083 }
8084
8085 int event;
8086 String name;
8087 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8088 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8089 if (event == XmlPullParser.START_TAG) {
8090 name = in.getName();
8091 if (TAG_CATEGORIES.equals(name)) {
8092 attrCount = in.getAttributeCount();
8093 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8094 intent.addCategory(in.getAttributeValue(attrNdx));
8095 }
8096 } else {
8097 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8098 XmlUtils.skipCurrentTag(in);
8099 }
8100 }
8101 }
8102
8103 return intent;
8104 }
8105
Nick Pellyccae4122012-01-09 14:12:58 -08008106 /**
8107 * Normalize a MIME data type.
8108 *
8109 * <p>A normalized MIME type has white-space trimmed,
8110 * content-type parameters removed, and is lower-case.
8111 * This aligns the type with Android best practices for
8112 * intent filtering.
8113 *
8114 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8115 * "text/x-vCard" becomes "text/x-vcard".
8116 *
8117 * <p>All MIME types received from outside Android (such as user input,
8118 * or external sources like Bluetooth, NFC, or the Internet) should
8119 * be normalized before they are used to create an Intent.
8120 *
8121 * @param type MIME data type to normalize
8122 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008123 * @see #setType
8124 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008125 */
8126 public static String normalizeMimeType(String type) {
8127 if (type == null) {
8128 return null;
8129 }
8130
Elliott Hughescb64d432013-08-02 10:00:44 -07008131 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008132
8133 final int semicolonIndex = type.indexOf(';');
8134 if (semicolonIndex != -1) {
8135 type = type.substring(0, semicolonIndex);
8136 }
8137 return type;
8138 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008139
8140 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008141 * Prepare this {@link Intent} to leave an app process.
8142 *
8143 * @hide
8144 */
8145 public void prepareToLeaveProcess() {
8146 setAllowFds(false);
8147
8148 if (mSelector != null) {
8149 mSelector.prepareToLeaveProcess();
8150 }
8151 if (mClipData != null) {
8152 mClipData.prepareToLeaveProcess();
8153 }
8154
8155 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
8156 // There are several ACTION_MEDIA_* broadcasts that send file://
8157 // Uris, so only check common actions.
8158 if (ACTION_VIEW.equals(mAction) ||
8159 ACTION_EDIT.equals(mAction) ||
8160 ACTION_ATTACH_DATA.equals(mAction)) {
8161 mData.checkFileUriExposed("Intent.getData()");
8162 }
8163 }
8164 }
8165
8166 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008167 * @hide
8168 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008169 public void prepareToEnterProcess() {
8170 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008171 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8172 fixUris(mContentUserHint);
8173 mContentUserHint = UserHandle.USER_CURRENT;
8174 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008175 }
8176 }
8177
8178 /**
8179 * @hide
8180 */
8181 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008182 Uri data = getData();
8183 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008184 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008185 }
8186 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008187 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008188 }
8189 String action = getAction();
8190 if (ACTION_SEND.equals(action)) {
8191 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8192 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008193 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008194 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008195 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008196 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8197 if (streams != null) {
8198 ArrayList<Uri> newStreams = new ArrayList<Uri>();
8199 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008200 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008201 }
8202 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
8203 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008204 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8205 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8206 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8207 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8208 if (output != null) {
8209 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
8210 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008211 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008212 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008213
8214 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008215 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008216 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
8217 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008218 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008219 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008220 * @hide
8221 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008222 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008223 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008224 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008225
8226 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008227 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008228
8229 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008230 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008231 // Inspect contained intents to see if we need to migrate extras. We
8232 // don't promote ClipData to the parent, since ChooserActivity will
8233 // already start the picked item as the caller, and we can't combine
8234 // the flags in a safe way.
8235
8236 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07008237 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008238 final Intent intent = getParcelableExtra(EXTRA_INTENT);
8239 if (intent != null) {
8240 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07008241 }
8242 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008243 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008244 try {
8245 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
8246 if (intents != null) {
8247 for (int i = 0; i < intents.length; i++) {
8248 final Intent intent = (Intent) intents[i];
8249 if (intent != null) {
8250 migrated |= intent.migrateExtraStreamToClipData();
8251 }
8252 }
8253 }
8254 } catch (ClassCastException e) {
8255 }
8256 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008257
8258 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008259 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008260 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8261 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
8262 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
8263 if (stream != null || text != null || htmlText != null) {
8264 final ClipData clipData = new ClipData(
8265 null, new String[] { getType() },
8266 new ClipData.Item(text, htmlText, null, stream));
8267 setClipData(clipData);
8268 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008269 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008270 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008271 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008272 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008273
8274 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008275 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008276 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8277 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
8278 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
8279 int num = -1;
8280 if (streams != null) {
8281 num = streams.size();
8282 }
8283 if (texts != null) {
8284 if (num >= 0 && num != texts.size()) {
8285 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008286 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008287 }
8288 num = texts.size();
8289 }
8290 if (htmlTexts != null) {
8291 if (num >= 0 && num != htmlTexts.size()) {
8292 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008293 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008294 }
8295 num = htmlTexts.size();
8296 }
8297 if (num > 0) {
8298 final ClipData clipData = new ClipData(
8299 null, new String[] { getType() },
8300 makeClipItem(streams, texts, htmlTexts, 0));
8301
8302 for (int i = 1; i < num; i++) {
8303 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
8304 }
8305
8306 setClipData(clipData);
8307 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008308 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07008309 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008310 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07008311 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008312 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8313 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8314 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8315 final Uri output;
8316 try {
8317 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8318 } catch (ClassCastException e) {
8319 return false;
8320 }
8321 if (output != null) {
8322 setClipData(ClipData.newRawUri("", output));
8323 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
8324 return true;
8325 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008326 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008327
8328 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008329 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07008330
8331 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
8332 ArrayList<String> htmlTexts, int which) {
8333 Uri uri = streams != null ? streams.get(which) : null;
8334 CharSequence text = texts != null ? texts.get(which) : null;
8335 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
8336 return new ClipData.Item(text, htmlText, null, uri);
8337 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07008338
8339 /** @hide */
8340 public boolean isDocument() {
8341 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
8342 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008343}