blob: 66e0ada27b52915a709b62751d3c015b1696f804 [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
Tor Norbye7b9c9122013-05-30 16:48:33 -070019import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070020import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070021import android.annotation.SdkConstant;
22import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050023import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070024import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050025import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060026import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.content.pm.PackageManager;
28import android.content.pm.ResolveInfo;
29import android.content.res.Resources;
30import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080031import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060033import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.os.Bundle;
35import android.os.IBinder;
36import android.os.Parcel;
37import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000038import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050039import android.os.ResultReceiver;
40import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070041import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010042import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070043import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070044import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050045import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070046import android.provider.OpenableColumns;
Jason Monk2f68e8a2016-02-23 17:57:28 -050047import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070048import android.util.AttributeSet;
49import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080050import com.android.internal.util.XmlUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050051import org.xmlpull.v1.XmlPullParser;
52import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070053import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054
55import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080056import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070057import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070058import java.lang.annotation.Retention;
59import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070060import java.net.URISyntaxException;
61import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080062import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070063import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080064import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070065import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.util.Set;
67
Jason Monk2f68e8a2016-02-23 17:57:28 -050068import static android.content.ContentProvider.maybeAddUserId;
69
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070070/**
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}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000541 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
542 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * <li> {@link #ACTION_UID_REMOVED}
544 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700545 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700546 * <li> {@link #ACTION_POWER_DISCONNECTED}
547 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700548 * </ul>
549 *
550 * <h3>Standard Categories</h3>
551 *
552 * <p>These are the current standard categories that can be used to further
553 * clarify an Intent via {@link #addCategory}.
554 *
555 * <ul>
556 * <li> {@link #CATEGORY_DEFAULT}
557 * <li> {@link #CATEGORY_BROWSABLE}
558 * <li> {@link #CATEGORY_TAB}
559 * <li> {@link #CATEGORY_ALTERNATIVE}
560 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
561 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800562 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700563 * <li> {@link #CATEGORY_HOME}
564 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700565 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400566 * <li> {@link #CATEGORY_CAR_DOCK}
567 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500568 * <li> {@link #CATEGORY_LE_DESK_DOCK}
569 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200570 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700571 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700572 * </ul>
573 *
574 * <h3>Standard Extra Data</h3>
575 *
576 * <p>These are the current standard fields that can be used as extra data via
577 * {@link #putExtra}.
578 *
579 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800580 * <li> {@link #EXTRA_ALARM_COUNT}
581 * <li> {@link #EXTRA_BCC}
582 * <li> {@link #EXTRA_CC}
583 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
584 * <li> {@link #EXTRA_DATA_REMOVED}
585 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500586 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
587 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800588 * <li> {@link #EXTRA_DOCK_STATE_CAR}
589 * <li> {@link #EXTRA_DOCK_STATE_DESK}
590 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
591 * <li> {@link #EXTRA_DONT_KILL_APP}
592 * <li> {@link #EXTRA_EMAIL}
593 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700594 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700596 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800597 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700598 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800599 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
600 * <li> {@link #EXTRA_REPLACING}
601 * <li> {@link #EXTRA_SHORTCUT_ICON}
602 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
603 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700604 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800605 * <li> {@link #EXTRA_SHORTCUT_NAME}
606 * <li> {@link #EXTRA_SUBJECT}
607 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800609 * <li> {@link #EXTRA_TITLE}
610 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700611 * </ul>
612 *
613 * <h3>Flags</h3>
614 *
615 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800616 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
617 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800619public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700620 private static final String ATTR_ACTION = "action";
621 private static final String TAG_CATEGORIES = "categories";
622 private static final String ATTR_CATEGORY = "category";
623 private static final String TAG_EXTRA = "extra";
624 private static final String ATTR_TYPE = "type";
625 private static final String ATTR_COMPONENT = "component";
626 private static final String ATTR_DATA = "data";
627 private static final String ATTR_FLAGS = "flags";
628
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700629 // ---------------------------------------------------------------------
630 // ---------------------------------------------------------------------
631 // Standard intent activity actions (see action variable).
632
633 /**
634 * Activity Action: Start as a main entry point, does not expect to
635 * receive data.
636 * <p>Input: nothing
637 * <p>Output: nothing
638 */
639 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
640 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700642 /**
643 * Activity Action: Display the data to the user. This is the most common
644 * action performed on data -- it is the generic action you can use on
645 * a piece of data to get the most reasonable thing to occur. For example,
646 * when used on a contacts entry it will view the entry; when used on a
647 * mailto: URI it will bring up a compose window filled with the information
648 * supplied by the URI; when used with a tel: URI it will invoke the
649 * dialer.
650 * <p>Input: {@link #getData} is URI from which to retrieve data.
651 * <p>Output: nothing.
652 */
653 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
654 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800655
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700656 /**
657 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
658 * performed on a piece of data.
659 */
660 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800661
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700662 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900663 * Activity Action: Quick view the data. Launches a quick viewer for
664 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900665 * <p>Activities handling this intent action should handle the vast majority of
666 * MIME types rather than only specific ones.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900667 * <p>Input: {@link #getData} is a mandatory content URI of the item to
668 * preview. {@link #getClipData} contains an optional list of content URIs
669 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
670 * optional index of the URI in the clip data to show first.
Steve McKayc78bcb82015-07-31 14:35:22 -0700671 * <p>Output: nothing.
Steve McKayc78bcb82015-07-31 14:35:22 -0700672 */
673 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
674 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
675
676 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 * Used to indicate that some piece of data should be attached to some other
678 * place. For example, image data could be attached to a contact. It is up
679 * to the recipient to decide where the data should be attached; the intent
680 * does not specify the ultimate destination.
681 * <p>Input: {@link #getData} is URI of data to be attached.
682 * <p>Output: nothing.
683 */
684 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
685 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800686
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700687 /**
688 * Activity Action: Provide explicit editable access to the given data.
689 * <p>Input: {@link #getData} is URI of data to be edited.
690 * <p>Output: nothing.
691 */
692 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
693 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800694
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700695 /**
696 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
697 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
698 * The extras can contain type specific data to pass through to the editing/creating
699 * activity.
700 * <p>Output: The URI of the item that was picked. This must be a content:
701 * URI so that any receiver can access it.
702 */
703 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
704 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800705
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700706 /**
707 * Activity Action: Pick an item from the data, returning what was selected.
708 * <p>Input: {@link #getData} is URI containing a directory of data
709 * (vnd.android.cursor.dir/*) from which to pick an item.
710 * <p>Output: The URI of the item that was picked.
711 */
712 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
713 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 /**
716 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800717 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700718 * <p>Output: An Intent representing the shortcut. The intent must contain three
719 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
720 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800721 * (value: ShortcutIconResource).</p>
722 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700723 * @see #EXTRA_SHORTCUT_INTENT
724 * @see #EXTRA_SHORTCUT_NAME
725 * @see #EXTRA_SHORTCUT_ICON
726 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
727 * @see android.content.Intent.ShortcutIconResource
728 */
729 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
730 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
731
732 /**
733 * The name of the extra used to define the Intent of a shortcut.
734 *
735 * @see #ACTION_CREATE_SHORTCUT
736 */
737 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
738 /**
739 * The name of the extra used to define the name of a shortcut.
740 *
741 * @see #ACTION_CREATE_SHORTCUT
742 */
743 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
744 /**
745 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
746 *
747 * @see #ACTION_CREATE_SHORTCUT
748 */
749 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
750 /**
751 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
752 *
753 * @see #ACTION_CREATE_SHORTCUT
754 * @see android.content.Intent.ShortcutIconResource
755 */
756 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
757 "android.intent.extra.shortcut.ICON_RESOURCE";
758
759 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500760 * An activity that provides a user interface for adjusting application preferences.
761 * Optional but recommended settings for all applications which have settings.
762 */
763 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
764 public static final String ACTION_APPLICATION_PREFERENCES
765 = "android.intent.action.APPLICATION_PREFERENCES";
766
767 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800768 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700769 *
770 * @see Intent#ACTION_CREATE_SHORTCUT
771 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800772 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
773 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700774 */
775 public static class ShortcutIconResource implements Parcelable {
776 /**
777 * The package name of the application containing the icon.
778 */
779 public String packageName;
780
781 /**
782 * The resource name of the icon, including package, name and type.
783 */
784 public String resourceName;
785
786 /**
787 * Creates a new ShortcutIconResource for the specified context and resource
788 * identifier.
789 *
790 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700791 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700792 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700793 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700794 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700795 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700796 ShortcutIconResource icon = new ShortcutIconResource();
797 icon.packageName = context.getPackageName();
798 icon.resourceName = context.getResources().getResourceName(resourceId);
799 return icon;
800 }
801
802 /**
803 * Used to read a ShortcutIconResource from a Parcel.
804 */
805 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
806 new Parcelable.Creator<ShortcutIconResource>() {
807
808 public ShortcutIconResource createFromParcel(Parcel source) {
809 ShortcutIconResource icon = new ShortcutIconResource();
810 icon.packageName = source.readString();
811 icon.resourceName = source.readString();
812 return icon;
813 }
814
815 public ShortcutIconResource[] newArray(int size) {
816 return new ShortcutIconResource[size];
817 }
818 };
819
820 /**
821 * No special parcel contents.
822 */
823 public int describeContents() {
824 return 0;
825 }
826
827 public void writeToParcel(Parcel dest, int flags) {
828 dest.writeString(packageName);
829 dest.writeString(resourceName);
830 }
831
832 @Override
833 public String toString() {
834 return resourceName;
835 }
836 }
837
838 /**
839 * Activity Action: Display an activity chooser, allowing the user to pick
840 * what they want to before proceeding. This can be used as an alternative
841 * to the standard activity picker that is displayed by the system when
842 * you try to start an activity with multiple possible matches, with these
843 * differences in behavior:
844 * <ul>
845 * <li>You can specify the title that will appear in the activity chooser.
846 * <li>The user does not have the option to make one of the matching
847 * activities a preferred activity, and all possible activities will
848 * always be shown even if one of them is currently marked as the
849 * preferred activity.
850 * </ul>
851 * <p>
852 * This action should be used when the user will naturally expect to
853 * select an activity in order to proceed. An example if when not to use
854 * it is when the user clicks on a "mailto:" link. They would naturally
855 * expect to go directly to their mail app, so startActivity() should be
856 * called directly: it will
857 * either launch the current preferred app, or put up a dialog allowing the
858 * user to pick an app to use and optionally marking that as preferred.
859 * <p>
860 * In contrast, if the user is selecting a menu item to send a picture
861 * they are viewing to someone else, there are many different things they
862 * may want to do at this point: send it through e-mail, upload it to a
863 * web service, etc. In this case the CHOOSER action should be used, to
864 * always present to the user a list of the things they can do, with a
865 * nice title given by the caller such as "Send this photo with:".
866 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700867 * If you need to grant URI permissions through a chooser, you must specify
868 * the permissions to be granted on the ACTION_CHOOSER Intent
869 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
870 * {@link #setClipData} to specify the URIs to be granted as well as
871 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
872 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
873 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700874 * As a convenience, an Intent of this form can be created with the
875 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700876 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700877 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700878 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
879 * and can optionally have a {@link #EXTRA_TITLE} field containing the
880 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700881 * <p>
882 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700883 */
884 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
885 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
886
887 /**
888 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
889 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700890 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
891 * target intent, also optionally supplying a title. If the target
892 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
893 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
894 * set in the returned chooser intent, with its ClipData set appropriately:
895 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500896 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700897 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700898 * @param target The Intent that the user will be selecting an activity
899 * to perform.
900 * @param title Optional title that will be displayed in the chooser.
901 * @return Return a new Intent object that you can hand to
902 * {@link Context#startActivity(Intent) Context.startActivity()} and
903 * related methods.
904 */
905 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700906 return createChooser(target, title, null);
907 }
908
909 /**
910 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
911 *
912 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
913 * target intent, also optionally supplying a title. If the target
914 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
915 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
916 * set in the returned chooser intent, with its ClipData set appropriately:
917 * either a direct reflection of {@link #getClipData()} if that is non-null,
918 * or a new ClipData built from {@link #getData()}.</p>
919 *
920 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
921 * when the user makes a choice. This can be useful if the calling application wants
922 * to remember the last chosen target and surface it as a more prominent or one-touch
923 * affordance elsewhere in the UI for next time.</p>
924 *
925 * @param target The Intent that the user will be selecting an activity
926 * to perform.
927 * @param title Optional title that will be displayed in the chooser.
928 * @param sender Optional IntentSender to be called when a choice is made.
929 * @return Return a new Intent object that you can hand to
930 * {@link Context#startActivity(Intent) Context.startActivity()} and
931 * related methods.
932 */
933 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700934 Intent intent = new Intent(ACTION_CHOOSER);
935 intent.putExtra(EXTRA_INTENT, target);
936 if (title != null) {
937 intent.putExtra(EXTRA_TITLE, title);
938 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700939
Adam Powell0b3c1122014-10-09 12:50:14 -0700940 if (sender != null) {
941 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
942 }
943
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700944 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700945 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
946 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
947 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700948 if (permFlags != 0) {
949 ClipData targetClipData = target.getClipData();
950 if (targetClipData == null && target.getData() != null) {
951 ClipData.Item item = new ClipData.Item(target.getData());
952 String[] mimeTypes;
953 if (target.getType() != null) {
954 mimeTypes = new String[] { target.getType() };
955 } else {
956 mimeTypes = new String[] { };
957 }
958 targetClipData = new ClipData(null, mimeTypes, item);
959 }
960 if (targetClipData != null) {
961 intent.setClipData(targetClipData);
962 intent.addFlags(permFlags);
963 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700964 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700965
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700966 return intent;
967 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700968
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700969 /**
970 * Activity Action: Allow the user to select a particular kind of data and
971 * return it. This is different than {@link #ACTION_PICK} in that here we
972 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800973 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700974 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900975 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700976 * etc.
977 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900978 * 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 -0700979 * of data, such as a person contact, you set the MIME type to the kind of
980 * data you want and launch it with {@link Context#startActivity(Intent)}.
981 * The system will then launch the best application to select that kind
982 * of data for you.
983 * <p>
984 * You may also be interested in any of a set of types of content the user
985 * can pick. For example, an e-mail application that wants to allow the
986 * user to add an attachment to an e-mail message can use this action to
987 * bring up a list of all of the types of content the user can attach.
988 * <p>
989 * In this case, you should wrap the GET_CONTENT intent with a chooser
990 * (through {@link #createChooser}), which will give the proper interface
991 * for the user to pick how to send your data and allow you to specify
992 * a prompt indicating what they are doing. You will usually specify a
993 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
994 * broad range of content types the user can select from.
995 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900996 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700997 * only pick from data that can be represented as a stream. This is
998 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
999 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001000 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001001 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001002 * is locally available on the device. For example, if this extra is set
1003 * to true then an image picker should not show any pictures that are available
1004 * from a remote server but not already on the local device (thus requiring
1005 * they be downloaded when opened).
1006 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001007 * If the caller can handle multiple returned items (the user performing
1008 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1009 * to indicate this.
1010 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001011 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1012 * that no URI is supplied in the intent, as there are no constraints on
1013 * where the returned data originally comes from. You may also include the
1014 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001015 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001016 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1017 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001018 * <p>
1019 * Output: The URI of the item that was picked. This must be a content:
1020 * URI so that any receiver can access it.
1021 */
1022 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1023 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1024 /**
1025 * Activity Action: Dial a number as specified by the data. This shows a
1026 * UI with the number being dialed, allowing the user to explicitly
1027 * initiate the call.
1028 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1029 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1030 * number.
1031 * <p>Output: nothing.
1032 */
1033 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1034 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1035 /**
1036 * Activity Action: Perform a call to someone specified by the data.
1037 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1038 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1039 * number.
1040 * <p>Output: nothing.
1041 *
1042 * <p>Note: there will be restrictions on which applications can initiate a
1043 * call; most applications should use the {@link #ACTION_DIAL}.
1044 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1045 * numbers. Applications can <strong>dial</strong> emergency numbers using
1046 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001047 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001048 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001049 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001050 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001051 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001052 */
1053 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1054 public static final String ACTION_CALL = "android.intent.action.CALL";
1055 /**
1056 * Activity Action: Perform a call to an emergency number specified by the
1057 * data.
1058 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1059 * tel: URI of an explicit phone number.
1060 * <p>Output: nothing.
1061 * @hide
1062 */
1063 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1064 /**
1065 * Activity action: Perform a call to any number (emergency or not)
1066 * specified by the data.
1067 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1068 * tel: URI of an explicit phone number.
1069 * <p>Output: nothing.
1070 * @hide
1071 */
1072 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1073 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001074 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1075 * sending this intent is a no-op.
1076 * <p>Input: No data should be specified. get*Extra may have an optional
1077 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1078 * send the activation result.
1079 * <p>Output: nothing.
1080 * @hide
1081 */
1082 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1083 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1084 "android.intent.action.SIM_ACTIVATION_REQUEST";
1085 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001086 * Activity Action: Send a message to someone specified by the data.
1087 * <p>Input: {@link #getData} is URI describing the target.
1088 * <p>Output: nothing.
1089 */
1090 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1091 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1092 /**
1093 * Activity Action: Deliver some data to someone else. Who the data is
1094 * being delivered to is not specified; it is up to the receiver of this
1095 * action to ask the user where the data should be sent.
1096 * <p>
1097 * When launching a SEND intent, you should usually wrap it in a chooser
1098 * (through {@link #createChooser}), which will give the proper interface
1099 * for the user to pick how to send your data and allow you to specify
1100 * a prompt indicating what they are doing.
1101 * <p>
1102 * Input: {@link #getType} is the MIME type of the data being sent.
1103 * get*Extra can have either a {@link #EXTRA_TEXT}
1104 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1105 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1106 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1107 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001108 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1109 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1110 * your text with HTML formatting.
1111 * <p>
1112 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1113 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1114 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1115 * content: URIs and other advanced features of {@link ClipData}. If
1116 * using this approach, you still must supply the same data through the
1117 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1118 * for compatibility with old applications. If you don't set a ClipData,
1119 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001120 * <p>
1121 * Optional standard extras, which may be interpreted by some recipients as
1122 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1123 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1124 * <p>
1125 * Output: nothing.
1126 */
1127 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1128 public static final String ACTION_SEND = "android.intent.action.SEND";
1129 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001130 * Activity Action: Deliver multiple data to someone else.
1131 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001132 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001133 * <p>
1134 * Input: {@link #getType} is the MIME type of the data being sent.
1135 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001136 * #EXTRA_STREAM} field, containing the data to be sent. If using
1137 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1138 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001139 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001140 * Multiple types are supported, and receivers should handle mixed types
1141 * whenever possible. The right way for the receiver to check them is to
1142 * use the content resolver on each URI. The intent sender should try to
1143 * put the most concrete mime type in the intent type, but it can fall
1144 * back to {@literal <type>/*} or {@literal *}/* as needed.
1145 * <p>
1146 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1147 * be image/jpg, but if you are sending image/jpg and image/png, then the
1148 * intent's type should be image/*.
1149 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001150 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1151 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1152 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1153 * content: URIs and other advanced features of {@link ClipData}. If
1154 * using this approach, you still must supply the same data through the
1155 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1156 * for compatibility with old applications. If you don't set a ClipData,
1157 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1158 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001159 * Optional standard extras, which may be interpreted by some recipients as
1160 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1161 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1162 * <p>
1163 * Output: nothing.
1164 */
1165 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1166 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1167 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001168 * Activity Action: Handle an incoming phone call.
1169 * <p>Input: nothing.
1170 * <p>Output: nothing.
1171 */
1172 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1173 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1174 /**
1175 * Activity Action: Insert an empty item into the given container.
1176 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1177 * in which to place the data.
1178 * <p>Output: URI of the new data that was created.
1179 */
1180 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1181 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1182 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001183 * Activity Action: Create a new item in the given container, initializing it
1184 * from the current contents of the clipboard.
1185 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1186 * in which to place the data.
1187 * <p>Output: URI of the new data that was created.
1188 */
1189 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1190 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1191 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001192 * Activity Action: Delete the given data from its container.
1193 * <p>Input: {@link #getData} is URI of data to be deleted.
1194 * <p>Output: nothing.
1195 */
1196 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1197 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1198 /**
1199 * Activity Action: Run the data, whatever that means.
1200 * <p>Input: ? (Note: this is currently specific to the test harness.)
1201 * <p>Output: nothing.
1202 */
1203 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1204 public static final String ACTION_RUN = "android.intent.action.RUN";
1205 /**
1206 * Activity Action: Perform a data synchronization.
1207 * <p>Input: ?
1208 * <p>Output: ?
1209 */
1210 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1211 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1212 /**
1213 * Activity Action: Pick an activity given an intent, returning the class
1214 * selected.
1215 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1216 * used with {@link PackageManager#queryIntentActivities} to determine the
1217 * set of activities from which to pick.
1218 * <p>Output: Class name of the activity that was selected.
1219 */
1220 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1221 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1222 /**
1223 * Activity Action: Perform a search.
1224 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1225 * is the text to search for. If empty, simply
1226 * enter your search results Activity with the search UI activated.
1227 * <p>Output: nothing.
1228 */
1229 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1230 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1231 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001232 * Activity Action: Start the platform-defined tutorial
1233 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1234 * is the text to search for. If empty, simply
1235 * enter your search results Activity with the search UI activated.
1236 * <p>Output: nothing.
1237 */
1238 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1239 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1240 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001241 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001242 * <p>
1243 * Input: {@link android.app.SearchManager#QUERY
1244 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1245 * a url starts with http or https, the site will be opened. If it is plain
1246 * text, Google search will be applied.
1247 * <p>
1248 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001249 */
1250 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1251 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001252
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001253 /**
Jim Miller07994402012-05-02 14:22:27 -07001254 * Activity Action: Perform assist action.
1255 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001256 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1257 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001258 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1259 * information.
Jim Miller07994402012-05-02 14:22:27 -07001260 * Output: nothing.
1261 */
1262 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1263 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001264
1265 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001266 * Activity Action: Perform voice assist action.
1267 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001268 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1269 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001270 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001271 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001272 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001273 */
1274 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1275 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1276
1277 /**
Adam Skory7140a252013-09-11 12:04:58 +01001278 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1279 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001280 */
1281 public static final String EXTRA_ASSIST_PACKAGE
1282 = "android.intent.extra.ASSIST_PACKAGE";
1283
1284 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001285 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1286 * application package at the time the assist was invoked.
1287 */
1288 public static final String EXTRA_ASSIST_UID
1289 = "android.intent.extra.ASSIST_UID";
1290
1291 /**
Adam Skory7140a252013-09-11 12:04:58 +01001292 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1293 * information supplied by the current foreground app at the time of the assist request.
1294 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001295 */
1296 public static final String EXTRA_ASSIST_CONTEXT
1297 = "android.intent.extra.ASSIST_CONTEXT";
1298
Jim Miller07994402012-05-02 14:22:27 -07001299 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001300 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1301 * keyboard as the primary input device for assistance.
1302 */
1303 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1304 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1305
1306 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001307 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1308 * that was used to invoke the assist.
1309 */
1310 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1311 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1312
1313 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001314 * Activity Action: List all available applications
1315 * <p>Input: Nothing.
1316 * <p>Output: nothing.
1317 */
1318 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1319 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1320 /**
1321 * Activity Action: Show settings for choosing wallpaper
1322 * <p>Input: Nothing.
1323 * <p>Output: Nothing.
1324 */
1325 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1326 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1327
1328 /**
1329 * Activity Action: Show activity for reporting a bug.
1330 * <p>Input: Nothing.
1331 * <p>Output: Nothing.
1332 */
1333 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1334 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1335
1336 /**
1337 * Activity Action: Main entry point for factory tests. Only used when
1338 * the device is booting in factory test node. The implementing package
1339 * must be installed in the system image.
1340 * <p>Input: nothing
1341 * <p>Output: nothing
1342 */
1343 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1344
1345 /**
1346 * Activity Action: The user pressed the "call" button to go to the dialer
1347 * or other appropriate UI for placing a call.
1348 * <p>Input: Nothing.
1349 * <p>Output: Nothing.
1350 */
1351 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1352 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1353
1354 /**
1355 * Activity Action: Start Voice Command.
1356 * <p>Input: Nothing.
1357 * <p>Output: Nothing.
1358 */
1359 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1360 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001361
1362 /**
1363 * Activity Action: Start action associated with long pressing on the
1364 * search key.
1365 * <p>Input: Nothing.
1366 * <p>Output: Nothing.
1367 */
1368 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1369 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001370
Jacek Surazski86b6c532009-05-13 14:38:28 +02001371 /**
1372 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1373 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001374 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001375 * <p>Input: No data is specified. The bug report is passed in using
1376 * an {@link #EXTRA_BUG_REPORT} field.
1377 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001378 *
1379 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001380 */
1381 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1382 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001383
1384 /**
1385 * Activity Action: Show power usage information to the user.
1386 * <p>Input: Nothing.
1387 * <p>Output: Nothing.
1388 */
1389 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1390 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001391
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001392 /**
1393 * Activity Action: Setup wizard to launch after a platform update. This
1394 * activity should have a string meta-data field associated with it,
1395 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1396 * the platform for setup. The activity will be launched only if
1397 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1398 * same value.
1399 * <p>Input: Nothing.
1400 * <p>Output: Nothing.
1401 * @hide
1402 */
1403 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1404 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001405
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001406 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001407 * Activity Action: Show settings for managing network data usage of a
1408 * specific application. Applications should define an activity that offers
1409 * options to control data usage.
1410 */
1411 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1412 public static final String ACTION_MANAGE_NETWORK_USAGE =
1413 "android.intent.action.MANAGE_NETWORK_USAGE";
1414
1415 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001416 * Activity Action: Launch application installer.
1417 * <p>
1418 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001419 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1420 * you can also use "package:<package-name>" to install an application for the
1421 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001422 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1423 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1424 * <p>
1425 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1426 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001427 * <p>
1428 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1429 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1430 * in order to launch the application installer.
1431 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001432 *
1433 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1434 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1435 * @see #EXTRA_RETURN_RESULT
1436 */
1437 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1438 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1439
1440 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001441 * Activity Action: Launch ephemeral installer.
1442 * <p>
1443 * Input: The data must be a http: URI that the ephemeral application is registered
1444 * to handle.
1445 * <p class="note">
1446 * This is a protected intent that can only be sent by the system.
1447 * </p>
1448 *
1449 * @hide
1450 */
1451 @SystemApi
1452 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1453 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1454 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1455
1456 /**
1457 * Service Action: Resolve ephemeral application.
1458 * <p>
1459 * The system will have a persistent connection to this service.
1460 * This is a protected intent that can only be sent by the system.
1461 * </p>
1462 *
1463 * @hide
1464 */
1465 @SystemApi
1466 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1467 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1468 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1469
1470 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001471 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1472 * package. Specifies the installer package name; this package will receive the
1473 * {@link #ACTION_APP_ERROR} intent.
1474 */
1475 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1476 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1477
1478 /**
1479 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1480 * package. Specifies that the application being installed should not be
1481 * treated as coming from an unknown source, but as coming from the app
1482 * invoking the Intent. For this to work you must start the installer with
1483 * startActivityForResult().
1484 */
1485 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1486 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1487
1488 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001489 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1490 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001491 * data field originated from.
1492 */
rich cannings706e8ba2012-08-20 13:20:14 -07001493 public static final String EXTRA_ORIGINATING_URI
1494 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001495
1496 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001497 * This extra can be used with any Intent used to launch an activity, supplying information
1498 * about who is launching that activity. This field contains a {@link android.net.Uri}
1499 * object, typically an http: or https: URI of the web site that the referral came from;
1500 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1501 * a native application that it came from.
1502 *
1503 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1504 * instead of directly retrieving the extra. It is also valid for applications to
1505 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1506 * a string, not a Uri; the field here, if supplied, will always take precedence,
1507 * however.</p>
1508 *
1509 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001510 */
1511 public static final String EXTRA_REFERRER
1512 = "android.intent.extra.REFERRER";
1513
1514 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001515 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1516 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1517 * not be created, in particular when Intent extras are supplied through the
1518 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1519 * schemes.
1520 *
1521 * @see #EXTRA_REFERRER
1522 */
1523 public static final String EXTRA_REFERRER_NAME
1524 = "android.intent.extra.REFERRER_NAME";
1525
1526 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001527 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1528 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1529 * @hide
1530 */
1531 public static final String EXTRA_ORIGINATING_UID
1532 = "android.intent.extra.ORIGINATING_UID";
1533
1534 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001535 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1536 * package. Tells the installer UI to skip the confirmation with the user
1537 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001538 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1539 * will no longer show an interstitial message about updating existing
1540 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001541 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001542 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001543 public static final String EXTRA_ALLOW_REPLACE
1544 = "android.intent.extra.ALLOW_REPLACE";
1545
1546 /**
1547 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1548 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1549 * return to the application the result code of the install/uninstall. The returned result
1550 * code will be {@link android.app.Activity#RESULT_OK} on success or
1551 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1552 */
1553 public static final String EXTRA_RETURN_RESULT
1554 = "android.intent.extra.RETURN_RESULT";
1555
1556 /**
1557 * Package manager install result code. @hide because result codes are not
1558 * yet ready to be exposed.
1559 */
1560 public static final String EXTRA_INSTALL_RESULT
1561 = "android.intent.extra.INSTALL_RESULT";
1562
1563 /**
1564 * Activity Action: Launch application uninstaller.
1565 * <p>
1566 * Input: The data must be a package: URI whose scheme specific part is
1567 * the package name of the current installed package to be uninstalled.
1568 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1569 * <p>
1570 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1571 * succeeded.
1572 */
1573 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1574 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1575
1576 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001577 * Specify whether the package should be uninstalled for all users.
1578 * @hide because these should not be part of normal application flow.
1579 */
1580 public static final String EXTRA_UNINSTALL_ALL_USERS
1581 = "android.intent.extra.UNINSTALL_ALL_USERS";
1582
1583 /**
Suprabh Shukla74a2fe42016-01-27 12:57:24 -08001584 * Specified when the uninstall confirmation dialog is not required to be shown.
1585 * Use with {@link #ACTION_UNINSTALL_PACKAGE}
1586 * @hide
1587 */
1588 public static final String EXTRA_SKIP_UNINSTALL_CONFIRMATION =
1589 "android.intent.extra.SKIP_UNINSTALL_CONFIRMATION";
1590
1591 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001592 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1593 * describing the last run version of the platform that was setup.
1594 * @hide
1595 */
1596 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1597
Svet Ganov3695b8a2015-03-24 16:30:25 -07001598 /**
1599 * Activity action: Launch UI to manage the permissions of an app.
1600 * <p>
1601 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1602 * will be managed by the launched UI.
1603 * </p>
1604 * <p>
1605 * Output: Nothing.
1606 * </p>
1607 *
1608 * @see #EXTRA_PACKAGE_NAME
1609 *
1610 * @hide
1611 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001612 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1613 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1614 "android.intent.action.MANAGE_APP_PERMISSIONS";
1615
1616 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001617 * Activity action: Launch UI to manage permissions.
1618 * <p>
1619 * Input: Nothing.
1620 * </p>
1621 * <p>
1622 * Output: Nothing.
1623 * </p>
1624 *
1625 * @hide
1626 */
Svet Ganov321f0152015-05-16 22:51:50 -07001627 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1628 public static final String ACTION_MANAGE_PERMISSIONS =
1629 "android.intent.action.MANAGE_PERMISSIONS";
1630
1631 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001632 * Activity action: Launch UI to review permissions for an app.
1633 * The system uses this intent if permission review for apps not
1634 * supporting the new runtime permissions model is enabled. In
1635 * this mode a permission review is required before any of the
1636 * app components can run.
1637 * <p>
1638 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1639 * permissions will be reviewed (mandatory).
1640 * </p>
1641 * <p>
1642 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1643 * be fired after the permission review (optional).
1644 * </p>
1645 * <p>
1646 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1647 * be invoked after the permission review (optional).
1648 * </p>
1649 * <p>
1650 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1651 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1652 * </p>
1653 * <p>
1654 * Output: Nothing.
1655 * </p>
1656 *
1657 * @see #EXTRA_PACKAGE_NAME
1658 * @see #EXTRA_INTENT
1659 * @see #EXTRA_REMOTE_CALLBACK
1660 * @see #EXTRA_RESULT_NEEDED
1661 *
1662 * @hide
1663 */
1664 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1665 public static final String ACTION_REVIEW_PERMISSIONS =
1666 "android.intent.action.REVIEW_PERMISSIONS";
1667
1668 /**
1669 * Intent extra: A callback for reporting remote result as a bundle.
1670 * <p>
1671 * Type: IRemoteCallback
1672 * </p>
1673 *
1674 * @hide
1675 */
1676 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1677
1678 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001679 * Intent extra: An app package name.
1680 * <p>
1681 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001682 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001683 *
1684 * @hide
1685 */
1686 @SystemApi
1687 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1688
1689 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001690 * Intent extra: An extra for specifying whether a result is needed.
1691 * <p>
1692 * Type: boolean
1693 * </p>
1694 *
1695 * @hide
1696 */
1697 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1698
1699 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001700 * Broadcast action that requests current permission granted information. It will respond
1701 * to the request by sending a broadcast with action defined by
1702 * {@link #EXTRA_GET_PERMISSIONS_RESPONSE_INTENT}. The response will contain
Makoto Onukibbb912a2015-06-05 16:27:23 -07001703 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}, as well as
1704 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}, with contents described below or
1705 * a null upon failure.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001706 *
Makoto Onukibbb912a2015-06-05 16:27:23 -07001707 * <p>If {@link #EXTRA_PACKAGE_NAME} is included then the number of permissions granted, the
1708 * number of permissions requested and the number of granted additional permissions
1709 * by that package will be calculated and included as the first
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001710 * and second elements respectively of an int[] in the response as
Makoto Onukibbb912a2015-06-05 16:27:23 -07001711 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}. The response will also deliver the list
1712 * of localized permission group names that are granted in
1713 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001714 *
1715 * <p>If {@link #EXTRA_PACKAGE_NAME} is not included then the number of apps granted any runtime
1716 * permissions and the total number of apps requesting runtime permissions will be the first
1717 * and second elements respectively of an int[] in the response as
1718 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1719 *
1720 * @hide
1721 */
1722 public static final String ACTION_GET_PERMISSIONS_COUNT
1723 = "android.intent.action.GET_PERMISSIONS_COUNT";
1724
1725 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001726 * Broadcast action that requests list of all apps that have runtime permissions. It will
1727 * respond to the request by sending a broadcast with action defined by
1728 * {@link #EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT}. The response will contain
1729 * {@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT}, as well as
1730 * {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}, with contents described below or
1731 * a null upon failure.
1732 *
1733 * <p>{@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT} will contain a list of package names of
1734 * apps that have runtime permissions. {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}
1735 * will contain the list of app labels corresponding ot the apps in the first list.
1736 *
1737 * @hide
1738 */
1739 public static final String ACTION_GET_PERMISSIONS_PACKAGES
1740 = "android.intent.action.GET_PERMISSIONS_PACKAGES";
1741
1742 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001743 * Extra included in response to {@link #ACTION_GET_PERMISSIONS_COUNT}.
1744 * @hide
1745 */
1746 public static final String EXTRA_GET_PERMISSIONS_COUNT_RESULT
1747 = "android.intent.extra.GET_PERMISSIONS_COUNT_RESULT";
1748
1749 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001750 * List of CharSequence of localized permission group labels.
1751 * @hide
1752 */
1753 public static final String EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT
1754 = "android.intent.extra.GET_PERMISSIONS_GROUP_LIST_RESULT";
1755
1756 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001757 * String list of apps that have one or more runtime permissions.
1758 * @hide
1759 */
1760 public static final String EXTRA_GET_PERMISSIONS_APP_LIST_RESULT
1761 = "android.intent.extra.GET_PERMISSIONS_APP_LIST_RESULT";
1762
1763 /**
1764 * String list of app labels for apps that have one or more runtime permissions.
1765 * @hide
1766 */
1767 public static final String EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT
1768 = "android.intent.extra.GET_PERMISSIONS_APP_LABEL_LIST_RESULT";
1769
1770 /**
Anthony Hugh3575a402015-10-26 17:47:05 -07001771 * Boolean list describing if the app is a system app for apps that have one or more runtime
1772 * permissions.
1773 * @hide
1774 */
1775 public static final String EXTRA_GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT
1776 = "android.intent.extra.GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT";
1777
1778 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001779 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_COUNT} broadcasts.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001780 * @hide
1781 */
1782 public static final String EXTRA_GET_PERMISSIONS_RESPONSE_INTENT
1783 = "android.intent.extra.GET_PERMISSIONS_RESONSE_INTENT";
1784
1785 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001786 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_PACKAGES} broadcasts.
1787 * @hide
1788 */
1789 public static final String EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT
1790 = "android.intent.extra.GET_PERMISSIONS_PACKAGES_RESONSE_INTENT";
1791
1792 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001793 * Activity action: Launch UI to manage which apps have a given permission.
1794 * <p>
1795 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1796 * to which will be managed by the launched UI.
1797 * </p>
1798 * <p>
1799 * Output: Nothing.
1800 * </p>
1801 *
1802 * @see #EXTRA_PERMISSION_NAME
1803 *
1804 * @hide
1805 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001806 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1807 public static final String ACTION_MANAGE_PERMISSION_APPS =
1808 "android.intent.action.MANAGE_PERMISSION_APPS";
1809
1810 /**
1811 * Intent extra: The name of a permission.
1812 * <p>
1813 * Type: String
1814 * </p>
1815 *
1816 * @hide
1817 */
1818 @SystemApi
1819 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1820
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001821 // ---------------------------------------------------------------------
1822 // ---------------------------------------------------------------------
1823 // Standard intent broadcast actions (see action variable).
1824
1825 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001826 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1827 * <p>
1828 * For historical reasons, the name of this broadcast action refers to the power
1829 * state of the screen but it is actually sent in response to changes in the
1830 * overall interactive state of the device.
1831 * </p><p>
1832 * This broadcast is sent when the device becomes non-interactive which may have
1833 * nothing to do with the screen turning off. To determine the
1834 * actual state of the screen, use {@link android.view.Display#getState}.
1835 * </p><p>
1836 * See {@link android.os.PowerManager#isInteractive} for details.
1837 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001838 * You <em>cannot</em> receive this through components declared in
1839 * manifests, only by explicitly registering for it with
1840 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1841 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001842 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001843 * <p class="note">This is a protected intent that can only be sent
1844 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001848
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001849 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001850 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1851 * <p>
1852 * For historical reasons, the name of this broadcast action refers to the power
1853 * state of the screen but it is actually sent in response to changes in the
1854 * overall interactive state of the device.
1855 * </p><p>
1856 * This broadcast is sent when the device becomes interactive which may have
1857 * nothing to do with the screen turning on. To determine the
1858 * actual state of the screen, use {@link android.view.Display#getState}.
1859 * </p><p>
1860 * See {@link android.os.PowerManager#isInteractive} for details.
1861 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001862 * You <em>cannot</em> receive this through components declared in
1863 * manifests, only by explicitly registering for it with
1864 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1865 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001866 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001867 * <p class="note">This is a protected intent that can only be sent
1868 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001869 */
1870 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1871 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001872
1873 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001874 * Broadcast Action: Sent after the system stops dreaming.
1875 *
1876 * <p class="note">This is a protected intent that can only be sent by the system.
1877 * It is only sent to registered receivers.</p>
1878 */
1879 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1880 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1881
1882 /**
1883 * Broadcast Action: Sent after the system starts dreaming.
1884 *
1885 * <p class="note">This is a protected intent that can only be sent by the system.
1886 * It is only sent to registered receivers.</p>
1887 */
1888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1889 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1890
1891 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001892 * 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 -07001893 * keyguard is gone).
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 Projectb2a3dd82009-03-09 11:52:12 -07001897 */
1898 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001899 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001900
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001901 /**
1902 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001903 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001904 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001905 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1906 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001907 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001908 * <p class="note">This is a protected intent that can only be sent
1909 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001910 */
1911 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1912 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1913 /**
1914 * Broadcast Action: The time was set.
1915 */
1916 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1917 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1918 /**
1919 * Broadcast Action: The date has changed.
1920 */
1921 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1922 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1923 /**
1924 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1925 * <ul>
1926 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1927 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001928 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001929 * <p class="note">This is a protected intent that can only be sent
1930 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001931 */
1932 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1933 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1934 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001935 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1936 * DNS entries should be tossed.
1937 * @hide
1938 */
1939 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1940 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1941 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001942 * Alarm Changed Action: This is broadcast when the AlarmClock
1943 * application's alarm is set or unset. It is used by the
1944 * AlarmClock application and the StatusBar service.
1945 * @hide
1946 */
1947 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1948 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001949
1950 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001951 * Broadcast Action: This is broadcast once, after the user has finished
1952 * booting, but while still in the "locked" state. It can be used to perform
1953 * application-specific initialization, such as installing alarms. You must
1954 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1955 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001956 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001957 * This broadcast is sent immediately at boot by all devices (regardless of
1958 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1959 * higher. Upon receipt of this broadcast, the user is still locked and only
1960 * device-protected storage can be accessed safely. If you want to access
1961 * credential-protected storage, you need to wait for the user to be
1962 * unlocked (typically by entering their lock pattern or PIN for the first
1963 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1964 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1965 * <p>
1966 * To receive this broadcast, your receiver component must be marked as
1967 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001968 * <p class="note">
1969 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001970 *
1971 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001972 */
1973 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1974 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1975
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001976 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001977 * Broadcast Action: This is broadcast once, after the user has finished
1978 * booting. It can be used to perform application-specific initialization,
1979 * such as installing alarms. You must hold the
1980 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1981 * order to receive this broadcast.
1982 * <p>
1983 * This broadcast is sent at boot by all devices (both with and without
1984 * direct boot support). Upon receipt of this broadcast, the user is
1985 * unlocked and both device-protected and credential-protected storage can
1986 * accessed safely.
1987 * <p>
1988 * If you need to run while the user is still locked (before they've entered
1989 * their lock pattern or PIN for the first time), you can listen for the
1990 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1991 * <p class="note">
1992 * This is a protected intent that can only be sent 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_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001996
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001997 /**
1998 * Broadcast Action: This is broadcast when a user action should request a
1999 * temporary system dialog to dismiss. Some examples of temporary system
2000 * dialogs are the notification window-shade and the recent tasks dialog.
2001 */
2002 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2003 /**
2004 * Broadcast Action: Trigger the download and eventual installation
2005 * of a package.
2006 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002007 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002008 * <p class="note">This is a protected intent that can only be sent
2009 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002010 *
2011 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002012 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002013 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002014 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2015 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2016 /**
2017 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002018 * device. The data contains the name of the package. Note that the
2019 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002020 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002021 * <ul>
2022 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2023 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
2024 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2025 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002026 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002027 * <p class="note">This is a protected intent that can only be sent
2028 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002029 */
2030 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2031 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2032 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002033 * Broadcast Action: A new version of an application package has been
2034 * installed, replacing an existing version that was previously installed.
2035 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002036 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002037 * <ul>
2038 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2039 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002040 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002041 * <p class="note">This is a protected intent that can only be sent
2042 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002043 */
2044 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2045 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2046 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002047 * Broadcast Action: A new version of your application has been installed
2048 * over an existing one. This is only sent to the application that was
2049 * replaced. It does not contain any additional data; to receive it, just
2050 * use an intent filter for this action.
2051 *
2052 * <p class="note">This is a protected intent that can only be sent
2053 * by the system.
2054 */
2055 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2056 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2057 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002058 * Broadcast Action: An existing application package has been removed from
2059 * the device. The data contains the name of the package. The package
2060 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002061 * <ul>
2062 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2063 * to the package.
2064 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2065 * application -- data and code -- is being removed.
2066 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2067 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2068 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002069 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002070 * <p class="note">This is a protected intent that can only be sent
2071 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002072 */
2073 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2074 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2075 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002076 * Broadcast Action: An existing application package has been completely
2077 * removed from the device. The data contains the name of the package.
2078 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2079 * {@link #EXTRA_DATA_REMOVED} is true and
2080 * {@link #EXTRA_REPLACING} is false of that broadcast.
2081 *
2082 * <ul>
2083 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2084 * to the package.
2085 * </ul>
2086 *
2087 * <p class="note">This is a protected intent that can only be sent
2088 * by the system.
2089 */
2090 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2091 public static final String ACTION_PACKAGE_FULLY_REMOVED
2092 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2093 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002094 * Broadcast Action: An existing application package has been changed (e.g.
2095 * a component has been enabled or disabled). The data contains the name of
2096 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002097 * <ul>
2098 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002099 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002100 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002101 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2102 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002103 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002104 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002105 * <p class="note">This is a protected intent that can only be sent
2106 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002107 */
2108 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2109 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2110 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002111 * @hide
2112 * Broadcast Action: Ask system services if there is any reason to
2113 * restart the given package. The data contains the name of the
2114 * package.
2115 * <ul>
2116 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2117 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2118 * </ul>
2119 *
2120 * <p class="note">This is a protected intent that can only be sent
2121 * by the system.
2122 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002123 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2125 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2126 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002127 * Broadcast Action: The user has restarted a package, and all of its
2128 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002129 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002130 * be removed. Note that the restarted package does <em>not</em>
2131 * receive this broadcast.
2132 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002133 * <ul>
2134 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2135 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002136 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002137 * <p class="note">This is a protected intent that can only be sent
2138 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002139 */
2140 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2141 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2142 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002143 * Broadcast Action: The user has cleared the data of a package. This should
2144 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002145 * its persistent data is erased and this broadcast sent.
2146 * Note that the cleared package does <em>not</em>
2147 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002148 * <ul>
2149 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2150 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002151 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002152 * <p class="note">This is a protected intent that can only be sent
2153 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002154 */
2155 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2156 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2157 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002158 * Broadcast Action: Packages have been suspended.
2159 * <p>Includes the following extras:
2160 * <ul>
2161 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2162 * </ul>
2163 *
2164 * <p class="note">This is a protected intent that can only be sent
2165 * by the system. It is only sent to registered receivers.
2166 */
2167 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2168 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2169 /**
2170 * Broadcast Action: Packages have been unsuspended.
2171 * <p>Includes the following extras:
2172 * <ul>
2173 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2174 * </ul>
2175 *
2176 * <p class="note">This is a protected intent that can only be sent
2177 * by the system. It is only sent to registered receivers.
2178 */
2179 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2180 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2181 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002182 * Broadcast Action: A user ID has been removed from the system. The user
2183 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002184 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002185 * <p class="note">This is a protected intent that can only be sent
2186 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002187 */
2188 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2189 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002190
2191 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002192 * Broadcast Action: Sent to the installer package of an application
2193 * when that application is first launched (that is the first time it
2194 * is moved out of the stopped state). The data contains the name of the package.
2195 *
2196 * <p class="note">This is a protected intent that can only be sent
2197 * by the system.
2198 */
2199 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2200 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2201
2202 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002203 * Broadcast Action: Sent to the system package verifier when a package
2204 * needs to be verified. The data contains the package URI.
2205 * <p class="note">
2206 * This is a protected intent that can only be sent by the system.
2207 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002208 */
2209 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2210 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2211
2212 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002213 * Broadcast Action: Sent to the system package verifier when a package is
2214 * verified. The data contains the package URI.
2215 * <p class="note">
2216 * This is a protected intent that can only be sent by the system.
2217 */
2218 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2219 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2220
2221 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002222 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
2223 * needs to be verified. The data contains the filter data hosts to be verified against.
2224 * <p class="note">
2225 * This is a protected intent that can only be sent by the system.
2226 * </p>
2227 *
2228 * @hide
2229 */
2230 @SystemApi
2231 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2232 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2233
2234 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002235 * Broadcast Action: Resources for a set of packages (which were
2236 * previously unavailable) are currently
2237 * available since the media on which they exist is available.
2238 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2239 * list of packages whose availability changed.
2240 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2241 * list of uids of packages whose availability changed.
2242 * Note that the
2243 * packages in this list do <em>not</em> receive this broadcast.
2244 * The specified set of packages are now available on the system.
2245 * <p>Includes the following extras:
2246 * <ul>
2247 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2248 * whose resources(were previously unavailable) are currently available.
2249 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2250 * packages whose resources(were previously unavailable)
2251 * are currently available.
2252 * </ul>
2253 *
2254 * <p class="note">This is a protected intent that can only be sent
2255 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002256 */
2257 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002258 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2259 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002260
2261 /**
2262 * Broadcast Action: Resources for a set of packages are currently
2263 * unavailable since the media on which they exist is unavailable.
2264 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2265 * list of packages whose availability changed.
2266 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2267 * list of uids of packages whose availability changed.
2268 * The specified set of packages can no longer be
2269 * launched and are practically unavailable on the system.
2270 * <p>Inclues the following extras:
2271 * <ul>
2272 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2273 * whose resources are no longer available.
2274 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2275 * whose resources are no longer available.
2276 * </ul>
2277 *
2278 * <p class="note">This is a protected intent that can only be sent
2279 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002280 */
2281 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002282 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002283 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002284
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002285 /**
2286 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002287 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002288 * This should <em>only</em> be used to determine when the wallpaper
2289 * has changed to show the new wallpaper to the user. You should certainly
2290 * never, in response to this, change the wallpaper or other attributes of
2291 * it such as the suggested size. That would be crazy, right? You'd cause
2292 * all kinds of loops, especially if other apps are doing similar things,
2293 * right? Of course. So please don't do this.
2294 *
2295 * @deprecated Modern applications should use
2296 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2297 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2298 * shown behind their UI, rather than watching for this broadcast and
2299 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002300 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002301 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002302 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2303 /**
2304 * Broadcast Action: The current device {@link android.content.res.Configuration}
2305 * (orientation, locale, etc) has changed. When such a change happens, the
2306 * UIs (view hierarchy) will need to be rebuilt based on this new
2307 * information; for the most part, applications don't need to worry about
2308 * this, because the system will take care of stopping and restarting the
2309 * application to make sure it sees the new changes. Some system code that
2310 * can not be restarted will need to watch for this action and handle it
2311 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002312 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002313 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002314 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002315 * in manifests, only by explicitly registering for it with
2316 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2317 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002318 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002319 * <p class="note">This is a protected intent that can only be sent
2320 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002321 *
2322 * @see android.content.res.Configuration
2323 */
2324 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2325 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2326 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002327 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002328 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002329 * <p class="note">This is a protected intent that can only be sent
2330 * by the system.
2331 */
2332 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2333 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2334 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002335 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2336 * charging state, level, and other information about the battery.
2337 * See {@link android.os.BatteryManager} for documentation on the
2338 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002339 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002340 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002341 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002342 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002343 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002344 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2345 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2346 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2347 * broadcasts that are sent and can be received through manifest
2348 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002349 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002350 * <p class="note">This is a protected intent that can only be sent
2351 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002352 */
2353 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2354 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2355 /**
2356 * Broadcast Action: Indicates low battery condition on the device.
2357 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002358 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002359 * <p class="note">This is a protected intent that can only be sent
2360 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002361 */
2362 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2363 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2364 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002365 * Broadcast Action: Indicates the battery is now okay after being low.
2366 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2367 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002368 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002369 * <p class="note">This is a protected intent that can only be sent
2370 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002371 */
2372 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2373 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2374 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002375 * Broadcast Action: External power has been connected to the device.
2376 * This is intended for applications that wish to register specifically to this notification.
2377 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2378 * stay active to receive this notification. This action can be used to implement actions
2379 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002380 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002381 * <p class="note">This is a protected intent that can only be sent
2382 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002383 */
2384 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002385 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002386 /**
2387 * Broadcast Action: External power has been removed from the device.
2388 * This is intended for applications that wish to register specifically to this notification.
2389 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2390 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002391 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002392 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002393 * <p class="note">This is a protected intent that can only be sent
2394 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002395 */
2396 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002397 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002398 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002399 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002400 * Broadcast Action: Device is shutting down.
2401 * This is broadcast when the device is being shut down (completely turned
2402 * off, not sleeping). Once the broadcast is complete, the final shutdown
2403 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002404 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002405 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002406 * <p class="note">This is a protected intent that can only be sent
2407 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002408 * <p>May include the following extras:
2409 * <ul>
2410 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2411 * shutdown is only for userspace processes. If not set, assumed to be false.
2412 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002413 */
2414 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002415 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002416 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002417 * Activity Action: Start this activity to request system shutdown.
2418 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002419 * to request confirmation from the user before shutting down. The optional boolean
2420 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2421 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002422 *
2423 * <p class="note">This is a protected intent that can only be sent
2424 * by the system.
2425 *
2426 * {@hide}
2427 */
2428 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2429 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002430 * Broadcast Action: A sticky broadcast that indicates low memory
2431 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002432 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002433 * <p class="note">This is a protected intent that can only be sent
2434 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002435 */
2436 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2437 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2438 /**
2439 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002440 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002441 * <p class="note">This is a protected intent that can only be sent
2442 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002443 */
2444 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2445 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2446 /**
Jake Hambybb371632010-08-23 18:16:48 -07002447 * Broadcast Action: A sticky broadcast that indicates a memory full
2448 * condition on the device. This is intended for activities that want
2449 * to be able to fill the data partition completely, leaving only
2450 * enough free space to prevent system-wide SQLite failures.
2451 *
2452 * <p class="note">This is a protected intent that can only be sent
2453 * by the system.
2454 *
2455 * {@hide}
2456 */
2457 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2458 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2459 /**
2460 * Broadcast Action: Indicates memory full condition on the device
2461 * no longer exists.
2462 *
2463 * <p class="note">This is a protected intent that can only be sent
2464 * by the system.
2465 *
2466 * {@hide}
2467 */
2468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2469 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2470 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002471 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2472 * and package management should be started.
2473 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2474 * notification.
2475 */
2476 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2477 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2478 /**
2479 * Broadcast Action: The device has entered USB Mass Storage mode.
2480 * This is used mainly for the USB Settings panel.
2481 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2482 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002483 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002484 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002485 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002486 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2487
2488 /**
2489 * Broadcast Action: The device has exited USB Mass Storage mode.
2490 * This is used mainly for the USB Settings panel.
2491 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2492 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002493 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002494 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002495 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002496 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2497
2498 /**
2499 * Broadcast Action: External media has been removed.
2500 * The path to the mount point for the removed media is contained in the Intent.mData field.
2501 */
2502 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2503 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2504
2505 /**
2506 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002507 * 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 -07002508 */
2509 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2510 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2511
2512 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002513 * Broadcast Action: External media is present, and being disk-checked
2514 * 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 -08002515 */
2516 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2517 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2518
2519 /**
2520 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2521 * 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 -08002522 */
2523 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2524 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2525
2526 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002527 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002528 * 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 -07002529 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2530 * media was mounted read only.
2531 */
2532 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2533 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2534
2535 /**
2536 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002537 * 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 -07002538 */
2539 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2540 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2541
2542 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002543 * Broadcast Action: External media is no longer being shared via USB mass storage.
2544 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2545 *
2546 * @hide
2547 */
2548 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2549
2550 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002551 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2552 * The path to the mount point for the removed media is contained in the Intent.mData field.
2553 */
2554 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2555 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2556
2557 /**
2558 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002559 * 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 -07002560 */
2561 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2562 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2563
2564 /**
2565 * Broadcast Action: User has expressed the desire to remove the external storage media.
2566 * Applications should close all files they have open within the mount point when they receive this intent.
2567 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2568 */
2569 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2570 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2571
2572 /**
2573 * Broadcast Action: The media scanner has started scanning a directory.
2574 * The path to the directory being scanned is contained in the Intent.mData field.
2575 */
2576 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2577 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2578
2579 /**
2580 * Broadcast Action: The media scanner has finished scanning a directory.
2581 * The path to the scanned directory is contained in the Intent.mData field.
2582 */
2583 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2584 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2585
2586 /**
2587 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2588 * The path to the file is contained in the Intent.mData field.
2589 */
2590 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2591 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2592
2593 /**
2594 * Broadcast Action: The "Media Button" was pressed. Includes a single
2595 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2596 * caused the broadcast.
2597 */
2598 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2599 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2600
2601 /**
2602 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2603 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2604 * caused the broadcast.
2605 */
2606 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2607 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2608
2609 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2610 // location; they are not general-purpose actions.
2611
2612 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002613 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002614 */
2615 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2616 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2617 "android.intent.action.GTALK_CONNECTED";
2618
2619 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002620 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002621 */
2622 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2623 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2624 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002625
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002626 /**
2627 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002628 */
2629 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2630 public static final String ACTION_INPUT_METHOD_CHANGED =
2631 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002632
2633 /**
2634 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2635 * more radios have been turned off or on. The intent will have the following extra value:</p>
2636 * <ul>
2637 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2638 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2639 * turned off</li>
2640 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002641 *
Peng Xua35b5532016-01-20 00:05:45 -08002642 * <p class="note">This is a protected intent that can only be sent by the system.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002643 */
2644 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2645 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2646
2647 /**
2648 * Broadcast Action: Some content providers have parts of their namespace
2649 * where they publish new events or items that the user may be especially
2650 * interested in. For these things, they may broadcast this action when the
2651 * set of interesting items change.
2652 *
2653 * For example, GmailProvider sends this notification when the set of unread
2654 * mail in the inbox changes.
2655 *
2656 * <p>The data of the intent identifies which part of which provider
2657 * changed. When queried through the content resolver, the data URI will
2658 * return the data set in question.
2659 *
2660 * <p>The intent will have the following extra values:
2661 * <ul>
2662 * <li><em>count</em> - The number of items in the data set. This is the
2663 * same as the number of items in the cursor returned by querying the
2664 * data URI. </li>
2665 * </ul>
2666 *
2667 * This intent will be sent at boot (if the count is non-zero) and when the
2668 * data set changes. It is possible for the data set to change without the
2669 * count changing (for example, if a new unread message arrives in the same
2670 * sync operation in which a message is archived). The phone should still
2671 * ring/vibrate/etc as normal in this case.
2672 */
2673 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2674 public static final String ACTION_PROVIDER_CHANGED =
2675 "android.intent.action.PROVIDER_CHANGED";
2676
2677 /**
2678 * Broadcast Action: Wired Headset plugged in or unplugged.
2679 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002680 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2681 * and documentation.
2682 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002683 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002684 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002685 */
2686 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002687 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002688
2689 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002690 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2691 * <ul>
2692 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2693 * </ul>
2694 *
2695 * <p class="note">This is a protected intent that can only be sent
2696 * by the system.
2697 *
2698 * @hide
2699 */
2700 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2701 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2702 = "android.intent.action.ADVANCED_SETTINGS";
2703
2704 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002705 * Broadcast Action: Sent after application restrictions are changed.
2706 *
2707 * <p class="note">This is a protected intent that can only be sent
2708 * by the system.</p>
2709 */
2710 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2711 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2712 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2713
2714 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002715 * Broadcast Action: An outgoing call is about to be placed.
2716 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002717 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002718 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002719 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002720 * the phone number originally intended to be dialed.</li>
2721 * </ul>
2722 * <p>Once the broadcast is finished, the resultData is used as the actual
2723 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002724 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002725 * outgoing call in turn: for example, a parental control application
2726 * might verify that the user is authorized to place the call at that
2727 * time, then a number-rewriting application might add an area code if
2728 * one was not specified.</p>
2729 * <p>For consistency, any receiver whose purpose is to prohibit phone
2730 * calls should have a priority of 0, to ensure it will see the final
2731 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002732 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002733 * should have a positive priority.
2734 * Negative priorities are reserved for the system for this broadcast;
2735 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002736 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2737 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002738 * <p>Emergency calls cannot be intercepted using this mechanism, and
2739 * other calls cannot be modified to call emergency numbers using this
2740 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002741 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2742 * call to use their own service instead. Those apps should first prevent
2743 * the call from being placed by setting resultData to <code>null</code>
2744 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002745 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002746 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2747 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002748 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002749 * <p class="note">This is a protected intent that can only be sent
2750 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002751 */
2752 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2753 public static final String ACTION_NEW_OUTGOING_CALL =
2754 "android.intent.action.NEW_OUTGOING_CALL";
2755
2756 /**
2757 * Broadcast Action: Have the device reboot. This is only for use by
2758 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002759 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002760 * <p class="note">This is a protected intent that can only be sent
2761 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002762 */
2763 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2764 public static final String ACTION_REBOOT =
2765 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002766
Wei Huang97ecc9c2009-05-11 17:44:20 -07002767 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002768 * Broadcast Action: A sticky broadcast for changes in the physical
2769 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002770 *
2771 * <p>The intent will have the following extra values:
2772 * <ul>
2773 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002774 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002775 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002776 * <p>This is intended for monitoring the current physical dock state.
2777 * See {@link android.app.UiModeManager} for the normal API dealing with
2778 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002779 */
2780 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2781 public static final String ACTION_DOCK_EVENT =
2782 "android.intent.action.DOCK_EVENT";
2783
2784 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002785 * Broadcast Action: A broadcast when idle maintenance can be started.
2786 * This means that the user is not interacting with the device and is
2787 * not expected to do so soon. Typical use of the idle maintenance is
2788 * to perform somehow expensive tasks that can be postponed at a moment
2789 * when they will not degrade user experience.
2790 * <p>
2791 * <p class="note">In order to keep the device responsive in case of an
2792 * unexpected user interaction, implementations of a maintenance task
2793 * should be interruptible. In such a scenario a broadcast with action
2794 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2795 * should not do the maintenance work in
2796 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2797 * maintenance service by {@link Context#startService(Intent)}. Also
2798 * you should hold a wake lock while your maintenance service is running
2799 * to prevent the device going to sleep.
2800 * </p>
2801 * <p>
2802 * <p class="note">This is a protected intent that can only be sent by
2803 * the system.
2804 * </p>
2805 *
2806 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002807 *
2808 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002809 */
2810 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2811 public static final String ACTION_IDLE_MAINTENANCE_START =
2812 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2813
2814 /**
2815 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2816 * This means that the user was not interacting with the device as a result
2817 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2818 * was sent and now the user started interacting with the device. Typical
2819 * use of the idle maintenance is to perform somehow expensive tasks that
2820 * can be postponed at a moment when they will not degrade user experience.
2821 * <p>
2822 * <p class="note">In order to keep the device responsive in case of an
2823 * unexpected user interaction, implementations of a maintenance task
2824 * should be interruptible. Hence, on receiving a broadcast with this
2825 * action, the maintenance task should be interrupted as soon as possible.
2826 * In other words, you should not do the maintenance work in
2827 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2828 * maintenance service that was started on receiving of
2829 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2830 * lock you acquired when your maintenance service started.
2831 * </p>
2832 * <p class="note">This is a protected intent that can only be sent
2833 * by the system.
2834 *
2835 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002836 *
2837 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002838 */
2839 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2840 public static final String ACTION_IDLE_MAINTENANCE_END =
2841 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2842
2843 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002844 * Broadcast Action: a remote intent is to be broadcasted.
2845 *
2846 * A remote intent is used for remote RPC between devices. The remote intent
2847 * is serialized and sent from one device to another device. The receiving
2848 * device parses the remote intent and broadcasts it. Note that anyone can
2849 * broadcast a remote intent. However, if the intent receiver of the remote intent
2850 * does not trust intent broadcasts from arbitrary intent senders, it should require
2851 * the sender to hold certain permissions so only trusted sender's broadcast will be
2852 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002853 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002854 */
2855 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002856 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002857
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002858 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002859 * Broadcast Action: This is broadcast once when the user is booting after a
2860 * system update. It can be used to perform cleanup or upgrades after a
2861 * system update.
2862 * <p>
2863 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2864 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2865 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2866 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002867 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002868 * @hide
2869 */
2870 public static final String ACTION_PRE_BOOT_COMPLETED =
2871 "android.intent.action.PRE_BOOT_COMPLETED";
2872
Amith Yamasani13593602012-03-22 16:16:17 -07002873 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002874 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002875 * on restricted users. The broadcast intent contains an extra
2876 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2877 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2878 * String[] depending on the restriction type.<p/>
2879 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002880 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2881 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2882 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002883 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2884 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002885 * @see RestrictionEntry
2886 */
2887 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2888 "android.intent.action.GET_RESTRICTION_ENTRIES";
2889
2890 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002891 * Sent the first time a user is starting, to allow system apps to
2892 * perform one time initialization. (This will not be seen by third
2893 * party applications because a newly initialized user does not have any
2894 * third party applications installed for it.) This is sent early in
2895 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002896 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2897 * broadcast, since it is part of a visible user interaction; be as quick
2898 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002899 */
2900 public static final String ACTION_USER_INITIALIZE =
2901 "android.intent.action.USER_INITIALIZE";
2902
2903 /**
2904 * Sent when a user switch is happening, causing the process's user to be
2905 * brought to the foreground. This is only sent to receivers registered
2906 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2907 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002908 * foreground. This is sent as a foreground
2909 * broadcast, since it is part of a visible user interaction; be as quick
2910 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002911 */
2912 public static final String ACTION_USER_FOREGROUND =
2913 "android.intent.action.USER_FOREGROUND";
2914
2915 /**
2916 * Sent when a user switch is happening, causing the process's user to be
2917 * sent to the background. This is only sent to receivers registered
2918 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2919 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002920 * background. This is sent as a foreground
2921 * broadcast, since it is part of a visible user interaction; be as quick
2922 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002923 */
2924 public static final String ACTION_USER_BACKGROUND =
2925 "android.intent.action.USER_BACKGROUND";
2926
2927 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002928 * Broadcast sent to the system when a user is added. Carries an extra
2929 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2930 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002931 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002932 * @hide
2933 */
2934 public static final String ACTION_USER_ADDED =
2935 "android.intent.action.USER_ADDED";
2936
2937 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002938 * Broadcast sent by the system when a user is started. Carries an extra
2939 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002940 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002941 * that has been started. This is sent as a foreground
2942 * broadcast, since it is part of a visible user interaction; be as quick
2943 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002944 * @hide
2945 */
2946 public static final String ACTION_USER_STARTED =
2947 "android.intent.action.USER_STARTED";
2948
2949 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002950 * Broadcast sent when a user is in the process of starting. Carries an extra
2951 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2952 * sent to registered receivers, not manifest receivers. It is sent to all
2953 * users (including the one that is being started). You must hold
2954 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2955 * this broadcast. This is sent as a background broadcast, since
2956 * its result is not part of the primary UX flow; to safely keep track of
2957 * started/stopped state of a user you can use this in conjunction with
2958 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2959 * other user state broadcasts since those are foreground broadcasts so can
2960 * execute in a different order.
2961 * @hide
2962 */
2963 public static final String ACTION_USER_STARTING =
2964 "android.intent.action.USER_STARTING";
2965
2966 /**
2967 * Broadcast sent when a user is going to be stopped. Carries an extra
2968 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2969 * sent to registered receivers, not manifest receivers. It is sent to all
2970 * users (including the one that is being stopped). You must hold
2971 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2972 * this broadcast. The user will not stop until all receivers have
2973 * handled the broadcast. This is sent as a background broadcast, since
2974 * its result is not part of the primary UX flow; to safely keep track of
2975 * started/stopped state of a user you can use this in conjunction with
2976 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2977 * other user state broadcasts since those are foreground broadcasts so can
2978 * execute in a different order.
2979 * @hide
2980 */
2981 public static final String ACTION_USER_STOPPING =
2982 "android.intent.action.USER_STOPPING";
2983
2984 /**
2985 * Broadcast sent to the system when a user is stopped. Carries an extra
2986 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2987 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2988 * specific package. This is only sent to registered receivers, not manifest
2989 * receivers. It is sent to all running users <em>except</em> the one that
2990 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002991 * @hide
2992 */
2993 public static final String ACTION_USER_STOPPED =
2994 "android.intent.action.USER_STOPPED";
2995
2996 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002997 * 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 -07002998 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002999 * one that has been removed. The user will not be completely removed until all receivers have
3000 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003001 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003002 * @hide
3003 */
3004 public static final String ACTION_USER_REMOVED =
3005 "android.intent.action.USER_REMOVED";
3006
3007 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003008 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003009 * the userHandle of the user to become the current one. This is only sent to
3010 * registered receivers, not manifest receivers. It is sent to all running users.
3011 * You must hold
3012 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003013 * @hide
3014 */
3015 public static final String ACTION_USER_SWITCHED =
3016 "android.intent.action.USER_SWITCHED";
3017
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003018 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003019 * Broadcast Action: Sent when the credential-encrypted private storage has
3020 * become unlocked for the target user. This is only sent to registered
3021 * receivers, not manifest receivers.
3022 */
3023 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3024 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3025
3026 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003027 * Broadcast sent to the system when a user's information changes. Carries an extra
3028 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003029 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003030 * @hide
3031 */
3032 public static final String ACTION_USER_INFO_CHANGED =
3033 "android.intent.action.USER_INFO_CHANGED";
3034
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003035 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003036 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3037 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003038 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3039 * that need to display merged content across both primary and managed profiles need to
3040 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003041 * not manifest receivers.
3042 */
3043 public static final String ACTION_MANAGED_PROFILE_ADDED =
3044 "android.intent.action.MANAGED_PROFILE_ADDED";
3045
3046 /**
3047 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003048 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3049 * Only applications (for example Launchers) that need to display merged content across both
3050 * primary and managed profiles need to worry about this broadcast. This is only sent to
3051 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003052 */
3053 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3054 "android.intent.action.MANAGED_PROFILE_REMOVED";
3055
3056 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003057 * Broadcast sent to the primary user when the credential-encrypted private storage for
3058 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3059 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3060 * Launchers) that need to display merged content across both primary and managed profiles
3061 * need to worry about this broadcast. This is only sent to registered receivers,
3062 * not manifest receivers.
3063 */
3064 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3065 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3066
3067 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003068 * Broadcast sent to the primary user when an associated managed profile's availability has
Rubin Xuf13c9802016-01-21 18:06:00 +00003069 * changed. This includes when the user toggles the profile's quiet mode. Carries an extra
3070 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3071 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3072 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003073 */
3074 public static final String ACTION_MANAGED_PROFILE_AVAILABILITY_CHANGED =
3075 "android.intent.action.MANAGED_PROFILE_AVAILABILITY_CHANGED";
3076
3077 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003078 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3079 */
3080 public static final String ACTION_QUICK_CLOCK =
3081 "android.intent.action.QUICK_CLOCK";
3082
Michael Wright0087a142013-02-05 16:29:39 -08003083 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003084 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003085 * @hide
3086 */
3087 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3088 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3089
Justin Kohd378ad72013-04-01 12:18:26 -07003090 /**
3091 * Broadcast Action: A global button was pressed. Includes a single
3092 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3093 * caused the broadcast.
3094 * @hide
3095 */
3096 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3097
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003098 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003099 * Broadcast Action: Sent when media resource is granted.
3100 * <p>
3101 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3102 * granted.
3103 * </p>
3104 * <p class="note">
3105 * This is a protected intent that can only be sent by the system.
3106 * </p>
3107 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003108 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003109 * </p>
3110 *
3111 * @hide
3112 */
3113 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3114 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3115
3116 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003117 * Activity Action: Allow the user to select and return one or more existing
3118 * documents. When invoked, the system will display the various
3119 * {@link DocumentsProvider} instances installed on the device, letting the
3120 * user interactively navigate through them. These documents include local
3121 * media, such as photos and video, and documents provided by installed
3122 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003123 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003124 * Each document is represented as a {@code content://} URI backed by a
3125 * {@link DocumentsProvider}, which can be opened as a stream with
3126 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3127 * {@link android.provider.DocumentsContract.Document} metadata.
3128 * <p>
3129 * All selected documents are returned to the calling application with
3130 * persistable read and write permission grants. If you want to maintain
3131 * access to the documents across device reboots, you need to explicitly
3132 * take the persistable permissions using
3133 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3134 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003135 * Callers must indicate the acceptable document MIME types through
3136 * {@link #setType(String)}. For example, to select photos, use
3137 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3138 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3139 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003140 * <p>
3141 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003142 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3143 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003144 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003145 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3146 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003147 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003148 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003149 * Output: The URI of the item that was picked, returned in
3150 * {@link #getData()}. This must be a {@code content://} URI so that any
3151 * receiver can access it. If multiple documents were selected, they are
3152 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003153 *
3154 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003155 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003156 * @see #ACTION_CREATE_DOCUMENT
3157 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003158 */
3159 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3160 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3161
3162 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003163 * Activity Action: Allow the user to create a new document. When invoked,
3164 * the system will display the various {@link DocumentsProvider} instances
3165 * installed on the device, letting the user navigate through them. The
3166 * returned document may be a newly created document with no content, or it
3167 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003168 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003169 * Each document is represented as a {@code content://} URI backed by a
3170 * {@link DocumentsProvider}, which can be opened as a stream with
3171 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3172 * {@link android.provider.DocumentsContract.Document} metadata.
3173 * <p>
3174 * Callers must indicate the concrete MIME type of the document being
3175 * created by setting {@link #setType(String)}. This MIME type cannot be
3176 * changed after the document is created.
3177 * <p>
3178 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3179 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003180 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003181 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3182 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003183 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003184 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003185 * Output: The URI of the item that was created. This must be a
3186 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003187 *
3188 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003189 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003190 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003191 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003192 */
3193 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3194 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3195
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003196 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003197 * Activity Action: Allow the user to pick a directory subtree. When
3198 * invoked, the system will display the various {@link DocumentsProvider}
3199 * instances installed on the device, letting the user navigate through
3200 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003201 * <p>
3202 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003203 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3204 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3205 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003206 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003207 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003208 *
3209 * @see DocumentsContract
3210 */
3211 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003212 public static final String
3213 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003214
Felipe Lemec7b1f892016-01-15 15:02:31 -08003215 /**
Peng Xua35b5532016-01-20 00:05:45 -08003216 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3217 * exisiting sensor being disconnected.
3218 *
3219 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3220 *
3221 * {@hide}
3222 */
3223 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3224 public static final String
3225 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3226
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003227 /** {@hide} */
3228 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3229
Christopher Tate6597e342015-02-17 12:15:25 -08003230 /**
3231 * Broadcast action: report that a settings element is being restored from backup. The intent
3232 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3233 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3234 * is the value of that settings entry prior to the restore operation. All of these values are
3235 * represented as strings.
3236 *
3237 * <p>This broadcast is sent only for settings provider entries known to require special handling
3238 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3239 * the provider's backup agent implementation.
3240 *
3241 * @see #EXTRA_SETTING_NAME
3242 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3243 * @see #EXTRA_SETTING_NEW_VALUE
3244 * {@hide}
3245 */
3246 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3247
3248 /** {@hide} */
3249 public static final String EXTRA_SETTING_NAME = "setting_name";
3250 /** {@hide} */
3251 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3252 /** {@hide} */
3253 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3254
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003255 /**
3256 * Activity Action: Process a piece of text.
3257 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3258 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3259 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3260 */
3261 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3262 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3263 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003264 * The name of the extra used to define the text to be processed, as a
3265 * CharSequence. Note that this may be a styled CharSequence, so you must use
3266 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003267 */
3268 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3269 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003270 * 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 +00003271 */
3272 public static final String EXTRA_PROCESS_TEXT_READONLY =
3273 "android.intent.extra.PROCESS_TEXT_READONLY";
3274
Bryce Leebc58f592015-09-25 16:43:01 -07003275 /**
3276 * Broadcast action: reports when a new thermal event has been reached. When the device
3277 * is reaching its maximum temperatue, the thermal level reported
3278 * {@hide}
3279 */
3280 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3281 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3282
3283 /** {@hide} */
3284 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3285
3286 /**
3287 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003288 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003289 * {@hide}
3290 */
3291 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3292
3293 /**
3294 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003295 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003296 * {@hide}
3297 */
3298 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3299
3300 /**
3301 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003302 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003303 * {@hide}
3304 */
3305 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3306
3307
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003308 // ---------------------------------------------------------------------
3309 // ---------------------------------------------------------------------
3310 // Standard intent categories (see addCategory()).
3311
3312 /**
3313 * Set if the activity should be an option for the default action
3314 * (center press) to perform on a piece of data. Setting this will
3315 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003316 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003317 * Intent when initiating an action -- it is for use in intent filters
3318 * specified in packages.
3319 */
3320 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3321 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3322 /**
3323 * Activities that can be safely invoked from a browser must support this
3324 * category. For example, if the user is viewing a web page or an e-mail
3325 * and clicks on a link in the text, the Intent generated execute that
3326 * link will require the BROWSABLE category, so that only activities
3327 * supporting this category will be considered as possible actions. By
3328 * supporting this category, you are promising that there is nothing
3329 * damaging (without user intervention) that can happen by invoking any
3330 * matching Intent.
3331 */
3332 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3333 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3334 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003335 * Categories for activities that can participate in voice interaction.
3336 * An activity that supports this category must be prepared to run with
3337 * no UI shown at all (though in some case it may have a UI shown), and
3338 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3339 */
3340 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3341 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3342 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003343 * Set if the activity should be considered as an alternative action to
3344 * the data the user is currently viewing. See also
3345 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3346 * applies to the selection in a list of items.
3347 *
3348 * <p>Supporting this category means that you would like your activity to be
3349 * displayed in the set of alternative things the user can do, usually as
3350 * part of the current activity's options menu. You will usually want to
3351 * include a specific label in the &lt;intent-filter&gt; of this action
3352 * describing to the user what it does.
3353 *
3354 * <p>The action of IntentFilter with this category is important in that it
3355 * describes the specific action the target will perform. This generally
3356 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3357 * a specific name such as "com.android.camera.action.CROP. Only one
3358 * alternative of any particular action will be shown to the user, so using
3359 * a specific action like this makes sure that your alternative will be
3360 * displayed while also allowing other applications to provide their own
3361 * overrides of that particular action.
3362 */
3363 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3364 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3365 /**
3366 * Set if the activity should be considered as an alternative selection
3367 * action to the data the user has currently selected. This is like
3368 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3369 * of items from which the user can select, giving them alternatives to the
3370 * default action that will be performed on it.
3371 */
3372 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3373 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3374 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003375 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003376 */
3377 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3378 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3379 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003380 * Should be displayed in the top-level launcher.
3381 */
3382 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3383 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3384 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003385 * Indicates an activity optimized for Leanback mode, and that should
3386 * be displayed in the Leanback launcher.
3387 */
3388 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3389 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3390 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003391 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3392 * @hide
3393 */
3394 @SystemApi
3395 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3396 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003397 * Provides information about the package it is in; typically used if
3398 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3399 * a front-door to the user without having to be shown in the all apps list.
3400 */
3401 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3402 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3403 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003404 * This is the home activity, that is the first activity that is displayed
3405 * when the device boots.
3406 */
3407 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3408 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3409 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003410 * This is the home activity that is displayed when the device is finished setting up and ready
3411 * for use.
3412 * @hide
3413 */
3414 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3415 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3416 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003417 * This is the setup wizard activity, that is the first activity that is displayed
3418 * when the user sets up the device for the first time.
3419 * @hide
3420 */
3421 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3422 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3423 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003424 * This activity is a preference panel.
3425 */
3426 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3427 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3428 /**
3429 * This activity is a development preference panel.
3430 */
3431 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3432 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3433 /**
3434 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003435 */
3436 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3437 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3438 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003439 * This activity allows the user to browse and download new applications.
3440 */
3441 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3442 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3443 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003444 * This activity may be exercised by the monkey or other automated test tools.
3445 */
3446 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3447 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3448 /**
3449 * To be used as a test (not part of the normal user experience).
3450 */
3451 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3452 /**
3453 * To be used as a unit test (run through the Test Harness).
3454 */
3455 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3456 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003457 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003458 * experience).
3459 */
3460 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003461
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003462 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003463 * Used to indicate that an intent only wants URIs that can be opened with
3464 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3465 * must support at least the columns defined in {@link OpenableColumns} when
3466 * queried.
3467 *
3468 * @see #ACTION_GET_CONTENT
3469 * @see #ACTION_OPEN_DOCUMENT
3470 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003471 */
3472 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3473 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3474
3475 /**
3476 * To be used as code under test for framework instrumentation tests.
3477 */
3478 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3479 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003480 /**
3481 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003482 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3483 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003484 */
3485 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3486 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3487 /**
3488 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003489 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3490 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003491 */
3492 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3493 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003494 /**
3495 * An activity to run when device is inserted into a analog (low end) dock.
3496 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3497 * information, see {@link android.app.UiModeManager}.
3498 */
3499 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3500 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3501
3502 /**
3503 * An activity to run when device is inserted into a digital (high end) dock.
3504 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3505 * information, see {@link android.app.UiModeManager}.
3506 */
3507 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3508 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003509
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003510 /**
3511 * Used to indicate that the activity can be used in a car environment.
3512 */
3513 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3514 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3515
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003516 // ---------------------------------------------------------------------
3517 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003518 // Application launch intent categories (see addCategory()).
3519
3520 /**
3521 * Used with {@link #ACTION_MAIN} to launch the browser application.
3522 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003523 * <p>NOTE: This should not be used as the primary key of an Intent,
3524 * since it will not result in the app launching with the correct
3525 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003526 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003527 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003528 */
3529 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3530 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3531
3532 /**
3533 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3534 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003535 * <p>NOTE: This should not be used as the primary key of an Intent,
3536 * since it will not result in the app launching with the correct
3537 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003538 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003539 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003540 */
3541 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3542 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3543
3544 /**
3545 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3546 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003547 * <p>NOTE: This should not be used as the primary key of an Intent,
3548 * since it will not result in the app launching with the correct
3549 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003550 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003551 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003552 */
3553 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3554 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3555
3556 /**
3557 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3558 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003559 * <p>NOTE: This should not be used as the primary key of an Intent,
3560 * since it will not result in the app launching with the correct
3561 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003562 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003563 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003564 */
3565 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3566 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3567
3568 /**
3569 * Used with {@link #ACTION_MAIN} to launch the email application.
3570 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003571 * <p>NOTE: This should not be used as the primary key of an Intent,
3572 * since it will not result in the app launching with the correct
3573 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003574 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003575 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003576 */
3577 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3578 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3579
3580 /**
3581 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3582 * The activity should be able to view and manipulate image and video files
3583 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003584 * <p>NOTE: This should not be used as the primary key of an Intent,
3585 * since it will not result in the app launching with the correct
3586 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003587 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003588 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003589 */
3590 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3591 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3592
3593 /**
3594 * Used with {@link #ACTION_MAIN} to launch the maps application.
3595 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003596 * <p>NOTE: This should not be used as the primary key of an Intent,
3597 * since it will not result in the app launching with the correct
3598 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003599 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003600 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003601 */
3602 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3603 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3604
3605 /**
3606 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3607 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003608 * <p>NOTE: This should not be used as the primary key of an Intent,
3609 * since it will not result in the app launching with the correct
3610 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003611 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003612 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003613 */
3614 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3615 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3616
3617 /**
3618 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003619 * The activity should be able to play, browse, or manipulate music files
3620 * stored on the device.
3621 * <p>NOTE: This should not be used as the primary key of an Intent,
3622 * since it will not result in the app launching with the correct
3623 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003624 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003625 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003626 */
3627 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3628 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3629
3630 // ---------------------------------------------------------------------
3631 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003632 // Standard extra data keys.
3633
3634 /**
3635 * The initial data to place in a newly created record. Use with
3636 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3637 * fields as would be given to the underlying ContentProvider.insert()
3638 * call.
3639 */
3640 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3641
3642 /**
3643 * A constant CharSequence that is associated with the Intent, used with
3644 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3645 * this may be a styled CharSequence, so you must use
3646 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3647 * retrieve it.
3648 */
3649 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3650
3651 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003652 * A constant String that is associated with the Intent, used with
3653 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3654 * as HTML formatted text. Note that you <em>must</em> also supply
3655 * {@link #EXTRA_TEXT}.
3656 */
3657 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3658
3659 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003660 * A content: URI holding a stream of data associated with the Intent,
3661 * used with {@link #ACTION_SEND} to supply the data being sent.
3662 */
3663 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3664
3665 /**
3666 * A String[] holding e-mail addresses that should be delivered to.
3667 */
3668 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3669
3670 /**
3671 * A String[] holding e-mail addresses that should be carbon copied.
3672 */
3673 public static final String EXTRA_CC = "android.intent.extra.CC";
3674
3675 /**
3676 * A String[] holding e-mail addresses that should be blind carbon copied.
3677 */
3678 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3679
3680 /**
3681 * A constant string holding the desired subject line of a message.
3682 */
3683 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3684
3685 /**
3686 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003687 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003688 */
3689 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3690
3691 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003692 * An int representing the user id to be used.
3693 *
3694 * @hide
3695 */
3696 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3697
3698 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003699 * An int representing the task id to be retrieved. This is used when a launch from recents is
3700 * intercepted by another action such as credentials confirmation to remember which task should
3701 * be resumed when complete.
3702 *
3703 * @hide
3704 */
3705 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3706
3707 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003708 * An Intent[] describing additional, alternate choices you would like shown with
3709 * {@link #ACTION_CHOOSER}.
3710 *
3711 * <p>An app may be capable of providing several different payload types to complete a
3712 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3713 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3714 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3715 * photo data or a hosted link where the photos can be viewed.</p>
3716 *
3717 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3718 * first/primary/preferred intent in the set. Additional intents specified in
3719 * this extra are ordered; by default intents that appear earlier in the array will be
3720 * preferred over intents that appear later in the array as matches for the same
3721 * target component. To alter this preference, a calling app may also supply
3722 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3723 */
3724 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3725
3726 /**
3727 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3728 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3729 *
3730 * <p>An app preparing an action for another app to complete may wish to allow the user to
3731 * disambiguate between several options for completing the action based on the chosen target
3732 * or otherwise refine the action before it is invoked.
3733 * </p>
3734 *
3735 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3736 * <ul>
3737 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3738 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3739 * chosen target beyond the first</li>
3740 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3741 * should fill in and send once the disambiguation is complete</li>
3742 * </ul>
3743 */
3744 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3745 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3746
3747 /**
3748 * A {@link ResultReceiver} used to return data back to the sender.
3749 *
3750 * <p>Used to complete an app-specific
3751 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3752 *
3753 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3754 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3755 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3756 * when the user selects a target component from the chooser. It is up to the recipient
3757 * to send a result to this ResultReceiver to signal that disambiguation is complete
3758 * and that the chooser should invoke the user's choice.</p>
3759 *
3760 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3761 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3762 * to match and fill in the final Intent or ChooserTarget before starting it.
3763 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3764 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3765 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3766 *
3767 * <p>The result code passed to the ResultReceiver should be
3768 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3769 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3770 * the chooser should finish without starting a target.</p>
3771 */
3772 public static final String EXTRA_RESULT_RECEIVER
3773 = "android.intent.extra.RESULT_RECEIVER";
3774
3775 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003776 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003777 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003778 */
3779 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3780
3781 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003782 * A Parcelable[] of {@link Intent} or
3783 * {@link android.content.pm.LabeledIntent} objects as set with
3784 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3785 * a the front of the list of choices, when shown to the user with a
3786 * {@link #ACTION_CHOOSER}.
3787 */
3788 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3789
3790 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003791 * A {@link IntentSender} to start after ephemeral installation success.
3792 * @hide
3793 */
3794 @SystemApi
3795 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3796
3797 /**
3798 * A {@link IntentSender} to start after ephemeral installation failure.
3799 * @hide
3800 */
3801 @SystemApi
3802 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3803
3804 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003805 * A Bundle forming a mapping of potential target package names to different extras Bundles
3806 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3807 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3808 * be currently installed on the device.
3809 *
3810 * <p>An application may choose to provide alternate extras for the case where a user
3811 * selects an activity from a predetermined set of target packages. If the activity
3812 * the user selects from the chooser belongs to a package with its package name as
3813 * a key in this bundle, the corresponding extras for that package will be merged with
3814 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3815 * extra has the same key as an extra already present in the intent it will overwrite
3816 * the extra from the intent.</p>
3817 *
3818 * <p><em>Examples:</em>
3819 * <ul>
3820 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3821 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3822 * parameters for that target.</li>
3823 * <li>An application may offer additional metadata for known targets of a given intent
3824 * to pass along information only relevant to that target such as account or content
3825 * identifiers already known to that application.</li>
3826 * </ul></p>
3827 */
3828 public static final String EXTRA_REPLACEMENT_EXTRAS =
3829 "android.intent.extra.REPLACEMENT_EXTRAS";
3830
3831 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003832 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3833 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3834 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3835 * {@link ComponentName} of the chosen component.
3836 *
3837 * <p>In some situations this callback may never come, for example if the user abandons
3838 * the chooser, switches to another task or any number of other reasons. Apps should not
3839 * be written assuming that this callback will always occur.</p>
3840 */
3841 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3842 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3843
3844 /**
3845 * The {@link ComponentName} chosen by the user to complete an action.
3846 *
3847 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3848 */
3849 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3850
3851 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003852 * A {@link android.view.KeyEvent} object containing the event that
3853 * triggered the creation of the Intent it is in.
3854 */
3855 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3856
3857 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003858 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3859 * before shutting down.
3860 *
3861 * {@hide}
3862 */
3863 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3864
3865 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003866 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3867 * requested by the user.
3868 *
3869 * {@hide}
3870 */
3871 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3872 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3873
3874 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003875 * 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 -07003876 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3877 * of restarting the application.
3878 */
3879 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3880
3881 /**
3882 * A String holding the phone number originally entered in
3883 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3884 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3885 */
3886 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003887
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003888 /**
3889 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3890 * intents to supply the uid the package had been assigned. Also an optional
3891 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3892 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3893 * purpose.
3894 */
3895 public static final String EXTRA_UID = "android.intent.extra.UID";
3896
3897 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003898 * @hide String array of package names.
3899 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003900 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003901 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3902
3903 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003904 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3905 * intents to indicate whether this represents a full uninstall (removing
3906 * both the code and its data) or a partial uninstall (leaving its data,
3907 * implying that this is an update).
3908 */
3909 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003910
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003911 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003912 * @hide
3913 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3914 * intents to indicate that at this point the package has been removed for
3915 * all users on the device.
3916 */
3917 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3918 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3919
3920 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003921 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3922 * intents to indicate that this is a replacement of the package, so this
3923 * broadcast will immediately be followed by an add broadcast for a
3924 * different version of the same package.
3925 */
3926 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003927
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003928 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003929 * Used as an int extra field in {@link android.app.AlarmManager} intents
3930 * to tell the application being invoked how many pending alarms are being
3931 * delievered with the intent. For one-shot alarms this will always be 1.
3932 * For recurring alarms, this might be greater than 1 if the device was
3933 * asleep or powered off at the time an earlier alarm would have been
3934 * delivered.
3935 */
3936 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003937
Jacek Surazski86b6c532009-05-13 14:38:28 +02003938 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003939 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3940 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003941 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3942 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003943 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3944 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3945 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003946 */
3947 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3948
3949 /**
3950 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3951 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003952 */
3953 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3954
3955 /**
3956 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3957 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003958 */
3959 public static final int EXTRA_DOCK_STATE_DESK = 1;
3960
3961 /**
3962 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3963 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003964 */
3965 public static final int EXTRA_DOCK_STATE_CAR = 2;
3966
3967 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003968 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3969 * to represent that the phone is in a analog (low end) dock.
3970 */
3971 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3972
3973 /**
3974 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3975 * to represent that the phone is in a digital (high end) dock.
3976 */
3977 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3978
3979 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003980 * Boolean that can be supplied as meta-data with a dock activity, to
3981 * indicate that the dock should take over the home key when it is active.
3982 */
3983 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003984
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003985 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003986 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3987 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003988 */
3989 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3990
3991 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003992 * Used in the extra field in the remote intent. It's astring token passed with the
3993 * remote intent.
3994 */
3995 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3996 "android.intent.extra.remote_intent_token";
3997
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003998 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003999 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004000 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004001 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004002 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004003 "android.intent.extra.changed_component_name";
4004
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004005 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004006 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004007 * and contains a string array of all of the components that have changed. If
4008 * the state of the overall package has changed, then it will contain an entry
4009 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004010 */
4011 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4012 "android.intent.extra.changed_component_name_list";
4013
4014 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004015 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004016 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004017 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4018 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4019 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004020 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004021 */
4022 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4023 "android.intent.extra.changed_package_list";
4024
4025 /**
4026 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004027 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4028 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004029 * and contains an integer array of uids of all of the components
4030 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004031 */
4032 public static final String EXTRA_CHANGED_UID_LIST =
4033 "android.intent.extra.changed_uid_list";
4034
4035 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004036 * @hide
4037 * Magic extra system code can use when binding, to give a label for
4038 * who it is that has bound to a service. This is an integer giving
4039 * a framework string resource that can be displayed to the user.
4040 */
4041 public static final String EXTRA_CLIENT_LABEL =
4042 "android.intent.extra.client_label";
4043
4044 /**
4045 * @hide
4046 * Magic extra system code can use when binding, to give a PendingIntent object
4047 * that can be launched for the user to disable the system's use of this
4048 * service.
4049 */
4050 public static final String EXTRA_CLIENT_INTENT =
4051 "android.intent.extra.client_intent";
4052
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004053 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004054 * Extra used to indicate that an intent should only return data that is on
4055 * the local device. This is a boolean extra; the default is false. If true,
4056 * an implementation should only allow the user to select data that is
4057 * already on the device, not requiring it be downloaded from a remote
4058 * service when opened.
4059 *
4060 * @see #ACTION_GET_CONTENT
4061 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004062 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004063 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004064 */
4065 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004066 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004067
Amith Yamasani13593602012-03-22 16:16:17 -07004068 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004069 * Extra used to indicate that an intent can allow the user to select and
4070 * return multiple items. This is a boolean extra; the default is false. If
4071 * true, an implementation is allowed to present the user with a UI where
4072 * they can pick multiple items that are all returned to the caller. When
4073 * this happens, they should be returned as the {@link #getClipData()} part
4074 * of the result Intent.
4075 *
4076 * @see #ACTION_GET_CONTENT
4077 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004078 */
4079 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004080 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004081
4082 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004083 * The integer userHandle carried with broadcast intents related to addition, removal and
4084 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4085 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4086 *
Amith Yamasani13593602012-03-22 16:16:17 -07004087 * @hide
4088 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004089 public static final String EXTRA_USER_HANDLE =
4090 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004091
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004092 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004093 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4094 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4095 */
4096 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004097 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004098
4099 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004100 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004101 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4102 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004103 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004104 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4105
4106 /**
4107 * Extra sent in the intent to the BroadcastReceiver that handles
4108 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4109 * the restrictions as key/value pairs.
4110 */
4111 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4112 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004113
Amith Yamasani86118ba2013-03-28 14:33:16 -07004114 /**
4115 * Extra used in the response from a BroadcastReceiver that handles
4116 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4117 */
4118 public static final String EXTRA_RESTRICTIONS_INTENT =
4119 "android.intent.extra.restrictions_intent";
4120
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004121 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004122 * Extra used to communicate a set of acceptable MIME types. The type of the
4123 * extra is {@code String[]}. Values may be a combination of concrete MIME
4124 * types (such as "image/png") and/or partial MIME types (such as
4125 * "audio/*").
4126 *
4127 * @see #ACTION_GET_CONTENT
4128 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004129 */
4130 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4131
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004132 /**
4133 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4134 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004135 * When this is true, hardware devices can use this information to determine that
4136 * they shouldn't do a complete shutdown of their device since this is not a
4137 * complete shutdown down to the kernel, but only user space restarting.
4138 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004139 */
4140 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4141 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4142
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004143 /**
4144 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4145 * user has set their time format preferences to the 24 hour format.
4146 *
4147 * @hide for internal use only.
4148 */
4149 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4150 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4151
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004152 /** {@hide} */
4153 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4154
Rubin Xue8490f12015-06-25 12:17:48 +01004155 /** {@hide} */
4156 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4157
Santos Cordon15a13782015-03-31 18:32:31 -07004158 /**
4159 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4160 * activation request.
4161 * TODO: Add information about the structure and response data used with the pending intent.
4162 * @hide
4163 */
4164 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4165 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4166
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004167 /**
4168 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004169 *
4170 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004171 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004172 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4173
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004174 /**
4175 * Optional boolean extra indicating whether quiet mode has been switched on or off.
4176 */
4177 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004178
4179 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004180 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004181 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004182 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4183 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004184 *
4185 * @hide
4186 */
4187 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4188 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4189
4190 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004191 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004192 * to represent that a video codec is allowed to use.
4193 *
4194 * @hide
4195 */
4196 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4197
4198 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004199 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004200 * to represent that a audio codec is allowed to use.
4201 *
4202 * @hide
4203 */
4204 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4205
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004206 // ---------------------------------------------------------------------
4207 // ---------------------------------------------------------------------
4208 // Intent flags (see mFlags variable).
4209
Tor Norbyed9273d62013-05-30 15:59:53 -07004210 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004211 @IntDef(flag = true, value = {
4212 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4213 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004214 @Retention(RetentionPolicy.SOURCE)
4215 public @interface GrantUriMode {}
4216
Jeff Sharkey846318a2014-04-04 12:12:41 -07004217 /** @hide */
4218 @IntDef(flag = true, value = {
4219 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4220 @Retention(RetentionPolicy.SOURCE)
4221 public @interface AccessUriMode {}
4222
4223 /**
4224 * Test if given mode flags specify an access mode, which must be at least
4225 * read and/or write.
4226 *
4227 * @hide
4228 */
4229 public static boolean isAccessUriMode(int modeFlags) {
4230 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4231 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4232 }
4233
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004234 /**
4235 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004236 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004237 * specified in its ClipData. When applying to an Intent's ClipData,
4238 * all URIs as well as recursive traversals through data or other ClipData
4239 * in Intent items will be granted; only the grant flags of the top-level
4240 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004241 */
4242 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4243 /**
4244 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004245 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004246 * specified in its ClipData. When applying to an Intent's ClipData,
4247 * all URIs as well as recursive traversals through data or other ClipData
4248 * in Intent items will be granted; only the grant flags of the top-level
4249 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004250 */
4251 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4252 /**
4253 * Can be set by the caller to indicate that this Intent is coming from
4254 * a background operation, not from direct user interaction.
4255 */
4256 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4257 /**
4258 * A flag you can enable for debugging: when set, log messages will be
4259 * printed during the resolution of this intent to show you what has
4260 * been found to create the final resolved list.
4261 */
4262 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004263 /**
4264 * If set, this intent will not match any components in packages that
4265 * are currently stopped. If this is not set, then the default behavior
4266 * is to include such applications in the result.
4267 */
4268 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4269 /**
4270 * If set, this intent will always match any components in packages that
4271 * are currently stopped. This is the default behavior when
4272 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4273 * flags are set, this one wins (it allows overriding of exclude for
4274 * places where the framework may automatically set the exclude flag).
4275 */
4276 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004277
4278 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004279 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004280 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004281 * persisted across device reboots until explicitly revoked with
4282 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4283 * grant for possible persisting; the receiving application must call
4284 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4285 * actually persist.
4286 *
4287 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4288 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4289 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004290 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004291 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004292 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004293
4294 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004295 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4296 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4297 * applies to any URI that is a prefix match against the original granted
4298 * URI. (Without this flag, the URI must match exactly for access to be
4299 * granted.) Another URI is considered a prefix match only when scheme,
4300 * authority, and all path segments defined by the prefix are an exact
4301 * match.
4302 */
4303 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4304
4305 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004306 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004307 * homework and verified that they correctly handle packages and components
4308 * that come and go over time. In particular:
4309 * <ul>
4310 * <li>Apps installed on external storage, which will appear to be
4311 * uninstalled while the the device is ejected.
4312 * <li>Apps with encryption unaware components, which will appear to not
4313 * exist while the device is locked.
4314 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004315 *
4316 * @hide
4317 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004318 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004319
4320 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004321 * If set, the new activity is not kept in the history stack. As soon as
4322 * the user navigates away from it, the activity is finished. This may also
4323 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4324 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004325 *
4326 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4327 * is never invoked when the current activity starts a new activity which
4328 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004329 */
4330 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4331 /**
4332 * If set, the activity will not be launched if it is already running
4333 * at the top of the history stack.
4334 */
4335 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4336 /**
4337 * If set, this activity will become the start of a new task on this
4338 * history stack. A task (from the activity that started it to the
4339 * next task activity) defines an atomic group of activities that the
4340 * user can move to. Tasks can be moved to the foreground and background;
4341 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004342 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004343 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4344 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004345 *
4346 * <p>This flag is generally used by activities that want
4347 * to present a "launcher" style behavior: they give the user a list of
4348 * separate things that can be done, which otherwise run completely
4349 * independently of the activity launching them.
4350 *
4351 * <p>When using this flag, if a task is already running for the activity
4352 * you are now starting, then a new activity will not be started; instead,
4353 * the current task will simply be brought to the front of the screen with
4354 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4355 * to disable this behavior.
4356 *
4357 * <p>This flag can not be used when the caller is requesting a result from
4358 * the activity being launched.
4359 */
4360 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4361 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004362 * This flag is used to create a new task and launch an activity into it.
4363 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4364 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4365 * search through existing tasks for ones matching this Intent. Only if no such
4366 * task is found would a new task be created. When paired with
4367 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4368 * the search for a matching task and unconditionally start a new task.
4369 *
4370 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4371 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004372 * top-level application launcher.</strong> Used in conjunction with
4373 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4374 * behavior of bringing an existing task to the foreground. When set,
4375 * a new task is <em>always</em> started to host the Activity for the
4376 * Intent, regardless of whether there is already an existing task running
4377 * the same thing.
4378 *
4379 * <p><strong>Because the default system does not include graphical task management,
4380 * you should not use this flag unless you provide some way for a user to
4381 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004382 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004383 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4384 * creating new document tasks.
4385 *
4386 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004387 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004388 *
Scott Main7aee61f2011-02-08 11:25:01 -08004389 * <p>See
4390 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4391 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004392 *
4393 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4394 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004395 */
4396 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4397 /**
4398 * If set, and the activity being launched is already running in the
4399 * current task, then instead of launching a new instance of that activity,
4400 * all of the other activities on top of it will be closed and this Intent
4401 * will be delivered to the (now on top) old activity as a new Intent.
4402 *
4403 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4404 * If D calls startActivity() with an Intent that resolves to the component
4405 * of activity B, then C and D will be finished and B receive the given
4406 * Intent, resulting in the stack now being: A, B.
4407 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004408 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004409 * either receive the new intent you are starting here in its
4410 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004411 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004412 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4413 * the same intent, then it will be finished and re-created; for all other
4414 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4415 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004416 *
4417 * <p>This launch mode can also be used to good effect in conjunction with
4418 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4419 * of a task, it will bring any currently running instance of that task
4420 * to the foreground, and then clear it to its root state. This is
4421 * especially useful, for example, when launching an activity from the
4422 * notification manager.
4423 *
Scott Main7aee61f2011-02-08 11:25:01 -08004424 * <p>See
4425 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4426 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004427 */
4428 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4429 /**
4430 * If set and this intent is being used to launch a new activity from an
4431 * existing one, then the reply target of the existing activity will be
4432 * transfered to the new activity. This way the new activity can call
4433 * {@link android.app.Activity#setResult} and have that result sent back to
4434 * the reply target of the original activity.
4435 */
4436 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4437 /**
4438 * If set and this intent is being used to launch a new activity from an
4439 * existing one, the current activity will not be counted as the top
4440 * activity for deciding whether the new intent should be delivered to
4441 * the top instead of starting a new one. The previous activity will
4442 * be used as the top, with the assumption being that the current activity
4443 * will finish itself immediately.
4444 */
4445 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4446 /**
4447 * If set, the new activity is not kept in the list of recently launched
4448 * activities.
4449 */
4450 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4451 /**
4452 * This flag is not normally set by application code, but set for you by
4453 * the system as described in the
4454 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4455 * launchMode} documentation for the singleTask mode.
4456 */
4457 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4458 /**
4459 * If set, and this activity is either being started in a new task or
4460 * bringing to the top an existing task, then it will be launched as
4461 * the front door of the task. This will result in the application of
4462 * any affinities needed to have that task in the proper state (either
4463 * moving activities to or from it), or simply resetting that task to
4464 * its initial state if needed.
4465 */
4466 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4467 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004468 * This flag is not normally set by application code, but set for you by
4469 * the system if this activity is being launched from history
4470 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004471 */
4472 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004473 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004474 * @deprecated As of API 21 this performs identically to
4475 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004476 */
4477 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004478 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004479 * This flag is used to open a document into a new task rooted at the activity launched
4480 * by this Intent. Through the use of this flag, or its equivalent attribute,
4481 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004482 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004483 *
Craig Mautner026596b2014-05-21 15:35:44 -07004484 * <p>The use of the activity attribute form of this,
4485 * {@link android.R.attr#documentLaunchMode}, is
4486 * preferred over the Intent flag described here. The attribute form allows the
4487 * Activity to specify multiple document behavior for all launchers of the Activity
4488 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004489 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004490 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4491 * it is kept after the activity is finished is different than the use of
4492 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4493 * this flag is being used to create a new recents entry, then by default that entry
4494 * will be removed once the activity is finished. You can modify this behavior with
4495 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4496 *
Craig Mautner026596b2014-05-21 15:35:44 -07004497 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4498 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4499 * equivalent of the Activity manifest specifying {@link
4500 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4501 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4502 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004503 *
Craig Mautner026596b2014-05-21 15:35:44 -07004504 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004505 *
Craig Mautner026596b2014-05-21 15:35:44 -07004506 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004507 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4508 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004509 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004510 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004511 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004512 * callback from occurring on the current frontmost activity before it is
4513 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004514 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004515 * <p>Typically, an activity can rely on that callback to indicate that an
4516 * explicit user action has caused their activity to be moved out of the
4517 * foreground. The callback marks an appropriate point in the activity's
4518 * lifecycle for it to dismiss any notifications that it intends to display
4519 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004520 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004521 * <p>If an activity is ever started via any non-user-driven events such as
4522 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4523 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004524 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004525 */
4526 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004527 /**
4528 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4529 * this flag will cause the launched activity to be brought to the front of its
4530 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004531 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004532 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4533 * If D calls startActivity() with an Intent that resolves to the component
4534 * of activity B, then B will be brought to the front of the history stack,
4535 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004536 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004537 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004538 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004539 */
4540 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004541 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004542 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4543 * this flag will prevent the system from applying an activity transition
4544 * animation to go to the next activity state. This doesn't mean an
4545 * animation will never run -- if another activity change happens that doesn't
4546 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004547 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004548 * when you are going to do a series of activity operations but the
4549 * animation seen by the user shouldn't be driven by the first activity
4550 * change but rather a later one.
4551 */
4552 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4553 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004554 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4555 * this flag will cause any existing task that would be associated with the
4556 * activity to be cleared before the activity is started. That is, the activity
4557 * becomes the new root of an otherwise empty task, and any old activities
4558 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4559 */
4560 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4561 /**
4562 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4563 * this flag will cause a newly launching task to be placed on top of the current
4564 * home activity task (if there is one). That is, pressing back from the task
4565 * will always return the user to home even if that was not the last activity they
4566 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4567 */
4568 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4569 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004570 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4571 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004572 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004573 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004574 * this flag. When set and the task's activity is finished, the recents
4575 * entry will remain in the interface for the user to re-launch it, like a
4576 * recents entry for a top-level application.
4577 * <p>
4578 * The receiving activity can override this request with
4579 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4580 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004581 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004582 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004583 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004584
4585 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004586 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4587 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004588 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4589 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004590 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004591 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004592
4593 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004594 * If set, when sending a broadcast only registered receivers will be
4595 * called -- no BroadcastReceiver components will be launched.
4596 */
4597 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004598 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004599 * If set, when sending a broadcast the new broadcast will replace
4600 * any existing pending broadcast that matches it. Matching is defined
4601 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4602 * true for the intents of the two broadcasts. When a match is found,
4603 * the new broadcast (and receivers associated with it) will replace the
4604 * existing one in the pending broadcast list, remaining at the same
4605 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004606 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004607 * <p>This flag is most typically used with sticky broadcasts, which
4608 * only care about delivering the most recent values of the broadcast
4609 * to their receivers.
4610 */
4611 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4612 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004613 * If set, when sending a broadcast the recipient is allowed to run at
4614 * foreground priority, with a shorter timeout interval. During normal
4615 * broadcasts the receivers are not automatically hoisted out of the
4616 * background priority class.
4617 */
4618 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4619 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004620 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4621 * They can still propagate results through to later receivers, but they can not prevent
4622 * later receivers from seeing the broadcast.
4623 */
4624 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4625 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004626 * If set, when sending a broadcast <i>before boot has completed</i> only
4627 * registered receivers will be called -- no BroadcastReceiver components
4628 * will be launched. Sticky intent state will be recorded properly even
4629 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4630 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004631 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004632 * <p>This flag is only for use by system sevices as a convenience to
4633 * avoid having to implement a more complex mechanism around detection
4634 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004635 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004636 * @hide
4637 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004638 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004639 /**
4640 * Set when this broadcast is for a boot upgrade, a special mode that
4641 * allows the broadcast to be sent before the system is ready and launches
4642 * the app process with no providers running in it.
4643 * @hide
4644 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004645 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004646 /**
4647 * If set, the broadcast will always go to manifest receivers in background (cached
4648 * or not running) apps, regardless of whether that would be done by default. By
4649 * default they will only receive broadcasts if the broadcast has specified an
4650 * explicit component or package name.
4651 * @hide
4652 */
4653 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4654 /**
4655 * If set, the broadcast will never go to manifest receivers in background (cached
4656 * or not running) apps, regardless of whether that would be done by default. By
4657 * default they will receive broadcasts if the broadcast has specified an
4658 * explicit component or package name.
4659 * @hide
4660 */
4661 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004662
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004663 /**
4664 * @hide Flags that can't be changed with PendingIntent.
4665 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004666 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4667 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4668 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004669
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004670 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004671 // ---------------------------------------------------------------------
4672 // toUri() and parseUri() options.
4673
4674 /**
4675 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4676 * always has the "intent:" scheme. This syntax can be used when you want
4677 * to later disambiguate between URIs that are intended to describe an
4678 * Intent vs. all others that should be treated as raw URIs. When used
4679 * with {@link #parseUri}, any other scheme will result in a generic
4680 * VIEW action for that raw URI.
4681 */
4682 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004683
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004684 /**
4685 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4686 * always has the "android-app:" scheme. This is a variation of
4687 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4688 * http/https URI being delivered to a specific package name. The format
4689 * is:
4690 *
4691 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004692 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004693 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004694 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4695 * you must also include a scheme; including a path also requires both a host and a scheme.
4696 * The final #Intent; fragment can be used without a scheme, host, or path.
4697 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004698 * used with intents that have a {@link #setSelector}, since the base intent
4699 * will always have an explicit package name.</p>
4700 *
4701 * <p>Some examples of how this scheme maps to Intent objects:</p>
4702 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4703 * <colgroup align="left" />
4704 * <colgroup align="left" />
4705 * <thead>
4706 * <tr><th>URI</th> <th>Intent</th></tr>
4707 * </thead>
4708 *
4709 * <tbody>
4710 * <tr><td><code>android-app://com.example.app</code></td>
4711 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4712 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4713 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4714 * </table></td>
4715 * </tr>
4716 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4717 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4718 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4719 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4720 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4721 * </table></td>
4722 * </tr>
4723 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4724 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4725 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4726 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4727 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4728 * </table></td>
4729 * </tr>
4730 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4731 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4732 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4733 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4734 * </table></td>
4735 * </tr>
4736 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4737 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4738 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4739 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4740 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4741 * </table></td>
4742 * </tr>
4743 * <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>
4744 * <td><table border="" style="margin:0" >
4745 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4746 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4747 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4748 * </table></td>
4749 * </tr>
4750 * </tbody>
4751 * </table>
4752 */
4753 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4754
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004755 /**
4756 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4757 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4758 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4759 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4760 * generated Intent can not cause unexpected data access to happen.
4761 *
4762 * <p>If you do not trust the source of the URI being parsed, you should still do further
4763 * processing to protect yourself from it. In particular, when using it to start an
4764 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4765 * that can handle it.</p>
4766 */
4767 public static final int URI_ALLOW_UNSAFE = 1<<2;
4768
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004769 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004770
4771 private String mAction;
4772 private Uri mData;
4773 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004774 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004775 private ComponentName mComponent;
4776 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004777 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004778 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004779 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004780 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004781 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004782 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004783
4784 // ---------------------------------------------------------------------
4785
4786 /**
4787 * Create an empty intent.
4788 */
4789 public Intent() {
4790 }
4791
4792 /**
4793 * Copy constructor.
4794 */
4795 public Intent(Intent o) {
4796 this.mAction = o.mAction;
4797 this.mData = o.mData;
4798 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004799 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004800 this.mComponent = o.mComponent;
4801 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004802 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004803 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004804 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004805 }
4806 if (o.mExtras != null) {
4807 this.mExtras = new Bundle(o.mExtras);
4808 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004809 if (o.mSourceBounds != null) {
4810 this.mSourceBounds = new Rect(o.mSourceBounds);
4811 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004812 if (o.mSelector != null) {
4813 this.mSelector = new Intent(o.mSelector);
4814 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004815 if (o.mClipData != null) {
4816 this.mClipData = new ClipData(o.mClipData);
4817 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004818 }
4819
4820 @Override
4821 public Object clone() {
4822 return new Intent(this);
4823 }
4824
4825 private Intent(Intent o, boolean all) {
4826 this.mAction = o.mAction;
4827 this.mData = o.mData;
4828 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004829 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004830 this.mComponent = o.mComponent;
4831 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004832 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004833 }
4834 }
4835
4836 /**
4837 * Make a clone of only the parts of the Intent that are relevant for
4838 * filter matching: the action, data, type, component, and categories.
4839 */
4840 public Intent cloneFilter() {
4841 return new Intent(this, false);
4842 }
4843
4844 /**
4845 * Create an intent with a given action. All other fields (data, type,
4846 * class) are null. Note that the action <em>must</em> be in a
4847 * namespace because Intents are used globally in the system -- for
4848 * example the system VIEW action is android.intent.action.VIEW; an
4849 * application's custom action would be something like
4850 * com.google.app.myapp.CUSTOM_ACTION.
4851 *
4852 * @param action The Intent action, such as ACTION_VIEW.
4853 */
4854 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004855 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004856 }
4857
4858 /**
4859 * Create an intent with a given action and for a given data url. Note
4860 * that the action <em>must</em> be in a namespace because Intents are
4861 * used globally in the system -- for example the system VIEW action is
4862 * android.intent.action.VIEW; an application's custom action would be
4863 * something like com.google.app.myapp.CUSTOM_ACTION.
4864 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004865 * <p><em>Note: scheme and host name matching in the Android framework is
4866 * case-sensitive, unlike the formal RFC. As a result,
4867 * you should always ensure that you write your Uri with these elements
4868 * using lower case letters, and normalize any Uris you receive from
4869 * outside of Android to ensure the scheme and host is lower case.</em></p>
4870 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004871 * @param action The Intent action, such as ACTION_VIEW.
4872 * @param uri The Intent data URI.
4873 */
4874 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004875 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004876 mData = uri;
4877 }
4878
4879 /**
4880 * Create an intent for a specific component. All other fields (action, data,
4881 * type, class) are null, though they can be modified later with explicit
4882 * calls. This provides a convenient way to create an intent that is
4883 * intended to execute a hard-coded class name, rather than relying on the
4884 * system to find an appropriate class for you; see {@link #setComponent}
4885 * for more information on the repercussions of this.
4886 *
4887 * @param packageContext A Context of the application package implementing
4888 * this class.
4889 * @param cls The component class that is to be used for the intent.
4890 *
4891 * @see #setClass
4892 * @see #setComponent
4893 * @see #Intent(String, android.net.Uri , Context, Class)
4894 */
4895 public Intent(Context packageContext, Class<?> cls) {
4896 mComponent = new ComponentName(packageContext, cls);
4897 }
4898
4899 /**
4900 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004901 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004902 * construct the Intent and then calling {@link #setClass} to set its
4903 * class.
4904 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004905 * <p><em>Note: scheme and host name matching in the Android framework is
4906 * case-sensitive, unlike the formal RFC. As a result,
4907 * you should always ensure that you write your Uri with these elements
4908 * using lower case letters, and normalize any Uris you receive from
4909 * outside of Android to ensure the scheme and host is lower case.</em></p>
4910 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004911 * @param action The Intent action, such as ACTION_VIEW.
4912 * @param uri The Intent data URI.
4913 * @param packageContext A Context of the application package implementing
4914 * this class.
4915 * @param cls The component class that is to be used for the intent.
4916 *
4917 * @see #Intent(String, android.net.Uri)
4918 * @see #Intent(Context, Class)
4919 * @see #setClass
4920 * @see #setComponent
4921 */
4922 public Intent(String action, Uri uri,
4923 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004924 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004925 mData = uri;
4926 mComponent = new ComponentName(packageContext, cls);
4927 }
4928
4929 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004930 * Create an intent to launch the main (root) activity of a task. This
4931 * is the Intent that is started when the application's is launched from
4932 * Home. For anything else that wants to launch an application in the
4933 * same way, it is important that they use an Intent structured the same
4934 * way, and can use this function to ensure this is the case.
4935 *
4936 * <p>The returned Intent has the given Activity component as its explicit
4937 * component, {@link #ACTION_MAIN} as its action, and includes the
4938 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4939 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4940 * to do that through {@link #addFlags(int)} on the returned Intent.
4941 *
4942 * @param mainActivity The main activity component that this Intent will
4943 * launch.
4944 * @return Returns a newly created Intent that can be used to launch the
4945 * activity as a main application entry.
4946 *
4947 * @see #setClass
4948 * @see #setComponent
4949 */
4950 public static Intent makeMainActivity(ComponentName mainActivity) {
4951 Intent intent = new Intent(ACTION_MAIN);
4952 intent.setComponent(mainActivity);
4953 intent.addCategory(CATEGORY_LAUNCHER);
4954 return intent;
4955 }
4956
4957 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004958 * Make an Intent for the main activity of an application, without
4959 * specifying a specific activity to run but giving a selector to find
4960 * the activity. This results in a final Intent that is structured
4961 * the same as when the application is launched from
4962 * Home. For anything else that wants to launch an application in the
4963 * same way, it is important that they use an Intent structured the same
4964 * way, and can use this function to ensure this is the case.
4965 *
4966 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4967 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4968 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4969 * to do that through {@link #addFlags(int)} on the returned Intent.
4970 *
4971 * @param selectorAction The action name of the Intent's selector.
4972 * @param selectorCategory The name of a category to add to the Intent's
4973 * selector.
4974 * @return Returns a newly created Intent that can be used to launch the
4975 * activity as a main application entry.
4976 *
4977 * @see #setSelector(Intent)
4978 */
4979 public static Intent makeMainSelectorActivity(String selectorAction,
4980 String selectorCategory) {
4981 Intent intent = new Intent(ACTION_MAIN);
4982 intent.addCategory(CATEGORY_LAUNCHER);
4983 Intent selector = new Intent();
4984 selector.setAction(selectorAction);
4985 selector.addCategory(selectorCategory);
4986 intent.setSelector(selector);
4987 return intent;
4988 }
4989
4990 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004991 * Make an Intent that can be used to re-launch an application's task
4992 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4993 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4994 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4995 *
4996 * @param mainActivity The activity component that is the root of the
4997 * task; this is the activity that has been published in the application's
4998 * manifest as the main launcher icon.
4999 *
5000 * @return Returns a newly created Intent that can be used to relaunch the
5001 * activity's task in its root state.
5002 */
5003 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5004 Intent intent = makeMainActivity(mainActivity);
5005 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5006 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5007 return intent;
5008 }
5009
5010 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005011 * Call {@link #parseUri} with 0 flags.
5012 * @deprecated Use {@link #parseUri} instead.
5013 */
5014 @Deprecated
5015 public static Intent getIntent(String uri) throws URISyntaxException {
5016 return parseUri(uri, 0);
5017 }
Tom Taylord4a47292009-12-21 13:59:18 -08005018
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005019 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005020 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005021 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005022 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005023 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005024 *
5025 * <p>The URI given here must not be relative -- that is, it must include
5026 * the scheme and full path.
5027 *
5028 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005029 * @param flags Additional processing flags. Either 0,
5030 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005031 *
5032 * @return Intent The newly created Intent object.
5033 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005034 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5035 * it bad (as parsed by the Uri class) or the Intent data within the
5036 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005037 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005038 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005039 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005040 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005041 int i = 0;
5042 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005043 final boolean androidApp = uri.startsWith("android-app:");
5044
5045 // Validate intent scheme if requested.
5046 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5047 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005048 Intent intent = new Intent(ACTION_VIEW);
5049 try {
5050 intent.setData(Uri.parse(uri));
5051 } catch (IllegalArgumentException e) {
5052 throw new URISyntaxException(uri, e.getMessage());
5053 }
5054 return intent;
5055 }
5056 }
Tom Taylord4a47292009-12-21 13:59:18 -08005057
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005058 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005059 // simple case
5060 if (i == -1) {
5061 if (!androidApp) {
5062 return new Intent(ACTION_VIEW, Uri.parse(uri));
5063 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005064
5065 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005066 } else if (!uri.startsWith("#Intent;", i)) {
5067 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005068 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005069 } else {
5070 i = -1;
5071 }
5072 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005073
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005074 // new format
5075 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005076 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005077 boolean explicitAction = false;
5078 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005079
5080 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005081 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005082 String data;
5083 if (i >= 0) {
5084 data = uri.substring(0, i);
5085 i += 8; // length of "#Intent;"
5086 } else {
5087 data = uri;
5088 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005089
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005090 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005091 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005092 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005093 if (eq < 0) eq = i-1;
5094 int semi = uri.indexOf(';', i);
5095 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005096
5097 // action
5098 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005099 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005100 if (!inSelector) {
5101 explicitAction = true;
5102 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005103 }
5104
5105 // categories
5106 else if (uri.startsWith("category=", i)) {
5107 intent.addCategory(value);
5108 }
5109
5110 // type
5111 else if (uri.startsWith("type=", i)) {
5112 intent.mType = value;
5113 }
5114
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005115 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005116 else if (uri.startsWith("launchFlags=", i)) {
5117 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005118 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5119 intent.mFlags &= ~IMMUTABLE_FLAGS;
5120 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005121 }
5122
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005123 // package
5124 else if (uri.startsWith("package=", i)) {
5125 intent.mPackage = value;
5126 }
5127
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005128 // component
5129 else if (uri.startsWith("component=", i)) {
5130 intent.mComponent = ComponentName.unflattenFromString(value);
5131 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005132
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005133 // scheme
5134 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005135 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005136 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005137 } else {
5138 scheme = value;
5139 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005140 }
5141
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005142 // source bounds
5143 else if (uri.startsWith("sourceBounds=", i)) {
5144 intent.mSourceBounds = Rect.unflattenFromString(value);
5145 }
5146
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005147 // selector
5148 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5149 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005150 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005151 }
5152
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005153 // extra
5154 else {
5155 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005156 // create Bundle if it doesn't already exist
5157 if (intent.mExtras == null) intent.mExtras = new Bundle();
5158 Bundle b = intent.mExtras;
5159 // add EXTRA
5160 if (uri.startsWith("S.", i)) b.putString(key, value);
5161 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5162 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5163 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5164 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5165 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5166 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5167 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5168 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5169 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5170 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005171
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005172 // move to the next item
5173 i = semi + 1;
5174 }
5175
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005176 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005177 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005178 if (baseIntent.mPackage == null) {
5179 baseIntent.setSelector(intent);
5180 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005181 intent = baseIntent;
5182 }
5183
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005184 if (data != null) {
5185 if (data.startsWith("intent:")) {
5186 data = data.substring(7);
5187 if (scheme != null) {
5188 data = scheme + ':' + data;
5189 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005190 } else if (data.startsWith("android-app:")) {
5191 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5192 // Correctly formed android-app, first part is package name.
5193 int end = data.indexOf('/', 14);
5194 if (end < 0) {
5195 // All we have is a package name.
5196 intent.mPackage = data.substring(14);
5197 if (!explicitAction) {
5198 intent.setAction(ACTION_MAIN);
5199 }
5200 data = "";
5201 } else {
5202 // Target the Intent at the given package name always.
5203 String authority = null;
5204 intent.mPackage = data.substring(14, end);
5205 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005206 if ((end+1) < data.length()) {
5207 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5208 // Found a scheme, remember it.
5209 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005210 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005211 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5212 // Found a authority, remember it.
5213 authority = data.substring(end+1, newEnd);
5214 end = newEnd;
5215 }
5216 } else {
5217 // All we have is a scheme.
5218 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005219 }
5220 }
5221 if (scheme == null) {
5222 // If there was no scheme, then this just targets the package.
5223 if (!explicitAction) {
5224 intent.setAction(ACTION_MAIN);
5225 }
5226 data = "";
5227 } else if (authority == null) {
5228 data = scheme + ":";
5229 } else {
5230 data = scheme + "://" + authority + data.substring(end);
5231 }
5232 }
5233 } else {
5234 data = "";
5235 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005236 }
Tom Taylord4a47292009-12-21 13:59:18 -08005237
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005238 if (data.length() > 0) {
5239 try {
5240 intent.mData = Uri.parse(data);
5241 } catch (IllegalArgumentException e) {
5242 throw new URISyntaxException(uri, e.getMessage());
5243 }
5244 }
5245 }
Tom Taylord4a47292009-12-21 13:59:18 -08005246
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005247 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005248
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005249 } catch (IndexOutOfBoundsException e) {
5250 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5251 }
5252 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005253
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005254 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005255 return getIntentOld(uri, 0);
5256 }
5257
5258 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005259 Intent intent;
5260
5261 int i = uri.lastIndexOf('#');
5262 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005263 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005264 final int intentFragmentStart = i;
5265 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005266
5267 i++;
5268
5269 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005270 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005271 i += 7;
5272 int j = uri.indexOf(')', i);
5273 action = uri.substring(i, j);
5274 i = j + 1;
5275 }
5276
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005277 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005278
5279 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005280 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005281 i += 11;
5282 int j = uri.indexOf(')', i);
5283 while (i < j) {
5284 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005285 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005286 if (i < sep) {
5287 intent.addCategory(uri.substring(i, sep));
5288 }
5289 i = sep + 1;
5290 }
5291 i = j + 1;
5292 }
5293
5294 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005295 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005296 i += 5;
5297 int j = uri.indexOf(')', i);
5298 intent.mType = uri.substring(i, j);
5299 i = j + 1;
5300 }
5301
5302 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005303 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005304 i += 12;
5305 int j = uri.indexOf(')', i);
5306 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005307 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5308 intent.mFlags &= ~IMMUTABLE_FLAGS;
5309 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005310 i = j + 1;
5311 }
5312
5313 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005314 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005315 i += 10;
5316 int j = uri.indexOf(')', i);
5317 int sep = uri.indexOf('!', i);
5318 if (sep >= 0 && sep < j) {
5319 String pkg = uri.substring(i, sep);
5320 String cls = uri.substring(sep + 1, j);
5321 intent.mComponent = new ComponentName(pkg, cls);
5322 }
5323 i = j + 1;
5324 }
5325
5326 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005327 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005328 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005329
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005330 final int closeParen = uri.indexOf(')', i);
5331 if (closeParen == -1) throw new URISyntaxException(uri,
5332 "EXTRA missing trailing ')'", i);
5333
5334 while (i < closeParen) {
5335 // fetch the key value
5336 int j = uri.indexOf('=', i);
5337 if (j <= i + 1 || i >= closeParen) {
5338 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5339 }
5340 char type = uri.charAt(i);
5341 i++;
5342 String key = uri.substring(i, j);
5343 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005344
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005345 // get type-value
5346 j = uri.indexOf('!', i);
5347 if (j == -1 || j >= closeParen) j = closeParen;
5348 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5349 String value = uri.substring(i, j);
5350 i = j;
5351
5352 // create Bundle if it doesn't already exist
5353 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005354
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005355 // add item to bundle
5356 try {
5357 switch (type) {
5358 case 'S':
5359 intent.mExtras.putString(key, Uri.decode(value));
5360 break;
5361 case 'B':
5362 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5363 break;
5364 case 'b':
5365 intent.mExtras.putByte(key, Byte.parseByte(value));
5366 break;
5367 case 'c':
5368 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5369 break;
5370 case 'd':
5371 intent.mExtras.putDouble(key, Double.parseDouble(value));
5372 break;
5373 case 'f':
5374 intent.mExtras.putFloat(key, Float.parseFloat(value));
5375 break;
5376 case 'i':
5377 intent.mExtras.putInt(key, Integer.parseInt(value));
5378 break;
5379 case 'l':
5380 intent.mExtras.putLong(key, Long.parseLong(value));
5381 break;
5382 case 's':
5383 intent.mExtras.putShort(key, Short.parseShort(value));
5384 break;
5385 default:
5386 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5387 }
5388 } catch (NumberFormatException e) {
5389 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5390 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005391
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005392 char ch = uri.charAt(i);
5393 if (ch == ')') break;
5394 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5395 i++;
5396 }
5397 }
5398
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005399 if (isIntentFragment) {
5400 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5401 } else {
5402 intent.mData = Uri.parse(uri);
5403 }
Tom Taylord4a47292009-12-21 13:59:18 -08005404
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005405 if (intent.mAction == null) {
5406 // By default, if no action is specified, then use VIEW.
5407 intent.mAction = ACTION_VIEW;
5408 }
5409
5410 } else {
5411 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5412 }
5413
5414 return intent;
5415 }
5416
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005417 /** @hide */
5418 public interface CommandOptionHandler {
5419 boolean handleOption(String opt, ShellCommand cmd);
5420 }
5421
5422 /** @hide */
5423 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5424 throws URISyntaxException {
5425 Intent intent = new Intent();
5426 Intent baseIntent = intent;
5427 boolean hasIntentInfo = false;
5428
5429 Uri data = null;
5430 String type = null;
5431
5432 String opt;
5433 while ((opt=cmd.getNextOption()) != null) {
5434 switch (opt) {
5435 case "-a":
5436 intent.setAction(cmd.getNextArgRequired());
5437 if (intent == baseIntent) {
5438 hasIntentInfo = true;
5439 }
5440 break;
5441 case "-d":
5442 data = Uri.parse(cmd.getNextArgRequired());
5443 if (intent == baseIntent) {
5444 hasIntentInfo = true;
5445 }
5446 break;
5447 case "-t":
5448 type = cmd.getNextArgRequired();
5449 if (intent == baseIntent) {
5450 hasIntentInfo = true;
5451 }
5452 break;
5453 case "-c":
5454 intent.addCategory(cmd.getNextArgRequired());
5455 if (intent == baseIntent) {
5456 hasIntentInfo = true;
5457 }
5458 break;
5459 case "-e":
5460 case "--es": {
5461 String key = cmd.getNextArgRequired();
5462 String value = cmd.getNextArgRequired();
5463 intent.putExtra(key, value);
5464 }
5465 break;
5466 case "--esn": {
5467 String key = cmd.getNextArgRequired();
5468 intent.putExtra(key, (String) null);
5469 }
5470 break;
5471 case "--ei": {
5472 String key = cmd.getNextArgRequired();
5473 String value = cmd.getNextArgRequired();
5474 intent.putExtra(key, Integer.decode(value));
5475 }
5476 break;
5477 case "--eu": {
5478 String key = cmd.getNextArgRequired();
5479 String value = cmd.getNextArgRequired();
5480 intent.putExtra(key, Uri.parse(value));
5481 }
5482 break;
5483 case "--ecn": {
5484 String key = cmd.getNextArgRequired();
5485 String value = cmd.getNextArgRequired();
5486 ComponentName cn = ComponentName.unflattenFromString(value);
5487 if (cn == null)
5488 throw new IllegalArgumentException("Bad component name: " + value);
5489 intent.putExtra(key, cn);
5490 }
5491 break;
5492 case "--eia": {
5493 String key = cmd.getNextArgRequired();
5494 String value = cmd.getNextArgRequired();
5495 String[] strings = value.split(",");
5496 int[] list = new int[strings.length];
5497 for (int i = 0; i < strings.length; i++) {
5498 list[i] = Integer.decode(strings[i]);
5499 }
5500 intent.putExtra(key, list);
5501 }
5502 break;
5503 case "--eial": {
5504 String key = cmd.getNextArgRequired();
5505 String value = cmd.getNextArgRequired();
5506 String[] strings = value.split(",");
5507 ArrayList<Integer> list = new ArrayList<>(strings.length);
5508 for (int i = 0; i < strings.length; i++) {
5509 list.add(Integer.decode(strings[i]));
5510 }
5511 intent.putExtra(key, list);
5512 }
5513 break;
5514 case "--el": {
5515 String key = cmd.getNextArgRequired();
5516 String value = cmd.getNextArgRequired();
5517 intent.putExtra(key, Long.valueOf(value));
5518 }
5519 break;
5520 case "--ela": {
5521 String key = cmd.getNextArgRequired();
5522 String value = cmd.getNextArgRequired();
5523 String[] strings = value.split(",");
5524 long[] list = new long[strings.length];
5525 for (int i = 0; i < strings.length; i++) {
5526 list[i] = Long.valueOf(strings[i]);
5527 }
5528 intent.putExtra(key, list);
5529 hasIntentInfo = true;
5530 }
5531 break;
5532 case "--elal": {
5533 String key = cmd.getNextArgRequired();
5534 String value = cmd.getNextArgRequired();
5535 String[] strings = value.split(",");
5536 ArrayList<Long> list = new ArrayList<>(strings.length);
5537 for (int i = 0; i < strings.length; i++) {
5538 list.add(Long.valueOf(strings[i]));
5539 }
5540 intent.putExtra(key, list);
5541 hasIntentInfo = true;
5542 }
5543 break;
5544 case "--ef": {
5545 String key = cmd.getNextArgRequired();
5546 String value = cmd.getNextArgRequired();
5547 intent.putExtra(key, Float.valueOf(value));
5548 hasIntentInfo = true;
5549 }
5550 break;
5551 case "--efa": {
5552 String key = cmd.getNextArgRequired();
5553 String value = cmd.getNextArgRequired();
5554 String[] strings = value.split(",");
5555 float[] list = new float[strings.length];
5556 for (int i = 0; i < strings.length; i++) {
5557 list[i] = Float.valueOf(strings[i]);
5558 }
5559 intent.putExtra(key, list);
5560 hasIntentInfo = true;
5561 }
5562 break;
5563 case "--efal": {
5564 String key = cmd.getNextArgRequired();
5565 String value = cmd.getNextArgRequired();
5566 String[] strings = value.split(",");
5567 ArrayList<Float> list = new ArrayList<>(strings.length);
5568 for (int i = 0; i < strings.length; i++) {
5569 list.add(Float.valueOf(strings[i]));
5570 }
5571 intent.putExtra(key, list);
5572 hasIntentInfo = true;
5573 }
5574 break;
5575 case "--esa": {
5576 String key = cmd.getNextArgRequired();
5577 String value = cmd.getNextArgRequired();
5578 // Split on commas unless they are preceeded by an escape.
5579 // The escape character must be escaped for the string and
5580 // again for the regex, thus four escape characters become one.
5581 String[] strings = value.split("(?<!\\\\),");
5582 intent.putExtra(key, strings);
5583 hasIntentInfo = true;
5584 }
5585 break;
5586 case "--esal": {
5587 String key = cmd.getNextArgRequired();
5588 String value = cmd.getNextArgRequired();
5589 // Split on commas unless they are preceeded by an escape.
5590 // The escape character must be escaped for the string and
5591 // again for the regex, thus four escape characters become one.
5592 String[] strings = value.split("(?<!\\\\),");
5593 ArrayList<String> list = new ArrayList<>(strings.length);
5594 for (int i = 0; i < strings.length; i++) {
5595 list.add(strings[i]);
5596 }
5597 intent.putExtra(key, list);
5598 hasIntentInfo = true;
5599 }
5600 break;
5601 case "--ez": {
5602 String key = cmd.getNextArgRequired();
5603 String value = cmd.getNextArgRequired().toLowerCase();
5604 // Boolean.valueOf() results in false for anything that is not "true", which is
5605 // error-prone in shell commands
5606 boolean arg;
5607 if ("true".equals(value) || "t".equals(value)) {
5608 arg = true;
5609 } else if ("false".equals(value) || "f".equals(value)) {
5610 arg = false;
5611 } else {
5612 try {
5613 arg = Integer.decode(value) != 0;
5614 } catch (NumberFormatException ex) {
5615 throw new IllegalArgumentException("Invalid boolean value: " + value);
5616 }
5617 }
5618
5619 intent.putExtra(key, arg);
5620 }
5621 break;
5622 case "-n": {
5623 String str = cmd.getNextArgRequired();
5624 ComponentName cn = ComponentName.unflattenFromString(str);
5625 if (cn == null)
5626 throw new IllegalArgumentException("Bad component name: " + str);
5627 intent.setComponent(cn);
5628 if (intent == baseIntent) {
5629 hasIntentInfo = true;
5630 }
5631 }
5632 break;
5633 case "-p": {
5634 String str = cmd.getNextArgRequired();
5635 intent.setPackage(str);
5636 if (intent == baseIntent) {
5637 hasIntentInfo = true;
5638 }
5639 }
5640 break;
5641 case "-f":
5642 String str = cmd.getNextArgRequired();
5643 intent.setFlags(Integer.decode(str).intValue());
5644 break;
5645 case "--grant-read-uri-permission":
5646 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5647 break;
5648 case "--grant-write-uri-permission":
5649 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5650 break;
5651 case "--grant-persistable-uri-permission":
5652 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5653 break;
5654 case "--grant-prefix-uri-permission":
5655 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5656 break;
5657 case "--exclude-stopped-packages":
5658 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5659 break;
5660 case "--include-stopped-packages":
5661 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5662 break;
5663 case "--debug-log-resolution":
5664 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5665 break;
5666 case "--activity-brought-to-front":
5667 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5668 break;
5669 case "--activity-clear-top":
5670 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5671 break;
5672 case "--activity-clear-when-task-reset":
5673 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5674 break;
5675 case "--activity-exclude-from-recents":
5676 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5677 break;
5678 case "--activity-launched-from-history":
5679 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5680 break;
5681 case "--activity-multiple-task":
5682 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5683 break;
5684 case "--activity-no-animation":
5685 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5686 break;
5687 case "--activity-no-history":
5688 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5689 break;
5690 case "--activity-no-user-action":
5691 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5692 break;
5693 case "--activity-previous-is-top":
5694 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5695 break;
5696 case "--activity-reorder-to-front":
5697 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5698 break;
5699 case "--activity-reset-task-if-needed":
5700 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5701 break;
5702 case "--activity-single-top":
5703 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5704 break;
5705 case "--activity-clear-task":
5706 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5707 break;
5708 case "--activity-task-on-home":
5709 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5710 break;
5711 case "--receiver-registered-only":
5712 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5713 break;
5714 case "--receiver-replace-pending":
5715 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5716 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005717 case "--receiver-foreground":
5718 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5719 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005720 case "--selector":
5721 intent.setDataAndType(data, type);
5722 intent = new Intent();
5723 break;
5724 default:
5725 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5726 // Okay, caller handled this option.
5727 } else {
5728 throw new IllegalArgumentException("Unknown option: " + opt);
5729 }
5730 break;
5731 }
5732 }
5733 intent.setDataAndType(data, type);
5734
5735 final boolean hasSelector = intent != baseIntent;
5736 if (hasSelector) {
5737 // A selector was specified; fix up.
5738 baseIntent.setSelector(intent);
5739 intent = baseIntent;
5740 }
5741
5742 String arg = cmd.getNextArg();
5743 baseIntent = null;
5744 if (arg == null) {
5745 if (hasSelector) {
5746 // If a selector has been specified, and no arguments
5747 // have been supplied for the main Intent, then we can
5748 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5749 // need to have a component name specified yet, the
5750 // selector will take care of that.
5751 baseIntent = new Intent(Intent.ACTION_MAIN);
5752 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5753 }
5754 } else if (arg.indexOf(':') >= 0) {
5755 // The argument is a URI. Fully parse it, and use that result
5756 // to fill in any data not specified so far.
5757 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5758 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5759 } else if (arg.indexOf('/') >= 0) {
5760 // The argument is a component name. Build an Intent to launch
5761 // it.
5762 baseIntent = new Intent(Intent.ACTION_MAIN);
5763 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5764 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5765 } else {
5766 // Assume the argument is a package name.
5767 baseIntent = new Intent(Intent.ACTION_MAIN);
5768 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5769 baseIntent.setPackage(arg);
5770 }
5771 if (baseIntent != null) {
5772 Bundle extras = intent.getExtras();
5773 intent.replaceExtras((Bundle)null);
5774 Bundle uriExtras = baseIntent.getExtras();
5775 baseIntent.replaceExtras((Bundle)null);
5776 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5777 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5778 for (String c : cats) {
5779 baseIntent.removeCategory(c);
5780 }
5781 }
5782 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5783 if (extras == null) {
5784 extras = uriExtras;
5785 } else if (uriExtras != null) {
5786 uriExtras.putAll(extras);
5787 extras = uriExtras;
5788 }
5789 intent.replaceExtras(extras);
5790 hasIntentInfo = true;
5791 }
5792
5793 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5794 return intent;
5795 }
5796
5797 /** @hide */
5798 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5799 final String[] lines = new String[] {
5800 "<INTENT> specifications include these flags and arguments:",
5801 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5802 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5803 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5804 " [--esn <EXTRA_KEY> ...]",
5805 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5806 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5807 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5808 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5809 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5810 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5811 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5812 " (mutiple extras passed as Integer[])",
5813 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5814 " (mutiple extras passed as List<Integer>)",
5815 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5816 " (mutiple extras passed as Long[])",
5817 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5818 " (mutiple extras passed as List<Long>)",
5819 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5820 " (mutiple extras passed as Float[])",
5821 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5822 " (mutiple extras passed as List<Float>)",
5823 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5824 " (mutiple extras passed as String[]; to embed a comma into a string,",
5825 " escape it using \"\\,\")",
5826 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5827 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5828 " escape it using \"\\,\")",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005829 " [--f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005830 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5831 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5832 " [--debug-log-resolution] [--exclude-stopped-packages]",
5833 " [--include-stopped-packages]",
5834 " [--activity-brought-to-front] [--activity-clear-top]",
5835 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5836 " [--activity-launched-from-history] [--activity-multiple-task]",
5837 " [--activity-no-animation] [--activity-no-history]",
5838 " [--activity-no-user-action] [--activity-previous-is-top]",
5839 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5840 " [--activity-single-top] [--activity-clear-task]",
5841 " [--activity-task-on-home]",
5842 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005843 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005844 " [--selector]",
5845 " [<URI> | <PACKAGE> | <COMPONENT>]"
5846 };
5847 for (String line : lines) {
5848 pw.print(prefix);
5849 pw.println(line);
5850 }
5851 }
5852
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005853 /**
5854 * Retrieve the general action to be performed, such as
5855 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5856 * the information in the intent should be interpreted -- most importantly,
5857 * what to do with the data returned by {@link #getData}.
5858 *
5859 * @return The action of this intent or null if none is specified.
5860 *
5861 * @see #setAction
5862 */
5863 public String getAction() {
5864 return mAction;
5865 }
5866
5867 /**
5868 * Retrieve data this intent is operating on. This URI specifies the name
5869 * of the data; often it uses the content: scheme, specifying data in a
5870 * content provider. Other schemes may be handled by specific activities,
5871 * such as http: by the web browser.
5872 *
5873 * @return The URI of the data this intent is targeting or null.
5874 *
5875 * @see #getScheme
5876 * @see #setData
5877 */
5878 public Uri getData() {
5879 return mData;
5880 }
5881
5882 /**
5883 * The same as {@link #getData()}, but returns the URI as an encoded
5884 * String.
5885 */
5886 public String getDataString() {
5887 return mData != null ? mData.toString() : null;
5888 }
5889
5890 /**
5891 * Return the scheme portion of the intent's data. If the data is null or
5892 * does not include a scheme, null is returned. Otherwise, the scheme
5893 * prefix without the final ':' is returned, i.e. "http".
5894 *
5895 * <p>This is the same as calling getData().getScheme() (and checking for
5896 * null data).
5897 *
5898 * @return The scheme of this intent.
5899 *
5900 * @see #getData
5901 */
5902 public String getScheme() {
5903 return mData != null ? mData.getScheme() : null;
5904 }
5905
5906 /**
5907 * Retrieve any explicit MIME type included in the intent. This is usually
5908 * null, as the type is determined by the intent data.
5909 *
5910 * @return If a type was manually set, it is returned; else null is
5911 * returned.
5912 *
5913 * @see #resolveType(ContentResolver)
5914 * @see #setType
5915 */
5916 public String getType() {
5917 return mType;
5918 }
5919
5920 /**
5921 * Return the MIME data type of this intent. If the type field is
5922 * explicitly set, that is simply returned. Otherwise, if the data is set,
5923 * the type of that data is returned. If neither fields are set, a null is
5924 * returned.
5925 *
5926 * @return The MIME type of this intent.
5927 *
5928 * @see #getType
5929 * @see #resolveType(ContentResolver)
5930 */
5931 public String resolveType(Context context) {
5932 return resolveType(context.getContentResolver());
5933 }
5934
5935 /**
5936 * Return the MIME data type of this intent. If the type field is
5937 * explicitly set, that is simply returned. Otherwise, if the data is set,
5938 * the type of that data is returned. If neither fields are set, a null is
5939 * returned.
5940 *
5941 * @param resolver A ContentResolver that can be used to determine the MIME
5942 * type of the intent's data.
5943 *
5944 * @return The MIME type of this intent.
5945 *
5946 * @see #getType
5947 * @see #resolveType(Context)
5948 */
5949 public String resolveType(ContentResolver resolver) {
5950 if (mType != null) {
5951 return mType;
5952 }
5953 if (mData != null) {
5954 if ("content".equals(mData.getScheme())) {
5955 return resolver.getType(mData);
5956 }
5957 }
5958 return null;
5959 }
5960
5961 /**
5962 * Return the MIME data type of this intent, only if it will be needed for
5963 * intent resolution. This is not generally useful for application code;
5964 * it is used by the frameworks for communicating with back-end system
5965 * services.
5966 *
5967 * @param resolver A ContentResolver that can be used to determine the MIME
5968 * type of the intent's data.
5969 *
5970 * @return The MIME type of this intent, or null if it is unknown or not
5971 * needed.
5972 */
5973 public String resolveTypeIfNeeded(ContentResolver resolver) {
5974 if (mComponent != null) {
5975 return mType;
5976 }
5977 return resolveType(resolver);
5978 }
5979
5980 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005981 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005982 *
5983 * @param category The category to check.
5984 *
5985 * @return boolean True if the intent contains the category, else false.
5986 *
5987 * @see #getCategories
5988 * @see #addCategory
5989 */
5990 public boolean hasCategory(String category) {
5991 return mCategories != null && mCategories.contains(category);
5992 }
5993
5994 /**
5995 * Return the set of all categories in the intent. If there are no categories,
5996 * returns NULL.
5997 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005998 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005999 *
6000 * @see #hasCategory
6001 * @see #addCategory
6002 */
6003 public Set<String> getCategories() {
6004 return mCategories;
6005 }
6006
6007 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006008 * Return the specific selector associated with this Intent. If there is
6009 * none, returns null. See {@link #setSelector} for more information.
6010 *
6011 * @see #setSelector
6012 */
6013 public Intent getSelector() {
6014 return mSelector;
6015 }
6016
6017 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006018 * Return the {@link ClipData} associated with this Intent. If there is
6019 * none, returns null. See {@link #setClipData} for more information.
6020 *
John Spurlock125d1332013-11-25 11:58:37 -05006021 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006022 */
6023 public ClipData getClipData() {
6024 return mClipData;
6025 }
6026
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006027 /** @hide */
6028 public int getContentUserHint() {
6029 return mContentUserHint;
6030 }
6031
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006032 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006033 * Sets the ClassLoader that will be used when unmarshalling
6034 * any Parcelable values from the extras of this Intent.
6035 *
6036 * @param loader a ClassLoader, or null to use the default loader
6037 * at the time of unmarshalling.
6038 */
6039 public void setExtrasClassLoader(ClassLoader loader) {
6040 if (mExtras != null) {
6041 mExtras.setClassLoader(loader);
6042 }
6043 }
6044
6045 /**
6046 * Returns true if an extra value is associated with the given name.
6047 * @param name the extra's name
6048 * @return true if the given extra is present.
6049 */
6050 public boolean hasExtra(String name) {
6051 return mExtras != null && mExtras.containsKey(name);
6052 }
6053
6054 /**
6055 * Returns true if the Intent's extras contain a parcelled file descriptor.
6056 * @return true if the Intent contains a parcelled file descriptor.
6057 */
6058 public boolean hasFileDescriptors() {
6059 return mExtras != null && mExtras.hasFileDescriptors();
6060 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006061
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006062 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006063 public void setAllowFds(boolean allowFds) {
6064 if (mExtras != null) {
6065 mExtras.setAllowFds(allowFds);
6066 }
6067 }
6068
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006069 /** {@hide} */
6070 public void setDefusable(boolean defusable) {
6071 if (mExtras != null) {
6072 mExtras.setDefusable(defusable);
6073 }
6074 }
6075
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006076 /**
6077 * Retrieve extended data from the intent.
6078 *
6079 * @param name The name of the desired item.
6080 *
6081 * @return the value of an item that previously added with putExtra()
6082 * or null if none was found.
6083 *
6084 * @deprecated
6085 * @hide
6086 */
6087 @Deprecated
6088 public Object getExtra(String name) {
6089 return getExtra(name, null);
6090 }
6091
6092 /**
6093 * Retrieve extended data from the intent.
6094 *
6095 * @param name The name of the desired item.
6096 * @param defaultValue the value to be returned if no value of the desired
6097 * type is stored with the given name.
6098 *
6099 * @return the value of an item that previously added with putExtra()
6100 * or the default value if none was found.
6101 *
6102 * @see #putExtra(String, boolean)
6103 */
6104 public boolean getBooleanExtra(String name, boolean defaultValue) {
6105 return mExtras == null ? defaultValue :
6106 mExtras.getBoolean(name, defaultValue);
6107 }
6108
6109 /**
6110 * Retrieve extended data from the intent.
6111 *
6112 * @param name The name of the desired item.
6113 * @param defaultValue the value to be returned if no value of the desired
6114 * type is stored with the given name.
6115 *
6116 * @return the value of an item that previously added with putExtra()
6117 * or the default value if none was found.
6118 *
6119 * @see #putExtra(String, byte)
6120 */
6121 public byte getByteExtra(String name, byte defaultValue) {
6122 return mExtras == null ? defaultValue :
6123 mExtras.getByte(name, defaultValue);
6124 }
6125
6126 /**
6127 * Retrieve extended data from the intent.
6128 *
6129 * @param name The name of the desired item.
6130 * @param defaultValue the value to be returned if no value of the desired
6131 * type is stored with the given name.
6132 *
6133 * @return the value of an item that previously added with putExtra()
6134 * or the default value if none was found.
6135 *
6136 * @see #putExtra(String, short)
6137 */
6138 public short getShortExtra(String name, short defaultValue) {
6139 return mExtras == null ? defaultValue :
6140 mExtras.getShort(name, defaultValue);
6141 }
6142
6143 /**
6144 * Retrieve extended data from the intent.
6145 *
6146 * @param name The name of the desired item.
6147 * @param defaultValue the value to be returned if no value of the desired
6148 * type is stored with the given name.
6149 *
6150 * @return the value of an item that previously added with putExtra()
6151 * or the default value if none was found.
6152 *
6153 * @see #putExtra(String, char)
6154 */
6155 public char getCharExtra(String name, char defaultValue) {
6156 return mExtras == null ? defaultValue :
6157 mExtras.getChar(name, defaultValue);
6158 }
6159
6160 /**
6161 * Retrieve extended data from the intent.
6162 *
6163 * @param name The name of the desired item.
6164 * @param defaultValue the value to be returned if no value of the desired
6165 * type is stored with the given name.
6166 *
6167 * @return the value of an item that previously added with putExtra()
6168 * or the default value if none was found.
6169 *
6170 * @see #putExtra(String, int)
6171 */
6172 public int getIntExtra(String name, int defaultValue) {
6173 return mExtras == null ? defaultValue :
6174 mExtras.getInt(name, defaultValue);
6175 }
6176
6177 /**
6178 * Retrieve extended data from the intent.
6179 *
6180 * @param name The name of the desired item.
6181 * @param defaultValue the value to be returned if no value of the desired
6182 * type is stored with the given name.
6183 *
6184 * @return the value of an item that previously added with putExtra()
6185 * or the default value if none was found.
6186 *
6187 * @see #putExtra(String, long)
6188 */
6189 public long getLongExtra(String name, long defaultValue) {
6190 return mExtras == null ? defaultValue :
6191 mExtras.getLong(name, defaultValue);
6192 }
6193
6194 /**
6195 * Retrieve extended data from the intent.
6196 *
6197 * @param name The name of the desired item.
6198 * @param defaultValue the value to be returned if no value of the desired
6199 * type is stored with the given name.
6200 *
6201 * @return the value of an item that previously added with putExtra(),
6202 * or the default value if no such item is present
6203 *
6204 * @see #putExtra(String, float)
6205 */
6206 public float getFloatExtra(String name, float defaultValue) {
6207 return mExtras == null ? defaultValue :
6208 mExtras.getFloat(name, defaultValue);
6209 }
6210
6211 /**
6212 * Retrieve extended data from the intent.
6213 *
6214 * @param name The name of the desired item.
6215 * @param defaultValue the value to be returned if no value of the desired
6216 * type is stored with the given name.
6217 *
6218 * @return the value of an item that previously added with putExtra()
6219 * or the default value if none was found.
6220 *
6221 * @see #putExtra(String, double)
6222 */
6223 public double getDoubleExtra(String name, double defaultValue) {
6224 return mExtras == null ? defaultValue :
6225 mExtras.getDouble(name, defaultValue);
6226 }
6227
6228 /**
6229 * Retrieve extended data from the intent.
6230 *
6231 * @param name The name of the desired item.
6232 *
6233 * @return the value of an item that previously added with putExtra()
6234 * or null if no String value was found.
6235 *
6236 * @see #putExtra(String, String)
6237 */
6238 public String getStringExtra(String name) {
6239 return mExtras == null ? null : mExtras.getString(name);
6240 }
6241
6242 /**
6243 * Retrieve extended data from the intent.
6244 *
6245 * @param name The name of the desired item.
6246 *
6247 * @return the value of an item that previously added with putExtra()
6248 * or null if no CharSequence value was found.
6249 *
6250 * @see #putExtra(String, CharSequence)
6251 */
6252 public CharSequence getCharSequenceExtra(String name) {
6253 return mExtras == null ? null : mExtras.getCharSequence(name);
6254 }
6255
6256 /**
6257 * Retrieve extended data from the intent.
6258 *
6259 * @param name The name of the desired item.
6260 *
6261 * @return the value of an item that previously added with putExtra()
6262 * or null if no Parcelable value was found.
6263 *
6264 * @see #putExtra(String, Parcelable)
6265 */
6266 public <T extends Parcelable> T getParcelableExtra(String name) {
6267 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6268 }
6269
6270 /**
6271 * Retrieve extended data from the intent.
6272 *
6273 * @param name The name of the desired item.
6274 *
6275 * @return the value of an item that previously added with putExtra()
6276 * or null if no Parcelable[] value was found.
6277 *
6278 * @see #putExtra(String, Parcelable[])
6279 */
6280 public Parcelable[] getParcelableArrayExtra(String name) {
6281 return mExtras == null ? null : mExtras.getParcelableArray(name);
6282 }
6283
6284 /**
6285 * Retrieve extended data from the intent.
6286 *
6287 * @param name The name of the desired item.
6288 *
6289 * @return the value of an item that previously added with putExtra()
6290 * or null if no ArrayList<Parcelable> value was found.
6291 *
6292 * @see #putParcelableArrayListExtra(String, ArrayList)
6293 */
6294 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6295 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6296 }
6297
6298 /**
6299 * Retrieve extended data from the intent.
6300 *
6301 * @param name The name of the desired item.
6302 *
6303 * @return the value of an item that previously added with putExtra()
6304 * or null if no Serializable value was found.
6305 *
6306 * @see #putExtra(String, Serializable)
6307 */
6308 public Serializable getSerializableExtra(String name) {
6309 return mExtras == null ? null : mExtras.getSerializable(name);
6310 }
6311
6312 /**
6313 * Retrieve extended data from the intent.
6314 *
6315 * @param name The name of the desired item.
6316 *
6317 * @return the value of an item that previously added with putExtra()
6318 * or null if no ArrayList<Integer> value was found.
6319 *
6320 * @see #putIntegerArrayListExtra(String, ArrayList)
6321 */
6322 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6323 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6324 }
6325
6326 /**
6327 * Retrieve extended data from the intent.
6328 *
6329 * @param name The name of the desired item.
6330 *
6331 * @return the value of an item that previously added with putExtra()
6332 * or null if no ArrayList<String> value was found.
6333 *
6334 * @see #putStringArrayListExtra(String, ArrayList)
6335 */
6336 public ArrayList<String> getStringArrayListExtra(String name) {
6337 return mExtras == null ? null : mExtras.getStringArrayList(name);
6338 }
6339
6340 /**
6341 * Retrieve extended data from the intent.
6342 *
6343 * @param name The name of the desired item.
6344 *
6345 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006346 * or null if no ArrayList<CharSequence> value was found.
6347 *
6348 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6349 */
6350 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6351 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6352 }
6353
6354 /**
6355 * Retrieve extended data from the intent.
6356 *
6357 * @param name The name of the desired item.
6358 *
6359 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006360 * or null if no boolean array value was found.
6361 *
6362 * @see #putExtra(String, boolean[])
6363 */
6364 public boolean[] getBooleanArrayExtra(String name) {
6365 return mExtras == null ? null : mExtras.getBooleanArray(name);
6366 }
6367
6368 /**
6369 * Retrieve extended data from the intent.
6370 *
6371 * @param name The name of the desired item.
6372 *
6373 * @return the value of an item that previously added with putExtra()
6374 * or null if no byte array value was found.
6375 *
6376 * @see #putExtra(String, byte[])
6377 */
6378 public byte[] getByteArrayExtra(String name) {
6379 return mExtras == null ? null : mExtras.getByteArray(name);
6380 }
6381
6382 /**
6383 * Retrieve extended data from the intent.
6384 *
6385 * @param name The name of the desired item.
6386 *
6387 * @return the value of an item that previously added with putExtra()
6388 * or null if no short array value was found.
6389 *
6390 * @see #putExtra(String, short[])
6391 */
6392 public short[] getShortArrayExtra(String name) {
6393 return mExtras == null ? null : mExtras.getShortArray(name);
6394 }
6395
6396 /**
6397 * Retrieve extended data from the intent.
6398 *
6399 * @param name The name of the desired item.
6400 *
6401 * @return the value of an item that previously added with putExtra()
6402 * or null if no char array value was found.
6403 *
6404 * @see #putExtra(String, char[])
6405 */
6406 public char[] getCharArrayExtra(String name) {
6407 return mExtras == null ? null : mExtras.getCharArray(name);
6408 }
6409
6410 /**
6411 * Retrieve extended data from the intent.
6412 *
6413 * @param name The name of the desired item.
6414 *
6415 * @return the value of an item that previously added with putExtra()
6416 * or null if no int array value was found.
6417 *
6418 * @see #putExtra(String, int[])
6419 */
6420 public int[] getIntArrayExtra(String name) {
6421 return mExtras == null ? null : mExtras.getIntArray(name);
6422 }
6423
6424 /**
6425 * Retrieve extended data from the intent.
6426 *
6427 * @param name The name of the desired item.
6428 *
6429 * @return the value of an item that previously added with putExtra()
6430 * or null if no long array value was found.
6431 *
6432 * @see #putExtra(String, long[])
6433 */
6434 public long[] getLongArrayExtra(String name) {
6435 return mExtras == null ? null : mExtras.getLongArray(name);
6436 }
6437
6438 /**
6439 * Retrieve extended data from the intent.
6440 *
6441 * @param name The name of the desired item.
6442 *
6443 * @return the value of an item that previously added with putExtra()
6444 * or null if no float array value was found.
6445 *
6446 * @see #putExtra(String, float[])
6447 */
6448 public float[] getFloatArrayExtra(String name) {
6449 return mExtras == null ? null : mExtras.getFloatArray(name);
6450 }
6451
6452 /**
6453 * Retrieve extended data from the intent.
6454 *
6455 * @param name The name of the desired item.
6456 *
6457 * @return the value of an item that previously added with putExtra()
6458 * or null if no double array value was found.
6459 *
6460 * @see #putExtra(String, double[])
6461 */
6462 public double[] getDoubleArrayExtra(String name) {
6463 return mExtras == null ? null : mExtras.getDoubleArray(name);
6464 }
6465
6466 /**
6467 * Retrieve extended data from the intent.
6468 *
6469 * @param name The name of the desired item.
6470 *
6471 * @return the value of an item that previously added with putExtra()
6472 * or null if no String array value was found.
6473 *
6474 * @see #putExtra(String, String[])
6475 */
6476 public String[] getStringArrayExtra(String name) {
6477 return mExtras == null ? null : mExtras.getStringArray(name);
6478 }
6479
6480 /**
6481 * Retrieve extended data from the intent.
6482 *
6483 * @param name The name of the desired item.
6484 *
6485 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006486 * or null if no CharSequence array value was found.
6487 *
6488 * @see #putExtra(String, CharSequence[])
6489 */
6490 public CharSequence[] getCharSequenceArrayExtra(String name) {
6491 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6492 }
6493
6494 /**
6495 * Retrieve extended data from the intent.
6496 *
6497 * @param name The name of the desired item.
6498 *
6499 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006500 * or null if no Bundle value was found.
6501 *
6502 * @see #putExtra(String, Bundle)
6503 */
6504 public Bundle getBundleExtra(String name) {
6505 return mExtras == null ? null : mExtras.getBundle(name);
6506 }
6507
6508 /**
6509 * Retrieve extended data from the intent.
6510 *
6511 * @param name The name of the desired item.
6512 *
6513 * @return the value of an item that previously added with putExtra()
6514 * or null if no IBinder value was found.
6515 *
6516 * @see #putExtra(String, IBinder)
6517 *
6518 * @deprecated
6519 * @hide
6520 */
6521 @Deprecated
6522 public IBinder getIBinderExtra(String name) {
6523 return mExtras == null ? null : mExtras.getIBinder(name);
6524 }
6525
6526 /**
6527 * Retrieve extended data from the intent.
6528 *
6529 * @param name The name of the desired item.
6530 * @param defaultValue The default value to return in case no item is
6531 * associated with the key 'name'
6532 *
6533 * @return the value of an item that previously added with putExtra()
6534 * or defaultValue if none was found.
6535 *
6536 * @see #putExtra
6537 *
6538 * @deprecated
6539 * @hide
6540 */
6541 @Deprecated
6542 public Object getExtra(String name, Object defaultValue) {
6543 Object result = defaultValue;
6544 if (mExtras != null) {
6545 Object result2 = mExtras.get(name);
6546 if (result2 != null) {
6547 result = result2;
6548 }
6549 }
6550
6551 return result;
6552 }
6553
6554 /**
6555 * Retrieves a map of extended data from the intent.
6556 *
6557 * @return the map of all extras previously added with putExtra(),
6558 * or null if none have been added.
6559 */
6560 public Bundle getExtras() {
6561 return (mExtras != null)
6562 ? new Bundle(mExtras)
6563 : null;
6564 }
6565
6566 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006567 * Filter extras to only basic types.
6568 * @hide
6569 */
6570 public void removeUnsafeExtras() {
6571 if (mExtras != null) {
6572 mExtras.filterValues();
6573 }
6574 }
6575
6576 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006577 * Retrieve any special flags associated with this intent. You will
6578 * normally just set them with {@link #setFlags} and let the system
6579 * take the appropriate action with them.
6580 *
6581 * @return int The currently set flags.
6582 *
6583 * @see #setFlags
6584 */
6585 public int getFlags() {
6586 return mFlags;
6587 }
6588
Dianne Hackborne7f97212011-02-24 14:40:20 -08006589 /** @hide */
6590 public boolean isExcludingStopped() {
6591 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6592 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6593 }
6594
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006595 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006596 * Retrieve the application package name this Intent is limited to. When
6597 * resolving an Intent, if non-null this limits the resolution to only
6598 * components in the given application package.
6599 *
6600 * @return The name of the application package for the Intent.
6601 *
6602 * @see #resolveActivity
6603 * @see #setPackage
6604 */
6605 public String getPackage() {
6606 return mPackage;
6607 }
6608
6609 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006610 * Retrieve the concrete component associated with the intent. When receiving
6611 * an intent, this is the component that was found to best handle it (that is,
6612 * yourself) and will always be non-null; in all other cases it will be
6613 * null unless explicitly set.
6614 *
6615 * @return The name of the application component to handle the intent.
6616 *
6617 * @see #resolveActivity
6618 * @see #setComponent
6619 */
6620 public ComponentName getComponent() {
6621 return mComponent;
6622 }
6623
6624 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006625 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6626 * used as a hint to the receiver for animations and the like. Null means that there
6627 * is no source bounds.
6628 */
6629 public Rect getSourceBounds() {
6630 return mSourceBounds;
6631 }
6632
6633 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006634 * Return the Activity component that should be used to handle this intent.
6635 * The appropriate component is determined based on the information in the
6636 * intent, evaluated as follows:
6637 *
6638 * <p>If {@link #getComponent} returns an explicit class, that is returned
6639 * without any further consideration.
6640 *
6641 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6642 * category to be considered.
6643 *
6644 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6645 * action.
6646 *
6647 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6648 * this type.
6649 *
6650 * <p>If {@link #addCategory} has added any categories, the activity must
6651 * handle ALL of the categories specified.
6652 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006653 * <p>If {@link #getPackage} is non-NULL, only activity components in
6654 * that application package will be considered.
6655 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006656 * <p>If there are no activities that satisfy all of these conditions, a
6657 * null string is returned.
6658 *
6659 * <p>If multiple activities are found to satisfy the intent, the one with
6660 * the highest priority will be used. If there are multiple activities
6661 * with the same priority, the system will either pick the best activity
6662 * based on user preference, or resolve to a system class that will allow
6663 * the user to pick an activity and forward from there.
6664 *
6665 * <p>This method is implemented simply by calling
6666 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6667 * true.</p>
6668 * <p> This API is called for you as part of starting an activity from an
6669 * intent. You do not normally need to call it yourself.</p>
6670 *
6671 * @param pm The package manager with which to resolve the Intent.
6672 *
6673 * @return Name of the component implementing an activity that can
6674 * display the intent.
6675 *
6676 * @see #setComponent
6677 * @see #getComponent
6678 * @see #resolveActivityInfo
6679 */
6680 public ComponentName resolveActivity(PackageManager pm) {
6681 if (mComponent != null) {
6682 return mComponent;
6683 }
6684
6685 ResolveInfo info = pm.resolveActivity(
6686 this, PackageManager.MATCH_DEFAULT_ONLY);
6687 if (info != null) {
6688 return new ComponentName(
6689 info.activityInfo.applicationInfo.packageName,
6690 info.activityInfo.name);
6691 }
6692
6693 return null;
6694 }
6695
6696 /**
6697 * Resolve the Intent into an {@link ActivityInfo}
6698 * describing the activity that should execute the intent. Resolution
6699 * follows the same rules as described for {@link #resolveActivity}, but
6700 * you get back the completely information about the resolved activity
6701 * instead of just its class name.
6702 *
6703 * @param pm The package manager with which to resolve the Intent.
6704 * @param flags Addition information to retrieve as per
6705 * {@link PackageManager#getActivityInfo(ComponentName, int)
6706 * PackageManager.getActivityInfo()}.
6707 *
6708 * @return PackageManager.ActivityInfo
6709 *
6710 * @see #resolveActivity
6711 */
6712 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6713 ActivityInfo ai = null;
6714 if (mComponent != null) {
6715 try {
6716 ai = pm.getActivityInfo(mComponent, flags);
6717 } catch (PackageManager.NameNotFoundException e) {
6718 // ignore
6719 }
6720 } else {
6721 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006722 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006723 if (info != null) {
6724 ai = info.activityInfo;
6725 }
6726 }
6727
6728 return ai;
6729 }
6730
6731 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006732 * Special function for use by the system to resolve service
6733 * intents to system apps. Throws an exception if there are
6734 * multiple potential matches to the Intent. Returns null if
6735 * there are no matches.
6736 * @hide
6737 */
6738 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6739 if (mComponent != null) {
6740 return mComponent;
6741 }
6742
6743 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6744 if (results == null) {
6745 return null;
6746 }
6747 ComponentName comp = null;
6748 for (int i=0; i<results.size(); i++) {
6749 ResolveInfo ri = results.get(i);
6750 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6751 continue;
6752 }
6753 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6754 ri.serviceInfo.name);
6755 if (comp != null) {
6756 throw new IllegalStateException("Multiple system services handle " + this
6757 + ": " + comp + ", " + foundComp);
6758 }
6759 comp = foundComp;
6760 }
6761 return comp;
6762 }
6763
6764 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006765 * Set the general action to be performed.
6766 *
6767 * @param action An action name, such as ACTION_VIEW. Application-specific
6768 * actions should be prefixed with the vendor's package name.
6769 *
6770 * @return Returns the same Intent object, for chaining multiple calls
6771 * into a single statement.
6772 *
6773 * @see #getAction
6774 */
6775 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006776 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006777 return this;
6778 }
6779
6780 /**
6781 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006782 * clears any type that was previously set by {@link #setType} or
6783 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006784 *
Nick Pellyccae4122012-01-09 14:12:58 -08006785 * <p><em>Note: scheme matching in the Android framework is
6786 * case-sensitive, unlike the formal RFC. As a result,
6787 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006788 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006789 * {@link #setDataAndNormalize}
6790 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006791 *
Nick Pellyccae4122012-01-09 14:12:58 -08006792 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006793 *
6794 * @return Returns the same Intent object, for chaining multiple calls
6795 * into a single statement.
6796 *
6797 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006798 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006799 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006800 */
6801 public Intent setData(Uri data) {
6802 mData = data;
6803 mType = null;
6804 return this;
6805 }
6806
6807 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006808 * Normalize and set the data this intent is operating on.
6809 *
6810 * <p>This method automatically clears any type that was
6811 * previously set (for example, by {@link #setType}).
6812 *
6813 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006814 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006815 * so really this is just a convenience method for
6816 * <pre>
6817 * setData(data.normalize())
6818 * </pre>
6819 *
6820 * @param data The Uri of the data this intent is now targeting.
6821 *
6822 * @return Returns the same Intent object, for chaining multiple calls
6823 * into a single statement.
6824 *
6825 * @see #getData
6826 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006827 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006828 */
6829 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006830 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006831 }
6832
6833 /**
6834 * Set an explicit MIME data type.
6835 *
6836 * <p>This is used to create intents that only specify a type and not data,
6837 * for example to indicate the type of data to return.
6838 *
6839 * <p>This method automatically clears any data that was
6840 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006841 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006842 * <p><em>Note: MIME type matching in the Android framework is
6843 * case-sensitive, unlike formal RFC MIME types. As a result,
6844 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006845 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6846 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006847 *
6848 * @param type The MIME type of the data being handled by this intent.
6849 *
6850 * @return Returns the same Intent object, for chaining multiple calls
6851 * into a single statement.
6852 *
6853 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006854 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006855 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006856 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006857 */
6858 public Intent setType(String type) {
6859 mData = null;
6860 mType = type;
6861 return this;
6862 }
6863
6864 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006865 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006866 *
Nick Pellyccae4122012-01-09 14:12:58 -08006867 * <p>This is used to create intents that only specify a type and not data,
6868 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006869 *
Nick Pellyccae4122012-01-09 14:12:58 -08006870 * <p>This method automatically clears any data that was
6871 * previously set (for example by {@link #setData}).
6872 *
6873 * <p>The MIME type is normalized using
6874 * {@link #normalizeMimeType} before it is set,
6875 * so really this is just a convenience method for
6876 * <pre>
6877 * setType(Intent.normalizeMimeType(type))
6878 * </pre>
6879 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006880 * @param type The MIME type of the data being handled by this intent.
6881 *
6882 * @return Returns the same Intent object, for chaining multiple calls
6883 * into a single statement.
6884 *
Nick Pellyccae4122012-01-09 14:12:58 -08006885 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006886 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006887 * @see #normalizeMimeType
6888 */
6889 public Intent setTypeAndNormalize(String type) {
6890 return setType(normalizeMimeType(type));
6891 }
6892
6893 /**
6894 * (Usually optional) Set the data for the intent along with an explicit
6895 * MIME data type. This method should very rarely be used -- it allows you
6896 * to override the MIME type that would ordinarily be inferred from the
6897 * data with your own type given here.
6898 *
6899 * <p><em>Note: MIME type and Uri scheme matching in the
6900 * Android framework is case-sensitive, unlike the formal RFC definitions.
6901 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006902 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006903 * {@link #setDataAndTypeAndNormalize}
6904 * to ensure that they are converted to lower case.</em>
6905 *
6906 * @param data The Uri of the data this intent is now targeting.
6907 * @param type The MIME type of the data being handled by this intent.
6908 *
6909 * @return Returns the same Intent object, for chaining multiple calls
6910 * into a single statement.
6911 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006912 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006913 * @see #setData
6914 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006915 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006916 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006917 */
6918 public Intent setDataAndType(Uri data, String type) {
6919 mData = data;
6920 mType = type;
6921 return this;
6922 }
6923
6924 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006925 * (Usually optional) Normalize and set both the data Uri and an explicit
6926 * MIME data type. This method should very rarely be used -- it allows you
6927 * to override the MIME type that would ordinarily be inferred from the
6928 * data with your own type given here.
6929 *
6930 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006931 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006932 * before they are set, so really this is just a convenience method for
6933 * <pre>
6934 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6935 * </pre>
6936 *
6937 * @param data The Uri of the data this intent is now targeting.
6938 * @param type The MIME type of the data being handled by this intent.
6939 *
6940 * @return Returns the same Intent object, for chaining multiple calls
6941 * into a single statement.
6942 *
6943 * @see #setType
6944 * @see #setData
6945 * @see #setDataAndType
6946 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006947 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006948 */
6949 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006950 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006951 }
6952
6953 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006954 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006955 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006956 * activities that provide <em>all</em> of the requested categories will be
6957 * used.
6958 *
6959 * @param category The desired category. This can be either one of the
6960 * predefined Intent categories, or a custom category in your own
6961 * namespace.
6962 *
6963 * @return Returns the same Intent object, for chaining multiple calls
6964 * into a single statement.
6965 *
6966 * @see #hasCategory
6967 * @see #removeCategory
6968 */
6969 public Intent addCategory(String category) {
6970 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006971 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006972 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006973 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006974 return this;
6975 }
6976
6977 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006978 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006979 *
6980 * @param category The category to remove.
6981 *
6982 * @see #addCategory
6983 */
6984 public void removeCategory(String category) {
6985 if (mCategories != null) {
6986 mCategories.remove(category);
6987 if (mCategories.size() == 0) {
6988 mCategories = null;
6989 }
6990 }
6991 }
6992
6993 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006994 * Set a selector for this Intent. This is a modification to the kinds of
6995 * things the Intent will match. If the selector is set, it will be used
6996 * when trying to find entities that can handle the Intent, instead of the
6997 * main contents of the Intent. This allows you build an Intent containing
6998 * a generic protocol while targeting it more specifically.
6999 *
7000 * <p>An example of where this may be used is with things like
7001 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7002 * Intent that will launch the Browser application. However, the correct
7003 * main entry point of an application is actually {@link #ACTION_MAIN}
7004 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7005 * used to specify the actual Activity to launch. If you launch the browser
7006 * with something different, undesired behavior may happen if the user has
7007 * previously or later launches it the normal way, since they do not match.
7008 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7009 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7010 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7011 *
7012 * <p>Setting a selector does not impact the behavior of
7013 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7014 * desired behavior of a selector -- it does not impact the base meaning
7015 * of the Intent, just what kinds of things will be matched against it
7016 * when determining who can handle it.</p>
7017 *
7018 * <p>You can not use both a selector and {@link #setPackage(String)} on
7019 * the same base Intent.</p>
7020 *
7021 * @param selector The desired selector Intent; set to null to not use
7022 * a special selector.
7023 */
7024 public void setSelector(Intent selector) {
7025 if (selector == this) {
7026 throw new IllegalArgumentException(
7027 "Intent being set as a selector of itself");
7028 }
7029 if (selector != null && mPackage != null) {
7030 throw new IllegalArgumentException(
7031 "Can't set selector when package name is already set");
7032 }
7033 mSelector = selector;
7034 }
7035
7036 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007037 * Set a {@link ClipData} associated with this Intent. This replaces any
7038 * previously set ClipData.
7039 *
7040 * <p>The ClipData in an intent is not used for Intent matching or other
7041 * such operations. Semantically it is like extras, used to transmit
7042 * additional data with the Intent. The main feature of using this over
7043 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7044 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7045 * items included in the clip data. This is useful, in particular, if
7046 * you want to transmit an Intent containing multiple <code>content:</code>
7047 * URIs for which the recipient may not have global permission to access the
7048 * content provider.
7049 *
7050 * <p>If the ClipData contains items that are themselves Intents, any
7051 * grant flags in those Intents will be ignored. Only the top-level flags
7052 * of the main Intent are respected, and will be applied to all Uri or
7053 * Intent items in the clip (or sub-items of the clip).
7054 *
7055 * <p>The MIME type, label, and icon in the ClipData object are not
7056 * directly used by Intent. Applications should generally rely on the
7057 * MIME type of the Intent itself, not what it may find in the ClipData.
7058 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007059 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007060 *
7061 * @param clip The new clip to set. May be null to clear the current clip.
7062 */
7063 public void setClipData(ClipData clip) {
7064 mClipData = clip;
7065 }
7066
7067 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007068 * This is NOT a secure mechanism to identify the user who sent the intent.
7069 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7070 * who sent the intent.
7071 * @hide
7072 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007073 public void prepareToLeaveUser(int userId) {
7074 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7075 // We want mContentUserHint to refer to the original user, so don't do anything.
7076 if (mContentUserHint == UserHandle.USER_CURRENT) {
7077 mContentUserHint = userId;
7078 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007079 }
7080
7081 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007082 * Add extended data to the intent. The name must include a package
7083 * prefix, for example the app com.android.contacts would use names
7084 * like "com.android.contacts.ShowAll".
7085 *
7086 * @param name The name of the extra data, with package prefix.
7087 * @param value The boolean data value.
7088 *
7089 * @return Returns the same Intent object, for chaining multiple calls
7090 * into a single statement.
7091 *
7092 * @see #putExtras
7093 * @see #removeExtra
7094 * @see #getBooleanExtra(String, boolean)
7095 */
7096 public Intent putExtra(String name, boolean value) {
7097 if (mExtras == null) {
7098 mExtras = new Bundle();
7099 }
7100 mExtras.putBoolean(name, value);
7101 return this;
7102 }
7103
7104 /**
7105 * Add extended data to the intent. The name must include a package
7106 * prefix, for example the app com.android.contacts would use names
7107 * like "com.android.contacts.ShowAll".
7108 *
7109 * @param name The name of the extra data, with package prefix.
7110 * @param value The byte data value.
7111 *
7112 * @return Returns the same Intent object, for chaining multiple calls
7113 * into a single statement.
7114 *
7115 * @see #putExtras
7116 * @see #removeExtra
7117 * @see #getByteExtra(String, byte)
7118 */
7119 public Intent putExtra(String name, byte value) {
7120 if (mExtras == null) {
7121 mExtras = new Bundle();
7122 }
7123 mExtras.putByte(name, value);
7124 return this;
7125 }
7126
7127 /**
7128 * Add extended data to the intent. The name must include a package
7129 * prefix, for example the app com.android.contacts would use names
7130 * like "com.android.contacts.ShowAll".
7131 *
7132 * @param name The name of the extra data, with package prefix.
7133 * @param value The char data value.
7134 *
7135 * @return Returns the same Intent object, for chaining multiple calls
7136 * into a single statement.
7137 *
7138 * @see #putExtras
7139 * @see #removeExtra
7140 * @see #getCharExtra(String, char)
7141 */
7142 public Intent putExtra(String name, char value) {
7143 if (mExtras == null) {
7144 mExtras = new Bundle();
7145 }
7146 mExtras.putChar(name, value);
7147 return this;
7148 }
7149
7150 /**
7151 * Add extended data to the intent. The name must include a package
7152 * prefix, for example the app com.android.contacts would use names
7153 * like "com.android.contacts.ShowAll".
7154 *
7155 * @param name The name of the extra data, with package prefix.
7156 * @param value The short data value.
7157 *
7158 * @return Returns the same Intent object, for chaining multiple calls
7159 * into a single statement.
7160 *
7161 * @see #putExtras
7162 * @see #removeExtra
7163 * @see #getShortExtra(String, short)
7164 */
7165 public Intent putExtra(String name, short value) {
7166 if (mExtras == null) {
7167 mExtras = new Bundle();
7168 }
7169 mExtras.putShort(name, value);
7170 return this;
7171 }
7172
7173 /**
7174 * Add extended data to the intent. The name must include a package
7175 * prefix, for example the app com.android.contacts would use names
7176 * like "com.android.contacts.ShowAll".
7177 *
7178 * @param name The name of the extra data, with package prefix.
7179 * @param value The integer data value.
7180 *
7181 * @return Returns the same Intent object, for chaining multiple calls
7182 * into a single statement.
7183 *
7184 * @see #putExtras
7185 * @see #removeExtra
7186 * @see #getIntExtra(String, int)
7187 */
7188 public Intent putExtra(String name, int value) {
7189 if (mExtras == null) {
7190 mExtras = new Bundle();
7191 }
7192 mExtras.putInt(name, value);
7193 return this;
7194 }
7195
7196 /**
7197 * Add extended data to the intent. The name must include a package
7198 * prefix, for example the app com.android.contacts would use names
7199 * like "com.android.contacts.ShowAll".
7200 *
7201 * @param name The name of the extra data, with package prefix.
7202 * @param value The long data value.
7203 *
7204 * @return Returns the same Intent object, for chaining multiple calls
7205 * into a single statement.
7206 *
7207 * @see #putExtras
7208 * @see #removeExtra
7209 * @see #getLongExtra(String, long)
7210 */
7211 public Intent putExtra(String name, long value) {
7212 if (mExtras == null) {
7213 mExtras = new Bundle();
7214 }
7215 mExtras.putLong(name, value);
7216 return this;
7217 }
7218
7219 /**
7220 * Add extended data to the intent. The name must include a package
7221 * prefix, for example the app com.android.contacts would use names
7222 * like "com.android.contacts.ShowAll".
7223 *
7224 * @param name The name of the extra data, with package prefix.
7225 * @param value The float data value.
7226 *
7227 * @return Returns the same Intent object, for chaining multiple calls
7228 * into a single statement.
7229 *
7230 * @see #putExtras
7231 * @see #removeExtra
7232 * @see #getFloatExtra(String, float)
7233 */
7234 public Intent putExtra(String name, float value) {
7235 if (mExtras == null) {
7236 mExtras = new Bundle();
7237 }
7238 mExtras.putFloat(name, value);
7239 return this;
7240 }
7241
7242 /**
7243 * Add extended data to the intent. The name must include a package
7244 * prefix, for example the app com.android.contacts would use names
7245 * like "com.android.contacts.ShowAll".
7246 *
7247 * @param name The name of the extra data, with package prefix.
7248 * @param value The double data value.
7249 *
7250 * @return Returns the same Intent object, for chaining multiple calls
7251 * into a single statement.
7252 *
7253 * @see #putExtras
7254 * @see #removeExtra
7255 * @see #getDoubleExtra(String, double)
7256 */
7257 public Intent putExtra(String name, double value) {
7258 if (mExtras == null) {
7259 mExtras = new Bundle();
7260 }
7261 mExtras.putDouble(name, value);
7262 return this;
7263 }
7264
7265 /**
7266 * Add extended data to the intent. The name must include a package
7267 * prefix, for example the app com.android.contacts would use names
7268 * like "com.android.contacts.ShowAll".
7269 *
7270 * @param name The name of the extra data, with package prefix.
7271 * @param value The String data value.
7272 *
7273 * @return Returns the same Intent object, for chaining multiple calls
7274 * into a single statement.
7275 *
7276 * @see #putExtras
7277 * @see #removeExtra
7278 * @see #getStringExtra(String)
7279 */
7280 public Intent putExtra(String name, String value) {
7281 if (mExtras == null) {
7282 mExtras = new Bundle();
7283 }
7284 mExtras.putString(name, value);
7285 return this;
7286 }
7287
7288 /**
7289 * Add extended data to the intent. The name must include a package
7290 * prefix, for example the app com.android.contacts would use names
7291 * like "com.android.contacts.ShowAll".
7292 *
7293 * @param name The name of the extra data, with package prefix.
7294 * @param value The CharSequence data value.
7295 *
7296 * @return Returns the same Intent object, for chaining multiple calls
7297 * into a single statement.
7298 *
7299 * @see #putExtras
7300 * @see #removeExtra
7301 * @see #getCharSequenceExtra(String)
7302 */
7303 public Intent putExtra(String name, CharSequence value) {
7304 if (mExtras == null) {
7305 mExtras = new Bundle();
7306 }
7307 mExtras.putCharSequence(name, value);
7308 return this;
7309 }
7310
7311 /**
7312 * Add extended data to the intent. The name must include a package
7313 * prefix, for example the app com.android.contacts would use names
7314 * like "com.android.contacts.ShowAll".
7315 *
7316 * @param name The name of the extra data, with package prefix.
7317 * @param value The Parcelable data value.
7318 *
7319 * @return Returns the same Intent object, for chaining multiple calls
7320 * into a single statement.
7321 *
7322 * @see #putExtras
7323 * @see #removeExtra
7324 * @see #getParcelableExtra(String)
7325 */
7326 public Intent putExtra(String name, Parcelable value) {
7327 if (mExtras == null) {
7328 mExtras = new Bundle();
7329 }
7330 mExtras.putParcelable(name, value);
7331 return this;
7332 }
7333
7334 /**
7335 * Add extended data to the intent. The name must include a package
7336 * prefix, for example the app com.android.contacts would use names
7337 * like "com.android.contacts.ShowAll".
7338 *
7339 * @param name The name of the extra data, with package prefix.
7340 * @param value The Parcelable[] data value.
7341 *
7342 * @return Returns the same Intent object, for chaining multiple calls
7343 * into a single statement.
7344 *
7345 * @see #putExtras
7346 * @see #removeExtra
7347 * @see #getParcelableArrayExtra(String)
7348 */
7349 public Intent putExtra(String name, Parcelable[] value) {
7350 if (mExtras == null) {
7351 mExtras = new Bundle();
7352 }
7353 mExtras.putParcelableArray(name, value);
7354 return this;
7355 }
7356
7357 /**
7358 * Add extended data to the intent. The name must include a package
7359 * prefix, for example the app com.android.contacts would use names
7360 * like "com.android.contacts.ShowAll".
7361 *
7362 * @param name The name of the extra data, with package prefix.
7363 * @param value The ArrayList<Parcelable> data value.
7364 *
7365 * @return Returns the same Intent object, for chaining multiple calls
7366 * into a single statement.
7367 *
7368 * @see #putExtras
7369 * @see #removeExtra
7370 * @see #getParcelableArrayListExtra(String)
7371 */
7372 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7373 if (mExtras == null) {
7374 mExtras = new Bundle();
7375 }
7376 mExtras.putParcelableArrayList(name, value);
7377 return this;
7378 }
7379
7380 /**
7381 * Add extended data to the intent. The name must include a package
7382 * prefix, for example the app com.android.contacts would use names
7383 * like "com.android.contacts.ShowAll".
7384 *
7385 * @param name The name of the extra data, with package prefix.
7386 * @param value The ArrayList<Integer> data value.
7387 *
7388 * @return Returns the same Intent object, for chaining multiple calls
7389 * into a single statement.
7390 *
7391 * @see #putExtras
7392 * @see #removeExtra
7393 * @see #getIntegerArrayListExtra(String)
7394 */
7395 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7396 if (mExtras == null) {
7397 mExtras = new Bundle();
7398 }
7399 mExtras.putIntegerArrayList(name, value);
7400 return this;
7401 }
7402
7403 /**
7404 * Add extended data to the intent. The name must include a package
7405 * prefix, for example the app com.android.contacts would use names
7406 * like "com.android.contacts.ShowAll".
7407 *
7408 * @param name The name of the extra data, with package prefix.
7409 * @param value The ArrayList<String> data value.
7410 *
7411 * @return Returns the same Intent object, for chaining multiple calls
7412 * into a single statement.
7413 *
7414 * @see #putExtras
7415 * @see #removeExtra
7416 * @see #getStringArrayListExtra(String)
7417 */
7418 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7419 if (mExtras == null) {
7420 mExtras = new Bundle();
7421 }
7422 mExtras.putStringArrayList(name, value);
7423 return this;
7424 }
7425
7426 /**
7427 * Add extended data to the intent. The name must include a package
7428 * prefix, for example the app com.android.contacts would use names
7429 * like "com.android.contacts.ShowAll".
7430 *
7431 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007432 * @param value The ArrayList<CharSequence> data value.
7433 *
7434 * @return Returns the same Intent object, for chaining multiple calls
7435 * into a single statement.
7436 *
7437 * @see #putExtras
7438 * @see #removeExtra
7439 * @see #getCharSequenceArrayListExtra(String)
7440 */
7441 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7442 if (mExtras == null) {
7443 mExtras = new Bundle();
7444 }
7445 mExtras.putCharSequenceArrayList(name, value);
7446 return this;
7447 }
7448
7449 /**
7450 * Add extended data to the intent. The name must include a package
7451 * prefix, for example the app com.android.contacts would use names
7452 * like "com.android.contacts.ShowAll".
7453 *
7454 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007455 * @param value The Serializable data value.
7456 *
7457 * @return Returns the same Intent object, for chaining multiple calls
7458 * into a single statement.
7459 *
7460 * @see #putExtras
7461 * @see #removeExtra
7462 * @see #getSerializableExtra(String)
7463 */
7464 public Intent putExtra(String name, Serializable value) {
7465 if (mExtras == null) {
7466 mExtras = new Bundle();
7467 }
7468 mExtras.putSerializable(name, value);
7469 return this;
7470 }
7471
7472 /**
7473 * Add extended data to the intent. The name must include a package
7474 * prefix, for example the app com.android.contacts would use names
7475 * like "com.android.contacts.ShowAll".
7476 *
7477 * @param name The name of the extra data, with package prefix.
7478 * @param value The boolean array data value.
7479 *
7480 * @return Returns the same Intent object, for chaining multiple calls
7481 * into a single statement.
7482 *
7483 * @see #putExtras
7484 * @see #removeExtra
7485 * @see #getBooleanArrayExtra(String)
7486 */
7487 public Intent putExtra(String name, boolean[] value) {
7488 if (mExtras == null) {
7489 mExtras = new Bundle();
7490 }
7491 mExtras.putBooleanArray(name, value);
7492 return this;
7493 }
7494
7495 /**
7496 * Add extended data to the intent. The name must include a package
7497 * prefix, for example the app com.android.contacts would use names
7498 * like "com.android.contacts.ShowAll".
7499 *
7500 * @param name The name of the extra data, with package prefix.
7501 * @param value The byte array data value.
7502 *
7503 * @return Returns the same Intent object, for chaining multiple calls
7504 * into a single statement.
7505 *
7506 * @see #putExtras
7507 * @see #removeExtra
7508 * @see #getByteArrayExtra(String)
7509 */
7510 public Intent putExtra(String name, byte[] value) {
7511 if (mExtras == null) {
7512 mExtras = new Bundle();
7513 }
7514 mExtras.putByteArray(name, value);
7515 return this;
7516 }
7517
7518 /**
7519 * Add extended data to the intent. The name must include a package
7520 * prefix, for example the app com.android.contacts would use names
7521 * like "com.android.contacts.ShowAll".
7522 *
7523 * @param name The name of the extra data, with package prefix.
7524 * @param value The short array data value.
7525 *
7526 * @return Returns the same Intent object, for chaining multiple calls
7527 * into a single statement.
7528 *
7529 * @see #putExtras
7530 * @see #removeExtra
7531 * @see #getShortArrayExtra(String)
7532 */
7533 public Intent putExtra(String name, short[] value) {
7534 if (mExtras == null) {
7535 mExtras = new Bundle();
7536 }
7537 mExtras.putShortArray(name, value);
7538 return this;
7539 }
7540
7541 /**
7542 * Add extended data to the intent. The name must include a package
7543 * prefix, for example the app com.android.contacts would use names
7544 * like "com.android.contacts.ShowAll".
7545 *
7546 * @param name The name of the extra data, with package prefix.
7547 * @param value The char array data value.
7548 *
7549 * @return Returns the same Intent object, for chaining multiple calls
7550 * into a single statement.
7551 *
7552 * @see #putExtras
7553 * @see #removeExtra
7554 * @see #getCharArrayExtra(String)
7555 */
7556 public Intent putExtra(String name, char[] value) {
7557 if (mExtras == null) {
7558 mExtras = new Bundle();
7559 }
7560 mExtras.putCharArray(name, value);
7561 return this;
7562 }
7563
7564 /**
7565 * Add extended data to the intent. The name must include a package
7566 * prefix, for example the app com.android.contacts would use names
7567 * like "com.android.contacts.ShowAll".
7568 *
7569 * @param name The name of the extra data, with package prefix.
7570 * @param value The int array data value.
7571 *
7572 * @return Returns the same Intent object, for chaining multiple calls
7573 * into a single statement.
7574 *
7575 * @see #putExtras
7576 * @see #removeExtra
7577 * @see #getIntArrayExtra(String)
7578 */
7579 public Intent putExtra(String name, int[] value) {
7580 if (mExtras == null) {
7581 mExtras = new Bundle();
7582 }
7583 mExtras.putIntArray(name, value);
7584 return this;
7585 }
7586
7587 /**
7588 * Add extended data to the intent. The name must include a package
7589 * prefix, for example the app com.android.contacts would use names
7590 * like "com.android.contacts.ShowAll".
7591 *
7592 * @param name The name of the extra data, with package prefix.
7593 * @param value The byte array data value.
7594 *
7595 * @return Returns the same Intent object, for chaining multiple calls
7596 * into a single statement.
7597 *
7598 * @see #putExtras
7599 * @see #removeExtra
7600 * @see #getLongArrayExtra(String)
7601 */
7602 public Intent putExtra(String name, long[] value) {
7603 if (mExtras == null) {
7604 mExtras = new Bundle();
7605 }
7606 mExtras.putLongArray(name, value);
7607 return this;
7608 }
7609
7610 /**
7611 * Add extended data to the intent. The name must include a package
7612 * prefix, for example the app com.android.contacts would use names
7613 * like "com.android.contacts.ShowAll".
7614 *
7615 * @param name The name of the extra data, with package prefix.
7616 * @param value The float array data value.
7617 *
7618 * @return Returns the same Intent object, for chaining multiple calls
7619 * into a single statement.
7620 *
7621 * @see #putExtras
7622 * @see #removeExtra
7623 * @see #getFloatArrayExtra(String)
7624 */
7625 public Intent putExtra(String name, float[] value) {
7626 if (mExtras == null) {
7627 mExtras = new Bundle();
7628 }
7629 mExtras.putFloatArray(name, value);
7630 return this;
7631 }
7632
7633 /**
7634 * Add extended data to the intent. The name must include a package
7635 * prefix, for example the app com.android.contacts would use names
7636 * like "com.android.contacts.ShowAll".
7637 *
7638 * @param name The name of the extra data, with package prefix.
7639 * @param value The double array data value.
7640 *
7641 * @return Returns the same Intent object, for chaining multiple calls
7642 * into a single statement.
7643 *
7644 * @see #putExtras
7645 * @see #removeExtra
7646 * @see #getDoubleArrayExtra(String)
7647 */
7648 public Intent putExtra(String name, double[] value) {
7649 if (mExtras == null) {
7650 mExtras = new Bundle();
7651 }
7652 mExtras.putDoubleArray(name, value);
7653 return this;
7654 }
7655
7656 /**
7657 * Add extended data to the intent. The name must include a package
7658 * prefix, for example the app com.android.contacts would use names
7659 * like "com.android.contacts.ShowAll".
7660 *
7661 * @param name The name of the extra data, with package prefix.
7662 * @param value The String array data value.
7663 *
7664 * @return Returns the same Intent object, for chaining multiple calls
7665 * into a single statement.
7666 *
7667 * @see #putExtras
7668 * @see #removeExtra
7669 * @see #getStringArrayExtra(String)
7670 */
7671 public Intent putExtra(String name, String[] value) {
7672 if (mExtras == null) {
7673 mExtras = new Bundle();
7674 }
7675 mExtras.putStringArray(name, value);
7676 return this;
7677 }
7678
7679 /**
7680 * Add extended data to the intent. The name must include a package
7681 * prefix, for example the app com.android.contacts would use names
7682 * like "com.android.contacts.ShowAll".
7683 *
7684 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007685 * @param value The CharSequence array data value.
7686 *
7687 * @return Returns the same Intent object, for chaining multiple calls
7688 * into a single statement.
7689 *
7690 * @see #putExtras
7691 * @see #removeExtra
7692 * @see #getCharSequenceArrayExtra(String)
7693 */
7694 public Intent putExtra(String name, CharSequence[] value) {
7695 if (mExtras == null) {
7696 mExtras = new Bundle();
7697 }
7698 mExtras.putCharSequenceArray(name, value);
7699 return this;
7700 }
7701
7702 /**
7703 * Add extended data to the intent. The name must include a package
7704 * prefix, for example the app com.android.contacts would use names
7705 * like "com.android.contacts.ShowAll".
7706 *
7707 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007708 * @param value The Bundle data value.
7709 *
7710 * @return Returns the same Intent object, for chaining multiple calls
7711 * into a single statement.
7712 *
7713 * @see #putExtras
7714 * @see #removeExtra
7715 * @see #getBundleExtra(String)
7716 */
7717 public Intent putExtra(String name, Bundle value) {
7718 if (mExtras == null) {
7719 mExtras = new Bundle();
7720 }
7721 mExtras.putBundle(name, value);
7722 return this;
7723 }
7724
7725 /**
7726 * Add extended data to the intent. The name must include a package
7727 * prefix, for example the app com.android.contacts would use names
7728 * like "com.android.contacts.ShowAll".
7729 *
7730 * @param name The name of the extra data, with package prefix.
7731 * @param value The IBinder data value.
7732 *
7733 * @return Returns the same Intent object, for chaining multiple calls
7734 * into a single statement.
7735 *
7736 * @see #putExtras
7737 * @see #removeExtra
7738 * @see #getIBinderExtra(String)
7739 *
7740 * @deprecated
7741 * @hide
7742 */
7743 @Deprecated
7744 public Intent putExtra(String name, IBinder value) {
7745 if (mExtras == null) {
7746 mExtras = new Bundle();
7747 }
7748 mExtras.putIBinder(name, value);
7749 return this;
7750 }
7751
7752 /**
7753 * Copy all extras in 'src' in to this intent.
7754 *
7755 * @param src Contains the extras to copy.
7756 *
7757 * @see #putExtra
7758 */
7759 public Intent putExtras(Intent src) {
7760 if (src.mExtras != null) {
7761 if (mExtras == null) {
7762 mExtras = new Bundle(src.mExtras);
7763 } else {
7764 mExtras.putAll(src.mExtras);
7765 }
7766 }
7767 return this;
7768 }
7769
7770 /**
7771 * Add a set of extended data to the intent. The keys must include a package
7772 * prefix, for example the app com.android.contacts would use names
7773 * like "com.android.contacts.ShowAll".
7774 *
7775 * @param extras The Bundle of extras to add to this intent.
7776 *
7777 * @see #putExtra
7778 * @see #removeExtra
7779 */
7780 public Intent putExtras(Bundle extras) {
7781 if (mExtras == null) {
7782 mExtras = new Bundle();
7783 }
7784 mExtras.putAll(extras);
7785 return this;
7786 }
7787
7788 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007789 * Completely replace the extras in the Intent with the extras in the
7790 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007791 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007792 * @param src The exact extras contained in this Intent are copied
7793 * into the target intent, replacing any that were previously there.
7794 */
7795 public Intent replaceExtras(Intent src) {
7796 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7797 return this;
7798 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007799
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007800 /**
7801 * Completely replace the extras in the Intent with the given Bundle of
7802 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007803 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007804 * @param extras The new set of extras in the Intent, or null to erase
7805 * all extras.
7806 */
7807 public Intent replaceExtras(Bundle extras) {
7808 mExtras = extras != null ? new Bundle(extras) : null;
7809 return this;
7810 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007811
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007812 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007813 * Remove extended data from the intent.
7814 *
7815 * @see #putExtra
7816 */
7817 public void removeExtra(String name) {
7818 if (mExtras != null) {
7819 mExtras.remove(name);
7820 if (mExtras.size() == 0) {
7821 mExtras = null;
7822 }
7823 }
7824 }
7825
7826 /**
7827 * Set special flags controlling how this intent is handled. Most values
7828 * here depend on the type of component being executed by the Intent,
7829 * specifically the FLAG_ACTIVITY_* flags are all for use with
7830 * {@link Context#startActivity Context.startActivity()} and the
7831 * FLAG_RECEIVER_* flags are all for use with
7832 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7833 *
Scott Main7aee61f2011-02-08 11:25:01 -08007834 * <p>See the
7835 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7836 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007837 * the behavior of your application.
7838 *
7839 * @param flags The desired flags.
7840 *
7841 * @return Returns the same Intent object, for chaining multiple calls
7842 * into a single statement.
7843 *
7844 * @see #getFlags
7845 * @see #addFlags
7846 *
7847 * @see #FLAG_GRANT_READ_URI_PERMISSION
7848 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007849 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7850 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007851 * @see #FLAG_DEBUG_LOG_RESOLUTION
7852 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007853 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007854 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007855 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007856 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007857 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7858 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007859 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007860 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007861 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007862 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007863 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007864 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007865 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007866 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7867 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007868 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007869 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007870 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007871 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7872 */
7873 public Intent setFlags(int flags) {
7874 mFlags = flags;
7875 return this;
7876 }
7877
7878 /**
7879 * Add additional flags to the intent (or with existing flags
7880 * value).
7881 *
7882 * @param flags The new flags to set.
7883 *
7884 * @return Returns the same Intent object, for chaining multiple calls
7885 * into a single statement.
7886 *
7887 * @see #setFlags
7888 */
7889 public Intent addFlags(int flags) {
7890 mFlags |= flags;
7891 return this;
7892 }
7893
7894 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007895 * (Usually optional) Set an explicit application package name that limits
7896 * the components this Intent will resolve to. If left to the default
7897 * value of null, all components in all applications will considered.
7898 * If non-null, the Intent can only match the components in the given
7899 * application package.
7900 *
7901 * @param packageName The name of the application package to handle the
7902 * intent, or null to allow any application package.
7903 *
7904 * @return Returns the same Intent object, for chaining multiple calls
7905 * into a single statement.
7906 *
7907 * @see #getPackage
7908 * @see #resolveActivity
7909 */
7910 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007911 if (packageName != null && mSelector != null) {
7912 throw new IllegalArgumentException(
7913 "Can't set package name when selector is already set");
7914 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007915 mPackage = packageName;
7916 return this;
7917 }
7918
7919 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007920 * (Usually optional) Explicitly set the component to handle the intent.
7921 * If left with the default value of null, the system will determine the
7922 * appropriate class to use based on the other fields (action, data,
7923 * type, categories) in the Intent. If this class is defined, the
7924 * specified class will always be used regardless of the other fields. You
7925 * should only set this value when you know you absolutely want a specific
7926 * class to be used; otherwise it is better to let the system find the
7927 * appropriate class so that you will respect the installed applications
7928 * and user preferences.
7929 *
7930 * @param component The name of the application component to handle the
7931 * intent, or null to let the system find one for you.
7932 *
7933 * @return Returns the same Intent object, for chaining multiple calls
7934 * into a single statement.
7935 *
7936 * @see #setClass
7937 * @see #setClassName(Context, String)
7938 * @see #setClassName(String, String)
7939 * @see #getComponent
7940 * @see #resolveActivity
7941 */
7942 public Intent setComponent(ComponentName component) {
7943 mComponent = component;
7944 return this;
7945 }
7946
7947 /**
7948 * Convenience for calling {@link #setComponent} with an
7949 * explicit class name.
7950 *
7951 * @param packageContext A Context of the application package implementing
7952 * this class.
7953 * @param className The name of a class inside of the application package
7954 * that will be used as the component for this Intent.
7955 *
7956 * @return Returns the same Intent object, for chaining multiple calls
7957 * into a single statement.
7958 *
7959 * @see #setComponent
7960 * @see #setClass
7961 */
7962 public Intent setClassName(Context packageContext, String className) {
7963 mComponent = new ComponentName(packageContext, className);
7964 return this;
7965 }
7966
7967 /**
7968 * Convenience for calling {@link #setComponent} with an
7969 * explicit application package name and class name.
7970 *
7971 * @param packageName The name of the package implementing the desired
7972 * component.
7973 * @param className The name of a class inside of the application package
7974 * that will be used as the component for this Intent.
7975 *
7976 * @return Returns the same Intent object, for chaining multiple calls
7977 * into a single statement.
7978 *
7979 * @see #setComponent
7980 * @see #setClass
7981 */
7982 public Intent setClassName(String packageName, String className) {
7983 mComponent = new ComponentName(packageName, className);
7984 return this;
7985 }
7986
7987 /**
7988 * Convenience for calling {@link #setComponent(ComponentName)} with the
7989 * name returned by a {@link Class} object.
7990 *
7991 * @param packageContext A Context of the application package implementing
7992 * this class.
7993 * @param cls The class name to set, equivalent to
7994 * <code>setClassName(context, cls.getName())</code>.
7995 *
7996 * @return Returns the same Intent object, for chaining multiple calls
7997 * into a single statement.
7998 *
7999 * @see #setComponent
8000 */
8001 public Intent setClass(Context packageContext, Class<?> cls) {
8002 mComponent = new ComponentName(packageContext, cls);
8003 return this;
8004 }
8005
8006 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008007 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8008 * used as a hint to the receiver for animations and the like. Null means that there
8009 * is no source bounds.
8010 */
8011 public void setSourceBounds(Rect r) {
8012 if (r != null) {
8013 mSourceBounds = new Rect(r);
8014 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008015 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008016 }
8017 }
8018
Tor Norbyed9273d62013-05-30 15:59:53 -07008019 /** @hide */
8020 @IntDef(flag = true,
8021 value = {
8022 FILL_IN_ACTION,
8023 FILL_IN_DATA,
8024 FILL_IN_CATEGORIES,
8025 FILL_IN_COMPONENT,
8026 FILL_IN_PACKAGE,
8027 FILL_IN_SOURCE_BOUNDS,
8028 FILL_IN_SELECTOR,
8029 FILL_IN_CLIP_DATA
8030 })
8031 @Retention(RetentionPolicy.SOURCE)
8032 public @interface FillInFlags {}
8033
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008034 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008035 * Use with {@link #fillIn} to allow the current action value to be
8036 * overwritten, even if it is already set.
8037 */
8038 public static final int FILL_IN_ACTION = 1<<0;
8039
8040 /**
8041 * Use with {@link #fillIn} to allow the current data or type value
8042 * overwritten, even if it is already set.
8043 */
8044 public static final int FILL_IN_DATA = 1<<1;
8045
8046 /**
8047 * Use with {@link #fillIn} to allow the current categories to be
8048 * overwritten, even if they are already set.
8049 */
8050 public static final int FILL_IN_CATEGORIES = 1<<2;
8051
8052 /**
8053 * Use with {@link #fillIn} to allow the current component value to be
8054 * overwritten, even if it is already set.
8055 */
8056 public static final int FILL_IN_COMPONENT = 1<<3;
8057
8058 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008059 * Use with {@link #fillIn} to allow the current package value to be
8060 * overwritten, even if it is already set.
8061 */
8062 public static final int FILL_IN_PACKAGE = 1<<4;
8063
8064 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008065 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008066 * overwritten, even if it is already set.
8067 */
8068 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8069
8070 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008071 * Use with {@link #fillIn} to allow the current selector to be
8072 * overwritten, even if it is already set.
8073 */
8074 public static final int FILL_IN_SELECTOR = 1<<6;
8075
8076 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008077 * Use with {@link #fillIn} to allow the current ClipData to be
8078 * overwritten, even if it is already set.
8079 */
8080 public static final int FILL_IN_CLIP_DATA = 1<<7;
8081
8082 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008083 * Copy the contents of <var>other</var> in to this object, but only
8084 * where fields are not defined by this object. For purposes of a field
8085 * being defined, the following pieces of data in the Intent are
8086 * considered to be separate fields:
8087 *
8088 * <ul>
8089 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008090 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008091 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8092 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008093 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008094 * <li> component, as set by {@link #setComponent(ComponentName)} or
8095 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008096 * <li> source bounds, as set by {@link #setSourceBounds}.
8097 * <li> selector, as set by {@link #setSelector(Intent)}.
8098 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008099 * <li> each top-level name in the associated extras.
8100 * </ul>
8101 *
8102 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008103 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008104 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8105 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8106 * the restriction where the corresponding field will not be replaced if
8107 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008108 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008109 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8110 * is explicitly specified. The selector will only be copied if
8111 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008112 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008113 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8114 * and Intent B with {action="gotit", data-type="some/thing",
8115 * categories="one","two"}.
8116 *
8117 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8118 * containing: {action="gotit", data-type="some/thing",
8119 * categories="bar"}.
8120 *
8121 * @param other Another Intent whose values are to be used to fill in
8122 * the current one.
8123 * @param flags Options to control which fields can be filled in.
8124 *
8125 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008126 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008127 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8128 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8129 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008130 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008131 @FillInFlags
8132 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008133 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008134 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008135 if (other.mAction != null
8136 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008137 mAction = other.mAction;
8138 changes |= FILL_IN_ACTION;
8139 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008140 if ((other.mData != null || other.mType != null)
8141 && ((mData == null && mType == null)
8142 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008143 mData = other.mData;
8144 mType = other.mType;
8145 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008146 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008147 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008148 if (other.mCategories != null
8149 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008150 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008151 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008152 }
8153 changes |= FILL_IN_CATEGORIES;
8154 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008155 if (other.mPackage != null
8156 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008157 // Only do this if mSelector is not set.
8158 if (mSelector == null) {
8159 mPackage = other.mPackage;
8160 changes |= FILL_IN_PACKAGE;
8161 }
8162 }
8163 // Selector is special: it can only be set if explicitly allowed,
8164 // for the same reason as the component name.
8165 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8166 if (mPackage == null) {
8167 mSelector = new Intent(other.mSelector);
8168 mPackage = null;
8169 changes |= FILL_IN_SELECTOR;
8170 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008171 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008172 if (other.mClipData != null
8173 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8174 mClipData = other.mClipData;
8175 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008176 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008177 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008178 // Component is special: it can -only- be set if explicitly allowed,
8179 // since otherwise the sender could force the intent somewhere the
8180 // originator didn't intend.
8181 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008182 mComponent = other.mComponent;
8183 changes |= FILL_IN_COMPONENT;
8184 }
8185 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008186 if (other.mSourceBounds != null
8187 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8188 mSourceBounds = new Rect(other.mSourceBounds);
8189 changes |= FILL_IN_SOURCE_BOUNDS;
8190 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008191 if (mExtras == null) {
8192 if (other.mExtras != null) {
8193 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008194 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008195 }
8196 } else if (other.mExtras != null) {
8197 try {
8198 Bundle newb = new Bundle(other.mExtras);
8199 newb.putAll(mExtras);
8200 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008201 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008202 } catch (RuntimeException e) {
8203 // Modifying the extras can cause us to unparcel the contents
8204 // of the bundle, and if we do this in the system process that
8205 // may fail. We really should handle this (i.e., the Bundle
8206 // impl shouldn't be on top of a plain map), but for now just
8207 // ignore it and keep the original contents. :(
8208 Log.w("Intent", "Failure filling in extras", e);
8209 }
8210 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008211 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8212 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8213 mContentUserHint = other.mContentUserHint;
8214 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008215 return changes;
8216 }
8217
8218 /**
8219 * Wrapper class holding an Intent and implementing comparisons on it for
8220 * the purpose of filtering. The class implements its
8221 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8222 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8223 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8224 * on the wrapped Intent.
8225 */
8226 public static final class FilterComparison {
8227 private final Intent mIntent;
8228 private final int mHashCode;
8229
8230 public FilterComparison(Intent intent) {
8231 mIntent = intent;
8232 mHashCode = intent.filterHashCode();
8233 }
8234
8235 /**
8236 * Return the Intent that this FilterComparison represents.
8237 * @return Returns the Intent held by the FilterComparison. Do
8238 * not modify!
8239 */
8240 public Intent getIntent() {
8241 return mIntent;
8242 }
8243
8244 @Override
8245 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008246 if (obj instanceof FilterComparison) {
8247 Intent other = ((FilterComparison)obj).mIntent;
8248 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008249 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008250 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008251 }
8252
8253 @Override
8254 public int hashCode() {
8255 return mHashCode;
8256 }
8257 }
8258
8259 /**
8260 * Determine if two intents are the same for the purposes of intent
8261 * resolution (filtering). That is, if their action, data, type,
8262 * class, and categories are the same. This does <em>not</em> compare
8263 * any extra data included in the intents.
8264 *
8265 * @param other The other Intent to compare against.
8266 *
8267 * @return Returns true if action, data, type, class, and categories
8268 * are the same.
8269 */
8270 public boolean filterEquals(Intent other) {
8271 if (other == null) {
8272 return false;
8273 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008274 if (!Objects.equals(this.mAction, other.mAction)) return false;
8275 if (!Objects.equals(this.mData, other.mData)) return false;
8276 if (!Objects.equals(this.mType, other.mType)) return false;
8277 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8278 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8279 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008280
8281 return true;
8282 }
8283
8284 /**
8285 * Generate hash code that matches semantics of filterEquals().
8286 *
8287 * @return Returns the hash value of the action, data, type, class, and
8288 * categories.
8289 *
8290 * @see #filterEquals
8291 */
8292 public int filterHashCode() {
8293 int code = 0;
8294 if (mAction != null) {
8295 code += mAction.hashCode();
8296 }
8297 if (mData != null) {
8298 code += mData.hashCode();
8299 }
8300 if (mType != null) {
8301 code += mType.hashCode();
8302 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008303 if (mPackage != null) {
8304 code += mPackage.hashCode();
8305 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008306 if (mComponent != null) {
8307 code += mComponent.hashCode();
8308 }
8309 if (mCategories != null) {
8310 code += mCategories.hashCode();
8311 }
8312 return code;
8313 }
8314
8315 @Override
8316 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008317 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008318
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008319 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008320 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008321 b.append(" }");
8322
8323 return b.toString();
8324 }
8325
8326 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008327 public String toInsecureString() {
8328 StringBuilder b = new StringBuilder(128);
8329
8330 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008331 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008332 b.append(" }");
8333
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008334 return b.toString();
8335 }
Romain Guy4969af72009-06-17 10:53:19 -07008336
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008337 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008338 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008339 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008340
8341 b.append("Intent { ");
8342 toShortString(b, false, true, true, true);
8343 b.append(" }");
8344
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008345 return b.toString();
8346 }
8347
8348 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008349 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8350 StringBuilder b = new StringBuilder(128);
8351 toShortString(b, secure, comp, extras, clip);
8352 return b.toString();
8353 }
8354
8355 /** @hide */
8356 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8357 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008358 boolean first = true;
8359 if (mAction != null) {
8360 b.append("act=").append(mAction);
8361 first = false;
8362 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008363 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008364 if (!first) {
8365 b.append(' ');
8366 }
8367 first = false;
8368 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008369 for (int i=0; i<mCategories.size(); i++) {
8370 if (i > 0) b.append(',');
8371 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008372 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008373 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008374 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008375 if (mData != null) {
8376 if (!first) {
8377 b.append(' ');
8378 }
8379 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008380 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008381 if (secure) {
8382 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008383 } else {
8384 b.append(mData);
8385 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008386 }
8387 if (mType != null) {
8388 if (!first) {
8389 b.append(' ');
8390 }
8391 first = false;
8392 b.append("typ=").append(mType);
8393 }
8394 if (mFlags != 0) {
8395 if (!first) {
8396 b.append(' ');
8397 }
8398 first = false;
8399 b.append("flg=0x").append(Integer.toHexString(mFlags));
8400 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008401 if (mPackage != null) {
8402 if (!first) {
8403 b.append(' ');
8404 }
8405 first = false;
8406 b.append("pkg=").append(mPackage);
8407 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008408 if (comp && mComponent != null) {
8409 if (!first) {
8410 b.append(' ');
8411 }
8412 first = false;
8413 b.append("cmp=").append(mComponent.flattenToShortString());
8414 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008415 if (mSourceBounds != null) {
8416 if (!first) {
8417 b.append(' ');
8418 }
8419 first = false;
8420 b.append("bnds=").append(mSourceBounds.toShortString());
8421 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008422 if (mClipData != null) {
8423 if (!first) {
8424 b.append(' ');
8425 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008426 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008427 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008428 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008429 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008430 if (mClipData.getDescription() != null) {
8431 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8432 } else {
8433 first = true;
8434 }
8435 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008436 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008437 first = false;
8438 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008439 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008440 if (extras && mExtras != null) {
8441 if (!first) {
8442 b.append(' ');
8443 }
8444 first = false;
8445 b.append("(has extras)");
8446 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008447 if (mContentUserHint != UserHandle.USER_CURRENT) {
8448 if (!first) {
8449 b.append(' ');
8450 }
8451 first = false;
8452 b.append("u=").append(mContentUserHint);
8453 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008454 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008455 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008456 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008457 b.append("}");
8458 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008459 }
8460
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008461 /**
8462 * Call {@link #toUri} with 0 flags.
8463 * @deprecated Use {@link #toUri} instead.
8464 */
8465 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008466 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008467 return toUri(0);
8468 }
8469
8470 /**
8471 * Convert this Intent into a String holding a URI representation of it.
8472 * The returned URI string has been properly URI encoded, so it can be
8473 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8474 * Intent's data as the base URI, with an additional fragment describing
8475 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008476 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008477 * <p>You can convert the returned string back to an Intent with
8478 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008479 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008480 * @param flags Additional operating flags. Either 0,
8481 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008482 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008483 * @return Returns a URI encoding URI string describing the entire contents
8484 * of the Intent.
8485 */
8486 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008487 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008488 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8489 if (mPackage == null) {
8490 throw new IllegalArgumentException(
8491 "Intent must include an explicit package name to build an android-app: "
8492 + this);
8493 }
8494 uri.append("android-app://");
8495 uri.append(mPackage);
8496 String scheme = null;
8497 if (mData != null) {
8498 scheme = mData.getScheme();
8499 if (scheme != null) {
8500 uri.append('/');
8501 uri.append(scheme);
8502 String authority = mData.getEncodedAuthority();
8503 if (authority != null) {
8504 uri.append('/');
8505 uri.append(authority);
8506 String path = mData.getEncodedPath();
8507 if (path != null) {
8508 uri.append(path);
8509 }
8510 String queryParams = mData.getEncodedQuery();
8511 if (queryParams != null) {
8512 uri.append('?');
8513 uri.append(queryParams);
8514 }
8515 String fragment = mData.getEncodedFragment();
8516 if (fragment != null) {
8517 uri.append('#');
8518 uri.append(fragment);
8519 }
8520 }
8521 }
8522 }
8523 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8524 mPackage, flags);
8525 return uri.toString();
8526 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008527 String scheme = null;
8528 if (mData != null) {
8529 String data = mData.toString();
8530 if ((flags&URI_INTENT_SCHEME) != 0) {
8531 final int N = data.length();
8532 for (int i=0; i<N; i++) {
8533 char c = data.charAt(i);
8534 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8535 || c == '.' || c == '-') {
8536 continue;
8537 }
8538 if (c == ':' && i > 0) {
8539 // Valid scheme.
8540 scheme = data.substring(0, i);
8541 uri.append("intent:");
8542 data = data.substring(i+1);
8543 break;
8544 }
Tom Taylord4a47292009-12-21 13:59:18 -08008545
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008546 // No scheme.
8547 break;
8548 }
8549 }
8550 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008551
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008552 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8553 uri.append("intent:");
8554 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008555
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008556 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008557
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008558 return uri.toString();
8559 }
8560
8561 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8562 String defPackage, int flags) {
8563 StringBuilder frag = new StringBuilder(128);
8564
8565 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008566 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008567 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008568 // Note that for now we are not going to try to handle the
8569 // data part; not clear how to represent this as a URI, and
8570 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008571 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8572 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008573 }
8574
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008575 if (frag.length() > 0) {
8576 uri.append("#Intent;");
8577 uri.append(frag);
8578 uri.append("end");
8579 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008580 }
8581
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008582 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8583 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008584 if (scheme != null) {
8585 uri.append("scheme=").append(scheme).append(';');
8586 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008587 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008588 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008589 }
8590 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008591 for (int i=0; i<mCategories.size(); i++) {
8592 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008593 }
8594 }
8595 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008596 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008597 }
8598 if (mFlags != 0) {
8599 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8600 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008601 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008602 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8603 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008604 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008605 uri.append("component=").append(Uri.encode(
8606 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008607 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008608 if (mSourceBounds != null) {
8609 uri.append("sourceBounds=")
8610 .append(Uri.encode(mSourceBounds.flattenToString()))
8611 .append(';');
8612 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008613 if (mExtras != null) {
8614 for (String key : mExtras.keySet()) {
8615 final Object value = mExtras.get(key);
8616 char entryType =
8617 value instanceof String ? 'S' :
8618 value instanceof Boolean ? 'B' :
8619 value instanceof Byte ? 'b' :
8620 value instanceof Character ? 'c' :
8621 value instanceof Double ? 'd' :
8622 value instanceof Float ? 'f' :
8623 value instanceof Integer ? 'i' :
8624 value instanceof Long ? 'l' :
8625 value instanceof Short ? 's' :
8626 '\0';
8627
8628 if (entryType != '\0') {
8629 uri.append(entryType);
8630 uri.append('.');
8631 uri.append(Uri.encode(key));
8632 uri.append('=');
8633 uri.append(Uri.encode(value.toString()));
8634 uri.append(';');
8635 }
8636 }
8637 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008638 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008639
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008640 public int describeContents() {
8641 return (mExtras != null) ? mExtras.describeContents() : 0;
8642 }
8643
8644 public void writeToParcel(Parcel out, int flags) {
8645 out.writeString(mAction);
8646 Uri.writeToParcel(out, mData);
8647 out.writeString(mType);
8648 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008649 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008650 ComponentName.writeToParcel(mComponent, out);
8651
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008652 if (mSourceBounds != null) {
8653 out.writeInt(1);
8654 mSourceBounds.writeToParcel(out, flags);
8655 } else {
8656 out.writeInt(0);
8657 }
8658
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008659 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008660 final int N = mCategories.size();
8661 out.writeInt(N);
8662 for (int i=0; i<N; i++) {
8663 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008664 }
8665 } else {
8666 out.writeInt(0);
8667 }
8668
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008669 if (mSelector != null) {
8670 out.writeInt(1);
8671 mSelector.writeToParcel(out, flags);
8672 } else {
8673 out.writeInt(0);
8674 }
8675
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008676 if (mClipData != null) {
8677 out.writeInt(1);
8678 mClipData.writeToParcel(out, flags);
8679 } else {
8680 out.writeInt(0);
8681 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008682 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008683 out.writeBundle(mExtras);
8684 }
8685
8686 public static final Parcelable.Creator<Intent> CREATOR
8687 = new Parcelable.Creator<Intent>() {
8688 public Intent createFromParcel(Parcel in) {
8689 return new Intent(in);
8690 }
8691 public Intent[] newArray(int size) {
8692 return new Intent[size];
8693 }
8694 };
8695
Dianne Hackborneb034652009-09-07 00:49:58 -07008696 /** @hide */
8697 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008698 readFromParcel(in);
8699 }
8700
8701 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008702 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008703 mData = Uri.CREATOR.createFromParcel(in);
8704 mType = in.readString();
8705 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008706 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008707 mComponent = ComponentName.readFromParcel(in);
8708
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008709 if (in.readInt() != 0) {
8710 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8711 }
8712
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008713 int N = in.readInt();
8714 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008715 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008716 int i;
8717 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008718 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008719 }
8720 } else {
8721 mCategories = null;
8722 }
8723
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008724 if (in.readInt() != 0) {
8725 mSelector = new Intent(in);
8726 }
8727
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008728 if (in.readInt() != 0) {
8729 mClipData = new ClipData(in);
8730 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008731 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008732 mExtras = in.readBundle();
8733 }
8734
8735 /**
8736 * Parses the "intent" element (and its children) from XML and instantiates
8737 * an Intent object. The given XML parser should be located at the tag
8738 * where parsing should start (often named "intent"), from which the
8739 * basic action, data, type, and package and class name will be
8740 * retrieved. The function will then parse in to any child elements,
8741 * looking for <category android:name="xxx"> tags to add categories and
8742 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8743 * to the intent.
8744 *
8745 * @param resources The Resources to use when inflating resources.
8746 * @param parser The XML parser pointing at an "intent" tag.
8747 * @param attrs The AttributeSet interface for retrieving extended
8748 * attribute data at the current <var>parser</var> location.
8749 * @return An Intent object matching the XML data.
8750 * @throws XmlPullParserException If there was an XML parsing error.
8751 * @throws IOException If there was an I/O error.
8752 */
8753 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8754 throws XmlPullParserException, IOException {
8755 Intent intent = new Intent();
8756
8757 TypedArray sa = resources.obtainAttributes(attrs,
8758 com.android.internal.R.styleable.Intent);
8759
8760 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8761
8762 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8763 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8764 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8765
8766 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8767 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8768 if (packageName != null && className != null) {
8769 intent.setComponent(new ComponentName(packageName, className));
8770 }
8771
8772 sa.recycle();
8773
8774 int outerDepth = parser.getDepth();
8775 int type;
8776 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8777 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8778 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8779 continue;
8780 }
8781
8782 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008783 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008784 sa = resources.obtainAttributes(attrs,
8785 com.android.internal.R.styleable.IntentCategory);
8786 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8787 sa.recycle();
8788
8789 if (cat != null) {
8790 intent.addCategory(cat);
8791 }
8792 XmlUtils.skipCurrentTag(parser);
8793
Craig Mautner21d24a22014-04-23 11:45:37 -07008794 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008795 if (intent.mExtras == null) {
8796 intent.mExtras = new Bundle();
8797 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008798 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008799 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008800
8801 } else {
8802 XmlUtils.skipCurrentTag(parser);
8803 }
8804 }
8805
8806 return intent;
8807 }
Nick Pellyccae4122012-01-09 14:12:58 -08008808
Craig Mautner21d24a22014-04-23 11:45:37 -07008809 /** @hide */
8810 public void saveToXml(XmlSerializer out) throws IOException {
8811 if (mAction != null) {
8812 out.attribute(null, ATTR_ACTION, mAction);
8813 }
8814 if (mData != null) {
8815 out.attribute(null, ATTR_DATA, mData.toString());
8816 }
8817 if (mType != null) {
8818 out.attribute(null, ATTR_TYPE, mType);
8819 }
8820 if (mComponent != null) {
8821 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8822 }
8823 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8824
8825 if (mCategories != null) {
8826 out.startTag(null, TAG_CATEGORIES);
8827 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8828 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8829 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008830 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008831 }
8832 }
8833
8834 /** @hide */
8835 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8836 XmlPullParserException {
8837 Intent intent = new Intent();
8838 final int outerDepth = in.getDepth();
8839
8840 int attrCount = in.getAttributeCount();
8841 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8842 final String attrName = in.getAttributeName(attrNdx);
8843 final String attrValue = in.getAttributeValue(attrNdx);
8844 if (ATTR_ACTION.equals(attrName)) {
8845 intent.setAction(attrValue);
8846 } else if (ATTR_DATA.equals(attrName)) {
8847 intent.setData(Uri.parse(attrValue));
8848 } else if (ATTR_TYPE.equals(attrName)) {
8849 intent.setType(attrValue);
8850 } else if (ATTR_COMPONENT.equals(attrName)) {
8851 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8852 } else if (ATTR_FLAGS.equals(attrName)) {
8853 intent.setFlags(Integer.valueOf(attrValue, 16));
8854 } else {
8855 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8856 }
8857 }
8858
8859 int event;
8860 String name;
8861 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8862 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8863 if (event == XmlPullParser.START_TAG) {
8864 name = in.getName();
8865 if (TAG_CATEGORIES.equals(name)) {
8866 attrCount = in.getAttributeCount();
8867 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8868 intent.addCategory(in.getAttributeValue(attrNdx));
8869 }
8870 } else {
8871 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8872 XmlUtils.skipCurrentTag(in);
8873 }
8874 }
8875 }
8876
8877 return intent;
8878 }
8879
Nick Pellyccae4122012-01-09 14:12:58 -08008880 /**
8881 * Normalize a MIME data type.
8882 *
8883 * <p>A normalized MIME type has white-space trimmed,
8884 * content-type parameters removed, and is lower-case.
8885 * This aligns the type with Android best practices for
8886 * intent filtering.
8887 *
8888 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8889 * "text/x-vCard" becomes "text/x-vcard".
8890 *
8891 * <p>All MIME types received from outside Android (such as user input,
8892 * or external sources like Bluetooth, NFC, or the Internet) should
8893 * be normalized before they are used to create an Intent.
8894 *
8895 * @param type MIME data type to normalize
8896 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008897 * @see #setType
8898 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008899 */
8900 public static String normalizeMimeType(String type) {
8901 if (type == null) {
8902 return null;
8903 }
8904
Elliott Hughescb64d432013-08-02 10:00:44 -07008905 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008906
8907 final int semicolonIndex = type.indexOf(';');
8908 if (semicolonIndex != -1) {
8909 type = type.substring(0, semicolonIndex);
8910 }
8911 return type;
8912 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008913
8914 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008915 * Prepare this {@link Intent} to leave an app process.
8916 *
8917 * @hide
8918 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07008919 public void prepareToLeaveProcess(Context context) {
8920 final boolean leavingPackage = (mComponent == null)
8921 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
8922 prepareToLeaveProcess(leavingPackage);
8923 }
8924
8925 /**
8926 * Prepare this {@link Intent} to leave an app process.
8927 *
8928 * @hide
8929 */
8930 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008931 setAllowFds(false);
8932
8933 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008934 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008935 }
8936 if (mClipData != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008937 mClipData.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008938 }
8939
Jeff Sharkeya8b42782016-01-30 17:58:09 -07008940 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
8941 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008942 switch (mAction) {
8943 case ACTION_MEDIA_REMOVED:
8944 case ACTION_MEDIA_UNMOUNTED:
8945 case ACTION_MEDIA_CHECKING:
8946 case ACTION_MEDIA_NOFS:
8947 case ACTION_MEDIA_MOUNTED:
8948 case ACTION_MEDIA_SHARED:
8949 case ACTION_MEDIA_UNSHARED:
8950 case ACTION_MEDIA_BAD_REMOVAL:
8951 case ACTION_MEDIA_UNMOUNTABLE:
8952 case ACTION_MEDIA_EJECT:
8953 case ACTION_MEDIA_SCANNER_STARTED:
8954 case ACTION_MEDIA_SCANNER_FINISHED:
8955 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07008956 case ACTION_PACKAGE_NEEDS_VERIFICATION:
8957 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07008958 // Ignore legacy actions
8959 break;
8960 default:
8961 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008962 }
8963 }
8964 }
8965
8966 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008967 * @hide
8968 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008969 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07008970 // We just entered destination process, so we should be able to read all
8971 // parcelables inside.
8972 setDefusable(true);
8973
8974 if (mSelector != null) {
8975 mSelector.prepareToEnterProcess();
8976 }
8977 if (mClipData != null) {
8978 mClipData.prepareToEnterProcess();
8979 }
8980
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008981 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008982 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8983 fixUris(mContentUserHint);
8984 mContentUserHint = UserHandle.USER_CURRENT;
8985 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008986 }
8987 }
8988
8989 /**
8990 * @hide
8991 */
8992 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008993 Uri data = getData();
8994 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008995 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008996 }
8997 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008998 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008999 }
9000 String action = getAction();
9001 if (ACTION_SEND.equals(action)) {
9002 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9003 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009004 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009005 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009006 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009007 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9008 if (streams != null) {
9009 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9010 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009011 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009012 }
9013 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9014 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009015 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9016 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9017 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9018 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9019 if (output != null) {
9020 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9021 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009022 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009023 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009024
9025 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009026 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009027 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9028 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009029 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009030 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009031 * @hide
9032 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009033 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009034 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009035 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009036
9037 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009038 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009039
9040 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009041 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009042 // Inspect contained intents to see if we need to migrate extras. We
9043 // don't promote ClipData to the parent, since ChooserActivity will
9044 // already start the picked item as the caller, and we can't combine
9045 // the flags in a safe way.
9046
9047 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009048 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009049 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9050 if (intent != null) {
9051 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009052 }
9053 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009054 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009055 try {
9056 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9057 if (intents != null) {
9058 for (int i = 0; i < intents.length; i++) {
9059 final Intent intent = (Intent) intents[i];
9060 if (intent != null) {
9061 migrated |= intent.migrateExtraStreamToClipData();
9062 }
9063 }
9064 }
9065 } catch (ClassCastException e) {
9066 }
9067 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009068
9069 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009070 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009071 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9072 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9073 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9074 if (stream != null || text != null || htmlText != null) {
9075 final ClipData clipData = new ClipData(
9076 null, new String[] { getType() },
9077 new ClipData.Item(text, htmlText, null, stream));
9078 setClipData(clipData);
9079 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009080 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009081 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009082 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009083 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009084
9085 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009086 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009087 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9088 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9089 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9090 int num = -1;
9091 if (streams != null) {
9092 num = streams.size();
9093 }
9094 if (texts != null) {
9095 if (num >= 0 && num != texts.size()) {
9096 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009097 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009098 }
9099 num = texts.size();
9100 }
9101 if (htmlTexts != null) {
9102 if (num >= 0 && num != htmlTexts.size()) {
9103 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009104 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009105 }
9106 num = htmlTexts.size();
9107 }
9108 if (num > 0) {
9109 final ClipData clipData = new ClipData(
9110 null, new String[] { getType() },
9111 makeClipItem(streams, texts, htmlTexts, 0));
9112
9113 for (int i = 1; i < num; i++) {
9114 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9115 }
9116
9117 setClipData(clipData);
9118 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009119 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009120 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009121 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009122 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009123 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9124 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9125 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9126 final Uri output;
9127 try {
9128 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9129 } catch (ClassCastException e) {
9130 return false;
9131 }
9132 if (output != null) {
9133 setClipData(ClipData.newRawUri("", output));
9134 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9135 return true;
9136 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009137 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009138
9139 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009140 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009141
9142 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9143 ArrayList<String> htmlTexts, int which) {
9144 Uri uri = streams != null ? streams.get(which) : null;
9145 CharSequence text = texts != null ? texts.get(which) : null;
9146 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9147 return new ClipData.Item(text, htmlText, null, uri);
9148 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009149
9150 /** @hide */
9151 public boolean isDocument() {
9152 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9153 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009154}