blob: 158a284112e758ff0f294fe0d2e816e3c702b677 [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Dianne Hackborn221ea892013-08-04 16:50:16 -070019import android.content.pm.ApplicationInfo;
Adam Powell2ed547e2015-04-29 18:45:04 -070020import android.os.ResultReceiver;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080021import android.os.ShellCommand;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010022import android.provider.MediaStore;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070023import android.util.ArraySet;
Jeff Sharkey846318a2014-04-04 12:12:41 -070024
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070025import org.xmlpull.v1.XmlPullParser;
26import org.xmlpull.v1.XmlPullParserException;
27
Tor Norbye7b9c9122013-05-30 16:48:33 -070028import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070029import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.annotation.SdkConstant;
Jose Lima73915cf2014-07-29 17:16:31 -070031import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.annotation.SdkConstant.SdkConstantType;
33import android.content.pm.ActivityInfo;
Jose Lima73915cf2014-07-29 17:16:31 -070034
Nicolas Prevotd85fc722014-04-16 19:52:08 +010035import static android.content.ContentProvider.maybeAddUserId;
Jose Lima73915cf2014-07-29 17:16:31 -070036
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070037import android.content.pm.PackageManager;
38import android.content.pm.ResolveInfo;
39import android.content.res.Resources;
40import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080041import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070042import android.net.Uri;
43import android.os.Bundle;
Felipe Lemec7b1f892016-01-15 15:02:31 -080044import android.os.Environment;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070045import android.os.IBinder;
46import android.os.Parcel;
47import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000048import android.os.Process;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070049import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010050import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070051import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070052import android.provider.DocumentsProvider;
53import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054import android.util.AttributeSet;
55import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080056
57import com.android.internal.util.XmlUtils;
Jose Lima73915cf2014-07-29 17:16:31 -070058
Craig Mautner21d24a22014-04-23 11:45:37 -070059import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070060
61import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080062import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070063import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070064import java.lang.annotation.Retention;
65import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.net.URISyntaxException;
67import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080068import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070069import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080070import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070071import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070072import java.util.Set;
73
74/**
75 * An intent is an abstract description of an operation to be performed. It
76 * can be used with {@link Context#startActivity(Intent) startActivity} to
77 * launch an {@link android.app.Activity},
78 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
79 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
80 * and {@link android.content.Context#startService} or
81 * {@link android.content.Context#bindService} to communicate with a
82 * background {@link android.app.Service}.
83 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070084 * <p>An Intent provides a facility for performing late runtime binding between the code in
85 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070086 * can be thought of as the glue between activities. It is basically a passive data structure
87 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070088 *
89 * <div class="special reference">
90 * <h3>Developer Guides</h3>
91 * <p>For information about how to create and resolve intents, read the
92 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
93 * developer guide.</p>
94 * </div>
95 *
96 * <a name="IntentStructure"></a>
97 * <h3>Intent Structure</h3>
98 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070099 *
100 * <ul>
101 * <li> <p><b>action</b> -- The general action to be performed, such as
102 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
103 * etc.</p>
104 * </li>
105 * <li> <p><b>data</b> -- The data to operate on, such as a person record
106 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
107 * </li>
108 * </ul>
109 *
110 *
111 * <p>Some examples of action/data pairs are:</p>
112 *
113 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700114 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700115 * information about the person whose identifier is "1".</p>
116 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700117 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700118 * the phone dialer with the person filled in.</p>
119 * </li>
120 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
121 * the phone dialer with the given number filled in. Note how the
122 * VIEW action does what what is considered the most reasonable thing for
123 * a particular URI.</p>
124 * </li>
125 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
126 * the phone dialer with the given number filled in.</p>
127 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700128 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700129 * information about the person whose identifier is "1".</p>
130 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700131 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700132 * a list of people, which the user can browse through. This example is a
133 * typical top-level entry into the Contacts application, showing you the
134 * list of people. Selecting a particular person to view would result in a
135 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
136 * being used to start an activity to display that person.</p>
137 * </li>
138 * </ul>
139 *
140 * <p>In addition to these primary attributes, there are a number of secondary
141 * attributes that you can also include with an intent:</p>
142 *
143 * <ul>
144 * <li> <p><b>category</b> -- Gives additional information about the action
145 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
146 * appear in the Launcher as a top-level application, while
147 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
148 * of alternative actions the user can perform on a piece of data.</p>
149 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
150 * intent data. Normally the type is inferred from the data itself.
151 * By setting this attribute, you disable that evaluation and force
152 * an explicit type.</p>
153 * <li> <p><b>component</b> -- Specifies an explicit name of a component
154 * class to use for the intent. Normally this is determined by looking
155 * at the other information in the intent (the action, data/type, and
156 * categories) and matching that with a component that can handle it.
157 * If this attribute is set then none of the evaluation is performed,
158 * and this component is used exactly as is. By specifying this attribute,
159 * all of the other Intent attributes become optional.</p>
160 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
161 * This can be used to provide extended information to the component.
162 * For example, if we have a action to send an e-mail message, we could
163 * also include extra pieces of data here to supply a subject, body,
164 * etc.</p>
165 * </ul>
166 *
167 * <p>Here are some examples of other operations you can specify as intents
168 * using these additional parameters:</p>
169 *
170 * <ul>
171 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
172 * Launch the home screen.</p>
173 * </li>
174 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
175 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
176 * vnd.android.cursor.item/phone}</i></b>
177 * -- Display the list of people's phone numbers, allowing the user to
178 * browse through them and pick one and return it to the parent activity.</p>
179 * </li>
180 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
181 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
182 * -- Display all pickers for data that can be opened with
183 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
184 * allowing the user to pick one of them and then some data inside of it
185 * and returning the resulting URI to the caller. This can be used,
186 * for example, in an e-mail application to allow the user to pick some
187 * data to include as an attachment.</p>
188 * </li>
189 * </ul>
190 *
191 * <p>There are a variety of standard Intent action and category constants
192 * defined in the Intent class, but applications can also define their own.
193 * These strings use java style scoping, to ensure they are unique -- for
194 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700195 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700196 *
197 * <p>Put together, the set of actions, data types, categories, and extra data
198 * defines a language for the system allowing for the expression of phrases
199 * such as "call john smith's cell". As applications are added to the system,
200 * they can extend this language by adding new actions, types, and categories, or
201 * they can modify the behavior of existing phrases by supplying their own
202 * activities that handle them.</p>
203 *
204 * <a name="IntentResolution"></a>
205 * <h3>Intent Resolution</h3>
206 *
207 * <p>There are two primary forms of intents you will use.
208 *
209 * <ul>
210 * <li> <p><b>Explicit Intents</b> have specified a component (via
211 * {@link #setComponent} or {@link #setClass}), which provides the exact
212 * class to be run. Often these will not include any other information,
213 * simply being a way for an application to launch various internal
214 * activities it has as the user interacts with the application.
215 *
216 * <li> <p><b>Implicit Intents</b> have not specified a component;
217 * instead, they must include enough information for the system to
218 * determine which of the available components is best to run for that
219 * intent.
220 * </ul>
221 *
222 * <p>When using implicit intents, given such an arbitrary intent we need to
223 * know what to do with it. This is handled by the process of <em>Intent
224 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
225 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
226 * more activities/receivers) that can handle it.</p>
227 *
228 * <p>The intent resolution mechanism basically revolves around matching an
229 * Intent against all of the &lt;intent-filter&gt; descriptions in the
230 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
231 * objects explicitly registered with {@link Context#registerReceiver}.) More
232 * details on this can be found in the documentation on the {@link
233 * IntentFilter} class.</p>
234 *
235 * <p>There are three pieces of information in the Intent that are used for
236 * resolution: the action, type, and category. Using this information, a query
237 * is done on the {@link PackageManager} for a component that can handle the
238 * intent. The appropriate component is determined based on the intent
239 * information supplied in the <code>AndroidManifest.xml</code> file as
240 * follows:</p>
241 *
242 * <ul>
243 * <li> <p>The <b>action</b>, if given, must be listed by the component as
244 * one it handles.</p>
245 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
246 * already supplied in the Intent. Like the action, if a type is
247 * included in the intent (either explicitly or implicitly in its
248 * data), then this must be listed by the component as one it handles.</p>
249 * <li> For data that is not a <code>content:</code> URI and where no explicit
250 * type is included in the Intent, instead the <b>scheme</b> of the
251 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
252 * considered. Again like the action, if we are matching a scheme it
253 * must be listed by the component as one it can handle.
254 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
255 * by the activity as categories it handles. That is, if you include
256 * the categories {@link #CATEGORY_LAUNCHER} and
257 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
258 * with an intent that lists <em>both</em> of those categories.
259 * Activities will very often need to support the
260 * {@link #CATEGORY_DEFAULT} so that they can be found by
261 * {@link Context#startActivity Context.startActivity()}.</p>
262 * </ul>
263 *
264 * <p>For example, consider the Note Pad sample application that
265 * allows user to browse through a list of notes data and view details about
266 * individual items. Text in italics indicate places were you would replace a
267 * name with one specific to your own package.</p>
268 *
269 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
270 * package="<i>com.android.notepad</i>"&gt;
271 * &lt;application android:icon="@drawable/app_notes"
272 * android:label="@string/app_name"&gt;
273 *
274 * &lt;provider class=".NotePadProvider"
275 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
276 *
277 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
278 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="android.intent.action.MAIN" /&gt;
280 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700281 * &lt;/intent-filter&gt;
282 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700283 * &lt;action android:name="android.intent.action.VIEW" /&gt;
284 * &lt;action android:name="android.intent.action.EDIT" /&gt;
285 * &lt;action android:name="android.intent.action.PICK" /&gt;
286 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
287 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700288 * &lt;/intent-filter&gt;
289 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700293 * &lt;/intent-filter&gt;
294 * &lt;/activity&gt;
295 *
296 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
297 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700298 * &lt;action android:name="android.intent.action.VIEW" /&gt;
299 * &lt;action android:name="android.intent.action.EDIT" /&gt;
300 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
301 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700302 * &lt;/intent-filter&gt;
303 *
304 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700305 * &lt;action android:name="android.intent.action.INSERT" /&gt;
306 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
307 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700308 * &lt;/intent-filter&gt;
309 *
310 * &lt;/activity&gt;
311 *
312 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
313 * android:theme="@android:style/Theme.Dialog"&gt;
314 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700315 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
316 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
317 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
318 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
319 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700320 * &lt;/intent-filter&gt;
321 * &lt;/activity&gt;
322 *
323 * &lt;/application&gt;
324 * &lt;/manifest&gt;</pre>
325 *
326 * <p>The first activity,
327 * <code>com.android.notepad.NotesList</code>, serves as our main
328 * entry into the app. It can do three things as described by its three intent
329 * templates:
330 * <ol>
331 * <li><pre>
332 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700333 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
334 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700335 * &lt;/intent-filter&gt;</pre>
336 * <p>This provides a top-level entry into the NotePad application: the standard
337 * MAIN action is a main entry point (not requiring any other information in
338 * the Intent), and the LAUNCHER category says that this entry point should be
339 * listed in the application launcher.</p>
340 * <li><pre>
341 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700342 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
343 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
344 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
345 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
346 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700347 * &lt;/intent-filter&gt;</pre>
348 * <p>This declares the things that the activity can do on a directory of
349 * notes. The type being supported is given with the &lt;type&gt; tag, where
350 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
351 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
352 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
353 * The activity allows the user to view or edit the directory of data (via
354 * the VIEW and EDIT actions), or to pick a particular note and return it
355 * to the caller (via the PICK action). Note also the DEFAULT category
356 * supplied here: this is <em>required</em> for the
357 * {@link Context#startActivity Context.startActivity} method to resolve your
358 * activity when its component name is not explicitly specified.</p>
359 * <li><pre>
360 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700361 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
362 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
363 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700364 * &lt;/intent-filter&gt;</pre>
365 * <p>This filter describes the ability return to the caller a note selected by
366 * the user without needing to know where it came from. The data type
367 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
368 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
369 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
370 * The GET_CONTENT action is similar to the PICK action, where the activity
371 * will return to its caller a piece of data selected by the user. Here,
372 * however, the caller specifies the type of data they desire instead of
373 * the type of data the user will be picking from.</p>
374 * </ol>
375 *
376 * <p>Given these capabilities, the following intents will resolve to the
377 * NotesList activity:</p>
378 *
379 * <ul>
380 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
381 * activities that can be used as top-level entry points into an
382 * application.</p>
383 * <li> <p><b>{ action=android.app.action.MAIN,
384 * category=android.app.category.LAUNCHER }</b> is the actual intent
385 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700386 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700387 * data=content://com.google.provider.NotePad/notes }</b>
388 * displays a list of all the notes under
389 * "content://com.google.provider.NotePad/notes", which
390 * the user can browse through and see the details on.</p>
391 * <li> <p><b>{ action=android.app.action.PICK
392 * data=content://com.google.provider.NotePad/notes }</b>
393 * provides a list of the notes under
394 * "content://com.google.provider.NotePad/notes", from which
395 * the user can pick a note whose data URL is returned back to the caller.</p>
396 * <li> <p><b>{ action=android.app.action.GET_CONTENT
397 * type=vnd.android.cursor.item/vnd.google.note }</b>
398 * is similar to the pick action, but allows the caller to specify the
399 * kind of data they want back so that the system can find the appropriate
400 * activity to pick something of that data type.</p>
401 * </ul>
402 *
403 * <p>The second activity,
404 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
405 * note entry and allows them to edit it. It can do two things as described
406 * by its two intent templates:
407 * <ol>
408 * <li><pre>
409 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700410 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
411 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
412 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
413 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700414 * &lt;/intent-filter&gt;</pre>
415 * <p>The first, primary, purpose of this activity is to let the user interact
416 * with a single note, as decribed by the MIME type
417 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
418 * either VIEW a note or allow the user to EDIT it. Again we support the
419 * DEFAULT category to allow the activity to be launched without explicitly
420 * specifying its component.</p>
421 * <li><pre>
422 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700423 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
424 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
425 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700426 * &lt;/intent-filter&gt;</pre>
427 * <p>The secondary use of this activity is to insert a new note entry into
428 * an existing directory of notes. This is used when the user creates a new
429 * note: the INSERT action is executed on the directory of notes, causing
430 * this activity to run and have the user create the new note data which
431 * it then adds to the content provider.</p>
432 * </ol>
433 *
434 * <p>Given these capabilities, the following intents will resolve to the
435 * NoteEditor activity:</p>
436 *
437 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700438 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700439 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
440 * shows the user the content of note <var>{ID}</var>.</p>
441 * <li> <p><b>{ action=android.app.action.EDIT
442 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
443 * allows the user to edit the content of note <var>{ID}</var>.</p>
444 * <li> <p><b>{ action=android.app.action.INSERT
445 * data=content://com.google.provider.NotePad/notes }</b>
446 * creates a new, empty note in the notes list at
447 * "content://com.google.provider.NotePad/notes"
448 * and allows the user to edit it. If they keep their changes, the URI
449 * of the newly created note is returned to the caller.</p>
450 * </ul>
451 *
452 * <p>The last activity,
453 * <code>com.android.notepad.TitleEditor</code>, allows the user to
454 * edit the title of a note. This could be implemented as a class that the
455 * application directly invokes (by explicitly setting its component in
456 * the Intent), but here we show a way you can publish alternative
457 * operations on existing data:</p>
458 *
459 * <pre>
460 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700461 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
462 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
463 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
464 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
465 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700466 * &lt;/intent-filter&gt;</pre>
467 *
468 * <p>In the single intent template here, we
469 * have created our own private action called
470 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
471 * edit the title of a note. It must be invoked on a specific note
472 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
473 * view and edit actions, but here displays and edits the title contained
474 * in the note data.
475 *
476 * <p>In addition to supporting the default category as usual, our title editor
477 * also supports two other standard categories: ALTERNATIVE and
478 * SELECTED_ALTERNATIVE. Implementing
479 * these categories allows others to find the special action it provides
480 * without directly knowing about it, through the
481 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
482 * more often to build dynamic menu items with
483 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
484 * template here was also supply an explicit name for the template
485 * (via <code>android:label="@string/resolve_title"</code>) to better control
486 * what the user sees when presented with this activity as an alternative
487 * action to the data they are viewing.
488 *
489 * <p>Given these capabilities, the following intent will resolve to the
490 * TitleEditor activity:</p>
491 *
492 * <ul>
493 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
494 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
495 * displays and allows the user to edit the title associated
496 * with note <var>{ID}</var>.</p>
497 * </ul>
498 *
499 * <h3>Standard Activity Actions</h3>
500 *
501 * <p>These are the current standard actions that Intent defines for launching
502 * activities (usually through {@link Context#startActivity}. The most
503 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
504 * {@link #ACTION_EDIT}.
505 *
506 * <ul>
507 * <li> {@link #ACTION_MAIN}
508 * <li> {@link #ACTION_VIEW}
509 * <li> {@link #ACTION_ATTACH_DATA}
510 * <li> {@link #ACTION_EDIT}
511 * <li> {@link #ACTION_PICK}
512 * <li> {@link #ACTION_CHOOSER}
513 * <li> {@link #ACTION_GET_CONTENT}
514 * <li> {@link #ACTION_DIAL}
515 * <li> {@link #ACTION_CALL}
516 * <li> {@link #ACTION_SEND}
517 * <li> {@link #ACTION_SENDTO}
518 * <li> {@link #ACTION_ANSWER}
519 * <li> {@link #ACTION_INSERT}
520 * <li> {@link #ACTION_DELETE}
521 * <li> {@link #ACTION_RUN}
522 * <li> {@link #ACTION_SYNC}
523 * <li> {@link #ACTION_PICK_ACTIVITY}
524 * <li> {@link #ACTION_SEARCH}
525 * <li> {@link #ACTION_WEB_SEARCH}
526 * <li> {@link #ACTION_FACTORY_TEST}
527 * </ul>
528 *
529 * <h3>Standard Broadcast Actions</h3>
530 *
531 * <p>These are the current standard actions that Intent defines for receiving
532 * broadcasts (usually through {@link Context#registerReceiver} or a
533 * &lt;receiver&gt; tag in a manifest).
534 *
535 * <ul>
536 * <li> {@link #ACTION_TIME_TICK}
537 * <li> {@link #ACTION_TIME_CHANGED}
538 * <li> {@link #ACTION_TIMEZONE_CHANGED}
539 * <li> {@link #ACTION_BOOT_COMPLETED}
540 * <li> {@link #ACTION_PACKAGE_ADDED}
541 * <li> {@link #ACTION_PACKAGE_CHANGED}
542 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800543 * <li> {@link #ACTION_PACKAGE_RESTARTED}
544 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000545 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
546 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700547 * <li> {@link #ACTION_UID_REMOVED}
548 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700549 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700550 * <li> {@link #ACTION_POWER_DISCONNECTED}
551 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700552 * </ul>
553 *
554 * <h3>Standard Categories</h3>
555 *
556 * <p>These are the current standard categories that can be used to further
557 * clarify an Intent via {@link #addCategory}.
558 *
559 * <ul>
560 * <li> {@link #CATEGORY_DEFAULT}
561 * <li> {@link #CATEGORY_BROWSABLE}
562 * <li> {@link #CATEGORY_TAB}
563 * <li> {@link #CATEGORY_ALTERNATIVE}
564 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
565 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800566 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700567 * <li> {@link #CATEGORY_HOME}
568 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700569 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400570 * <li> {@link #CATEGORY_CAR_DOCK}
571 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500572 * <li> {@link #CATEGORY_LE_DESK_DOCK}
573 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200574 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700575 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700576 * </ul>
577 *
578 * <h3>Standard Extra Data</h3>
579 *
580 * <p>These are the current standard fields that can be used as extra data via
581 * {@link #putExtra}.
582 *
583 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800584 * <li> {@link #EXTRA_ALARM_COUNT}
585 * <li> {@link #EXTRA_BCC}
586 * <li> {@link #EXTRA_CC}
587 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
588 * <li> {@link #EXTRA_DATA_REMOVED}
589 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500590 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
591 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800592 * <li> {@link #EXTRA_DOCK_STATE_CAR}
593 * <li> {@link #EXTRA_DOCK_STATE_DESK}
594 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
595 * <li> {@link #EXTRA_DONT_KILL_APP}
596 * <li> {@link #EXTRA_EMAIL}
597 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700598 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800599 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700600 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800601 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700602 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800603 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
604 * <li> {@link #EXTRA_REPLACING}
605 * <li> {@link #EXTRA_SHORTCUT_ICON}
606 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
607 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800609 * <li> {@link #EXTRA_SHORTCUT_NAME}
610 * <li> {@link #EXTRA_SUBJECT}
611 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700612 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800613 * <li> {@link #EXTRA_TITLE}
614 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700615 * </ul>
616 *
617 * <h3>Flags</h3>
618 *
619 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800620 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
621 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700622 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800623public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700624 private static final String ATTR_ACTION = "action";
625 private static final String TAG_CATEGORIES = "categories";
626 private static final String ATTR_CATEGORY = "category";
627 private static final String TAG_EXTRA = "extra";
628 private static final String ATTR_TYPE = "type";
629 private static final String ATTR_COMPONENT = "component";
630 private static final String ATTR_DATA = "data";
631 private static final String ATTR_FLAGS = "flags";
632
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700633 // ---------------------------------------------------------------------
634 // ---------------------------------------------------------------------
635 // Standard intent activity actions (see action variable).
636
637 /**
638 * Activity Action: Start as a main entry point, does not expect to
639 * receive data.
640 * <p>Input: nothing
641 * <p>Output: nothing
642 */
643 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
644 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800645
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700646 /**
647 * Activity Action: Display the data to the user. This is the most common
648 * action performed on data -- it is the generic action you can use on
649 * a piece of data to get the most reasonable thing to occur. For example,
650 * when used on a contacts entry it will view the entry; when used on a
651 * mailto: URI it will bring up a compose window filled with the information
652 * supplied by the URI; when used with a tel: URI it will invoke the
653 * dialer.
654 * <p>Input: {@link #getData} is URI from which to retrieve data.
655 * <p>Output: nothing.
656 */
657 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
658 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700660 /**
661 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
662 * performed on a piece of data.
663 */
664 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800665
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700666 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900667 * Activity Action: Quick view the data. Launches a quick viewer for
668 * a URI or a list of URIs.
669 * <p>Input: {@link #getData} is a mandatory content URI of the item to
670 * preview. {@link #getClipData} contains an optional list of content URIs
671 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
672 * optional index of the URI in the clip data to show first.
Steve McKayc78bcb82015-07-31 14:35:22 -0700673 * <p>Output: nothing.
Steve McKayc78bcb82015-07-31 14:35:22 -0700674 */
675 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
676 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
677
678 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700679 * Used to indicate that some piece of data should be attached to some other
680 * place. For example, image data could be attached to a contact. It is up
681 * to the recipient to decide where the data should be attached; the intent
682 * does not specify the ultimate destination.
683 * <p>Input: {@link #getData} is URI of data to be attached.
684 * <p>Output: nothing.
685 */
686 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
687 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800688
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700689 /**
690 * Activity Action: Provide explicit editable access to the given data.
691 * <p>Input: {@link #getData} is URI of data to be edited.
692 * <p>Output: nothing.
693 */
694 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
695 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800696
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700697 /**
698 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
699 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
700 * The extras can contain type specific data to pass through to the editing/creating
701 * activity.
702 * <p>Output: The URI of the item that was picked. This must be a content:
703 * URI so that any receiver can access it.
704 */
705 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
706 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800707
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700708 /**
709 * Activity Action: Pick an item from the data, returning what was selected.
710 * <p>Input: {@link #getData} is URI containing a directory of data
711 * (vnd.android.cursor.dir/*) from which to pick an item.
712 * <p>Output: The URI of the item that was picked.
713 */
714 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
715 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800716
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700717 /**
718 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800719 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700720 * <p>Output: An Intent representing the shortcut. The intent must contain three
721 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
722 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800723 * (value: ShortcutIconResource).</p>
724 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700725 * @see #EXTRA_SHORTCUT_INTENT
726 * @see #EXTRA_SHORTCUT_NAME
727 * @see #EXTRA_SHORTCUT_ICON
728 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
729 * @see android.content.Intent.ShortcutIconResource
730 */
731 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
732 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
733
734 /**
735 * The name of the extra used to define the Intent of a shortcut.
736 *
737 * @see #ACTION_CREATE_SHORTCUT
738 */
739 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
740 /**
741 * The name of the extra used to define the name of a shortcut.
742 *
743 * @see #ACTION_CREATE_SHORTCUT
744 */
745 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
746 /**
747 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
748 *
749 * @see #ACTION_CREATE_SHORTCUT
750 */
751 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
752 /**
753 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
754 *
755 * @see #ACTION_CREATE_SHORTCUT
756 * @see android.content.Intent.ShortcutIconResource
757 */
758 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
759 "android.intent.extra.shortcut.ICON_RESOURCE";
760
761 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800762 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700763 *
764 * @see Intent#ACTION_CREATE_SHORTCUT
765 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800766 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
767 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700768 */
769 public static class ShortcutIconResource implements Parcelable {
770 /**
771 * The package name of the application containing the icon.
772 */
773 public String packageName;
774
775 /**
776 * The resource name of the icon, including package, name and type.
777 */
778 public String resourceName;
779
780 /**
781 * Creates a new ShortcutIconResource for the specified context and resource
782 * identifier.
783 *
784 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700785 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700786 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700787 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700788 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700789 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700790 ShortcutIconResource icon = new ShortcutIconResource();
791 icon.packageName = context.getPackageName();
792 icon.resourceName = context.getResources().getResourceName(resourceId);
793 return icon;
794 }
795
796 /**
797 * Used to read a ShortcutIconResource from a Parcel.
798 */
799 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
800 new Parcelable.Creator<ShortcutIconResource>() {
801
802 public ShortcutIconResource createFromParcel(Parcel source) {
803 ShortcutIconResource icon = new ShortcutIconResource();
804 icon.packageName = source.readString();
805 icon.resourceName = source.readString();
806 return icon;
807 }
808
809 public ShortcutIconResource[] newArray(int size) {
810 return new ShortcutIconResource[size];
811 }
812 };
813
814 /**
815 * No special parcel contents.
816 */
817 public int describeContents() {
818 return 0;
819 }
820
821 public void writeToParcel(Parcel dest, int flags) {
822 dest.writeString(packageName);
823 dest.writeString(resourceName);
824 }
825
826 @Override
827 public String toString() {
828 return resourceName;
829 }
830 }
831
832 /**
833 * Activity Action: Display an activity chooser, allowing the user to pick
834 * what they want to before proceeding. This can be used as an alternative
835 * to the standard activity picker that is displayed by the system when
836 * you try to start an activity with multiple possible matches, with these
837 * differences in behavior:
838 * <ul>
839 * <li>You can specify the title that will appear in the activity chooser.
840 * <li>The user does not have the option to make one of the matching
841 * activities a preferred activity, and all possible activities will
842 * always be shown even if one of them is currently marked as the
843 * preferred activity.
844 * </ul>
845 * <p>
846 * This action should be used when the user will naturally expect to
847 * select an activity in order to proceed. An example if when not to use
848 * it is when the user clicks on a "mailto:" link. They would naturally
849 * expect to go directly to their mail app, so startActivity() should be
850 * called directly: it will
851 * either launch the current preferred app, or put up a dialog allowing the
852 * user to pick an app to use and optionally marking that as preferred.
853 * <p>
854 * In contrast, if the user is selecting a menu item to send a picture
855 * they are viewing to someone else, there are many different things they
856 * may want to do at this point: send it through e-mail, upload it to a
857 * web service, etc. In this case the CHOOSER action should be used, to
858 * always present to the user a list of the things they can do, with a
859 * nice title given by the caller such as "Send this photo with:".
860 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700861 * If you need to grant URI permissions through a chooser, you must specify
862 * the permissions to be granted on the ACTION_CHOOSER Intent
863 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
864 * {@link #setClipData} to specify the URIs to be granted as well as
865 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
866 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
867 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700868 * As a convenience, an Intent of this form can be created with the
869 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700870 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700871 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700872 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
873 * and can optionally have a {@link #EXTRA_TITLE} field containing the
874 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700875 * <p>
876 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700877 */
878 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
879 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
880
881 /**
882 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
883 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700884 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
885 * target intent, also optionally supplying a title. If the target
886 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
887 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
888 * set in the returned chooser intent, with its ClipData set appropriately:
889 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500890 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700891 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700892 * @param target The Intent that the user will be selecting an activity
893 * to perform.
894 * @param title Optional title that will be displayed in the chooser.
895 * @return Return a new Intent object that you can hand to
896 * {@link Context#startActivity(Intent) Context.startActivity()} and
897 * related methods.
898 */
899 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700900 return createChooser(target, title, null);
901 }
902
903 /**
904 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
905 *
906 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
907 * target intent, also optionally supplying a title. If the target
908 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
909 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
910 * set in the returned chooser intent, with its ClipData set appropriately:
911 * either a direct reflection of {@link #getClipData()} if that is non-null,
912 * or a new ClipData built from {@link #getData()}.</p>
913 *
914 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
915 * when the user makes a choice. This can be useful if the calling application wants
916 * to remember the last chosen target and surface it as a more prominent or one-touch
917 * affordance elsewhere in the UI for next time.</p>
918 *
919 * @param target The Intent that the user will be selecting an activity
920 * to perform.
921 * @param title Optional title that will be displayed in the chooser.
922 * @param sender Optional IntentSender to be called when a choice is made.
923 * @return Return a new Intent object that you can hand to
924 * {@link Context#startActivity(Intent) Context.startActivity()} and
925 * related methods.
926 */
927 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700928 Intent intent = new Intent(ACTION_CHOOSER);
929 intent.putExtra(EXTRA_INTENT, target);
930 if (title != null) {
931 intent.putExtra(EXTRA_TITLE, title);
932 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700933
Adam Powell0b3c1122014-10-09 12:50:14 -0700934 if (sender != null) {
935 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
936 }
937
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700938 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700939 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
940 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
941 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700942 if (permFlags != 0) {
943 ClipData targetClipData = target.getClipData();
944 if (targetClipData == null && target.getData() != null) {
945 ClipData.Item item = new ClipData.Item(target.getData());
946 String[] mimeTypes;
947 if (target.getType() != null) {
948 mimeTypes = new String[] { target.getType() };
949 } else {
950 mimeTypes = new String[] { };
951 }
952 targetClipData = new ClipData(null, mimeTypes, item);
953 }
954 if (targetClipData != null) {
955 intent.setClipData(targetClipData);
956 intent.addFlags(permFlags);
957 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700958 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700959
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700960 return intent;
961 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700962
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700963 /**
964 * Activity Action: Allow the user to select a particular kind of data and
965 * return it. This is different than {@link #ACTION_PICK} in that here we
966 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800967 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700968 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900969 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700970 * etc.
971 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900972 * 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 -0700973 * of data, such as a person contact, you set the MIME type to the kind of
974 * data you want and launch it with {@link Context#startActivity(Intent)}.
975 * The system will then launch the best application to select that kind
976 * of data for you.
977 * <p>
978 * You may also be interested in any of a set of types of content the user
979 * can pick. For example, an e-mail application that wants to allow the
980 * user to add an attachment to an e-mail message can use this action to
981 * bring up a list of all of the types of content the user can attach.
982 * <p>
983 * In this case, you should wrap the GET_CONTENT intent with a chooser
984 * (through {@link #createChooser}), which will give the proper interface
985 * for the user to pick how to send your data and allow you to specify
986 * a prompt indicating what they are doing. You will usually specify a
987 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
988 * broad range of content types the user can select from.
989 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900990 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700991 * only pick from data that can be represented as a stream. This is
992 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
993 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800994 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900995 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800996 * is locally available on the device. For example, if this extra is set
997 * to true then an image picker should not show any pictures that are available
998 * from a remote server but not already on the local device (thus requiring
999 * they be downloaded when opened).
1000 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001001 * If the caller can handle multiple returned items (the user performing
1002 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1003 * to indicate this.
1004 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001005 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1006 * that no URI is supplied in the intent, as there are no constraints on
1007 * where the returned data originally comes from. You may also include the
1008 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001009 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001010 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1011 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001012 * <p>
1013 * Output: The URI of the item that was picked. This must be a content:
1014 * URI so that any receiver can access it.
1015 */
1016 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1017 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1018 /**
1019 * Activity Action: Dial a number as specified by the data. This shows a
1020 * UI with the number being dialed, allowing the user to explicitly
1021 * initiate the call.
1022 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1023 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1024 * number.
1025 * <p>Output: nothing.
1026 */
1027 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1028 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1029 /**
1030 * Activity Action: Perform a call to someone specified by the data.
1031 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1032 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1033 * number.
1034 * <p>Output: nothing.
1035 *
1036 * <p>Note: there will be restrictions on which applications can initiate a
1037 * call; most applications should use the {@link #ACTION_DIAL}.
1038 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1039 * numbers. Applications can <strong>dial</strong> emergency numbers using
1040 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001041 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001042 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001043 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001044 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001045 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001046 */
1047 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1048 public static final String ACTION_CALL = "android.intent.action.CALL";
1049 /**
1050 * Activity Action: Perform a call to an emergency number specified by the
1051 * data.
1052 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1053 * tel: URI of an explicit phone number.
1054 * <p>Output: nothing.
1055 * @hide
1056 */
1057 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1058 /**
1059 * Activity action: Perform a call to any number (emergency or not)
1060 * specified by the data.
1061 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1062 * tel: URI of an explicit phone number.
1063 * <p>Output: nothing.
1064 * @hide
1065 */
1066 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1067 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001068 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1069 * sending this intent is a no-op.
1070 * <p>Input: No data should be specified. get*Extra may have an optional
1071 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1072 * send the activation result.
1073 * <p>Output: nothing.
1074 * @hide
1075 */
1076 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1077 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1078 "android.intent.action.SIM_ACTIVATION_REQUEST";
1079 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001080 * Activity Action: Send a message to someone specified by the data.
1081 * <p>Input: {@link #getData} is URI describing the target.
1082 * <p>Output: nothing.
1083 */
1084 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1085 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1086 /**
1087 * Activity Action: Deliver some data to someone else. Who the data is
1088 * being delivered to is not specified; it is up to the receiver of this
1089 * action to ask the user where the data should be sent.
1090 * <p>
1091 * When launching a SEND intent, you should usually wrap it in a chooser
1092 * (through {@link #createChooser}), which will give the proper interface
1093 * for the user to pick how to send your data and allow you to specify
1094 * a prompt indicating what they are doing.
1095 * <p>
1096 * Input: {@link #getType} is the MIME type of the data being sent.
1097 * get*Extra can have either a {@link #EXTRA_TEXT}
1098 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1099 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1100 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1101 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001102 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1103 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1104 * your text with HTML formatting.
1105 * <p>
1106 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1107 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1108 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1109 * content: URIs and other advanced features of {@link ClipData}. If
1110 * using this approach, you still must supply the same data through the
1111 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1112 * for compatibility with old applications. If you don't set a ClipData,
1113 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001114 * <p>
1115 * Optional standard extras, which may be interpreted by some recipients as
1116 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1117 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1118 * <p>
1119 * Output: nothing.
1120 */
1121 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1122 public static final String ACTION_SEND = "android.intent.action.SEND";
1123 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001124 * Activity Action: Deliver multiple data to someone else.
1125 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001126 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001127 * <p>
1128 * Input: {@link #getType} is the MIME type of the data being sent.
1129 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001130 * #EXTRA_STREAM} field, containing the data to be sent. If using
1131 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1132 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001133 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001134 * Multiple types are supported, and receivers should handle mixed types
1135 * whenever possible. The right way for the receiver to check them is to
1136 * use the content resolver on each URI. The intent sender should try to
1137 * put the most concrete mime type in the intent type, but it can fall
1138 * back to {@literal <type>/*} or {@literal *}/* as needed.
1139 * <p>
1140 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1141 * be image/jpg, but if you are sending image/jpg and image/png, then the
1142 * intent's type should be image/*.
1143 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001144 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1145 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1146 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1147 * content: URIs and other advanced features of {@link ClipData}. If
1148 * using this approach, you still must supply the same data through the
1149 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1150 * for compatibility with old applications. If you don't set a ClipData,
1151 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1152 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001153 * Optional standard extras, which may be interpreted by some recipients as
1154 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1155 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1156 * <p>
1157 * Output: nothing.
1158 */
1159 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1160 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1161 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001162 * Activity Action: Handle an incoming phone call.
1163 * <p>Input: nothing.
1164 * <p>Output: nothing.
1165 */
1166 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1167 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1168 /**
1169 * Activity Action: Insert an empty item into the given container.
1170 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1171 * in which to place the data.
1172 * <p>Output: URI of the new data that was created.
1173 */
1174 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1175 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1176 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001177 * Activity Action: Create a new item in the given container, initializing it
1178 * from the current contents of the clipboard.
1179 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1180 * in which to place the data.
1181 * <p>Output: URI of the new data that was created.
1182 */
1183 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1184 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1185 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001186 * Activity Action: Delete the given data from its container.
1187 * <p>Input: {@link #getData} is URI of data to be deleted.
1188 * <p>Output: nothing.
1189 */
1190 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1191 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1192 /**
1193 * Activity Action: Run the data, whatever that means.
1194 * <p>Input: ? (Note: this is currently specific to the test harness.)
1195 * <p>Output: nothing.
1196 */
1197 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1198 public static final String ACTION_RUN = "android.intent.action.RUN";
1199 /**
1200 * Activity Action: Perform a data synchronization.
1201 * <p>Input: ?
1202 * <p>Output: ?
1203 */
1204 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1205 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1206 /**
1207 * Activity Action: Pick an activity given an intent, returning the class
1208 * selected.
1209 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1210 * used with {@link PackageManager#queryIntentActivities} to determine the
1211 * set of activities from which to pick.
1212 * <p>Output: Class name of the activity that was selected.
1213 */
1214 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1215 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1216 /**
1217 * Activity Action: Perform a search.
1218 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1219 * is the text to search for. If empty, simply
1220 * enter your search results Activity with the search UI activated.
1221 * <p>Output: nothing.
1222 */
1223 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1224 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1225 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001226 * Activity Action: Start the platform-defined tutorial
1227 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1228 * is the text to search for. If empty, simply
1229 * enter your search results Activity with the search UI activated.
1230 * <p>Output: nothing.
1231 */
1232 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1233 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1234 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001235 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001236 * <p>
1237 * Input: {@link android.app.SearchManager#QUERY
1238 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1239 * a url starts with http or https, the site will be opened. If it is plain
1240 * text, Google search will be applied.
1241 * <p>
1242 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001243 */
1244 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1245 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001246
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001247 /**
Jim Miller07994402012-05-02 14:22:27 -07001248 * Activity Action: Perform assist action.
1249 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001250 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1251 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001252 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1253 * information.
Jim Miller07994402012-05-02 14:22:27 -07001254 * Output: nothing.
1255 */
1256 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1257 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001258
1259 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001260 * Activity Action: Perform voice assist action.
1261 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001262 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1263 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001264 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001265 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001266 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001267 */
1268 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1269 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1270
1271 /**
Adam Skory7140a252013-09-11 12:04:58 +01001272 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1273 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001274 */
1275 public static final String EXTRA_ASSIST_PACKAGE
1276 = "android.intent.extra.ASSIST_PACKAGE";
1277
1278 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001279 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1280 * application package at the time the assist was invoked.
1281 */
1282 public static final String EXTRA_ASSIST_UID
1283 = "android.intent.extra.ASSIST_UID";
1284
1285 /**
Adam Skory7140a252013-09-11 12:04:58 +01001286 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1287 * information supplied by the current foreground app at the time of the assist request.
1288 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001289 */
1290 public static final String EXTRA_ASSIST_CONTEXT
1291 = "android.intent.extra.ASSIST_CONTEXT";
1292
Jim Miller07994402012-05-02 14:22:27 -07001293 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001294 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1295 * keyboard as the primary input device for assistance.
1296 */
1297 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1298 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1299
1300 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001301 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1302 * that was used to invoke the assist.
1303 */
1304 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1305 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1306
1307 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001308 * Activity Action: List all available applications
1309 * <p>Input: Nothing.
1310 * <p>Output: nothing.
1311 */
1312 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1313 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1314 /**
1315 * Activity Action: Show settings for choosing wallpaper
1316 * <p>Input: Nothing.
1317 * <p>Output: Nothing.
1318 */
1319 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1320 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1321
1322 /**
1323 * Activity Action: Show activity for reporting a bug.
1324 * <p>Input: Nothing.
1325 * <p>Output: Nothing.
1326 */
1327 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1328 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1329
1330 /**
1331 * Activity Action: Main entry point for factory tests. Only used when
1332 * the device is booting in factory test node. The implementing package
1333 * must be installed in the system image.
1334 * <p>Input: nothing
1335 * <p>Output: nothing
1336 */
1337 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1338
1339 /**
1340 * Activity Action: The user pressed the "call" button to go to the dialer
1341 * or other appropriate UI for placing a call.
1342 * <p>Input: Nothing.
1343 * <p>Output: Nothing.
1344 */
1345 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1346 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1347
1348 /**
1349 * Activity Action: Start Voice Command.
1350 * <p>Input: Nothing.
1351 * <p>Output: Nothing.
1352 */
1353 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1354 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001355
1356 /**
1357 * Activity Action: Start action associated with long pressing on the
1358 * search key.
1359 * <p>Input: Nothing.
1360 * <p>Output: Nothing.
1361 */
1362 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1363 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001364
Jacek Surazski86b6c532009-05-13 14:38:28 +02001365 /**
1366 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1367 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001368 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001369 * <p>Input: No data is specified. The bug report is passed in using
1370 * an {@link #EXTRA_BUG_REPORT} field.
1371 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001372 *
1373 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001374 */
1375 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1376 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001377
1378 /**
1379 * Activity Action: Show power usage information to the user.
1380 * <p>Input: Nothing.
1381 * <p>Output: Nothing.
1382 */
1383 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1384 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001385
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001386 /**
1387 * Activity Action: Setup wizard to launch after a platform update. This
1388 * activity should have a string meta-data field associated with it,
1389 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1390 * the platform for setup. The activity will be launched only if
1391 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1392 * same value.
1393 * <p>Input: Nothing.
1394 * <p>Output: Nothing.
1395 * @hide
1396 */
1397 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1398 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001399
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001400 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001401 * Activity Action: Show settings for managing network data usage of a
1402 * specific application. Applications should define an activity that offers
1403 * options to control data usage.
1404 */
1405 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1406 public static final String ACTION_MANAGE_NETWORK_USAGE =
1407 "android.intent.action.MANAGE_NETWORK_USAGE";
1408
1409 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001410 * Activity Action: Launch application installer.
1411 * <p>
1412 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001413 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1414 * you can also use "package:<package-name>" to install an application for the
1415 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001416 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1417 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1418 * <p>
1419 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1420 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001421 * <p>
1422 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1423 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1424 * in order to launch the application installer.
1425 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001426 *
1427 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1428 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1429 * @see #EXTRA_RETURN_RESULT
1430 */
1431 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1432 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1433
1434 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001435 * Activity Action: Launch ephemeral installer.
1436 * <p>
1437 * Input: The data must be a http: URI that the ephemeral application is registered
1438 * to handle.
1439 * <p class="note">
1440 * This is a protected intent that can only be sent by the system.
1441 * </p>
1442 *
1443 * @hide
1444 */
1445 @SystemApi
1446 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1447 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1448 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1449
1450 /**
1451 * Service Action: Resolve ephemeral application.
1452 * <p>
1453 * The system will have a persistent connection to this service.
1454 * This is a protected intent that can only be sent by the system.
1455 * </p>
1456 *
1457 * @hide
1458 */
1459 @SystemApi
1460 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1461 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1462 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1463
1464 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001465 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1466 * package. Specifies the installer package name; this package will receive the
1467 * {@link #ACTION_APP_ERROR} intent.
1468 */
1469 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1470 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1471
1472 /**
1473 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1474 * package. Specifies that the application being installed should not be
1475 * treated as coming from an unknown source, but as coming from the app
1476 * invoking the Intent. For this to work you must start the installer with
1477 * startActivityForResult().
1478 */
1479 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1480 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1481
1482 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001483 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1484 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001485 * data field originated from.
1486 */
rich cannings706e8ba2012-08-20 13:20:14 -07001487 public static final String EXTRA_ORIGINATING_URI
1488 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001489
1490 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001491 * This extra can be used with any Intent used to launch an activity, supplying information
1492 * about who is launching that activity. This field contains a {@link android.net.Uri}
1493 * object, typically an http: or https: URI of the web site that the referral came from;
1494 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1495 * a native application that it came from.
1496 *
1497 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1498 * instead of directly retrieving the extra. It is also valid for applications to
1499 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1500 * a string, not a Uri; the field here, if supplied, will always take precedence,
1501 * however.</p>
1502 *
1503 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001504 */
1505 public static final String EXTRA_REFERRER
1506 = "android.intent.extra.REFERRER";
1507
1508 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001509 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1510 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1511 * not be created, in particular when Intent extras are supplied through the
1512 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1513 * schemes.
1514 *
1515 * @see #EXTRA_REFERRER
1516 */
1517 public static final String EXTRA_REFERRER_NAME
1518 = "android.intent.extra.REFERRER_NAME";
1519
1520 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001521 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1522 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1523 * @hide
1524 */
1525 public static final String EXTRA_ORIGINATING_UID
1526 = "android.intent.extra.ORIGINATING_UID";
1527
1528 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001529 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1530 * package. Tells the installer UI to skip the confirmation with the user
1531 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001532 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1533 * will no longer show an interstitial message about updating existing
1534 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001535 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001536 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001537 public static final String EXTRA_ALLOW_REPLACE
1538 = "android.intent.extra.ALLOW_REPLACE";
1539
1540 /**
1541 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1542 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1543 * return to the application the result code of the install/uninstall. The returned result
1544 * code will be {@link android.app.Activity#RESULT_OK} on success or
1545 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1546 */
1547 public static final String EXTRA_RETURN_RESULT
1548 = "android.intent.extra.RETURN_RESULT";
1549
1550 /**
1551 * Package manager install result code. @hide because result codes are not
1552 * yet ready to be exposed.
1553 */
1554 public static final String EXTRA_INSTALL_RESULT
1555 = "android.intent.extra.INSTALL_RESULT";
1556
1557 /**
1558 * Activity Action: Launch application uninstaller.
1559 * <p>
1560 * Input: The data must be a package: URI whose scheme specific part is
1561 * the package name of the current installed package to be uninstalled.
1562 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1563 * <p>
1564 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1565 * succeeded.
1566 */
1567 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1568 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1569
1570 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001571 * Specify whether the package should be uninstalled for all users.
1572 * @hide because these should not be part of normal application flow.
1573 */
1574 public static final String EXTRA_UNINSTALL_ALL_USERS
1575 = "android.intent.extra.UNINSTALL_ALL_USERS";
1576
1577 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001578 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1579 * describing the last run version of the platform that was setup.
1580 * @hide
1581 */
1582 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1583
Svet Ganov3695b8a2015-03-24 16:30:25 -07001584 /**
1585 * Activity action: Launch UI to manage the permissions of an app.
1586 * <p>
1587 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1588 * will be managed by the launched UI.
1589 * </p>
1590 * <p>
1591 * Output: Nothing.
1592 * </p>
1593 *
1594 * @see #EXTRA_PACKAGE_NAME
1595 *
1596 * @hide
1597 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001598 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1599 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1600 "android.intent.action.MANAGE_APP_PERMISSIONS";
1601
1602 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001603 * Activity action: Launch UI to manage permissions.
1604 * <p>
1605 * Input: Nothing.
1606 * </p>
1607 * <p>
1608 * Output: Nothing.
1609 * </p>
1610 *
1611 * @hide
1612 */
Svet Ganov321f0152015-05-16 22:51:50 -07001613 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1614 public static final String ACTION_MANAGE_PERMISSIONS =
1615 "android.intent.action.MANAGE_PERMISSIONS";
1616
1617 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001618 * Activity action: Launch UI to review permissions for an app.
1619 * The system uses this intent if permission review for apps not
1620 * supporting the new runtime permissions model is enabled. In
1621 * this mode a permission review is required before any of the
1622 * app components can run.
1623 * <p>
1624 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1625 * permissions will be reviewed (mandatory).
1626 * </p>
1627 * <p>
1628 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1629 * be fired after the permission review (optional).
1630 * </p>
1631 * <p>
1632 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1633 * be invoked after the permission review (optional).
1634 * </p>
1635 * <p>
1636 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1637 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1638 * </p>
1639 * <p>
1640 * Output: Nothing.
1641 * </p>
1642 *
1643 * @see #EXTRA_PACKAGE_NAME
1644 * @see #EXTRA_INTENT
1645 * @see #EXTRA_REMOTE_CALLBACK
1646 * @see #EXTRA_RESULT_NEEDED
1647 *
1648 * @hide
1649 */
1650 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1651 public static final String ACTION_REVIEW_PERMISSIONS =
1652 "android.intent.action.REVIEW_PERMISSIONS";
1653
1654 /**
1655 * Intent extra: A callback for reporting remote result as a bundle.
1656 * <p>
1657 * Type: IRemoteCallback
1658 * </p>
1659 *
1660 * @hide
1661 */
1662 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1663
1664 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001665 * Intent extra: An app package name.
1666 * <p>
1667 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001668 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001669 *
1670 * @hide
1671 */
1672 @SystemApi
1673 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1674
1675 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001676 * Intent extra: An extra for specifying whether a result is needed.
1677 * <p>
1678 * Type: boolean
1679 * </p>
1680 *
1681 * @hide
1682 */
1683 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1684
1685 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001686 * Broadcast action that requests current permission granted information. It will respond
1687 * to the request by sending a broadcast with action defined by
1688 * {@link #EXTRA_GET_PERMISSIONS_RESPONSE_INTENT}. The response will contain
Makoto Onukibbb912a2015-06-05 16:27:23 -07001689 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}, as well as
1690 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}, with contents described below or
1691 * a null upon failure.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001692 *
Makoto Onukibbb912a2015-06-05 16:27:23 -07001693 * <p>If {@link #EXTRA_PACKAGE_NAME} is included then the number of permissions granted, the
1694 * number of permissions requested and the number of granted additional permissions
1695 * by that package will be calculated and included as the first
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001696 * and second elements respectively of an int[] in the response as
Makoto Onukibbb912a2015-06-05 16:27:23 -07001697 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}. The response will also deliver the list
1698 * of localized permission group names that are granted in
1699 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001700 *
1701 * <p>If {@link #EXTRA_PACKAGE_NAME} is not included then the number of apps granted any runtime
1702 * permissions and the total number of apps requesting runtime permissions will be the first
1703 * and second elements respectively of an int[] in the response as
1704 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1705 *
1706 * @hide
1707 */
1708 public static final String ACTION_GET_PERMISSIONS_COUNT
1709 = "android.intent.action.GET_PERMISSIONS_COUNT";
1710
1711 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001712 * Broadcast action that requests list of all apps that have runtime permissions. It will
1713 * respond to the request by sending a broadcast with action defined by
1714 * {@link #EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT}. The response will contain
1715 * {@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT}, as well as
1716 * {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}, with contents described below or
1717 * a null upon failure.
1718 *
1719 * <p>{@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT} will contain a list of package names of
1720 * apps that have runtime permissions. {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}
1721 * will contain the list of app labels corresponding ot the apps in the first list.
1722 *
1723 * @hide
1724 */
1725 public static final String ACTION_GET_PERMISSIONS_PACKAGES
1726 = "android.intent.action.GET_PERMISSIONS_PACKAGES";
1727
1728 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001729 * Extra included in response to {@link #ACTION_GET_PERMISSIONS_COUNT}.
1730 * @hide
1731 */
1732 public static final String EXTRA_GET_PERMISSIONS_COUNT_RESULT
1733 = "android.intent.extra.GET_PERMISSIONS_COUNT_RESULT";
1734
1735 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001736 * List of CharSequence of localized permission group labels.
1737 * @hide
1738 */
1739 public static final String EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT
1740 = "android.intent.extra.GET_PERMISSIONS_GROUP_LIST_RESULT";
1741
1742 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001743 * String list of apps that have one or more runtime permissions.
1744 * @hide
1745 */
1746 public static final String EXTRA_GET_PERMISSIONS_APP_LIST_RESULT
1747 = "android.intent.extra.GET_PERMISSIONS_APP_LIST_RESULT";
1748
1749 /**
1750 * String list of app labels for apps that have one or more runtime permissions.
1751 * @hide
1752 */
1753 public static final String EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT
1754 = "android.intent.extra.GET_PERMISSIONS_APP_LABEL_LIST_RESULT";
1755
1756 /**
Anthony Hugh3575a402015-10-26 17:47:05 -07001757 * Boolean list describing if the app is a system app for apps that have one or more runtime
1758 * permissions.
1759 * @hide
1760 */
1761 public static final String EXTRA_GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT
1762 = "android.intent.extra.GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT";
1763
1764 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001765 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_COUNT} broadcasts.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001766 * @hide
1767 */
1768 public static final String EXTRA_GET_PERMISSIONS_RESPONSE_INTENT
1769 = "android.intent.extra.GET_PERMISSIONS_RESONSE_INTENT";
1770
1771 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001772 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_PACKAGES} broadcasts.
1773 * @hide
1774 */
1775 public static final String EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT
1776 = "android.intent.extra.GET_PERMISSIONS_PACKAGES_RESONSE_INTENT";
1777
1778 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001779 * Activity action: Launch UI to manage which apps have a given permission.
1780 * <p>
1781 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1782 * to which will be managed by the launched UI.
1783 * </p>
1784 * <p>
1785 * Output: Nothing.
1786 * </p>
1787 *
1788 * @see #EXTRA_PERMISSION_NAME
1789 *
1790 * @hide
1791 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001792 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1793 public static final String ACTION_MANAGE_PERMISSION_APPS =
1794 "android.intent.action.MANAGE_PERMISSION_APPS";
1795
1796 /**
1797 * Intent extra: The name of a permission.
1798 * <p>
1799 * Type: String
1800 * </p>
1801 *
1802 * @hide
1803 */
1804 @SystemApi
1805 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1806
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001807 // ---------------------------------------------------------------------
1808 // ---------------------------------------------------------------------
1809 // Standard intent broadcast actions (see action variable).
1810
1811 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001812 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1813 * <p>
1814 * For historical reasons, the name of this broadcast action refers to the power
1815 * state of the screen but it is actually sent in response to changes in the
1816 * overall interactive state of the device.
1817 * </p><p>
1818 * This broadcast is sent when the device becomes non-interactive which may have
1819 * nothing to do with the screen turning off. To determine the
1820 * actual state of the screen, use {@link android.view.Display#getState}.
1821 * </p><p>
1822 * See {@link android.os.PowerManager#isInteractive} for details.
1823 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001824 * You <em>cannot</em> receive this through components declared in
1825 * manifests, only by explicitly registering for it with
1826 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1827 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001828 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001829 * <p class="note">This is a protected intent that can only be sent
1830 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001831 */
1832 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1833 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001834
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001835 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001836 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1837 * <p>
1838 * For historical reasons, the name of this broadcast action refers to the power
1839 * state of the screen but it is actually sent in response to changes in the
1840 * overall interactive state of the device.
1841 * </p><p>
1842 * This broadcast is sent when the device becomes interactive which may have
1843 * nothing to do with the screen turning on. To determine the
1844 * actual state of the screen, use {@link android.view.Display#getState}.
1845 * </p><p>
1846 * See {@link android.os.PowerManager#isInteractive} for details.
1847 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001848 * You <em>cannot</em> receive this through components declared in
1849 * manifests, only by explicitly registering for it with
1850 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1851 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001852 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001853 * <p class="note">This is a protected intent that can only be sent
1854 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001855 */
1856 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1857 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001858
1859 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001860 * Broadcast Action: Sent after the system stops dreaming.
1861 *
1862 * <p class="note">This is a protected intent that can only be sent by the system.
1863 * It is only sent to registered receivers.</p>
1864 */
1865 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1866 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1867
1868 /**
1869 * Broadcast Action: Sent after the system starts dreaming.
1870 *
1871 * <p class="note">This is a protected intent that can only be sent by the system.
1872 * It is only sent to registered receivers.</p>
1873 */
1874 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1875 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1876
1877 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001878 * 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 -07001879 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001880 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001881 * <p class="note">This is a protected intent that can only be sent
1882 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001883 */
1884 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001885 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001886
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001887 /**
1888 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001889 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001890 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001891 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1892 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001893 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001894 * <p class="note">This is a protected intent that can only be sent
1895 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001896 */
1897 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1898 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1899 /**
1900 * Broadcast Action: The time was set.
1901 */
1902 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1903 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1904 /**
1905 * Broadcast Action: The date has changed.
1906 */
1907 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1908 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1909 /**
1910 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1911 * <ul>
1912 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1913 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001914 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001915 * <p class="note">This is a protected intent that can only be sent
1916 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001917 */
1918 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1919 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1920 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001921 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1922 * DNS entries should be tossed.
1923 * @hide
1924 */
1925 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1926 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1927 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001928 * Alarm Changed Action: This is broadcast when the AlarmClock
1929 * application's alarm is set or unset. It is used by the
1930 * AlarmClock application and the StatusBar service.
1931 * @hide
1932 */
1933 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1934 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001935
1936 /**
1937 * Broadcast Action: This is broadcast once, after the system has finished
1938 * booting and the user is in a "locked" state. A user is locked when their
1939 * credential-encrypted private app data storage is unavailable. Once the
1940 * user has entered their credentials (such as a lock pattern or PIN) for
1941 * the first time, the {@link #ACTION_BOOT_COMPLETED} broadcast will be
1942 * sent.
1943 * <p>
1944 * You must hold the
1945 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1946 * order to receive this broadcast.
1947 * <p class="note">
1948 * This is a protected intent that can only be sent by the system.
1949 */
1950 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1951 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1952
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001953 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001954 * Broadcast Action: This is broadcast once, after the system has finished
1955 * booting. It can be used to perform application-specific initialization,
1956 * such as installing alarms. You must hold the
1957 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1958 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001959 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001960 * <p class="note">This is a protected intent that can only be sent
1961 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001962 */
1963 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1964 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001965
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001966 /**
1967 * Broadcast Action: This is broadcast when a user action should request a
1968 * temporary system dialog to dismiss. Some examples of temporary system
1969 * dialogs are the notification window-shade and the recent tasks dialog.
1970 */
1971 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1972 /**
1973 * Broadcast Action: Trigger the download and eventual installation
1974 * of a package.
1975 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001976 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001977 * <p class="note">This is a protected intent that can only be sent
1978 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001979 *
1980 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001981 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001982 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001983 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1984 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1985 /**
1986 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001987 * device. The data contains the name of the package. Note that the
1988 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001989 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001990 * <ul>
1991 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1992 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1993 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1994 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001995 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001996 * <p class="note">This is a protected intent that can only be sent
1997 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001998 */
1999 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2000 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2001 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002002 * Broadcast Action: A new version of an application package has been
2003 * installed, replacing an existing version that was previously installed.
2004 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002005 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002006 * <ul>
2007 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2008 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002009 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002010 * <p class="note">This is a protected intent that can only be sent
2011 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002012 */
2013 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2014 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2015 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002016 * Broadcast Action: A new version of your application has been installed
2017 * over an existing one. This is only sent to the application that was
2018 * replaced. It does not contain any additional data; to receive it, just
2019 * use an intent filter for this action.
2020 *
2021 * <p class="note">This is a protected intent that can only be sent
2022 * by the system.
2023 */
2024 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2025 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2026 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002027 * Broadcast Action: An existing application package has been removed from
2028 * the device. The data contains the name of the package. The package
2029 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002030 * <ul>
2031 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2032 * to the package.
2033 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2034 * application -- data and code -- is being removed.
2035 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2036 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2037 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002038 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002039 * <p class="note">This is a protected intent that can only be sent
2040 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002041 */
2042 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2043 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2044 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002045 * Broadcast Action: An existing application package has been completely
2046 * removed from the device. The data contains the name of the package.
2047 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2048 * {@link #EXTRA_DATA_REMOVED} is true and
2049 * {@link #EXTRA_REPLACING} is false of that broadcast.
2050 *
2051 * <ul>
2052 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2053 * to the package.
2054 * </ul>
2055 *
2056 * <p class="note">This is a protected intent that can only be sent
2057 * by the system.
2058 */
2059 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2060 public static final String ACTION_PACKAGE_FULLY_REMOVED
2061 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2062 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002063 * Broadcast Action: An existing application package has been changed (e.g.
2064 * a component has been enabled or disabled). The data contains the name of
2065 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002066 * <ul>
2067 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002068 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002069 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002070 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2071 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002072 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002073 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002074 * <p class="note">This is a protected intent that can only be sent
2075 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002076 */
2077 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2078 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2079 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002080 * @hide
2081 * Broadcast Action: Ask system services if there is any reason to
2082 * restart the given package. The data contains the name of the
2083 * package.
2084 * <ul>
2085 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2086 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2087 * </ul>
2088 *
2089 * <p class="note">This is a protected intent that can only be sent
2090 * by the system.
2091 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002092 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002093 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2094 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2095 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002096 * Broadcast Action: The user has restarted a package, and all of its
2097 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002098 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002099 * be removed. Note that the restarted package does <em>not</em>
2100 * receive this broadcast.
2101 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002102 * <ul>
2103 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2104 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002105 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002106 * <p class="note">This is a protected intent that can only be sent
2107 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002108 */
2109 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2110 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2111 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002112 * Broadcast Action: The user has cleared the data of a package. This should
2113 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002114 * its persistent data is erased and this broadcast sent.
2115 * Note that the cleared package does <em>not</em>
2116 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002117 * <ul>
2118 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2119 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002120 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002121 * <p class="note">This is a protected intent that can only be sent
2122 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002123 */
2124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2125 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2126 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002127 * Broadcast Action: Packages have been suspended.
2128 * <p>Includes the following extras:
2129 * <ul>
2130 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2131 * </ul>
2132 *
2133 * <p class="note">This is a protected intent that can only be sent
2134 * by the system. It is only sent to registered receivers.
2135 */
2136 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2137 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2138 /**
2139 * Broadcast Action: Packages have been unsuspended.
2140 * <p>Includes the following extras:
2141 * <ul>
2142 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2143 * </ul>
2144 *
2145 * <p class="note">This is a protected intent that can only be sent
2146 * by the system. It is only sent to registered receivers.
2147 */
2148 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2149 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2150 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002151 * Broadcast Action: A user ID has been removed from the system. The user
2152 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002153 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002154 * <p class="note">This is a protected intent that can only be sent
2155 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002156 */
2157 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2158 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002159
2160 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002161 * Broadcast Action: Sent to the installer package of an application
2162 * when that application is first launched (that is the first time it
2163 * is moved out of the stopped state). The data contains the name of the package.
2164 *
2165 * <p class="note">This is a protected intent that can only be sent
2166 * by the system.
2167 */
2168 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2169 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2170
2171 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002172 * Broadcast Action: Sent to the system package verifier when a package
2173 * needs to be verified. The data contains the package URI.
2174 * <p class="note">
2175 * This is a protected intent that can only be sent by the system.
2176 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002177 */
2178 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2179 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2180
2181 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002182 * Broadcast Action: Sent to the system package verifier when a package is
2183 * verified. The data contains the package URI.
2184 * <p class="note">
2185 * This is a protected intent that can only be sent by the system.
2186 */
2187 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2188 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2189
2190 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002191 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
2192 * needs to be verified. The data contains the filter data hosts to be verified against.
2193 * <p class="note">
2194 * This is a protected intent that can only be sent by the system.
2195 * </p>
2196 *
2197 * @hide
2198 */
2199 @SystemApi
2200 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2201 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2202
2203 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002204 * Broadcast Action: Resources for a set of packages (which were
2205 * previously unavailable) are currently
2206 * available since the media on which they exist is available.
2207 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2208 * list of packages whose availability changed.
2209 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2210 * list of uids of packages whose availability changed.
2211 * Note that the
2212 * packages in this list do <em>not</em> receive this broadcast.
2213 * The specified set of packages are now available on the system.
2214 * <p>Includes the following extras:
2215 * <ul>
2216 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2217 * whose resources(were previously unavailable) are currently available.
2218 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2219 * packages whose resources(were previously unavailable)
2220 * are currently available.
2221 * </ul>
2222 *
2223 * <p class="note">This is a protected intent that can only be sent
2224 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002225 */
2226 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002227 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2228 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002229
2230 /**
2231 * Broadcast Action: Resources for a set of packages are currently
2232 * unavailable since the media on which they exist is unavailable.
2233 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2234 * list of packages whose availability changed.
2235 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2236 * list of uids of packages whose availability changed.
2237 * The specified set of packages can no longer be
2238 * launched and are practically unavailable on the system.
2239 * <p>Inclues the following extras:
2240 * <ul>
2241 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2242 * whose resources are no longer available.
2243 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2244 * whose resources are no longer available.
2245 * </ul>
2246 *
2247 * <p class="note">This is a protected intent that can only be sent
2248 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002249 */
2250 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002251 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002252 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002253
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002254 /**
2255 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002256 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002257 * This should <em>only</em> be used to determine when the wallpaper
2258 * has changed to show the new wallpaper to the user. You should certainly
2259 * never, in response to this, change the wallpaper or other attributes of
2260 * it such as the suggested size. That would be crazy, right? You'd cause
2261 * all kinds of loops, especially if other apps are doing similar things,
2262 * right? Of course. So please don't do this.
2263 *
2264 * @deprecated Modern applications should use
2265 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2266 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2267 * shown behind their UI, rather than watching for this broadcast and
2268 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002269 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002270 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002271 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2272 /**
2273 * Broadcast Action: The current device {@link android.content.res.Configuration}
2274 * (orientation, locale, etc) has changed. When such a change happens, the
2275 * UIs (view hierarchy) will need to be rebuilt based on this new
2276 * information; for the most part, applications don't need to worry about
2277 * this, because the system will take care of stopping and restarting the
2278 * application to make sure it sees the new changes. Some system code that
2279 * can not be restarted will need to watch for this action and handle it
2280 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002281 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002282 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002283 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002284 * in manifests, only by explicitly registering for it with
2285 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2286 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002287 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002288 * <p class="note">This is a protected intent that can only be sent
2289 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002290 *
2291 * @see android.content.res.Configuration
2292 */
2293 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2294 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2295 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002296 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002297 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002298 * <p class="note">This is a protected intent that can only be sent
2299 * by the system.
2300 */
2301 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2302 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2303 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002304 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2305 * charging state, level, and other information about the battery.
2306 * See {@link android.os.BatteryManager} for documentation on the
2307 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002308 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002309 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002310 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002311 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002312 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002313 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2314 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2315 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2316 * broadcasts that are sent and can be received through manifest
2317 * receivers.
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 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2323 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2324 /**
2325 * Broadcast Action: Indicates low battery condition on the device.
2326 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002327 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002328 * <p class="note">This is a protected intent that can only be sent
2329 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002330 */
2331 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2332 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2333 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002334 * Broadcast Action: Indicates the battery is now okay after being low.
2335 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2336 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002337 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002338 * <p class="note">This is a protected intent that can only be sent
2339 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002340 */
2341 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2342 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2343 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002344 * Broadcast Action: External power has been connected to the device.
2345 * This is intended for applications that wish to register specifically to this notification.
2346 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2347 * stay active to receive this notification. This action can be used to implement actions
2348 * that wait until power is available to trigger.
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.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002352 */
2353 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002354 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002355 /**
2356 * Broadcast Action: External power has been removed from the device.
2357 * This is intended for applications that wish to register specifically to this notification.
2358 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2359 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002360 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002361 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002362 * <p class="note">This is a protected intent that can only be sent
2363 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002364 */
2365 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002366 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002367 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002368 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002369 * Broadcast Action: Device is shutting down.
2370 * This is broadcast when the device is being shut down (completely turned
2371 * off, not sleeping). Once the broadcast is complete, the final shutdown
2372 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002373 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002374 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002375 * <p class="note">This is a protected intent that can only be sent
2376 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002377 * <p>May include the following extras:
2378 * <ul>
2379 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2380 * shutdown is only for userspace processes. If not set, assumed to be false.
2381 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002382 */
2383 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002384 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002385 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002386 * Activity Action: Start this activity to request system shutdown.
2387 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002388 * to request confirmation from the user before shutting down. The optional boolean
2389 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2390 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002391 *
2392 * <p class="note">This is a protected intent that can only be sent
2393 * by the system.
2394 *
2395 * {@hide}
2396 */
2397 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2398 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002399 * Broadcast Action: A sticky broadcast that indicates low memory
2400 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002401 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002402 * <p class="note">This is a protected intent that can only be sent
2403 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002404 */
2405 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2406 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2407 /**
2408 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002409 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002410 * <p class="note">This is a protected intent that can only be sent
2411 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002412 */
2413 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2414 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2415 /**
Jake Hambybb371632010-08-23 18:16:48 -07002416 * Broadcast Action: A sticky broadcast that indicates a memory full
2417 * condition on the device. This is intended for activities that want
2418 * to be able to fill the data partition completely, leaving only
2419 * enough free space to prevent system-wide SQLite failures.
2420 *
2421 * <p class="note">This is a protected intent that can only be sent
2422 * by the system.
2423 *
2424 * {@hide}
2425 */
2426 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2427 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2428 /**
2429 * Broadcast Action: Indicates memory full condition on the device
2430 * no longer exists.
2431 *
2432 * <p class="note">This is a protected intent that can only be sent
2433 * by the system.
2434 *
2435 * {@hide}
2436 */
2437 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2438 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2439 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002440 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2441 * and package management should be started.
2442 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2443 * notification.
2444 */
2445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2446 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2447 /**
2448 * Broadcast Action: The device has entered USB Mass Storage mode.
2449 * This is used mainly for the USB Settings panel.
2450 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2451 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002452 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002453 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002454 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002455 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2456
2457 /**
2458 * Broadcast Action: The device has exited USB Mass Storage mode.
2459 * This is used mainly for the USB Settings panel.
2460 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2461 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002462 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002463 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002464 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002465 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2466
2467 /**
2468 * Broadcast Action: External media has been removed.
2469 * The path to the mount point for the removed media is contained in the Intent.mData field.
2470 */
2471 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2472 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2473
2474 /**
2475 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002476 * 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 -07002477 */
2478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2479 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2480
2481 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002482 * Broadcast Action: External media is present, and being disk-checked
2483 * 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 -08002484 */
2485 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2486 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2487
2488 /**
2489 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2490 * 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 -08002491 */
2492 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2493 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2494
2495 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002496 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002497 * 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 -07002498 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2499 * media was mounted read only.
2500 */
2501 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2502 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2503
2504 /**
2505 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002506 * 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 -07002507 */
2508 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2509 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2510
2511 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002512 * Broadcast Action: External media is no longer being shared via USB mass storage.
2513 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2514 *
2515 * @hide
2516 */
2517 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2518
2519 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002520 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2521 * The path to the mount point for the removed media is contained in the Intent.mData field.
2522 */
2523 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2524 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2525
2526 /**
2527 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002528 * 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 -07002529 */
2530 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2531 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2532
2533 /**
2534 * Broadcast Action: User has expressed the desire to remove the external storage media.
2535 * Applications should close all files they have open within the mount point when they receive this intent.
2536 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2537 */
2538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2539 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2540
2541 /**
2542 * Broadcast Action: The media scanner has started scanning a directory.
2543 * The path to the directory being scanned is contained in the Intent.mData field.
2544 */
2545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2546 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2547
2548 /**
2549 * Broadcast Action: The media scanner has finished scanning a directory.
2550 * The path to the scanned directory is contained in the Intent.mData field.
2551 */
2552 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2553 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2554
2555 /**
2556 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2557 * The path to the file is contained in the Intent.mData field.
2558 */
2559 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2560 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2561
2562 /**
2563 * Broadcast Action: The "Media Button" was pressed. Includes a single
2564 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2565 * caused the broadcast.
2566 */
2567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2568 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2569
Jaewan Kim52632e22016-01-14 18:01:52 +09002570 /**
2571 * Broadcast Action: The "Picture-in-picture (PIP) Button" was pressed.
2572 * Includes a single extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2573 * caused the broadcast.
2574 * @hide
2575 */
2576 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2577 public static final String ACTION_PICTURE_IN_PICTURE_BUTTON =
2578 "android.intent.action.PICTURE_IN_PICTURE_BUTTON";
2579
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002580 /**
2581 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2582 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2583 * caused the broadcast.
2584 */
2585 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2586 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2587
2588 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2589 // location; they are not general-purpose actions.
2590
2591 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002592 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002593 */
2594 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2595 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2596 "android.intent.action.GTALK_CONNECTED";
2597
2598 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002599 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002600 */
2601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2602 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2603 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002604
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002605 /**
2606 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002607 */
2608 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2609 public static final String ACTION_INPUT_METHOD_CHANGED =
2610 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002611
2612 /**
2613 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2614 * more radios have been turned off or on. The intent will have the following extra value:</p>
2615 * <ul>
2616 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2617 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2618 * turned off</li>
2619 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002620 *
Peng Xua35b5532016-01-20 00:05:45 -08002621 * <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 -07002622 */
2623 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2624 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2625
2626 /**
2627 * Broadcast Action: Some content providers have parts of their namespace
2628 * where they publish new events or items that the user may be especially
2629 * interested in. For these things, they may broadcast this action when the
2630 * set of interesting items change.
2631 *
2632 * For example, GmailProvider sends this notification when the set of unread
2633 * mail in the inbox changes.
2634 *
2635 * <p>The data of the intent identifies which part of which provider
2636 * changed. When queried through the content resolver, the data URI will
2637 * return the data set in question.
2638 *
2639 * <p>The intent will have the following extra values:
2640 * <ul>
2641 * <li><em>count</em> - The number of items in the data set. This is the
2642 * same as the number of items in the cursor returned by querying the
2643 * data URI. </li>
2644 * </ul>
2645 *
2646 * This intent will be sent at boot (if the count is non-zero) and when the
2647 * data set changes. It is possible for the data set to change without the
2648 * count changing (for example, if a new unread message arrives in the same
2649 * sync operation in which a message is archived). The phone should still
2650 * ring/vibrate/etc as normal in this case.
2651 */
2652 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2653 public static final String ACTION_PROVIDER_CHANGED =
2654 "android.intent.action.PROVIDER_CHANGED";
2655
2656 /**
2657 * Broadcast Action: Wired Headset plugged in or unplugged.
2658 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002659 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2660 * and documentation.
2661 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002662 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002663 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002664 */
2665 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002666 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002667
2668 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002669 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2670 * <ul>
2671 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2672 * </ul>
2673 *
2674 * <p class="note">This is a protected intent that can only be sent
2675 * by the system.
2676 *
2677 * @hide
2678 */
2679 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2680 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2681 = "android.intent.action.ADVANCED_SETTINGS";
2682
2683 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002684 * Broadcast Action: Sent after application restrictions are changed.
2685 *
2686 * <p class="note">This is a protected intent that can only be sent
2687 * by the system.</p>
2688 */
2689 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2690 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2691 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2692
2693 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002694 * Broadcast Action: An outgoing call is about to be placed.
2695 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002696 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002697 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002698 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002699 * the phone number originally intended to be dialed.</li>
2700 * </ul>
2701 * <p>Once the broadcast is finished, the resultData is used as the actual
2702 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002703 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002704 * outgoing call in turn: for example, a parental control application
2705 * might verify that the user is authorized to place the call at that
2706 * time, then a number-rewriting application might add an area code if
2707 * one was not specified.</p>
2708 * <p>For consistency, any receiver whose purpose is to prohibit phone
2709 * calls should have a priority of 0, to ensure it will see the final
2710 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002711 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002712 * should have a positive priority.
2713 * Negative priorities are reserved for the system for this broadcast;
2714 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002715 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2716 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002717 * <p>Emergency calls cannot be intercepted using this mechanism, and
2718 * other calls cannot be modified to call emergency numbers using this
2719 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002720 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2721 * call to use their own service instead. Those apps should first prevent
2722 * the call from being placed by setting resultData to <code>null</code>
2723 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002724 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002725 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2726 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002727 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002728 * <p class="note">This is a protected intent that can only be sent
2729 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002730 */
2731 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2732 public static final String ACTION_NEW_OUTGOING_CALL =
2733 "android.intent.action.NEW_OUTGOING_CALL";
2734
2735 /**
2736 * Broadcast Action: Have the device reboot. This is only for use by
2737 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002738 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002739 * <p class="note">This is a protected intent that can only be sent
2740 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002741 */
2742 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2743 public static final String ACTION_REBOOT =
2744 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002745
Wei Huang97ecc9c2009-05-11 17:44:20 -07002746 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002747 * Broadcast Action: A sticky broadcast for changes in the physical
2748 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002749 *
2750 * <p>The intent will have the following extra values:
2751 * <ul>
2752 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002753 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002754 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002755 * <p>This is intended for monitoring the current physical dock state.
2756 * See {@link android.app.UiModeManager} for the normal API dealing with
2757 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002758 */
2759 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2760 public static final String ACTION_DOCK_EVENT =
2761 "android.intent.action.DOCK_EVENT";
2762
2763 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002764 * Broadcast Action: A broadcast when idle maintenance can be started.
2765 * This means that the user is not interacting with the device and is
2766 * not expected to do so soon. Typical use of the idle maintenance is
2767 * to perform somehow expensive tasks that can be postponed at a moment
2768 * when they will not degrade user experience.
2769 * <p>
2770 * <p class="note">In order to keep the device responsive in case of an
2771 * unexpected user interaction, implementations of a maintenance task
2772 * should be interruptible. In such a scenario a broadcast with action
2773 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2774 * should not do the maintenance work in
2775 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2776 * maintenance service by {@link Context#startService(Intent)}. Also
2777 * you should hold a wake lock while your maintenance service is running
2778 * to prevent the device going to sleep.
2779 * </p>
2780 * <p>
2781 * <p class="note">This is a protected intent that can only be sent by
2782 * the system.
2783 * </p>
2784 *
2785 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002786 *
2787 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002788 */
2789 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2790 public static final String ACTION_IDLE_MAINTENANCE_START =
2791 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2792
2793 /**
2794 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2795 * This means that the user was not interacting with the device as a result
2796 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2797 * was sent and now the user started interacting with the device. Typical
2798 * use of the idle maintenance is to perform somehow expensive tasks that
2799 * can be postponed at a moment when they will not degrade user experience.
2800 * <p>
2801 * <p class="note">In order to keep the device responsive in case of an
2802 * unexpected user interaction, implementations of a maintenance task
2803 * should be interruptible. Hence, on receiving a broadcast with this
2804 * action, the maintenance task should be interrupted as soon as possible.
2805 * In other words, you should not do the maintenance work in
2806 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2807 * maintenance service that was started on receiving of
2808 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2809 * lock you acquired when your maintenance service started.
2810 * </p>
2811 * <p class="note">This is a protected intent that can only be sent
2812 * by the system.
2813 *
2814 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002815 *
2816 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002817 */
2818 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2819 public static final String ACTION_IDLE_MAINTENANCE_END =
2820 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2821
2822 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002823 * Broadcast Action: a remote intent is to be broadcasted.
2824 *
2825 * A remote intent is used for remote RPC between devices. The remote intent
2826 * is serialized and sent from one device to another device. The receiving
2827 * device parses the remote intent and broadcasts it. Note that anyone can
2828 * broadcast a remote intent. However, if the intent receiver of the remote intent
2829 * does not trust intent broadcasts from arbitrary intent senders, it should require
2830 * the sender to hold certain permissions so only trusted sender's broadcast will be
2831 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002832 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002833 */
2834 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002835 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002836
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002837 /**
2838 * Broadcast Action: hook for permforming cleanup after a system update.
2839 *
2840 * The broadcast is sent when the system is booting, before the
2841 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2842 * image. A receiver for this should do its work and then disable itself
2843 * so that it does not get run again at the next boot.
2844 * @hide
2845 */
2846 public static final String ACTION_PRE_BOOT_COMPLETED =
2847 "android.intent.action.PRE_BOOT_COMPLETED";
2848
Amith Yamasani13593602012-03-22 16:16:17 -07002849 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002850 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002851 * on restricted users. The broadcast intent contains an extra
2852 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2853 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2854 * String[] depending on the restriction type.<p/>
2855 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002856 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2857 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2858 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002859 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2860 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002861 * @see RestrictionEntry
2862 */
2863 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2864 "android.intent.action.GET_RESTRICTION_ENTRIES";
2865
2866 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002867 * Sent the first time a user is starting, to allow system apps to
2868 * perform one time initialization. (This will not be seen by third
2869 * party applications because a newly initialized user does not have any
2870 * third party applications installed for it.) This is sent early in
2871 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002872 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2873 * broadcast, since it is part of a visible user interaction; be as quick
2874 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002875 */
2876 public static final String ACTION_USER_INITIALIZE =
2877 "android.intent.action.USER_INITIALIZE";
2878
2879 /**
2880 * Sent when a user switch is happening, causing the process's user to be
2881 * brought to the foreground. This is only sent to receivers registered
2882 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2883 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002884 * foreground. This is sent as a foreground
2885 * broadcast, since it is part of a visible user interaction; be as quick
2886 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002887 */
2888 public static final String ACTION_USER_FOREGROUND =
2889 "android.intent.action.USER_FOREGROUND";
2890
2891 /**
2892 * Sent when a user switch is happening, causing the process's user to be
2893 * sent to the background. This is only sent to receivers registered
2894 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2895 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002896 * background. 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_BACKGROUND =
2901 "android.intent.action.USER_BACKGROUND";
2902
2903 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002904 * Broadcast sent to the system when a user is added. Carries an extra
2905 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2906 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002907 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002908 * @hide
2909 */
2910 public static final String ACTION_USER_ADDED =
2911 "android.intent.action.USER_ADDED";
2912
2913 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002914 * Broadcast sent by the system when a user is started. Carries an extra
2915 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002916 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002917 * that has been started. This is sent as a foreground
2918 * broadcast, since it is part of a visible user interaction; be as quick
2919 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002920 * @hide
2921 */
2922 public static final String ACTION_USER_STARTED =
2923 "android.intent.action.USER_STARTED";
2924
2925 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002926 * Broadcast sent when a user is in the process of starting. Carries an extra
2927 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2928 * sent to registered receivers, not manifest receivers. It is sent to all
2929 * users (including the one that is being started). You must hold
2930 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2931 * this broadcast. This is sent as a background broadcast, since
2932 * its result is not part of the primary UX flow; to safely keep track of
2933 * started/stopped state of a user you can use this in conjunction with
2934 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2935 * other user state broadcasts since those are foreground broadcasts so can
2936 * execute in a different order.
2937 * @hide
2938 */
2939 public static final String ACTION_USER_STARTING =
2940 "android.intent.action.USER_STARTING";
2941
2942 /**
2943 * Broadcast sent when a user is going to be stopped. Carries an extra
2944 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2945 * sent to registered receivers, not manifest receivers. It is sent to all
2946 * users (including the one that is being stopped). You must hold
2947 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2948 * this broadcast. The user will not stop until all receivers have
2949 * handled the broadcast. This is sent as a background broadcast, since
2950 * its result is not part of the primary UX flow; to safely keep track of
2951 * started/stopped state of a user you can use this in conjunction with
2952 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2953 * other user state broadcasts since those are foreground broadcasts so can
2954 * execute in a different order.
2955 * @hide
2956 */
2957 public static final String ACTION_USER_STOPPING =
2958 "android.intent.action.USER_STOPPING";
2959
2960 /**
2961 * Broadcast sent to the system when a user is stopped. Carries an extra
2962 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2963 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2964 * specific package. This is only sent to registered receivers, not manifest
2965 * receivers. It is sent to all running users <em>except</em> the one that
2966 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002967 * @hide
2968 */
2969 public static final String ACTION_USER_STOPPED =
2970 "android.intent.action.USER_STOPPED";
2971
2972 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002973 * 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 -07002974 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002975 * one that has been removed. The user will not be completely removed until all receivers have
2976 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002977 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002978 * @hide
2979 */
2980 public static final String ACTION_USER_REMOVED =
2981 "android.intent.action.USER_REMOVED";
2982
2983 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002984 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002985 * the userHandle of the user to become the current one. This is only sent to
2986 * registered receivers, not manifest receivers. It is sent to all running users.
2987 * You must hold
2988 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002989 * @hide
2990 */
2991 public static final String ACTION_USER_SWITCHED =
2992 "android.intent.action.USER_SWITCHED";
2993
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002994 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07002995 * Broadcast Action: Sent when the credential-encrypted private storage has
2996 * become unlocked for the target user. This is only sent to registered
2997 * receivers, not manifest receivers.
2998 */
2999 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3000 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3001
3002 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003003 * Broadcast sent to the system when a user's information changes. Carries an extra
3004 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003005 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003006 * @hide
3007 */
3008 public static final String ACTION_USER_INFO_CHANGED =
3009 "android.intent.action.USER_INFO_CHANGED";
3010
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003011 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003012 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3013 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003014 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3015 * that need to display merged content across both primary and managed profiles need to
3016 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003017 * not manifest receivers.
3018 */
3019 public static final String ACTION_MANAGED_PROFILE_ADDED =
3020 "android.intent.action.MANAGED_PROFILE_ADDED";
3021
3022 /**
3023 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003024 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3025 * Only applications (for example Launchers) that need to display merged content across both
3026 * primary and managed profiles need to worry about this broadcast. This is only sent to
3027 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003028 */
3029 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3030 "android.intent.action.MANAGED_PROFILE_REMOVED";
3031
3032 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003033 * Broadcast sent to the primary user when an associated managed profile's availability has
Rubin Xuf13c9802016-01-21 18:06:00 +00003034 * changed. This includes when the user toggles the profile's quiet mode. Carries an extra
3035 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3036 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3037 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003038 */
3039 public static final String ACTION_MANAGED_PROFILE_AVAILABILITY_CHANGED =
3040 "android.intent.action.MANAGED_PROFILE_AVAILABILITY_CHANGED";
3041
3042 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003043 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3044 */
3045 public static final String ACTION_QUICK_CLOCK =
3046 "android.intent.action.QUICK_CLOCK";
3047
Michael Wright0087a142013-02-05 16:29:39 -08003048 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003049 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003050 * @hide
3051 */
3052 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3053 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3054
Justin Kohd378ad72013-04-01 12:18:26 -07003055 /**
3056 * Broadcast Action: A global button was pressed. Includes a single
3057 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3058 * caused the broadcast.
3059 * @hide
3060 */
3061 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3062
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003063 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003064 * Broadcast Action: Sent when media resource is granted.
3065 * <p>
3066 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3067 * granted.
3068 * </p>
3069 * <p class="note">
3070 * This is a protected intent that can only be sent by the system.
3071 * </p>
3072 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003073 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003074 * </p>
3075 *
3076 * @hide
3077 */
3078 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3079 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3080
3081 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003082 * Activity Action: Allow the user to select and return one or more existing
3083 * documents. When invoked, the system will display the various
3084 * {@link DocumentsProvider} instances installed on the device, letting the
3085 * user interactively navigate through them. These documents include local
3086 * media, such as photos and video, and documents provided by installed
3087 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003088 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003089 * Each document is represented as a {@code content://} URI backed by a
3090 * {@link DocumentsProvider}, which can be opened as a stream with
3091 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3092 * {@link android.provider.DocumentsContract.Document} metadata.
3093 * <p>
3094 * All selected documents are returned to the calling application with
3095 * persistable read and write permission grants. If you want to maintain
3096 * access to the documents across device reboots, you need to explicitly
3097 * take the persistable permissions using
3098 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3099 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003100 * Callers must indicate the acceptable document MIME types through
3101 * {@link #setType(String)}. For example, to select photos, use
3102 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3103 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3104 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003105 * <p>
3106 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003107 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3108 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003109 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003110 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3111 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003112 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003113 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003114 * Output: The URI of the item that was picked, returned in
3115 * {@link #getData()}. This must be a {@code content://} URI so that any
3116 * receiver can access it. If multiple documents were selected, they are
3117 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003118 *
3119 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003120 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003121 * @see #ACTION_CREATE_DOCUMENT
3122 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003123 */
3124 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3125 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3126
3127 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003128 * Activity Action: Allow the user to create a new document. When invoked,
3129 * the system will display the various {@link DocumentsProvider} instances
3130 * installed on the device, letting the user navigate through them. The
3131 * returned document may be a newly created document with no content, or it
3132 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003133 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003134 * Each document is represented as a {@code content://} URI backed by a
3135 * {@link DocumentsProvider}, which can be opened as a stream with
3136 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3137 * {@link android.provider.DocumentsContract.Document} metadata.
3138 * <p>
3139 * Callers must indicate the concrete MIME type of the document being
3140 * created by setting {@link #setType(String)}. This MIME type cannot be
3141 * changed after the document is created.
3142 * <p>
3143 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3144 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003145 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003146 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3147 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003148 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003149 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003150 * Output: The URI of the item that was created. This must be a
3151 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003152 *
3153 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003154 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003155 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003156 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003157 */
3158 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3159 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3160
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003161 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003162 * Activity Action: Allow the user to pick a directory subtree. When
3163 * invoked, the system will display the various {@link DocumentsProvider}
3164 * instances installed on the device, letting the user navigate through
3165 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003166 * <p>
3167 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003168 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3169 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3170 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003171 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003172 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003173 *
3174 * @see DocumentsContract
3175 */
3176 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003177 public static final String
3178 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003179
Felipe Lemec7b1f892016-01-15 15:02:31 -08003180 /**
3181 * Activity Action: Give access to a standard storage directory after obtaining the user's
3182 * approval.
3183 * <p>
3184 * When invoked, the system will ask the user to grant access to the requested directory (and
3185 * its descendants).
3186 * <p>
3187 * To gain access to descendant (child, grandchild, etc) documents, use
3188 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3189 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)} with the returned URI.
3190 * <p>
3191 * Input: full path to a standard directory, in the form of
3192 * {@code STORAGE_ROOT + STANDARD_DIRECTORY}, where {@code STORAGE_ROOT} is the physical path of
3193 * a storage container, and {@code STANDARD_DIRECTORY} is one of
3194 * {@link Environment#DIRECTORY_MUSIC}, {@link Environment#DIRECTORY_PODCASTS},
3195 * {@link Environment#DIRECTORY_RINGTONES}, {@link Environment#DIRECTORY_ALARMS},
3196 * {@link Environment#DIRECTORY_NOTIFICATIONS}, {@link Environment#DIRECTORY_PICTURES},
3197 * {@link Environment#DIRECTORY_MOVIES}, {@link Environment#DIRECTORY_DOWNLOADS},
3198 * {@link Environment#DIRECTORY_DCIM}, or {@link Environment#DIRECTORY_DOCUMENTS}
3199 * <p>
3200 * For example, to open the "Pictures" folder in the default external storage, the intent's data
3201 * would be: {@code Uri.fromFile(new File(Environment.getExternalStorageDirectory(),
3202 * Environment.DIRECTORY_PICTURES))}.
3203 * <p>
3204 * Output: The URI representing the requested directory tree.
3205 *
3206 * @see DocumentsContract
3207 */
3208 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3209 public static final String
3210 ACTION_OPEN_EXTERNAL_DIRECTORY = "android.intent.action.OPEN_EXTERNAL_DIRECTORY";
3211
Peng Xua35b5532016-01-20 00:05:45 -08003212 /**
3213 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3214 * exisiting sensor being disconnected.
3215 *
3216 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3217 *
3218 * {@hide}
3219 */
3220 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3221 public static final String
3222 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3223
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003224 /** {@hide} */
3225 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3226
Christopher Tate6597e342015-02-17 12:15:25 -08003227 /**
3228 * Broadcast action: report that a settings element is being restored from backup. The intent
3229 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3230 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3231 * is the value of that settings entry prior to the restore operation. All of these values are
3232 * represented as strings.
3233 *
3234 * <p>This broadcast is sent only for settings provider entries known to require special handling
3235 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3236 * the provider's backup agent implementation.
3237 *
3238 * @see #EXTRA_SETTING_NAME
3239 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3240 * @see #EXTRA_SETTING_NEW_VALUE
3241 * {@hide}
3242 */
3243 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3244
3245 /** {@hide} */
3246 public static final String EXTRA_SETTING_NAME = "setting_name";
3247 /** {@hide} */
3248 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3249 /** {@hide} */
3250 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3251
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003252 /**
3253 * Activity Action: Process a piece of text.
3254 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3255 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3256 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3257 */
3258 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3259 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3260 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003261 * The name of the extra used to define the text to be processed, as a
3262 * CharSequence. Note that this may be a styled CharSequence, so you must use
3263 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003264 */
3265 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3266 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003267 * 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 +00003268 */
3269 public static final String EXTRA_PROCESS_TEXT_READONLY =
3270 "android.intent.extra.PROCESS_TEXT_READONLY";
3271
Bryce Leebc58f592015-09-25 16:43:01 -07003272 /**
3273 * Broadcast action: reports when a new thermal event has been reached. When the device
3274 * is reaching its maximum temperatue, the thermal level reported
3275 * {@hide}
3276 */
3277 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3278 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3279
3280 /** {@hide} */
3281 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3282
3283 /**
3284 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003285 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003286 * {@hide}
3287 */
3288 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3289
3290 /**
3291 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003292 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003293 * {@hide}
3294 */
3295 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3296
3297 /**
3298 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003299 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003300 * {@hide}
3301 */
3302 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3303
3304
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003305 // ---------------------------------------------------------------------
3306 // ---------------------------------------------------------------------
3307 // Standard intent categories (see addCategory()).
3308
3309 /**
3310 * Set if the activity should be an option for the default action
3311 * (center press) to perform on a piece of data. Setting this will
3312 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003313 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003314 * Intent when initiating an action -- it is for use in intent filters
3315 * specified in packages.
3316 */
3317 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3318 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3319 /**
3320 * Activities that can be safely invoked from a browser must support this
3321 * category. For example, if the user is viewing a web page or an e-mail
3322 * and clicks on a link in the text, the Intent generated execute that
3323 * link will require the BROWSABLE category, so that only activities
3324 * supporting this category will be considered as possible actions. By
3325 * supporting this category, you are promising that there is nothing
3326 * damaging (without user intervention) that can happen by invoking any
3327 * matching Intent.
3328 */
3329 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3330 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3331 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003332 * Categories for activities that can participate in voice interaction.
3333 * An activity that supports this category must be prepared to run with
3334 * no UI shown at all (though in some case it may have a UI shown), and
3335 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3336 */
3337 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3338 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3339 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003340 * Set if the activity should be considered as an alternative action to
3341 * the data the user is currently viewing. See also
3342 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3343 * applies to the selection in a list of items.
3344 *
3345 * <p>Supporting this category means that you would like your activity to be
3346 * displayed in the set of alternative things the user can do, usually as
3347 * part of the current activity's options menu. You will usually want to
3348 * include a specific label in the &lt;intent-filter&gt; of this action
3349 * describing to the user what it does.
3350 *
3351 * <p>The action of IntentFilter with this category is important in that it
3352 * describes the specific action the target will perform. This generally
3353 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3354 * a specific name such as "com.android.camera.action.CROP. Only one
3355 * alternative of any particular action will be shown to the user, so using
3356 * a specific action like this makes sure that your alternative will be
3357 * displayed while also allowing other applications to provide their own
3358 * overrides of that particular action.
3359 */
3360 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3361 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3362 /**
3363 * Set if the activity should be considered as an alternative selection
3364 * action to the data the user has currently selected. This is like
3365 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3366 * of items from which the user can select, giving them alternatives to the
3367 * default action that will be performed on it.
3368 */
3369 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3370 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3371 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003372 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003373 */
3374 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3375 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3376 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003377 * Should be displayed in the top-level launcher.
3378 */
3379 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3380 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3381 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003382 * Indicates an activity optimized for Leanback mode, and that should
3383 * be displayed in the Leanback launcher.
3384 */
3385 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3386 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3387 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003388 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3389 * @hide
3390 */
3391 @SystemApi
3392 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3393 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003394 * Provides information about the package it is in; typically used if
3395 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3396 * a front-door to the user without having to be shown in the all apps list.
3397 */
3398 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3399 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3400 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003401 * This is the home activity, that is the first activity that is displayed
3402 * when the device boots.
3403 */
3404 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3405 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3406 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003407 * This is the home activity that is displayed when the device is finished setting up and ready
3408 * for use.
3409 * @hide
3410 */
3411 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3412 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3413 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003414 * This is the setup wizard activity, that is the first activity that is displayed
3415 * when the user sets up the device for the first time.
3416 * @hide
3417 */
3418 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3419 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3420 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003421 * This activity is a preference panel.
3422 */
3423 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3424 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3425 /**
3426 * This activity is a development preference panel.
3427 */
3428 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3429 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3430 /**
3431 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003432 */
3433 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3434 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3435 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003436 * This activity allows the user to browse and download new applications.
3437 */
3438 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3439 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3440 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003441 * This activity may be exercised by the monkey or other automated test tools.
3442 */
3443 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3444 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3445 /**
3446 * To be used as a test (not part of the normal user experience).
3447 */
3448 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3449 /**
3450 * To be used as a unit test (run through the Test Harness).
3451 */
3452 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3453 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003454 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003455 * experience).
3456 */
3457 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003458
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003459 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003460 * Used to indicate that an intent only wants URIs that can be opened with
3461 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3462 * must support at least the columns defined in {@link OpenableColumns} when
3463 * queried.
3464 *
3465 * @see #ACTION_GET_CONTENT
3466 * @see #ACTION_OPEN_DOCUMENT
3467 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003468 */
3469 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3470 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3471
3472 /**
3473 * To be used as code under test for framework instrumentation tests.
3474 */
3475 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3476 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003477 /**
3478 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003479 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3480 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003481 */
3482 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3483 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3484 /**
3485 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003486 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3487 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003488 */
3489 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3490 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003491 /**
3492 * An activity to run when device is inserted into a analog (low end) dock.
3493 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3494 * information, see {@link android.app.UiModeManager}.
3495 */
3496 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3497 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3498
3499 /**
3500 * An activity to run when device is inserted into a digital (high end) dock.
3501 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3502 * information, see {@link android.app.UiModeManager}.
3503 */
3504 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3505 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003506
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003507 /**
3508 * Used to indicate that the activity can be used in a car environment.
3509 */
3510 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3511 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3512
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003513 // ---------------------------------------------------------------------
3514 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003515 // Application launch intent categories (see addCategory()).
3516
3517 /**
3518 * Used with {@link #ACTION_MAIN} to launch the browser application.
3519 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003520 * <p>NOTE: This should not be used as the primary key of an Intent,
3521 * since it will not result in the app launching with the correct
3522 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003523 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003524 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003525 */
3526 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3527 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3528
3529 /**
3530 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3531 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003532 * <p>NOTE: This should not be used as the primary key of an Intent,
3533 * since it will not result in the app launching with the correct
3534 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003535 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003536 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003537 */
3538 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3539 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3540
3541 /**
3542 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3543 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003544 * <p>NOTE: This should not be used as the primary key of an Intent,
3545 * since it will not result in the app launching with the correct
3546 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003547 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003548 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003549 */
3550 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3551 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3552
3553 /**
3554 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3555 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003556 * <p>NOTE: This should not be used as the primary key of an Intent,
3557 * since it will not result in the app launching with the correct
3558 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003559 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003560 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003561 */
3562 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3563 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3564
3565 /**
3566 * Used with {@link #ACTION_MAIN} to launch the email application.
3567 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003568 * <p>NOTE: This should not be used as the primary key of an Intent,
3569 * since it will not result in the app launching with the correct
3570 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003571 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003572 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003573 */
3574 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3575 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3576
3577 /**
3578 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3579 * The activity should be able to view and manipulate image and video files
3580 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003581 * <p>NOTE: This should not be used as the primary key of an Intent,
3582 * since it will not result in the app launching with the correct
3583 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003584 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003585 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003586 */
3587 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3588 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3589
3590 /**
3591 * Used with {@link #ACTION_MAIN} to launch the maps application.
3592 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003593 * <p>NOTE: This should not be used as the primary key of an Intent,
3594 * since it will not result in the app launching with the correct
3595 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003596 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003597 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003598 */
3599 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3600 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3601
3602 /**
3603 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3604 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003605 * <p>NOTE: This should not be used as the primary key of an Intent,
3606 * since it will not result in the app launching with the correct
3607 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003608 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003609 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003610 */
3611 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3612 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3613
3614 /**
3615 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003616 * The activity should be able to play, browse, or manipulate music files
3617 * stored on the device.
3618 * <p>NOTE: This should not be used as the primary key of an Intent,
3619 * since it will not result in the app launching with the correct
3620 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003621 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003622 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003623 */
3624 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3625 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3626
3627 // ---------------------------------------------------------------------
3628 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003629 // Standard extra data keys.
3630
3631 /**
3632 * The initial data to place in a newly created record. Use with
3633 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3634 * fields as would be given to the underlying ContentProvider.insert()
3635 * call.
3636 */
3637 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3638
3639 /**
3640 * A constant CharSequence that is associated with the Intent, used with
3641 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3642 * this may be a styled CharSequence, so you must use
3643 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3644 * retrieve it.
3645 */
3646 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3647
3648 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003649 * A constant String that is associated with the Intent, used with
3650 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3651 * as HTML formatted text. Note that you <em>must</em> also supply
3652 * {@link #EXTRA_TEXT}.
3653 */
3654 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3655
3656 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003657 * A content: URI holding a stream of data associated with the Intent,
3658 * used with {@link #ACTION_SEND} to supply the data being sent.
3659 */
3660 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3661
3662 /**
3663 * A String[] holding e-mail addresses that should be delivered to.
3664 */
3665 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3666
3667 /**
3668 * A String[] holding e-mail addresses that should be carbon copied.
3669 */
3670 public static final String EXTRA_CC = "android.intent.extra.CC";
3671
3672 /**
3673 * A String[] holding e-mail addresses that should be blind carbon copied.
3674 */
3675 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3676
3677 /**
3678 * A constant string holding the desired subject line of a message.
3679 */
3680 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3681
3682 /**
3683 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003684 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003685 */
3686 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3687
3688 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003689 * An int representing the user id to be used.
3690 *
3691 * @hide
3692 */
3693 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3694
3695 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003696 * An int representing the task id to be retrieved. This is used when a launch from recents is
3697 * intercepted by another action such as credentials confirmation to remember which task should
3698 * be resumed when complete.
3699 *
3700 * @hide
3701 */
3702 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3703
3704 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003705 * An Intent[] describing additional, alternate choices you would like shown with
3706 * {@link #ACTION_CHOOSER}.
3707 *
3708 * <p>An app may be capable of providing several different payload types to complete a
3709 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3710 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3711 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3712 * photo data or a hosted link where the photos can be viewed.</p>
3713 *
3714 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3715 * first/primary/preferred intent in the set. Additional intents specified in
3716 * this extra are ordered; by default intents that appear earlier in the array will be
3717 * preferred over intents that appear later in the array as matches for the same
3718 * target component. To alter this preference, a calling app may also supply
3719 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3720 */
3721 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3722
3723 /**
3724 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3725 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3726 *
3727 * <p>An app preparing an action for another app to complete may wish to allow the user to
3728 * disambiguate between several options for completing the action based on the chosen target
3729 * or otherwise refine the action before it is invoked.
3730 * </p>
3731 *
3732 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3733 * <ul>
3734 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3735 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3736 * chosen target beyond the first</li>
3737 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3738 * should fill in and send once the disambiguation is complete</li>
3739 * </ul>
3740 */
3741 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3742 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3743
3744 /**
3745 * A {@link ResultReceiver} used to return data back to the sender.
3746 *
3747 * <p>Used to complete an app-specific
3748 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3749 *
3750 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3751 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3752 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3753 * when the user selects a target component from the chooser. It is up to the recipient
3754 * to send a result to this ResultReceiver to signal that disambiguation is complete
3755 * and that the chooser should invoke the user's choice.</p>
3756 *
3757 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3758 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3759 * to match and fill in the final Intent or ChooserTarget before starting it.
3760 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3761 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3762 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3763 *
3764 * <p>The result code passed to the ResultReceiver should be
3765 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3766 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3767 * the chooser should finish without starting a target.</p>
3768 */
3769 public static final String EXTRA_RESULT_RECEIVER
3770 = "android.intent.extra.RESULT_RECEIVER";
3771
3772 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003773 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003774 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003775 */
3776 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3777
3778 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003779 * A Parcelable[] of {@link Intent} or
3780 * {@link android.content.pm.LabeledIntent} objects as set with
3781 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3782 * a the front of the list of choices, when shown to the user with a
3783 * {@link #ACTION_CHOOSER}.
3784 */
3785 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3786
3787 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003788 * A {@link IntentSender} to start after ephemeral installation success.
3789 * @hide
3790 */
3791 @SystemApi
3792 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3793
3794 /**
3795 * A {@link IntentSender} to start after ephemeral installation failure.
3796 * @hide
3797 */
3798 @SystemApi
3799 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3800
3801 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003802 * A Bundle forming a mapping of potential target package names to different extras Bundles
3803 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3804 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3805 * be currently installed on the device.
3806 *
3807 * <p>An application may choose to provide alternate extras for the case where a user
3808 * selects an activity from a predetermined set of target packages. If the activity
3809 * the user selects from the chooser belongs to a package with its package name as
3810 * a key in this bundle, the corresponding extras for that package will be merged with
3811 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3812 * extra has the same key as an extra already present in the intent it will overwrite
3813 * the extra from the intent.</p>
3814 *
3815 * <p><em>Examples:</em>
3816 * <ul>
3817 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3818 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3819 * parameters for that target.</li>
3820 * <li>An application may offer additional metadata for known targets of a given intent
3821 * to pass along information only relevant to that target such as account or content
3822 * identifiers already known to that application.</li>
3823 * </ul></p>
3824 */
3825 public static final String EXTRA_REPLACEMENT_EXTRAS =
3826 "android.intent.extra.REPLACEMENT_EXTRAS";
3827
3828 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003829 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3830 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3831 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3832 * {@link ComponentName} of the chosen component.
3833 *
3834 * <p>In some situations this callback may never come, for example if the user abandons
3835 * the chooser, switches to another task or any number of other reasons. Apps should not
3836 * be written assuming that this callback will always occur.</p>
3837 */
3838 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3839 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3840
3841 /**
3842 * The {@link ComponentName} chosen by the user to complete an action.
3843 *
3844 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3845 */
3846 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3847
3848 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003849 * A {@link android.view.KeyEvent} object containing the event that
3850 * triggered the creation of the Intent it is in.
3851 */
3852 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3853
3854 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003855 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3856 * before shutting down.
3857 *
3858 * {@hide}
3859 */
3860 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3861
3862 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003863 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3864 * requested by the user.
3865 *
3866 * {@hide}
3867 */
3868 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3869 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3870
3871 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003872 * 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 -07003873 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3874 * of restarting the application.
3875 */
3876 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3877
3878 /**
3879 * A String holding the phone number originally entered in
3880 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3881 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3882 */
3883 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003884
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003885 /**
3886 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3887 * intents to supply the uid the package had been assigned. Also an optional
3888 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3889 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3890 * purpose.
3891 */
3892 public static final String EXTRA_UID = "android.intent.extra.UID";
3893
3894 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003895 * @hide String array of package names.
3896 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003897 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003898 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3899
3900 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003901 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3902 * intents to indicate whether this represents a full uninstall (removing
3903 * both the code and its data) or a partial uninstall (leaving its data,
3904 * implying that this is an update).
3905 */
3906 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003907
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003908 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003909 * @hide
3910 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3911 * intents to indicate that at this point the package has been removed for
3912 * all users on the device.
3913 */
3914 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3915 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3916
3917 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003918 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3919 * intents to indicate that this is a replacement of the package, so this
3920 * broadcast will immediately be followed by an add broadcast for a
3921 * different version of the same package.
3922 */
3923 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003924
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003925 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003926 * Used as an int extra field in {@link android.app.AlarmManager} intents
3927 * to tell the application being invoked how many pending alarms are being
3928 * delievered with the intent. For one-shot alarms this will always be 1.
3929 * For recurring alarms, this might be greater than 1 if the device was
3930 * asleep or powered off at the time an earlier alarm would have been
3931 * delivered.
3932 */
3933 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003934
Jacek Surazski86b6c532009-05-13 14:38:28 +02003935 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003936 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3937 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003938 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3939 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003940 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3941 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3942 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003943 */
3944 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3945
3946 /**
3947 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3948 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003949 */
3950 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3951
3952 /**
3953 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3954 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003955 */
3956 public static final int EXTRA_DOCK_STATE_DESK = 1;
3957
3958 /**
3959 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3960 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003961 */
3962 public static final int EXTRA_DOCK_STATE_CAR = 2;
3963
3964 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003965 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3966 * to represent that the phone is in a analog (low end) dock.
3967 */
3968 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3969
3970 /**
3971 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3972 * to represent that the phone is in a digital (high end) dock.
3973 */
3974 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3975
3976 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003977 * Boolean that can be supplied as meta-data with a dock activity, to
3978 * indicate that the dock should take over the home key when it is active.
3979 */
3980 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003981
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003982 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003983 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3984 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003985 */
3986 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3987
3988 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003989 * Used in the extra field in the remote intent. It's astring token passed with the
3990 * remote intent.
3991 */
3992 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3993 "android.intent.extra.remote_intent_token";
3994
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003995 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003996 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003997 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003998 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003999 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004000 "android.intent.extra.changed_component_name";
4001
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004002 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004003 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004004 * and contains a string array of all of the components that have changed. If
4005 * the state of the overall package has changed, then it will contain an entry
4006 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004007 */
4008 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4009 "android.intent.extra.changed_component_name_list";
4010
4011 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004012 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004013 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004014 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4015 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4016 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004017 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004018 */
4019 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4020 "android.intent.extra.changed_package_list";
4021
4022 /**
4023 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004024 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4025 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004026 * and contains an integer array of uids of all of the components
4027 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004028 */
4029 public static final String EXTRA_CHANGED_UID_LIST =
4030 "android.intent.extra.changed_uid_list";
4031
4032 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004033 * @hide
4034 * Magic extra system code can use when binding, to give a label for
4035 * who it is that has bound to a service. This is an integer giving
4036 * a framework string resource that can be displayed to the user.
4037 */
4038 public static final String EXTRA_CLIENT_LABEL =
4039 "android.intent.extra.client_label";
4040
4041 /**
4042 * @hide
4043 * Magic extra system code can use when binding, to give a PendingIntent object
4044 * that can be launched for the user to disable the system's use of this
4045 * service.
4046 */
4047 public static final String EXTRA_CLIENT_INTENT =
4048 "android.intent.extra.client_intent";
4049
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004050 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004051 * Extra used to indicate that an intent should only return data that is on
4052 * the local device. This is a boolean extra; the default is false. If true,
4053 * an implementation should only allow the user to select data that is
4054 * already on the device, not requiring it be downloaded from a remote
4055 * service when opened.
4056 *
4057 * @see #ACTION_GET_CONTENT
4058 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004059 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004060 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004061 */
4062 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004063 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004064
Amith Yamasani13593602012-03-22 16:16:17 -07004065 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004066 * Extra used to indicate that an intent can allow the user to select and
4067 * return multiple items. This is a boolean extra; the default is false. If
4068 * true, an implementation is allowed to present the user with a UI where
4069 * they can pick multiple items that are all returned to the caller. When
4070 * this happens, they should be returned as the {@link #getClipData()} part
4071 * of the result Intent.
4072 *
4073 * @see #ACTION_GET_CONTENT
4074 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004075 */
4076 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004077 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004078
4079 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004080 * The integer userHandle carried with broadcast intents related to addition, removal and
4081 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4082 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4083 *
Amith Yamasani13593602012-03-22 16:16:17 -07004084 * @hide
4085 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004086 public static final String EXTRA_USER_HANDLE =
4087 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004088
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004089 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004090 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4091 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4092 */
4093 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004094 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004095
4096 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004097 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004098 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4099 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004100 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004101 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4102
4103 /**
4104 * Extra sent in the intent to the BroadcastReceiver that handles
4105 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4106 * the restrictions as key/value pairs.
4107 */
4108 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4109 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004110
Amith Yamasani86118ba2013-03-28 14:33:16 -07004111 /**
4112 * Extra used in the response from a BroadcastReceiver that handles
4113 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4114 */
4115 public static final String EXTRA_RESTRICTIONS_INTENT =
4116 "android.intent.extra.restrictions_intent";
4117
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004118 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004119 * Extra used to communicate a set of acceptable MIME types. The type of the
4120 * extra is {@code String[]}. Values may be a combination of concrete MIME
4121 * types (such as "image/png") and/or partial MIME types (such as
4122 * "audio/*").
4123 *
4124 * @see #ACTION_GET_CONTENT
4125 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004126 */
4127 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4128
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004129 /**
4130 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4131 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004132 * When this is true, hardware devices can use this information to determine that
4133 * they shouldn't do a complete shutdown of their device since this is not a
4134 * complete shutdown down to the kernel, but only user space restarting.
4135 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004136 */
4137 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4138 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4139
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004140 /**
4141 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4142 * user has set their time format preferences to the 24 hour format.
4143 *
4144 * @hide for internal use only.
4145 */
4146 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4147 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4148
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004149 /** {@hide} */
4150 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4151
Rubin Xue8490f12015-06-25 12:17:48 +01004152 /** {@hide} */
4153 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4154
Santos Cordon15a13782015-03-31 18:32:31 -07004155 /**
4156 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4157 * activation request.
4158 * TODO: Add information about the structure and response data used with the pending intent.
4159 * @hide
4160 */
4161 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4162 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4163
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004164 /**
4165 * Optional index with semantics depending on the intent action.
4166 * @see #ACTION_QUICK_VIEW
4167 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004168 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4169
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004170 /**
4171 * Optional boolean extra indicating whether quiet mode has been switched on or off.
4172 */
4173 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004174
4175 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004176 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004177 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004178 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4179 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004180 *
4181 * @hide
4182 */
4183 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4184 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4185
4186 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004187 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004188 * to represent that a video codec is allowed to use.
4189 *
4190 * @hide
4191 */
4192 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4193
4194 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004195 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004196 * to represent that a audio codec is allowed to use.
4197 *
4198 * @hide
4199 */
4200 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4201
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004202 // ---------------------------------------------------------------------
4203 // ---------------------------------------------------------------------
4204 // Intent flags (see mFlags variable).
4205
Tor Norbyed9273d62013-05-30 15:59:53 -07004206 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004207 @IntDef(flag = true, value = {
4208 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4209 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004210 @Retention(RetentionPolicy.SOURCE)
4211 public @interface GrantUriMode {}
4212
Jeff Sharkey846318a2014-04-04 12:12:41 -07004213 /** @hide */
4214 @IntDef(flag = true, value = {
4215 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4216 @Retention(RetentionPolicy.SOURCE)
4217 public @interface AccessUriMode {}
4218
4219 /**
4220 * Test if given mode flags specify an access mode, which must be at least
4221 * read and/or write.
4222 *
4223 * @hide
4224 */
4225 public static boolean isAccessUriMode(int modeFlags) {
4226 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4227 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4228 }
4229
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004230 /**
4231 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004232 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004233 * specified in its ClipData. When applying to an Intent's ClipData,
4234 * all URIs as well as recursive traversals through data or other ClipData
4235 * in Intent items will be granted; only the grant flags of the top-level
4236 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004237 */
4238 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4239 /**
4240 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004241 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004242 * specified in its ClipData. When applying to an Intent's ClipData,
4243 * all URIs as well as recursive traversals through data or other ClipData
4244 * in Intent items will be granted; only the grant flags of the top-level
4245 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004246 */
4247 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4248 /**
4249 * Can be set by the caller to indicate that this Intent is coming from
4250 * a background operation, not from direct user interaction.
4251 */
4252 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4253 /**
4254 * A flag you can enable for debugging: when set, log messages will be
4255 * printed during the resolution of this intent to show you what has
4256 * been found to create the final resolved list.
4257 */
4258 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004259 /**
4260 * If set, this intent will not match any components in packages that
4261 * are currently stopped. If this is not set, then the default behavior
4262 * is to include such applications in the result.
4263 */
4264 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4265 /**
4266 * If set, this intent will always match any components in packages that
4267 * are currently stopped. This is the default behavior when
4268 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4269 * flags are set, this one wins (it allows overriding of exclude for
4270 * places where the framework may automatically set the exclude flag).
4271 */
4272 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004273
4274 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004275 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004276 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004277 * persisted across device reboots until explicitly revoked with
4278 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4279 * grant for possible persisting; the receiving application must call
4280 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4281 * actually persist.
4282 *
4283 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4284 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4285 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004286 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004287 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004288 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004289
4290 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004291 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4292 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4293 * applies to any URI that is a prefix match against the original granted
4294 * URI. (Without this flag, the URI must match exactly for access to be
4295 * granted.) Another URI is considered a prefix match only when scheme,
4296 * authority, and all path segments defined by the prefix are an exact
4297 * match.
4298 */
4299 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4300
4301 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004302 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004303 * homework and verified that they correctly handle packages and components
4304 * that come and go over time. In particular:
4305 * <ul>
4306 * <li>Apps installed on external storage, which will appear to be
4307 * uninstalled while the the device is ejected.
4308 * <li>Apps with encryption unaware components, which will appear to not
4309 * exist while the device is locked.
4310 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004311 *
4312 * @hide
4313 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004314 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004315
4316 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004317 * If set, the new activity is not kept in the history stack. As soon as
4318 * the user navigates away from it, the activity is finished. This may also
4319 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4320 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004321 *
4322 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4323 * is never invoked when the current activity starts a new activity which
4324 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004325 */
4326 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4327 /**
4328 * If set, the activity will not be launched if it is already running
4329 * at the top of the history stack.
4330 */
4331 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4332 /**
4333 * If set, this activity will become the start of a new task on this
4334 * history stack. A task (from the activity that started it to the
4335 * next task activity) defines an atomic group of activities that the
4336 * user can move to. Tasks can be moved to the foreground and background;
4337 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004338 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004339 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4340 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004341 *
4342 * <p>This flag is generally used by activities that want
4343 * to present a "launcher" style behavior: they give the user a list of
4344 * separate things that can be done, which otherwise run completely
4345 * independently of the activity launching them.
4346 *
4347 * <p>When using this flag, if a task is already running for the activity
4348 * you are now starting, then a new activity will not be started; instead,
4349 * the current task will simply be brought to the front of the screen with
4350 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4351 * to disable this behavior.
4352 *
4353 * <p>This flag can not be used when the caller is requesting a result from
4354 * the activity being launched.
4355 */
4356 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4357 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004358 * This flag is used to create a new task and launch an activity into it.
4359 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4360 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4361 * search through existing tasks for ones matching this Intent. Only if no such
4362 * task is found would a new task be created. When paired with
4363 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4364 * the search for a matching task and unconditionally start a new task.
4365 *
4366 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4367 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004368 * top-level application launcher.</strong> Used in conjunction with
4369 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4370 * behavior of bringing an existing task to the foreground. When set,
4371 * a new task is <em>always</em> started to host the Activity for the
4372 * Intent, regardless of whether there is already an existing task running
4373 * the same thing.
4374 *
4375 * <p><strong>Because the default system does not include graphical task management,
4376 * you should not use this flag unless you provide some way for a user to
4377 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004378 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004379 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4380 * creating new document tasks.
4381 *
4382 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004383 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004384 *
Scott Main7aee61f2011-02-08 11:25:01 -08004385 * <p>See
4386 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4387 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004388 *
4389 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4390 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004391 */
4392 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4393 /**
4394 * If set, and the activity being launched is already running in the
4395 * current task, then instead of launching a new instance of that activity,
4396 * all of the other activities on top of it will be closed and this Intent
4397 * will be delivered to the (now on top) old activity as a new Intent.
4398 *
4399 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4400 * If D calls startActivity() with an Intent that resolves to the component
4401 * of activity B, then C and D will be finished and B receive the given
4402 * Intent, resulting in the stack now being: A, B.
4403 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004404 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004405 * either receive the new intent you are starting here in its
4406 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004407 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004408 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4409 * the same intent, then it will be finished and re-created; for all other
4410 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4411 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004412 *
4413 * <p>This launch mode can also be used to good effect in conjunction with
4414 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4415 * of a task, it will bring any currently running instance of that task
4416 * to the foreground, and then clear it to its root state. This is
4417 * especially useful, for example, when launching an activity from the
4418 * notification manager.
4419 *
Scott Main7aee61f2011-02-08 11:25:01 -08004420 * <p>See
4421 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4422 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004423 */
4424 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4425 /**
4426 * If set and this intent is being used to launch a new activity from an
4427 * existing one, then the reply target of the existing activity will be
4428 * transfered to the new activity. This way the new activity can call
4429 * {@link android.app.Activity#setResult} and have that result sent back to
4430 * the reply target of the original activity.
4431 */
4432 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4433 /**
4434 * If set and this intent is being used to launch a new activity from an
4435 * existing one, the current activity will not be counted as the top
4436 * activity for deciding whether the new intent should be delivered to
4437 * the top instead of starting a new one. The previous activity will
4438 * be used as the top, with the assumption being that the current activity
4439 * will finish itself immediately.
4440 */
4441 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4442 /**
4443 * If set, the new activity is not kept in the list of recently launched
4444 * activities.
4445 */
4446 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4447 /**
4448 * This flag is not normally set by application code, but set for you by
4449 * the system as described in the
4450 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4451 * launchMode} documentation for the singleTask mode.
4452 */
4453 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4454 /**
4455 * If set, and this activity is either being started in a new task or
4456 * bringing to the top an existing task, then it will be launched as
4457 * the front door of the task. This will result in the application of
4458 * any affinities needed to have that task in the proper state (either
4459 * moving activities to or from it), or simply resetting that task to
4460 * its initial state if needed.
4461 */
4462 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4463 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004464 * This flag is not normally set by application code, but set for you by
4465 * the system if this activity is being launched from history
4466 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004467 */
4468 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004469 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004470 * @deprecated As of API 21 this performs identically to
4471 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004472 */
4473 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004474 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004475 * This flag is used to open a document into a new task rooted at the activity launched
4476 * by this Intent. Through the use of this flag, or its equivalent attribute,
4477 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004478 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004479 *
Craig Mautner026596b2014-05-21 15:35:44 -07004480 * <p>The use of the activity attribute form of this,
4481 * {@link android.R.attr#documentLaunchMode}, is
4482 * preferred over the Intent flag described here. The attribute form allows the
4483 * Activity to specify multiple document behavior for all launchers of the Activity
4484 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004485 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004486 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4487 * it is kept after the activity is finished is different than the use of
4488 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4489 * this flag is being used to create a new recents entry, then by default that entry
4490 * will be removed once the activity is finished. You can modify this behavior with
4491 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4492 *
Craig Mautner026596b2014-05-21 15:35:44 -07004493 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4494 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4495 * equivalent of the Activity manifest specifying {@link
4496 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4497 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4498 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004499 *
Craig Mautner026596b2014-05-21 15:35:44 -07004500 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004501 *
Craig Mautner026596b2014-05-21 15:35:44 -07004502 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004503 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4504 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004505 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004506 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004507 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004508 * callback from occurring on the current frontmost activity before it is
4509 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004510 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004511 * <p>Typically, an activity can rely on that callback to indicate that an
4512 * explicit user action has caused their activity to be moved out of the
4513 * foreground. The callback marks an appropriate point in the activity's
4514 * lifecycle for it to dismiss any notifications that it intends to display
4515 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004516 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004517 * <p>If an activity is ever started via any non-user-driven events such as
4518 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4519 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004520 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004521 */
4522 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004523 /**
4524 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4525 * this flag will cause the launched activity to be brought to the front of its
4526 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004527 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004528 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4529 * If D calls startActivity() with an Intent that resolves to the component
4530 * of activity B, then B will be brought to the front of the history stack,
4531 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004532 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004533 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004534 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004535 */
4536 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004537 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004538 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4539 * this flag will prevent the system from applying an activity transition
4540 * animation to go to the next activity state. This doesn't mean an
4541 * animation will never run -- if another activity change happens that doesn't
4542 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004543 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004544 * when you are going to do a series of activity operations but the
4545 * animation seen by the user shouldn't be driven by the first activity
4546 * change but rather a later one.
4547 */
4548 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4549 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004550 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4551 * this flag will cause any existing task that would be associated with the
4552 * activity to be cleared before the activity is started. That is, the activity
4553 * becomes the new root of an otherwise empty task, and any old activities
4554 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4555 */
4556 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4557 /**
4558 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4559 * this flag will cause a newly launching task to be placed on top of the current
4560 * home activity task (if there is one). That is, pressing back from the task
4561 * will always return the user to home even if that was not the last activity they
4562 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4563 */
4564 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4565 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004566 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4567 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004568 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004569 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004570 * this flag. When set and the task's activity is finished, the recents
4571 * entry will remain in the interface for the user to re-launch it, like a
4572 * recents entry for a top-level application.
4573 * <p>
4574 * The receiving activity can override this request with
4575 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4576 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004577 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004578 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004579 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004580
4581 /**
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004582 * This flag is only used in the multi-window mode. The new activity will be displayed on
4583 * the other side than the one that is launching it. This can only be used in conjunction with
4584 * {@link #FLAG_ACTIVITY_NEW_TASK}.
4585 */
4586 public static final int FLAG_ACTIVITY_LAUNCH_TO_SIDE = 0x00001000;
4587
4588 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004589 * If set, when sending a broadcast only registered receivers will be
4590 * called -- no BroadcastReceiver components will be launched.
4591 */
4592 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004593 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004594 * If set, when sending a broadcast the new broadcast will replace
4595 * any existing pending broadcast that matches it. Matching is defined
4596 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4597 * true for the intents of the two broadcasts. When a match is found,
4598 * the new broadcast (and receivers associated with it) will replace the
4599 * existing one in the pending broadcast list, remaining at the same
4600 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004601 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004602 * <p>This flag is most typically used with sticky broadcasts, which
4603 * only care about delivering the most recent values of the broadcast
4604 * to their receivers.
4605 */
4606 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4607 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004608 * If set, when sending a broadcast the recipient is allowed to run at
4609 * foreground priority, with a shorter timeout interval. During normal
4610 * broadcasts the receivers are not automatically hoisted out of the
4611 * background priority class.
4612 */
4613 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4614 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004615 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4616 * They can still propagate results through to later receivers, but they can not prevent
4617 * later receivers from seeing the broadcast.
4618 */
4619 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4620 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004621 * If set, when sending a broadcast <i>before boot has completed</i> only
4622 * registered receivers will be called -- no BroadcastReceiver components
4623 * will be launched. Sticky intent state will be recorded properly even
4624 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4625 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004626 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004627 * <p>This flag is only for use by system sevices as a convenience to
4628 * avoid having to implement a more complex mechanism around detection
4629 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004630 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004631 * @hide
4632 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004633 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004634 /**
4635 * Set when this broadcast is for a boot upgrade, a special mode that
4636 * allows the broadcast to be sent before the system is ready and launches
4637 * the app process with no providers running in it.
4638 * @hide
4639 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004640 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004641 /**
4642 * If set, the broadcast will always go to manifest receivers in background (cached
4643 * or not running) apps, regardless of whether that would be done by default. By
4644 * default they will only receive broadcasts if the broadcast has specified an
4645 * explicit component or package name.
4646 * @hide
4647 */
4648 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4649 /**
4650 * If set, the broadcast will never go to manifest receivers in background (cached
4651 * or not running) apps, regardless of whether that would be done by default. By
4652 * default they will receive broadcasts if the broadcast has specified an
4653 * explicit component or package name.
4654 * @hide
4655 */
4656 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004657
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004658 /**
4659 * @hide Flags that can't be changed with PendingIntent.
4660 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004661 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4662 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4663 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004664
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004665 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004666 // ---------------------------------------------------------------------
4667 // toUri() and parseUri() options.
4668
4669 /**
4670 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4671 * always has the "intent:" scheme. This syntax can be used when you want
4672 * to later disambiguate between URIs that are intended to describe an
4673 * Intent vs. all others that should be treated as raw URIs. When used
4674 * with {@link #parseUri}, any other scheme will result in a generic
4675 * VIEW action for that raw URI.
4676 */
4677 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004678
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004679 /**
4680 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4681 * always has the "android-app:" scheme. This is a variation of
4682 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4683 * http/https URI being delivered to a specific package name. The format
4684 * is:
4685 *
4686 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004687 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004688 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004689 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4690 * you must also include a scheme; including a path also requires both a host and a scheme.
4691 * The final #Intent; fragment can be used without a scheme, host, or path.
4692 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004693 * used with intents that have a {@link #setSelector}, since the base intent
4694 * will always have an explicit package name.</p>
4695 *
4696 * <p>Some examples of how this scheme maps to Intent objects:</p>
4697 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4698 * <colgroup align="left" />
4699 * <colgroup align="left" />
4700 * <thead>
4701 * <tr><th>URI</th> <th>Intent</th></tr>
4702 * </thead>
4703 *
4704 * <tbody>
4705 * <tr><td><code>android-app://com.example.app</code></td>
4706 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4707 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4708 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4709 * </table></td>
4710 * </tr>
4711 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4712 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4713 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4714 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4715 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4716 * </table></td>
4717 * </tr>
4718 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4719 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4720 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4721 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4722 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4723 * </table></td>
4724 * </tr>
4725 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4726 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4727 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4728 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4729 * </table></td>
4730 * </tr>
4731 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4732 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4733 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4734 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4735 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4736 * </table></td>
4737 * </tr>
4738 * <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>
4739 * <td><table border="" style="margin:0" >
4740 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4741 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4742 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4743 * </table></td>
4744 * </tr>
4745 * </tbody>
4746 * </table>
4747 */
4748 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4749
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004750 /**
4751 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4752 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4753 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4754 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4755 * generated Intent can not cause unexpected data access to happen.
4756 *
4757 * <p>If you do not trust the source of the URI being parsed, you should still do further
4758 * processing to protect yourself from it. In particular, when using it to start an
4759 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4760 * that can handle it.</p>
4761 */
4762 public static final int URI_ALLOW_UNSAFE = 1<<2;
4763
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004764 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004765
4766 private String mAction;
4767 private Uri mData;
4768 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004769 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004770 private ComponentName mComponent;
4771 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004772 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004773 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004774 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004775 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004776 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004777 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004778
4779 // ---------------------------------------------------------------------
4780
4781 /**
4782 * Create an empty intent.
4783 */
4784 public Intent() {
4785 }
4786
4787 /**
4788 * Copy constructor.
4789 */
4790 public Intent(Intent o) {
4791 this.mAction = o.mAction;
4792 this.mData = o.mData;
4793 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004794 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004795 this.mComponent = o.mComponent;
4796 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004797 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004798 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004799 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004800 }
4801 if (o.mExtras != null) {
4802 this.mExtras = new Bundle(o.mExtras);
4803 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004804 if (o.mSourceBounds != null) {
4805 this.mSourceBounds = new Rect(o.mSourceBounds);
4806 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004807 if (o.mSelector != null) {
4808 this.mSelector = new Intent(o.mSelector);
4809 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004810 if (o.mClipData != null) {
4811 this.mClipData = new ClipData(o.mClipData);
4812 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004813 }
4814
4815 @Override
4816 public Object clone() {
4817 return new Intent(this);
4818 }
4819
4820 private Intent(Intent o, boolean all) {
4821 this.mAction = o.mAction;
4822 this.mData = o.mData;
4823 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004824 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004825 this.mComponent = o.mComponent;
4826 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004827 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004828 }
4829 }
4830
4831 /**
4832 * Make a clone of only the parts of the Intent that are relevant for
4833 * filter matching: the action, data, type, component, and categories.
4834 */
4835 public Intent cloneFilter() {
4836 return new Intent(this, false);
4837 }
4838
4839 /**
4840 * Create an intent with a given action. All other fields (data, type,
4841 * class) are null. Note that the action <em>must</em> be in a
4842 * namespace because Intents are used globally in the system -- for
4843 * example the system VIEW action is android.intent.action.VIEW; an
4844 * application's custom action would be something like
4845 * com.google.app.myapp.CUSTOM_ACTION.
4846 *
4847 * @param action The Intent action, such as ACTION_VIEW.
4848 */
4849 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004850 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004851 }
4852
4853 /**
4854 * Create an intent with a given action and for a given data url. Note
4855 * that the action <em>must</em> be in a namespace because Intents are
4856 * used globally in the system -- for example the system VIEW action is
4857 * android.intent.action.VIEW; an application's custom action would be
4858 * something like com.google.app.myapp.CUSTOM_ACTION.
4859 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004860 * <p><em>Note: scheme and host name matching in the Android framework is
4861 * case-sensitive, unlike the formal RFC. As a result,
4862 * you should always ensure that you write your Uri with these elements
4863 * using lower case letters, and normalize any Uris you receive from
4864 * outside of Android to ensure the scheme and host is lower case.</em></p>
4865 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004866 * @param action The Intent action, such as ACTION_VIEW.
4867 * @param uri The Intent data URI.
4868 */
4869 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004870 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004871 mData = uri;
4872 }
4873
4874 /**
4875 * Create an intent for a specific component. All other fields (action, data,
4876 * type, class) are null, though they can be modified later with explicit
4877 * calls. This provides a convenient way to create an intent that is
4878 * intended to execute a hard-coded class name, rather than relying on the
4879 * system to find an appropriate class for you; see {@link #setComponent}
4880 * for more information on the repercussions of this.
4881 *
4882 * @param packageContext A Context of the application package implementing
4883 * this class.
4884 * @param cls The component class that is to be used for the intent.
4885 *
4886 * @see #setClass
4887 * @see #setComponent
4888 * @see #Intent(String, android.net.Uri , Context, Class)
4889 */
4890 public Intent(Context packageContext, Class<?> cls) {
4891 mComponent = new ComponentName(packageContext, cls);
4892 }
4893
4894 /**
4895 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004896 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004897 * construct the Intent and then calling {@link #setClass} to set its
4898 * class.
4899 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004900 * <p><em>Note: scheme and host name matching in the Android framework is
4901 * case-sensitive, unlike the formal RFC. As a result,
4902 * you should always ensure that you write your Uri with these elements
4903 * using lower case letters, and normalize any Uris you receive from
4904 * outside of Android to ensure the scheme and host is lower case.</em></p>
4905 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004906 * @param action The Intent action, such as ACTION_VIEW.
4907 * @param uri The Intent data URI.
4908 * @param packageContext A Context of the application package implementing
4909 * this class.
4910 * @param cls The component class that is to be used for the intent.
4911 *
4912 * @see #Intent(String, android.net.Uri)
4913 * @see #Intent(Context, Class)
4914 * @see #setClass
4915 * @see #setComponent
4916 */
4917 public Intent(String action, Uri uri,
4918 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004919 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004920 mData = uri;
4921 mComponent = new ComponentName(packageContext, cls);
4922 }
4923
4924 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004925 * Create an intent to launch the main (root) activity of a task. This
4926 * is the Intent that is started when the application's is launched from
4927 * Home. For anything else that wants to launch an application in the
4928 * same way, it is important that they use an Intent structured the same
4929 * way, and can use this function to ensure this is the case.
4930 *
4931 * <p>The returned Intent has the given Activity component as its explicit
4932 * component, {@link #ACTION_MAIN} as its action, and includes the
4933 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4934 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4935 * to do that through {@link #addFlags(int)} on the returned Intent.
4936 *
4937 * @param mainActivity The main activity component that this Intent will
4938 * launch.
4939 * @return Returns a newly created Intent that can be used to launch the
4940 * activity as a main application entry.
4941 *
4942 * @see #setClass
4943 * @see #setComponent
4944 */
4945 public static Intent makeMainActivity(ComponentName mainActivity) {
4946 Intent intent = new Intent(ACTION_MAIN);
4947 intent.setComponent(mainActivity);
4948 intent.addCategory(CATEGORY_LAUNCHER);
4949 return intent;
4950 }
4951
4952 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004953 * Make an Intent for the main activity of an application, without
4954 * specifying a specific activity to run but giving a selector to find
4955 * the activity. This results in a final Intent that is structured
4956 * the same as when the application is launched from
4957 * Home. For anything else that wants to launch an application in the
4958 * same way, it is important that they use an Intent structured the same
4959 * way, and can use this function to ensure this is the case.
4960 *
4961 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4962 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4963 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4964 * to do that through {@link #addFlags(int)} on the returned Intent.
4965 *
4966 * @param selectorAction The action name of the Intent's selector.
4967 * @param selectorCategory The name of a category to add to the Intent's
4968 * selector.
4969 * @return Returns a newly created Intent that can be used to launch the
4970 * activity as a main application entry.
4971 *
4972 * @see #setSelector(Intent)
4973 */
4974 public static Intent makeMainSelectorActivity(String selectorAction,
4975 String selectorCategory) {
4976 Intent intent = new Intent(ACTION_MAIN);
4977 intent.addCategory(CATEGORY_LAUNCHER);
4978 Intent selector = new Intent();
4979 selector.setAction(selectorAction);
4980 selector.addCategory(selectorCategory);
4981 intent.setSelector(selector);
4982 return intent;
4983 }
4984
4985 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004986 * Make an Intent that can be used to re-launch an application's task
4987 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4988 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4989 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4990 *
4991 * @param mainActivity The activity component that is the root of the
4992 * task; this is the activity that has been published in the application's
4993 * manifest as the main launcher icon.
4994 *
4995 * @return Returns a newly created Intent that can be used to relaunch the
4996 * activity's task in its root state.
4997 */
4998 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4999 Intent intent = makeMainActivity(mainActivity);
5000 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5001 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5002 return intent;
5003 }
5004
5005 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005006 * Call {@link #parseUri} with 0 flags.
5007 * @deprecated Use {@link #parseUri} instead.
5008 */
5009 @Deprecated
5010 public static Intent getIntent(String uri) throws URISyntaxException {
5011 return parseUri(uri, 0);
5012 }
Tom Taylord4a47292009-12-21 13:59:18 -08005013
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005014 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005015 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005016 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005017 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005018 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005019 *
5020 * <p>The URI given here must not be relative -- that is, it must include
5021 * the scheme and full path.
5022 *
5023 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005024 * @param flags Additional processing flags. Either 0,
5025 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005026 *
5027 * @return Intent The newly created Intent object.
5028 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005029 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5030 * it bad (as parsed by the Uri class) or the Intent data within the
5031 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005032 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005033 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005034 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005035 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005036 int i = 0;
5037 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005038 final boolean androidApp = uri.startsWith("android-app:");
5039
5040 // Validate intent scheme if requested.
5041 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5042 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005043 Intent intent = new Intent(ACTION_VIEW);
5044 try {
5045 intent.setData(Uri.parse(uri));
5046 } catch (IllegalArgumentException e) {
5047 throw new URISyntaxException(uri, e.getMessage());
5048 }
5049 return intent;
5050 }
5051 }
Tom Taylord4a47292009-12-21 13:59:18 -08005052
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005053 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005054 // simple case
5055 if (i == -1) {
5056 if (!androidApp) {
5057 return new Intent(ACTION_VIEW, Uri.parse(uri));
5058 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005059
5060 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005061 } else if (!uri.startsWith("#Intent;", i)) {
5062 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005063 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005064 } else {
5065 i = -1;
5066 }
5067 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005068
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005069 // new format
5070 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005071 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005072 boolean explicitAction = false;
5073 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005074
5075 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005076 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005077 String data;
5078 if (i >= 0) {
5079 data = uri.substring(0, i);
5080 i += 8; // length of "#Intent;"
5081 } else {
5082 data = uri;
5083 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005084
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005085 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005086 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005087 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005088 if (eq < 0) eq = i-1;
5089 int semi = uri.indexOf(';', i);
5090 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005091
5092 // action
5093 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005094 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005095 if (!inSelector) {
5096 explicitAction = true;
5097 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005098 }
5099
5100 // categories
5101 else if (uri.startsWith("category=", i)) {
5102 intent.addCategory(value);
5103 }
5104
5105 // type
5106 else if (uri.startsWith("type=", i)) {
5107 intent.mType = value;
5108 }
5109
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005110 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005111 else if (uri.startsWith("launchFlags=", i)) {
5112 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005113 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5114 intent.mFlags &= ~IMMUTABLE_FLAGS;
5115 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005116 }
5117
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005118 // package
5119 else if (uri.startsWith("package=", i)) {
5120 intent.mPackage = value;
5121 }
5122
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005123 // component
5124 else if (uri.startsWith("component=", i)) {
5125 intent.mComponent = ComponentName.unflattenFromString(value);
5126 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005127
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005128 // scheme
5129 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005130 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005131 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005132 } else {
5133 scheme = value;
5134 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005135 }
5136
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005137 // source bounds
5138 else if (uri.startsWith("sourceBounds=", i)) {
5139 intent.mSourceBounds = Rect.unflattenFromString(value);
5140 }
5141
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005142 // selector
5143 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5144 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005145 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005146 }
5147
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005148 // extra
5149 else {
5150 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005151 // create Bundle if it doesn't already exist
5152 if (intent.mExtras == null) intent.mExtras = new Bundle();
5153 Bundle b = intent.mExtras;
5154 // add EXTRA
5155 if (uri.startsWith("S.", i)) b.putString(key, value);
5156 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5157 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5158 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5159 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5160 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5161 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5162 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5163 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5164 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5165 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005166
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005167 // move to the next item
5168 i = semi + 1;
5169 }
5170
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005171 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005172 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005173 if (baseIntent.mPackage == null) {
5174 baseIntent.setSelector(intent);
5175 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005176 intent = baseIntent;
5177 }
5178
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005179 if (data != null) {
5180 if (data.startsWith("intent:")) {
5181 data = data.substring(7);
5182 if (scheme != null) {
5183 data = scheme + ':' + data;
5184 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005185 } else if (data.startsWith("android-app:")) {
5186 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5187 // Correctly formed android-app, first part is package name.
5188 int end = data.indexOf('/', 14);
5189 if (end < 0) {
5190 // All we have is a package name.
5191 intent.mPackage = data.substring(14);
5192 if (!explicitAction) {
5193 intent.setAction(ACTION_MAIN);
5194 }
5195 data = "";
5196 } else {
5197 // Target the Intent at the given package name always.
5198 String authority = null;
5199 intent.mPackage = data.substring(14, end);
5200 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005201 if ((end+1) < data.length()) {
5202 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5203 // Found a scheme, remember it.
5204 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005205 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005206 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5207 // Found a authority, remember it.
5208 authority = data.substring(end+1, newEnd);
5209 end = newEnd;
5210 }
5211 } else {
5212 // All we have is a scheme.
5213 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005214 }
5215 }
5216 if (scheme == null) {
5217 // If there was no scheme, then this just targets the package.
5218 if (!explicitAction) {
5219 intent.setAction(ACTION_MAIN);
5220 }
5221 data = "";
5222 } else if (authority == null) {
5223 data = scheme + ":";
5224 } else {
5225 data = scheme + "://" + authority + data.substring(end);
5226 }
5227 }
5228 } else {
5229 data = "";
5230 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005231 }
Tom Taylord4a47292009-12-21 13:59:18 -08005232
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005233 if (data.length() > 0) {
5234 try {
5235 intent.mData = Uri.parse(data);
5236 } catch (IllegalArgumentException e) {
5237 throw new URISyntaxException(uri, e.getMessage());
5238 }
5239 }
5240 }
Tom Taylord4a47292009-12-21 13:59:18 -08005241
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005242 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005243
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005244 } catch (IndexOutOfBoundsException e) {
5245 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5246 }
5247 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005248
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005249 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005250 return getIntentOld(uri, 0);
5251 }
5252
5253 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005254 Intent intent;
5255
5256 int i = uri.lastIndexOf('#');
5257 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005258 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005259 final int intentFragmentStart = i;
5260 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005261
5262 i++;
5263
5264 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005265 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005266 i += 7;
5267 int j = uri.indexOf(')', i);
5268 action = uri.substring(i, j);
5269 i = j + 1;
5270 }
5271
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005272 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005273
5274 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005275 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005276 i += 11;
5277 int j = uri.indexOf(')', i);
5278 while (i < j) {
5279 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005280 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005281 if (i < sep) {
5282 intent.addCategory(uri.substring(i, sep));
5283 }
5284 i = sep + 1;
5285 }
5286 i = j + 1;
5287 }
5288
5289 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005290 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005291 i += 5;
5292 int j = uri.indexOf(')', i);
5293 intent.mType = uri.substring(i, j);
5294 i = j + 1;
5295 }
5296
5297 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005298 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005299 i += 12;
5300 int j = uri.indexOf(')', i);
5301 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005302 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5303 intent.mFlags &= ~IMMUTABLE_FLAGS;
5304 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005305 i = j + 1;
5306 }
5307
5308 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005309 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005310 i += 10;
5311 int j = uri.indexOf(')', i);
5312 int sep = uri.indexOf('!', i);
5313 if (sep >= 0 && sep < j) {
5314 String pkg = uri.substring(i, sep);
5315 String cls = uri.substring(sep + 1, j);
5316 intent.mComponent = new ComponentName(pkg, cls);
5317 }
5318 i = j + 1;
5319 }
5320
5321 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005322 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005323 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005324
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005325 final int closeParen = uri.indexOf(')', i);
5326 if (closeParen == -1) throw new URISyntaxException(uri,
5327 "EXTRA missing trailing ')'", i);
5328
5329 while (i < closeParen) {
5330 // fetch the key value
5331 int j = uri.indexOf('=', i);
5332 if (j <= i + 1 || i >= closeParen) {
5333 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5334 }
5335 char type = uri.charAt(i);
5336 i++;
5337 String key = uri.substring(i, j);
5338 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005339
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005340 // get type-value
5341 j = uri.indexOf('!', i);
5342 if (j == -1 || j >= closeParen) j = closeParen;
5343 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5344 String value = uri.substring(i, j);
5345 i = j;
5346
5347 // create Bundle if it doesn't already exist
5348 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005349
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005350 // add item to bundle
5351 try {
5352 switch (type) {
5353 case 'S':
5354 intent.mExtras.putString(key, Uri.decode(value));
5355 break;
5356 case 'B':
5357 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5358 break;
5359 case 'b':
5360 intent.mExtras.putByte(key, Byte.parseByte(value));
5361 break;
5362 case 'c':
5363 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5364 break;
5365 case 'd':
5366 intent.mExtras.putDouble(key, Double.parseDouble(value));
5367 break;
5368 case 'f':
5369 intent.mExtras.putFloat(key, Float.parseFloat(value));
5370 break;
5371 case 'i':
5372 intent.mExtras.putInt(key, Integer.parseInt(value));
5373 break;
5374 case 'l':
5375 intent.mExtras.putLong(key, Long.parseLong(value));
5376 break;
5377 case 's':
5378 intent.mExtras.putShort(key, Short.parseShort(value));
5379 break;
5380 default:
5381 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5382 }
5383 } catch (NumberFormatException e) {
5384 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5385 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005386
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005387 char ch = uri.charAt(i);
5388 if (ch == ')') break;
5389 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5390 i++;
5391 }
5392 }
5393
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005394 if (isIntentFragment) {
5395 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5396 } else {
5397 intent.mData = Uri.parse(uri);
5398 }
Tom Taylord4a47292009-12-21 13:59:18 -08005399
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005400 if (intent.mAction == null) {
5401 // By default, if no action is specified, then use VIEW.
5402 intent.mAction = ACTION_VIEW;
5403 }
5404
5405 } else {
5406 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5407 }
5408
5409 return intent;
5410 }
5411
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005412 /** @hide */
5413 public interface CommandOptionHandler {
5414 boolean handleOption(String opt, ShellCommand cmd);
5415 }
5416
5417 /** @hide */
5418 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5419 throws URISyntaxException {
5420 Intent intent = new Intent();
5421 Intent baseIntent = intent;
5422 boolean hasIntentInfo = false;
5423
5424 Uri data = null;
5425 String type = null;
5426
5427 String opt;
5428 while ((opt=cmd.getNextOption()) != null) {
5429 switch (opt) {
5430 case "-a":
5431 intent.setAction(cmd.getNextArgRequired());
5432 if (intent == baseIntent) {
5433 hasIntentInfo = true;
5434 }
5435 break;
5436 case "-d":
5437 data = Uri.parse(cmd.getNextArgRequired());
5438 if (intent == baseIntent) {
5439 hasIntentInfo = true;
5440 }
5441 break;
5442 case "-t":
5443 type = cmd.getNextArgRequired();
5444 if (intent == baseIntent) {
5445 hasIntentInfo = true;
5446 }
5447 break;
5448 case "-c":
5449 intent.addCategory(cmd.getNextArgRequired());
5450 if (intent == baseIntent) {
5451 hasIntentInfo = true;
5452 }
5453 break;
5454 case "-e":
5455 case "--es": {
5456 String key = cmd.getNextArgRequired();
5457 String value = cmd.getNextArgRequired();
5458 intent.putExtra(key, value);
5459 }
5460 break;
5461 case "--esn": {
5462 String key = cmd.getNextArgRequired();
5463 intent.putExtra(key, (String) null);
5464 }
5465 break;
5466 case "--ei": {
5467 String key = cmd.getNextArgRequired();
5468 String value = cmd.getNextArgRequired();
5469 intent.putExtra(key, Integer.decode(value));
5470 }
5471 break;
5472 case "--eu": {
5473 String key = cmd.getNextArgRequired();
5474 String value = cmd.getNextArgRequired();
5475 intent.putExtra(key, Uri.parse(value));
5476 }
5477 break;
5478 case "--ecn": {
5479 String key = cmd.getNextArgRequired();
5480 String value = cmd.getNextArgRequired();
5481 ComponentName cn = ComponentName.unflattenFromString(value);
5482 if (cn == null)
5483 throw new IllegalArgumentException("Bad component name: " + value);
5484 intent.putExtra(key, cn);
5485 }
5486 break;
5487 case "--eia": {
5488 String key = cmd.getNextArgRequired();
5489 String value = cmd.getNextArgRequired();
5490 String[] strings = value.split(",");
5491 int[] list = new int[strings.length];
5492 for (int i = 0; i < strings.length; i++) {
5493 list[i] = Integer.decode(strings[i]);
5494 }
5495 intent.putExtra(key, list);
5496 }
5497 break;
5498 case "--eial": {
5499 String key = cmd.getNextArgRequired();
5500 String value = cmd.getNextArgRequired();
5501 String[] strings = value.split(",");
5502 ArrayList<Integer> list = new ArrayList<>(strings.length);
5503 for (int i = 0; i < strings.length; i++) {
5504 list.add(Integer.decode(strings[i]));
5505 }
5506 intent.putExtra(key, list);
5507 }
5508 break;
5509 case "--el": {
5510 String key = cmd.getNextArgRequired();
5511 String value = cmd.getNextArgRequired();
5512 intent.putExtra(key, Long.valueOf(value));
5513 }
5514 break;
5515 case "--ela": {
5516 String key = cmd.getNextArgRequired();
5517 String value = cmd.getNextArgRequired();
5518 String[] strings = value.split(",");
5519 long[] list = new long[strings.length];
5520 for (int i = 0; i < strings.length; i++) {
5521 list[i] = Long.valueOf(strings[i]);
5522 }
5523 intent.putExtra(key, list);
5524 hasIntentInfo = true;
5525 }
5526 break;
5527 case "--elal": {
5528 String key = cmd.getNextArgRequired();
5529 String value = cmd.getNextArgRequired();
5530 String[] strings = value.split(",");
5531 ArrayList<Long> list = new ArrayList<>(strings.length);
5532 for (int i = 0; i < strings.length; i++) {
5533 list.add(Long.valueOf(strings[i]));
5534 }
5535 intent.putExtra(key, list);
5536 hasIntentInfo = true;
5537 }
5538 break;
5539 case "--ef": {
5540 String key = cmd.getNextArgRequired();
5541 String value = cmd.getNextArgRequired();
5542 intent.putExtra(key, Float.valueOf(value));
5543 hasIntentInfo = true;
5544 }
5545 break;
5546 case "--efa": {
5547 String key = cmd.getNextArgRequired();
5548 String value = cmd.getNextArgRequired();
5549 String[] strings = value.split(",");
5550 float[] list = new float[strings.length];
5551 for (int i = 0; i < strings.length; i++) {
5552 list[i] = Float.valueOf(strings[i]);
5553 }
5554 intent.putExtra(key, list);
5555 hasIntentInfo = true;
5556 }
5557 break;
5558 case "--efal": {
5559 String key = cmd.getNextArgRequired();
5560 String value = cmd.getNextArgRequired();
5561 String[] strings = value.split(",");
5562 ArrayList<Float> list = new ArrayList<>(strings.length);
5563 for (int i = 0; i < strings.length; i++) {
5564 list.add(Float.valueOf(strings[i]));
5565 }
5566 intent.putExtra(key, list);
5567 hasIntentInfo = true;
5568 }
5569 break;
5570 case "--esa": {
5571 String key = cmd.getNextArgRequired();
5572 String value = cmd.getNextArgRequired();
5573 // Split on commas unless they are preceeded by an escape.
5574 // The escape character must be escaped for the string and
5575 // again for the regex, thus four escape characters become one.
5576 String[] strings = value.split("(?<!\\\\),");
5577 intent.putExtra(key, strings);
5578 hasIntentInfo = true;
5579 }
5580 break;
5581 case "--esal": {
5582 String key = cmd.getNextArgRequired();
5583 String value = cmd.getNextArgRequired();
5584 // Split on commas unless they are preceeded by an escape.
5585 // The escape character must be escaped for the string and
5586 // again for the regex, thus four escape characters become one.
5587 String[] strings = value.split("(?<!\\\\),");
5588 ArrayList<String> list = new ArrayList<>(strings.length);
5589 for (int i = 0; i < strings.length; i++) {
5590 list.add(strings[i]);
5591 }
5592 intent.putExtra(key, list);
5593 hasIntentInfo = true;
5594 }
5595 break;
5596 case "--ez": {
5597 String key = cmd.getNextArgRequired();
5598 String value = cmd.getNextArgRequired().toLowerCase();
5599 // Boolean.valueOf() results in false for anything that is not "true", which is
5600 // error-prone in shell commands
5601 boolean arg;
5602 if ("true".equals(value) || "t".equals(value)) {
5603 arg = true;
5604 } else if ("false".equals(value) || "f".equals(value)) {
5605 arg = false;
5606 } else {
5607 try {
5608 arg = Integer.decode(value) != 0;
5609 } catch (NumberFormatException ex) {
5610 throw new IllegalArgumentException("Invalid boolean value: " + value);
5611 }
5612 }
5613
5614 intent.putExtra(key, arg);
5615 }
5616 break;
5617 case "-n": {
5618 String str = cmd.getNextArgRequired();
5619 ComponentName cn = ComponentName.unflattenFromString(str);
5620 if (cn == null)
5621 throw new IllegalArgumentException("Bad component name: " + str);
5622 intent.setComponent(cn);
5623 if (intent == baseIntent) {
5624 hasIntentInfo = true;
5625 }
5626 }
5627 break;
5628 case "-p": {
5629 String str = cmd.getNextArgRequired();
5630 intent.setPackage(str);
5631 if (intent == baseIntent) {
5632 hasIntentInfo = true;
5633 }
5634 }
5635 break;
5636 case "-f":
5637 String str = cmd.getNextArgRequired();
5638 intent.setFlags(Integer.decode(str).intValue());
5639 break;
5640 case "--grant-read-uri-permission":
5641 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5642 break;
5643 case "--grant-write-uri-permission":
5644 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5645 break;
5646 case "--grant-persistable-uri-permission":
5647 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5648 break;
5649 case "--grant-prefix-uri-permission":
5650 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5651 break;
5652 case "--exclude-stopped-packages":
5653 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5654 break;
5655 case "--include-stopped-packages":
5656 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5657 break;
5658 case "--debug-log-resolution":
5659 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5660 break;
5661 case "--activity-brought-to-front":
5662 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5663 break;
5664 case "--activity-clear-top":
5665 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5666 break;
5667 case "--activity-clear-when-task-reset":
5668 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5669 break;
5670 case "--activity-exclude-from-recents":
5671 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5672 break;
5673 case "--activity-launched-from-history":
5674 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5675 break;
5676 case "--activity-multiple-task":
5677 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5678 break;
5679 case "--activity-no-animation":
5680 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5681 break;
5682 case "--activity-no-history":
5683 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5684 break;
5685 case "--activity-no-user-action":
5686 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5687 break;
5688 case "--activity-previous-is-top":
5689 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5690 break;
5691 case "--activity-reorder-to-front":
5692 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5693 break;
5694 case "--activity-reset-task-if-needed":
5695 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5696 break;
5697 case "--activity-single-top":
5698 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5699 break;
5700 case "--activity-clear-task":
5701 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5702 break;
5703 case "--activity-task-on-home":
5704 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5705 break;
5706 case "--receiver-registered-only":
5707 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5708 break;
5709 case "--receiver-replace-pending":
5710 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5711 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005712 case "--receiver-foreground":
5713 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5714 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005715 case "--selector":
5716 intent.setDataAndType(data, type);
5717 intent = new Intent();
5718 break;
5719 default:
5720 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5721 // Okay, caller handled this option.
5722 } else {
5723 throw new IllegalArgumentException("Unknown option: " + opt);
5724 }
5725 break;
5726 }
5727 }
5728 intent.setDataAndType(data, type);
5729
5730 final boolean hasSelector = intent != baseIntent;
5731 if (hasSelector) {
5732 // A selector was specified; fix up.
5733 baseIntent.setSelector(intent);
5734 intent = baseIntent;
5735 }
5736
5737 String arg = cmd.getNextArg();
5738 baseIntent = null;
5739 if (arg == null) {
5740 if (hasSelector) {
5741 // If a selector has been specified, and no arguments
5742 // have been supplied for the main Intent, then we can
5743 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5744 // need to have a component name specified yet, the
5745 // selector will take care of that.
5746 baseIntent = new Intent(Intent.ACTION_MAIN);
5747 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5748 }
5749 } else if (arg.indexOf(':') >= 0) {
5750 // The argument is a URI. Fully parse it, and use that result
5751 // to fill in any data not specified so far.
5752 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5753 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5754 } else if (arg.indexOf('/') >= 0) {
5755 // The argument is a component name. Build an Intent to launch
5756 // it.
5757 baseIntent = new Intent(Intent.ACTION_MAIN);
5758 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5759 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5760 } else {
5761 // Assume the argument is a package name.
5762 baseIntent = new Intent(Intent.ACTION_MAIN);
5763 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5764 baseIntent.setPackage(arg);
5765 }
5766 if (baseIntent != null) {
5767 Bundle extras = intent.getExtras();
5768 intent.replaceExtras((Bundle)null);
5769 Bundle uriExtras = baseIntent.getExtras();
5770 baseIntent.replaceExtras((Bundle)null);
5771 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5772 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5773 for (String c : cats) {
5774 baseIntent.removeCategory(c);
5775 }
5776 }
5777 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5778 if (extras == null) {
5779 extras = uriExtras;
5780 } else if (uriExtras != null) {
5781 uriExtras.putAll(extras);
5782 extras = uriExtras;
5783 }
5784 intent.replaceExtras(extras);
5785 hasIntentInfo = true;
5786 }
5787
5788 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5789 return intent;
5790 }
5791
5792 /** @hide */
5793 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5794 final String[] lines = new String[] {
5795 "<INTENT> specifications include these flags and arguments:",
5796 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5797 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5798 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5799 " [--esn <EXTRA_KEY> ...]",
5800 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5801 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5802 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5803 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5804 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5805 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5806 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5807 " (mutiple extras passed as Integer[])",
5808 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5809 " (mutiple extras passed as List<Integer>)",
5810 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5811 " (mutiple extras passed as Long[])",
5812 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5813 " (mutiple extras passed as List<Long>)",
5814 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5815 " (mutiple extras passed as Float[])",
5816 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5817 " (mutiple extras passed as List<Float>)",
5818 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5819 " (mutiple extras passed as String[]; to embed a comma into a string,",
5820 " escape it using \"\\,\")",
5821 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5822 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5823 " escape it using \"\\,\")",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005824 " [--f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005825 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5826 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5827 " [--debug-log-resolution] [--exclude-stopped-packages]",
5828 " [--include-stopped-packages]",
5829 " [--activity-brought-to-front] [--activity-clear-top]",
5830 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5831 " [--activity-launched-from-history] [--activity-multiple-task]",
5832 " [--activity-no-animation] [--activity-no-history]",
5833 " [--activity-no-user-action] [--activity-previous-is-top]",
5834 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5835 " [--activity-single-top] [--activity-clear-task]",
5836 " [--activity-task-on-home]",
5837 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005838 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005839 " [--selector]",
5840 " [<URI> | <PACKAGE> | <COMPONENT>]"
5841 };
5842 for (String line : lines) {
5843 pw.print(prefix);
5844 pw.println(line);
5845 }
5846 }
5847
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005848 /**
5849 * Retrieve the general action to be performed, such as
5850 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5851 * the information in the intent should be interpreted -- most importantly,
5852 * what to do with the data returned by {@link #getData}.
5853 *
5854 * @return The action of this intent or null if none is specified.
5855 *
5856 * @see #setAction
5857 */
5858 public String getAction() {
5859 return mAction;
5860 }
5861
5862 /**
5863 * Retrieve data this intent is operating on. This URI specifies the name
5864 * of the data; often it uses the content: scheme, specifying data in a
5865 * content provider. Other schemes may be handled by specific activities,
5866 * such as http: by the web browser.
5867 *
5868 * @return The URI of the data this intent is targeting or null.
5869 *
5870 * @see #getScheme
5871 * @see #setData
5872 */
5873 public Uri getData() {
5874 return mData;
5875 }
5876
5877 /**
5878 * The same as {@link #getData()}, but returns the URI as an encoded
5879 * String.
5880 */
5881 public String getDataString() {
5882 return mData != null ? mData.toString() : null;
5883 }
5884
5885 /**
5886 * Return the scheme portion of the intent's data. If the data is null or
5887 * does not include a scheme, null is returned. Otherwise, the scheme
5888 * prefix without the final ':' is returned, i.e. "http".
5889 *
5890 * <p>This is the same as calling getData().getScheme() (and checking for
5891 * null data).
5892 *
5893 * @return The scheme of this intent.
5894 *
5895 * @see #getData
5896 */
5897 public String getScheme() {
5898 return mData != null ? mData.getScheme() : null;
5899 }
5900
5901 /**
5902 * Retrieve any explicit MIME type included in the intent. This is usually
5903 * null, as the type is determined by the intent data.
5904 *
5905 * @return If a type was manually set, it is returned; else null is
5906 * returned.
5907 *
5908 * @see #resolveType(ContentResolver)
5909 * @see #setType
5910 */
5911 public String getType() {
5912 return mType;
5913 }
5914
5915 /**
5916 * Return the MIME data type of this intent. If the type field is
5917 * explicitly set, that is simply returned. Otherwise, if the data is set,
5918 * the type of that data is returned. If neither fields are set, a null is
5919 * returned.
5920 *
5921 * @return The MIME type of this intent.
5922 *
5923 * @see #getType
5924 * @see #resolveType(ContentResolver)
5925 */
5926 public String resolveType(Context context) {
5927 return resolveType(context.getContentResolver());
5928 }
5929
5930 /**
5931 * Return the MIME data type of this intent. If the type field is
5932 * explicitly set, that is simply returned. Otherwise, if the data is set,
5933 * the type of that data is returned. If neither fields are set, a null is
5934 * returned.
5935 *
5936 * @param resolver A ContentResolver that can be used to determine the MIME
5937 * type of the intent's data.
5938 *
5939 * @return The MIME type of this intent.
5940 *
5941 * @see #getType
5942 * @see #resolveType(Context)
5943 */
5944 public String resolveType(ContentResolver resolver) {
5945 if (mType != null) {
5946 return mType;
5947 }
5948 if (mData != null) {
5949 if ("content".equals(mData.getScheme())) {
5950 return resolver.getType(mData);
5951 }
5952 }
5953 return null;
5954 }
5955
5956 /**
5957 * Return the MIME data type of this intent, only if it will be needed for
5958 * intent resolution. This is not generally useful for application code;
5959 * it is used by the frameworks for communicating with back-end system
5960 * services.
5961 *
5962 * @param resolver A ContentResolver that can be used to determine the MIME
5963 * type of the intent's data.
5964 *
5965 * @return The MIME type of this intent, or null if it is unknown or not
5966 * needed.
5967 */
5968 public String resolveTypeIfNeeded(ContentResolver resolver) {
5969 if (mComponent != null) {
5970 return mType;
5971 }
5972 return resolveType(resolver);
5973 }
5974
5975 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005976 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005977 *
5978 * @param category The category to check.
5979 *
5980 * @return boolean True if the intent contains the category, else false.
5981 *
5982 * @see #getCategories
5983 * @see #addCategory
5984 */
5985 public boolean hasCategory(String category) {
5986 return mCategories != null && mCategories.contains(category);
5987 }
5988
5989 /**
5990 * Return the set of all categories in the intent. If there are no categories,
5991 * returns NULL.
5992 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005993 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005994 *
5995 * @see #hasCategory
5996 * @see #addCategory
5997 */
5998 public Set<String> getCategories() {
5999 return mCategories;
6000 }
6001
6002 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006003 * Return the specific selector associated with this Intent. If there is
6004 * none, returns null. See {@link #setSelector} for more information.
6005 *
6006 * @see #setSelector
6007 */
6008 public Intent getSelector() {
6009 return mSelector;
6010 }
6011
6012 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006013 * Return the {@link ClipData} associated with this Intent. If there is
6014 * none, returns null. See {@link #setClipData} for more information.
6015 *
John Spurlock125d1332013-11-25 11:58:37 -05006016 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006017 */
6018 public ClipData getClipData() {
6019 return mClipData;
6020 }
6021
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006022 /** @hide */
6023 public int getContentUserHint() {
6024 return mContentUserHint;
6025 }
6026
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006027 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006028 * Sets the ClassLoader that will be used when unmarshalling
6029 * any Parcelable values from the extras of this Intent.
6030 *
6031 * @param loader a ClassLoader, or null to use the default loader
6032 * at the time of unmarshalling.
6033 */
6034 public void setExtrasClassLoader(ClassLoader loader) {
6035 if (mExtras != null) {
6036 mExtras.setClassLoader(loader);
6037 }
6038 }
6039
6040 /**
6041 * Returns true if an extra value is associated with the given name.
6042 * @param name the extra's name
6043 * @return true if the given extra is present.
6044 */
6045 public boolean hasExtra(String name) {
6046 return mExtras != null && mExtras.containsKey(name);
6047 }
6048
6049 /**
6050 * Returns true if the Intent's extras contain a parcelled file descriptor.
6051 * @return true if the Intent contains a parcelled file descriptor.
6052 */
6053 public boolean hasFileDescriptors() {
6054 return mExtras != null && mExtras.hasFileDescriptors();
6055 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006056
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006057 /** @hide */
6058 public void setAllowFds(boolean allowFds) {
6059 if (mExtras != null) {
6060 mExtras.setAllowFds(allowFds);
6061 }
6062 }
6063
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006064 /**
6065 * Retrieve extended data from the intent.
6066 *
6067 * @param name The name of the desired item.
6068 *
6069 * @return the value of an item that previously added with putExtra()
6070 * or null if none was found.
6071 *
6072 * @deprecated
6073 * @hide
6074 */
6075 @Deprecated
6076 public Object getExtra(String name) {
6077 return getExtra(name, null);
6078 }
6079
6080 /**
6081 * Retrieve extended data from the intent.
6082 *
6083 * @param name The name of the desired item.
6084 * @param defaultValue the value to be returned if no value of the desired
6085 * type is stored with the given name.
6086 *
6087 * @return the value of an item that previously added with putExtra()
6088 * or the default value if none was found.
6089 *
6090 * @see #putExtra(String, boolean)
6091 */
6092 public boolean getBooleanExtra(String name, boolean defaultValue) {
6093 return mExtras == null ? defaultValue :
6094 mExtras.getBoolean(name, defaultValue);
6095 }
6096
6097 /**
6098 * Retrieve extended data from the intent.
6099 *
6100 * @param name The name of the desired item.
6101 * @param defaultValue the value to be returned if no value of the desired
6102 * type is stored with the given name.
6103 *
6104 * @return the value of an item that previously added with putExtra()
6105 * or the default value if none was found.
6106 *
6107 * @see #putExtra(String, byte)
6108 */
6109 public byte getByteExtra(String name, byte defaultValue) {
6110 return mExtras == null ? defaultValue :
6111 mExtras.getByte(name, defaultValue);
6112 }
6113
6114 /**
6115 * Retrieve extended data from the intent.
6116 *
6117 * @param name The name of the desired item.
6118 * @param defaultValue the value to be returned if no value of the desired
6119 * type is stored with the given name.
6120 *
6121 * @return the value of an item that previously added with putExtra()
6122 * or the default value if none was found.
6123 *
6124 * @see #putExtra(String, short)
6125 */
6126 public short getShortExtra(String name, short defaultValue) {
6127 return mExtras == null ? defaultValue :
6128 mExtras.getShort(name, defaultValue);
6129 }
6130
6131 /**
6132 * Retrieve extended data from the intent.
6133 *
6134 * @param name The name of the desired item.
6135 * @param defaultValue the value to be returned if no value of the desired
6136 * type is stored with the given name.
6137 *
6138 * @return the value of an item that previously added with putExtra()
6139 * or the default value if none was found.
6140 *
6141 * @see #putExtra(String, char)
6142 */
6143 public char getCharExtra(String name, char defaultValue) {
6144 return mExtras == null ? defaultValue :
6145 mExtras.getChar(name, defaultValue);
6146 }
6147
6148 /**
6149 * Retrieve extended data from the intent.
6150 *
6151 * @param name The name of the desired item.
6152 * @param defaultValue the value to be returned if no value of the desired
6153 * type is stored with the given name.
6154 *
6155 * @return the value of an item that previously added with putExtra()
6156 * or the default value if none was found.
6157 *
6158 * @see #putExtra(String, int)
6159 */
6160 public int getIntExtra(String name, int defaultValue) {
6161 return mExtras == null ? defaultValue :
6162 mExtras.getInt(name, defaultValue);
6163 }
6164
6165 /**
6166 * Retrieve extended data from the intent.
6167 *
6168 * @param name The name of the desired item.
6169 * @param defaultValue the value to be returned if no value of the desired
6170 * type is stored with the given name.
6171 *
6172 * @return the value of an item that previously added with putExtra()
6173 * or the default value if none was found.
6174 *
6175 * @see #putExtra(String, long)
6176 */
6177 public long getLongExtra(String name, long defaultValue) {
6178 return mExtras == null ? defaultValue :
6179 mExtras.getLong(name, defaultValue);
6180 }
6181
6182 /**
6183 * Retrieve extended data from the intent.
6184 *
6185 * @param name The name of the desired item.
6186 * @param defaultValue the value to be returned if no value of the desired
6187 * type is stored with the given name.
6188 *
6189 * @return the value of an item that previously added with putExtra(),
6190 * or the default value if no such item is present
6191 *
6192 * @see #putExtra(String, float)
6193 */
6194 public float getFloatExtra(String name, float defaultValue) {
6195 return mExtras == null ? defaultValue :
6196 mExtras.getFloat(name, defaultValue);
6197 }
6198
6199 /**
6200 * Retrieve extended data from the intent.
6201 *
6202 * @param name The name of the desired item.
6203 * @param defaultValue the value to be returned if no value of the desired
6204 * type is stored with the given name.
6205 *
6206 * @return the value of an item that previously added with putExtra()
6207 * or the default value if none was found.
6208 *
6209 * @see #putExtra(String, double)
6210 */
6211 public double getDoubleExtra(String name, double defaultValue) {
6212 return mExtras == null ? defaultValue :
6213 mExtras.getDouble(name, defaultValue);
6214 }
6215
6216 /**
6217 * Retrieve extended data from the intent.
6218 *
6219 * @param name The name of the desired item.
6220 *
6221 * @return the value of an item that previously added with putExtra()
6222 * or null if no String value was found.
6223 *
6224 * @see #putExtra(String, String)
6225 */
6226 public String getStringExtra(String name) {
6227 return mExtras == null ? null : mExtras.getString(name);
6228 }
6229
6230 /**
6231 * Retrieve extended data from the intent.
6232 *
6233 * @param name The name of the desired item.
6234 *
6235 * @return the value of an item that previously added with putExtra()
6236 * or null if no CharSequence value was found.
6237 *
6238 * @see #putExtra(String, CharSequence)
6239 */
6240 public CharSequence getCharSequenceExtra(String name) {
6241 return mExtras == null ? null : mExtras.getCharSequence(name);
6242 }
6243
6244 /**
6245 * Retrieve extended data from the intent.
6246 *
6247 * @param name The name of the desired item.
6248 *
6249 * @return the value of an item that previously added with putExtra()
6250 * or null if no Parcelable value was found.
6251 *
6252 * @see #putExtra(String, Parcelable)
6253 */
6254 public <T extends Parcelable> T getParcelableExtra(String name) {
6255 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6256 }
6257
6258 /**
6259 * Retrieve extended data from the intent.
6260 *
6261 * @param name The name of the desired item.
6262 *
6263 * @return the value of an item that previously added with putExtra()
6264 * or null if no Parcelable[] value was found.
6265 *
6266 * @see #putExtra(String, Parcelable[])
6267 */
6268 public Parcelable[] getParcelableArrayExtra(String name) {
6269 return mExtras == null ? null : mExtras.getParcelableArray(name);
6270 }
6271
6272 /**
6273 * Retrieve extended data from the intent.
6274 *
6275 * @param name The name of the desired item.
6276 *
6277 * @return the value of an item that previously added with putExtra()
6278 * or null if no ArrayList<Parcelable> value was found.
6279 *
6280 * @see #putParcelableArrayListExtra(String, ArrayList)
6281 */
6282 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6283 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6284 }
6285
6286 /**
6287 * Retrieve extended data from the intent.
6288 *
6289 * @param name The name of the desired item.
6290 *
6291 * @return the value of an item that previously added with putExtra()
6292 * or null if no Serializable value was found.
6293 *
6294 * @see #putExtra(String, Serializable)
6295 */
6296 public Serializable getSerializableExtra(String name) {
6297 return mExtras == null ? null : mExtras.getSerializable(name);
6298 }
6299
6300 /**
6301 * Retrieve extended data from the intent.
6302 *
6303 * @param name The name of the desired item.
6304 *
6305 * @return the value of an item that previously added with putExtra()
6306 * or null if no ArrayList<Integer> value was found.
6307 *
6308 * @see #putIntegerArrayListExtra(String, ArrayList)
6309 */
6310 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6311 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6312 }
6313
6314 /**
6315 * Retrieve extended data from the intent.
6316 *
6317 * @param name The name of the desired item.
6318 *
6319 * @return the value of an item that previously added with putExtra()
6320 * or null if no ArrayList<String> value was found.
6321 *
6322 * @see #putStringArrayListExtra(String, ArrayList)
6323 */
6324 public ArrayList<String> getStringArrayListExtra(String name) {
6325 return mExtras == null ? null : mExtras.getStringArrayList(name);
6326 }
6327
6328 /**
6329 * Retrieve extended data from the intent.
6330 *
6331 * @param name The name of the desired item.
6332 *
6333 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006334 * or null if no ArrayList<CharSequence> value was found.
6335 *
6336 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6337 */
6338 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6339 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6340 }
6341
6342 /**
6343 * Retrieve extended data from the intent.
6344 *
6345 * @param name The name of the desired item.
6346 *
6347 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006348 * or null if no boolean array value was found.
6349 *
6350 * @see #putExtra(String, boolean[])
6351 */
6352 public boolean[] getBooleanArrayExtra(String name) {
6353 return mExtras == null ? null : mExtras.getBooleanArray(name);
6354 }
6355
6356 /**
6357 * Retrieve extended data from the intent.
6358 *
6359 * @param name The name of the desired item.
6360 *
6361 * @return the value of an item that previously added with putExtra()
6362 * or null if no byte array value was found.
6363 *
6364 * @see #putExtra(String, byte[])
6365 */
6366 public byte[] getByteArrayExtra(String name) {
6367 return mExtras == null ? null : mExtras.getByteArray(name);
6368 }
6369
6370 /**
6371 * Retrieve extended data from the intent.
6372 *
6373 * @param name The name of the desired item.
6374 *
6375 * @return the value of an item that previously added with putExtra()
6376 * or null if no short array value was found.
6377 *
6378 * @see #putExtra(String, short[])
6379 */
6380 public short[] getShortArrayExtra(String name) {
6381 return mExtras == null ? null : mExtras.getShortArray(name);
6382 }
6383
6384 /**
6385 * Retrieve extended data from the intent.
6386 *
6387 * @param name The name of the desired item.
6388 *
6389 * @return the value of an item that previously added with putExtra()
6390 * or null if no char array value was found.
6391 *
6392 * @see #putExtra(String, char[])
6393 */
6394 public char[] getCharArrayExtra(String name) {
6395 return mExtras == null ? null : mExtras.getCharArray(name);
6396 }
6397
6398 /**
6399 * Retrieve extended data from the intent.
6400 *
6401 * @param name The name of the desired item.
6402 *
6403 * @return the value of an item that previously added with putExtra()
6404 * or null if no int array value was found.
6405 *
6406 * @see #putExtra(String, int[])
6407 */
6408 public int[] getIntArrayExtra(String name) {
6409 return mExtras == null ? null : mExtras.getIntArray(name);
6410 }
6411
6412 /**
6413 * Retrieve extended data from the intent.
6414 *
6415 * @param name The name of the desired item.
6416 *
6417 * @return the value of an item that previously added with putExtra()
6418 * or null if no long array value was found.
6419 *
6420 * @see #putExtra(String, long[])
6421 */
6422 public long[] getLongArrayExtra(String name) {
6423 return mExtras == null ? null : mExtras.getLongArray(name);
6424 }
6425
6426 /**
6427 * Retrieve extended data from the intent.
6428 *
6429 * @param name The name of the desired item.
6430 *
6431 * @return the value of an item that previously added with putExtra()
6432 * or null if no float array value was found.
6433 *
6434 * @see #putExtra(String, float[])
6435 */
6436 public float[] getFloatArrayExtra(String name) {
6437 return mExtras == null ? null : mExtras.getFloatArray(name);
6438 }
6439
6440 /**
6441 * Retrieve extended data from the intent.
6442 *
6443 * @param name The name of the desired item.
6444 *
6445 * @return the value of an item that previously added with putExtra()
6446 * or null if no double array value was found.
6447 *
6448 * @see #putExtra(String, double[])
6449 */
6450 public double[] getDoubleArrayExtra(String name) {
6451 return mExtras == null ? null : mExtras.getDoubleArray(name);
6452 }
6453
6454 /**
6455 * Retrieve extended data from the intent.
6456 *
6457 * @param name The name of the desired item.
6458 *
6459 * @return the value of an item that previously added with putExtra()
6460 * or null if no String array value was found.
6461 *
6462 * @see #putExtra(String, String[])
6463 */
6464 public String[] getStringArrayExtra(String name) {
6465 return mExtras == null ? null : mExtras.getStringArray(name);
6466 }
6467
6468 /**
6469 * Retrieve extended data from the intent.
6470 *
6471 * @param name The name of the desired item.
6472 *
6473 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006474 * or null if no CharSequence array value was found.
6475 *
6476 * @see #putExtra(String, CharSequence[])
6477 */
6478 public CharSequence[] getCharSequenceArrayExtra(String name) {
6479 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6480 }
6481
6482 /**
6483 * Retrieve extended data from the intent.
6484 *
6485 * @param name The name of the desired item.
6486 *
6487 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006488 * or null if no Bundle value was found.
6489 *
6490 * @see #putExtra(String, Bundle)
6491 */
6492 public Bundle getBundleExtra(String name) {
6493 return mExtras == null ? null : mExtras.getBundle(name);
6494 }
6495
6496 /**
6497 * Retrieve extended data from the intent.
6498 *
6499 * @param name The name of the desired item.
6500 *
6501 * @return the value of an item that previously added with putExtra()
6502 * or null if no IBinder value was found.
6503 *
6504 * @see #putExtra(String, IBinder)
6505 *
6506 * @deprecated
6507 * @hide
6508 */
6509 @Deprecated
6510 public IBinder getIBinderExtra(String name) {
6511 return mExtras == null ? null : mExtras.getIBinder(name);
6512 }
6513
6514 /**
6515 * Retrieve extended data from the intent.
6516 *
6517 * @param name The name of the desired item.
6518 * @param defaultValue The default value to return in case no item is
6519 * associated with the key 'name'
6520 *
6521 * @return the value of an item that previously added with putExtra()
6522 * or defaultValue if none was found.
6523 *
6524 * @see #putExtra
6525 *
6526 * @deprecated
6527 * @hide
6528 */
6529 @Deprecated
6530 public Object getExtra(String name, Object defaultValue) {
6531 Object result = defaultValue;
6532 if (mExtras != null) {
6533 Object result2 = mExtras.get(name);
6534 if (result2 != null) {
6535 result = result2;
6536 }
6537 }
6538
6539 return result;
6540 }
6541
6542 /**
6543 * Retrieves a map of extended data from the intent.
6544 *
6545 * @return the map of all extras previously added with putExtra(),
6546 * or null if none have been added.
6547 */
6548 public Bundle getExtras() {
6549 return (mExtras != null)
6550 ? new Bundle(mExtras)
6551 : null;
6552 }
6553
6554 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006555 * Filter extras to only basic types.
6556 * @hide
6557 */
6558 public void removeUnsafeExtras() {
6559 if (mExtras != null) {
6560 mExtras.filterValues();
6561 }
6562 }
6563
6564 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006565 * Retrieve any special flags associated with this intent. You will
6566 * normally just set them with {@link #setFlags} and let the system
6567 * take the appropriate action with them.
6568 *
6569 * @return int The currently set flags.
6570 *
6571 * @see #setFlags
6572 */
6573 public int getFlags() {
6574 return mFlags;
6575 }
6576
Dianne Hackborne7f97212011-02-24 14:40:20 -08006577 /** @hide */
6578 public boolean isExcludingStopped() {
6579 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6580 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6581 }
6582
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006583 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006584 * Retrieve the application package name this Intent is limited to. When
6585 * resolving an Intent, if non-null this limits the resolution to only
6586 * components in the given application package.
6587 *
6588 * @return The name of the application package for the Intent.
6589 *
6590 * @see #resolveActivity
6591 * @see #setPackage
6592 */
6593 public String getPackage() {
6594 return mPackage;
6595 }
6596
6597 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006598 * Retrieve the concrete component associated with the intent. When receiving
6599 * an intent, this is the component that was found to best handle it (that is,
6600 * yourself) and will always be non-null; in all other cases it will be
6601 * null unless explicitly set.
6602 *
6603 * @return The name of the application component to handle the intent.
6604 *
6605 * @see #resolveActivity
6606 * @see #setComponent
6607 */
6608 public ComponentName getComponent() {
6609 return mComponent;
6610 }
6611
6612 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006613 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6614 * used as a hint to the receiver for animations and the like. Null means that there
6615 * is no source bounds.
6616 */
6617 public Rect getSourceBounds() {
6618 return mSourceBounds;
6619 }
6620
6621 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006622 * Return the Activity component that should be used to handle this intent.
6623 * The appropriate component is determined based on the information in the
6624 * intent, evaluated as follows:
6625 *
6626 * <p>If {@link #getComponent} returns an explicit class, that is returned
6627 * without any further consideration.
6628 *
6629 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6630 * category to be considered.
6631 *
6632 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6633 * action.
6634 *
6635 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6636 * this type.
6637 *
6638 * <p>If {@link #addCategory} has added any categories, the activity must
6639 * handle ALL of the categories specified.
6640 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006641 * <p>If {@link #getPackage} is non-NULL, only activity components in
6642 * that application package will be considered.
6643 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006644 * <p>If there are no activities that satisfy all of these conditions, a
6645 * null string is returned.
6646 *
6647 * <p>If multiple activities are found to satisfy the intent, the one with
6648 * the highest priority will be used. If there are multiple activities
6649 * with the same priority, the system will either pick the best activity
6650 * based on user preference, or resolve to a system class that will allow
6651 * the user to pick an activity and forward from there.
6652 *
6653 * <p>This method is implemented simply by calling
6654 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6655 * true.</p>
6656 * <p> This API is called for you as part of starting an activity from an
6657 * intent. You do not normally need to call it yourself.</p>
6658 *
6659 * @param pm The package manager with which to resolve the Intent.
6660 *
6661 * @return Name of the component implementing an activity that can
6662 * display the intent.
6663 *
6664 * @see #setComponent
6665 * @see #getComponent
6666 * @see #resolveActivityInfo
6667 */
6668 public ComponentName resolveActivity(PackageManager pm) {
6669 if (mComponent != null) {
6670 return mComponent;
6671 }
6672
6673 ResolveInfo info = pm.resolveActivity(
6674 this, PackageManager.MATCH_DEFAULT_ONLY);
6675 if (info != null) {
6676 return new ComponentName(
6677 info.activityInfo.applicationInfo.packageName,
6678 info.activityInfo.name);
6679 }
6680
6681 return null;
6682 }
6683
6684 /**
6685 * Resolve the Intent into an {@link ActivityInfo}
6686 * describing the activity that should execute the intent. Resolution
6687 * follows the same rules as described for {@link #resolveActivity}, but
6688 * you get back the completely information about the resolved activity
6689 * instead of just its class name.
6690 *
6691 * @param pm The package manager with which to resolve the Intent.
6692 * @param flags Addition information to retrieve as per
6693 * {@link PackageManager#getActivityInfo(ComponentName, int)
6694 * PackageManager.getActivityInfo()}.
6695 *
6696 * @return PackageManager.ActivityInfo
6697 *
6698 * @see #resolveActivity
6699 */
6700 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6701 ActivityInfo ai = null;
6702 if (mComponent != null) {
6703 try {
6704 ai = pm.getActivityInfo(mComponent, flags);
6705 } catch (PackageManager.NameNotFoundException e) {
6706 // ignore
6707 }
6708 } else {
6709 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006710 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006711 if (info != null) {
6712 ai = info.activityInfo;
6713 }
6714 }
6715
6716 return ai;
6717 }
6718
6719 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006720 * Special function for use by the system to resolve service
6721 * intents to system apps. Throws an exception if there are
6722 * multiple potential matches to the Intent. Returns null if
6723 * there are no matches.
6724 * @hide
6725 */
6726 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6727 if (mComponent != null) {
6728 return mComponent;
6729 }
6730
6731 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6732 if (results == null) {
6733 return null;
6734 }
6735 ComponentName comp = null;
6736 for (int i=0; i<results.size(); i++) {
6737 ResolveInfo ri = results.get(i);
6738 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6739 continue;
6740 }
6741 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6742 ri.serviceInfo.name);
6743 if (comp != null) {
6744 throw new IllegalStateException("Multiple system services handle " + this
6745 + ": " + comp + ", " + foundComp);
6746 }
6747 comp = foundComp;
6748 }
6749 return comp;
6750 }
6751
6752 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006753 * Set the general action to be performed.
6754 *
6755 * @param action An action name, such as ACTION_VIEW. Application-specific
6756 * actions should be prefixed with the vendor's package name.
6757 *
6758 * @return Returns the same Intent object, for chaining multiple calls
6759 * into a single statement.
6760 *
6761 * @see #getAction
6762 */
6763 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006764 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006765 return this;
6766 }
6767
6768 /**
6769 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006770 * clears any type that was previously set by {@link #setType} or
6771 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006772 *
Nick Pellyccae4122012-01-09 14:12:58 -08006773 * <p><em>Note: scheme matching in the Android framework is
6774 * case-sensitive, unlike the formal RFC. As a result,
6775 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006776 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006777 * {@link #setDataAndNormalize}
6778 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006779 *
Nick Pellyccae4122012-01-09 14:12:58 -08006780 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006781 *
6782 * @return Returns the same Intent object, for chaining multiple calls
6783 * into a single statement.
6784 *
6785 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006786 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006787 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006788 */
6789 public Intent setData(Uri data) {
6790 mData = data;
6791 mType = null;
6792 return this;
6793 }
6794
6795 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006796 * Normalize and set the data this intent is operating on.
6797 *
6798 * <p>This method automatically clears any type that was
6799 * previously set (for example, by {@link #setType}).
6800 *
6801 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006802 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006803 * so really this is just a convenience method for
6804 * <pre>
6805 * setData(data.normalize())
6806 * </pre>
6807 *
6808 * @param data The Uri of the data this intent is now targeting.
6809 *
6810 * @return Returns the same Intent object, for chaining multiple calls
6811 * into a single statement.
6812 *
6813 * @see #getData
6814 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006815 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006816 */
6817 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006818 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006819 }
6820
6821 /**
6822 * Set an explicit MIME data type.
6823 *
6824 * <p>This is used to create intents that only specify a type and not data,
6825 * for example to indicate the type of data to return.
6826 *
6827 * <p>This method automatically clears any data that was
6828 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006829 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006830 * <p><em>Note: MIME type matching in the Android framework is
6831 * case-sensitive, unlike formal RFC MIME types. As a result,
6832 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006833 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6834 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006835 *
6836 * @param type The MIME type of the data being handled by this intent.
6837 *
6838 * @return Returns the same Intent object, for chaining multiple calls
6839 * into a single statement.
6840 *
6841 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006842 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006843 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006844 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006845 */
6846 public Intent setType(String type) {
6847 mData = null;
6848 mType = type;
6849 return this;
6850 }
6851
6852 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006853 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006854 *
Nick Pellyccae4122012-01-09 14:12:58 -08006855 * <p>This is used to create intents that only specify a type and not data,
6856 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006857 *
Nick Pellyccae4122012-01-09 14:12:58 -08006858 * <p>This method automatically clears any data that was
6859 * previously set (for example by {@link #setData}).
6860 *
6861 * <p>The MIME type is normalized using
6862 * {@link #normalizeMimeType} before it is set,
6863 * so really this is just a convenience method for
6864 * <pre>
6865 * setType(Intent.normalizeMimeType(type))
6866 * </pre>
6867 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006868 * @param type The MIME type of the data being handled by this intent.
6869 *
6870 * @return Returns the same Intent object, for chaining multiple calls
6871 * into a single statement.
6872 *
Nick Pellyccae4122012-01-09 14:12:58 -08006873 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006874 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006875 * @see #normalizeMimeType
6876 */
6877 public Intent setTypeAndNormalize(String type) {
6878 return setType(normalizeMimeType(type));
6879 }
6880
6881 /**
6882 * (Usually optional) Set the data for the intent along with an explicit
6883 * MIME data type. This method should very rarely be used -- it allows you
6884 * to override the MIME type that would ordinarily be inferred from the
6885 * data with your own type given here.
6886 *
6887 * <p><em>Note: MIME type and Uri scheme matching in the
6888 * Android framework is case-sensitive, unlike the formal RFC definitions.
6889 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006890 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006891 * {@link #setDataAndTypeAndNormalize}
6892 * to ensure that they are converted to lower case.</em>
6893 *
6894 * @param data The Uri of the data this intent is now targeting.
6895 * @param type The MIME type of the data being handled by this intent.
6896 *
6897 * @return Returns the same Intent object, for chaining multiple calls
6898 * into a single statement.
6899 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006900 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006901 * @see #setData
6902 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006903 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006904 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006905 */
6906 public Intent setDataAndType(Uri data, String type) {
6907 mData = data;
6908 mType = type;
6909 return this;
6910 }
6911
6912 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006913 * (Usually optional) Normalize and set both the data Uri and an explicit
6914 * MIME data type. This method should very rarely be used -- it allows you
6915 * to override the MIME type that would ordinarily be inferred from the
6916 * data with your own type given here.
6917 *
6918 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006919 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006920 * before they are set, so really this is just a convenience method for
6921 * <pre>
6922 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6923 * </pre>
6924 *
6925 * @param data The Uri of the data this intent is now targeting.
6926 * @param type The MIME type of the data being handled by this intent.
6927 *
6928 * @return Returns the same Intent object, for chaining multiple calls
6929 * into a single statement.
6930 *
6931 * @see #setType
6932 * @see #setData
6933 * @see #setDataAndType
6934 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006935 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006936 */
6937 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006938 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006939 }
6940
6941 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006942 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006943 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006944 * activities that provide <em>all</em> of the requested categories will be
6945 * used.
6946 *
6947 * @param category The desired category. This can be either one of the
6948 * predefined Intent categories, or a custom category in your own
6949 * namespace.
6950 *
6951 * @return Returns the same Intent object, for chaining multiple calls
6952 * into a single statement.
6953 *
6954 * @see #hasCategory
6955 * @see #removeCategory
6956 */
6957 public Intent addCategory(String category) {
6958 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006959 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006960 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006961 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006962 return this;
6963 }
6964
6965 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006966 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006967 *
6968 * @param category The category to remove.
6969 *
6970 * @see #addCategory
6971 */
6972 public void removeCategory(String category) {
6973 if (mCategories != null) {
6974 mCategories.remove(category);
6975 if (mCategories.size() == 0) {
6976 mCategories = null;
6977 }
6978 }
6979 }
6980
6981 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006982 * Set a selector for this Intent. This is a modification to the kinds of
6983 * things the Intent will match. If the selector is set, it will be used
6984 * when trying to find entities that can handle the Intent, instead of the
6985 * main contents of the Intent. This allows you build an Intent containing
6986 * a generic protocol while targeting it more specifically.
6987 *
6988 * <p>An example of where this may be used is with things like
6989 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6990 * Intent that will launch the Browser application. However, the correct
6991 * main entry point of an application is actually {@link #ACTION_MAIN}
6992 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
6993 * used to specify the actual Activity to launch. If you launch the browser
6994 * with something different, undesired behavior may happen if the user has
6995 * previously or later launches it the normal way, since they do not match.
6996 * Instead, you can build an Intent with the MAIN action (but no ComponentName
6997 * yet specified) and set a selector with {@link #ACTION_MAIN} and
6998 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
6999 *
7000 * <p>Setting a selector does not impact the behavior of
7001 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7002 * desired behavior of a selector -- it does not impact the base meaning
7003 * of the Intent, just what kinds of things will be matched against it
7004 * when determining who can handle it.</p>
7005 *
7006 * <p>You can not use both a selector and {@link #setPackage(String)} on
7007 * the same base Intent.</p>
7008 *
7009 * @param selector The desired selector Intent; set to null to not use
7010 * a special selector.
7011 */
7012 public void setSelector(Intent selector) {
7013 if (selector == this) {
7014 throw new IllegalArgumentException(
7015 "Intent being set as a selector of itself");
7016 }
7017 if (selector != null && mPackage != null) {
7018 throw new IllegalArgumentException(
7019 "Can't set selector when package name is already set");
7020 }
7021 mSelector = selector;
7022 }
7023
7024 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007025 * Set a {@link ClipData} associated with this Intent. This replaces any
7026 * previously set ClipData.
7027 *
7028 * <p>The ClipData in an intent is not used for Intent matching or other
7029 * such operations. Semantically it is like extras, used to transmit
7030 * additional data with the Intent. The main feature of using this over
7031 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7032 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7033 * items included in the clip data. This is useful, in particular, if
7034 * you want to transmit an Intent containing multiple <code>content:</code>
7035 * URIs for which the recipient may not have global permission to access the
7036 * content provider.
7037 *
7038 * <p>If the ClipData contains items that are themselves Intents, any
7039 * grant flags in those Intents will be ignored. Only the top-level flags
7040 * of the main Intent are respected, and will be applied to all Uri or
7041 * Intent items in the clip (or sub-items of the clip).
7042 *
7043 * <p>The MIME type, label, and icon in the ClipData object are not
7044 * directly used by Intent. Applications should generally rely on the
7045 * MIME type of the Intent itself, not what it may find in the ClipData.
7046 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007047 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007048 *
7049 * @param clip The new clip to set. May be null to clear the current clip.
7050 */
7051 public void setClipData(ClipData clip) {
7052 mClipData = clip;
7053 }
7054
7055 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007056 * This is NOT a secure mechanism to identify the user who sent the intent.
7057 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7058 * who sent the intent.
7059 * @hide
7060 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007061 public void prepareToLeaveUser(int userId) {
7062 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7063 // We want mContentUserHint to refer to the original user, so don't do anything.
7064 if (mContentUserHint == UserHandle.USER_CURRENT) {
7065 mContentUserHint = userId;
7066 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007067 }
7068
7069 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007070 * Add extended data to the intent. The name must include a package
7071 * prefix, for example the app com.android.contacts would use names
7072 * like "com.android.contacts.ShowAll".
7073 *
7074 * @param name The name of the extra data, with package prefix.
7075 * @param value The boolean data value.
7076 *
7077 * @return Returns the same Intent object, for chaining multiple calls
7078 * into a single statement.
7079 *
7080 * @see #putExtras
7081 * @see #removeExtra
7082 * @see #getBooleanExtra(String, boolean)
7083 */
7084 public Intent putExtra(String name, boolean value) {
7085 if (mExtras == null) {
7086 mExtras = new Bundle();
7087 }
7088 mExtras.putBoolean(name, value);
7089 return this;
7090 }
7091
7092 /**
7093 * Add extended data to the intent. The name must include a package
7094 * prefix, for example the app com.android.contacts would use names
7095 * like "com.android.contacts.ShowAll".
7096 *
7097 * @param name The name of the extra data, with package prefix.
7098 * @param value The byte data value.
7099 *
7100 * @return Returns the same Intent object, for chaining multiple calls
7101 * into a single statement.
7102 *
7103 * @see #putExtras
7104 * @see #removeExtra
7105 * @see #getByteExtra(String, byte)
7106 */
7107 public Intent putExtra(String name, byte value) {
7108 if (mExtras == null) {
7109 mExtras = new Bundle();
7110 }
7111 mExtras.putByte(name, value);
7112 return this;
7113 }
7114
7115 /**
7116 * Add extended data to the intent. The name must include a package
7117 * prefix, for example the app com.android.contacts would use names
7118 * like "com.android.contacts.ShowAll".
7119 *
7120 * @param name The name of the extra data, with package prefix.
7121 * @param value The char data value.
7122 *
7123 * @return Returns the same Intent object, for chaining multiple calls
7124 * into a single statement.
7125 *
7126 * @see #putExtras
7127 * @see #removeExtra
7128 * @see #getCharExtra(String, char)
7129 */
7130 public Intent putExtra(String name, char value) {
7131 if (mExtras == null) {
7132 mExtras = new Bundle();
7133 }
7134 mExtras.putChar(name, value);
7135 return this;
7136 }
7137
7138 /**
7139 * Add extended data to the intent. The name must include a package
7140 * prefix, for example the app com.android.contacts would use names
7141 * like "com.android.contacts.ShowAll".
7142 *
7143 * @param name The name of the extra data, with package prefix.
7144 * @param value The short data value.
7145 *
7146 * @return Returns the same Intent object, for chaining multiple calls
7147 * into a single statement.
7148 *
7149 * @see #putExtras
7150 * @see #removeExtra
7151 * @see #getShortExtra(String, short)
7152 */
7153 public Intent putExtra(String name, short value) {
7154 if (mExtras == null) {
7155 mExtras = new Bundle();
7156 }
7157 mExtras.putShort(name, value);
7158 return this;
7159 }
7160
7161 /**
7162 * Add extended data to the intent. The name must include a package
7163 * prefix, for example the app com.android.contacts would use names
7164 * like "com.android.contacts.ShowAll".
7165 *
7166 * @param name The name of the extra data, with package prefix.
7167 * @param value The integer data value.
7168 *
7169 * @return Returns the same Intent object, for chaining multiple calls
7170 * into a single statement.
7171 *
7172 * @see #putExtras
7173 * @see #removeExtra
7174 * @see #getIntExtra(String, int)
7175 */
7176 public Intent putExtra(String name, int value) {
7177 if (mExtras == null) {
7178 mExtras = new Bundle();
7179 }
7180 mExtras.putInt(name, value);
7181 return this;
7182 }
7183
7184 /**
7185 * Add extended data to the intent. The name must include a package
7186 * prefix, for example the app com.android.contacts would use names
7187 * like "com.android.contacts.ShowAll".
7188 *
7189 * @param name The name of the extra data, with package prefix.
7190 * @param value The long data value.
7191 *
7192 * @return Returns the same Intent object, for chaining multiple calls
7193 * into a single statement.
7194 *
7195 * @see #putExtras
7196 * @see #removeExtra
7197 * @see #getLongExtra(String, long)
7198 */
7199 public Intent putExtra(String name, long value) {
7200 if (mExtras == null) {
7201 mExtras = new Bundle();
7202 }
7203 mExtras.putLong(name, value);
7204 return this;
7205 }
7206
7207 /**
7208 * Add extended data to the intent. The name must include a package
7209 * prefix, for example the app com.android.contacts would use names
7210 * like "com.android.contacts.ShowAll".
7211 *
7212 * @param name The name of the extra data, with package prefix.
7213 * @param value The float data value.
7214 *
7215 * @return Returns the same Intent object, for chaining multiple calls
7216 * into a single statement.
7217 *
7218 * @see #putExtras
7219 * @see #removeExtra
7220 * @see #getFloatExtra(String, float)
7221 */
7222 public Intent putExtra(String name, float value) {
7223 if (mExtras == null) {
7224 mExtras = new Bundle();
7225 }
7226 mExtras.putFloat(name, value);
7227 return this;
7228 }
7229
7230 /**
7231 * Add extended data to the intent. The name must include a package
7232 * prefix, for example the app com.android.contacts would use names
7233 * like "com.android.contacts.ShowAll".
7234 *
7235 * @param name The name of the extra data, with package prefix.
7236 * @param value The double data value.
7237 *
7238 * @return Returns the same Intent object, for chaining multiple calls
7239 * into a single statement.
7240 *
7241 * @see #putExtras
7242 * @see #removeExtra
7243 * @see #getDoubleExtra(String, double)
7244 */
7245 public Intent putExtra(String name, double value) {
7246 if (mExtras == null) {
7247 mExtras = new Bundle();
7248 }
7249 mExtras.putDouble(name, value);
7250 return this;
7251 }
7252
7253 /**
7254 * Add extended data to the intent. The name must include a package
7255 * prefix, for example the app com.android.contacts would use names
7256 * like "com.android.contacts.ShowAll".
7257 *
7258 * @param name The name of the extra data, with package prefix.
7259 * @param value The String data value.
7260 *
7261 * @return Returns the same Intent object, for chaining multiple calls
7262 * into a single statement.
7263 *
7264 * @see #putExtras
7265 * @see #removeExtra
7266 * @see #getStringExtra(String)
7267 */
7268 public Intent putExtra(String name, String value) {
7269 if (mExtras == null) {
7270 mExtras = new Bundle();
7271 }
7272 mExtras.putString(name, value);
7273 return this;
7274 }
7275
7276 /**
7277 * Add extended data to the intent. The name must include a package
7278 * prefix, for example the app com.android.contacts would use names
7279 * like "com.android.contacts.ShowAll".
7280 *
7281 * @param name The name of the extra data, with package prefix.
7282 * @param value The CharSequence data value.
7283 *
7284 * @return Returns the same Intent object, for chaining multiple calls
7285 * into a single statement.
7286 *
7287 * @see #putExtras
7288 * @see #removeExtra
7289 * @see #getCharSequenceExtra(String)
7290 */
7291 public Intent putExtra(String name, CharSequence value) {
7292 if (mExtras == null) {
7293 mExtras = new Bundle();
7294 }
7295 mExtras.putCharSequence(name, value);
7296 return this;
7297 }
7298
7299 /**
7300 * Add extended data to the intent. The name must include a package
7301 * prefix, for example the app com.android.contacts would use names
7302 * like "com.android.contacts.ShowAll".
7303 *
7304 * @param name The name of the extra data, with package prefix.
7305 * @param value The Parcelable data value.
7306 *
7307 * @return Returns the same Intent object, for chaining multiple calls
7308 * into a single statement.
7309 *
7310 * @see #putExtras
7311 * @see #removeExtra
7312 * @see #getParcelableExtra(String)
7313 */
7314 public Intent putExtra(String name, Parcelable value) {
7315 if (mExtras == null) {
7316 mExtras = new Bundle();
7317 }
7318 mExtras.putParcelable(name, value);
7319 return this;
7320 }
7321
7322 /**
7323 * Add extended data to the intent. The name must include a package
7324 * prefix, for example the app com.android.contacts would use names
7325 * like "com.android.contacts.ShowAll".
7326 *
7327 * @param name The name of the extra data, with package prefix.
7328 * @param value The Parcelable[] data value.
7329 *
7330 * @return Returns the same Intent object, for chaining multiple calls
7331 * into a single statement.
7332 *
7333 * @see #putExtras
7334 * @see #removeExtra
7335 * @see #getParcelableArrayExtra(String)
7336 */
7337 public Intent putExtra(String name, Parcelable[] value) {
7338 if (mExtras == null) {
7339 mExtras = new Bundle();
7340 }
7341 mExtras.putParcelableArray(name, value);
7342 return this;
7343 }
7344
7345 /**
7346 * Add extended data to the intent. The name must include a package
7347 * prefix, for example the app com.android.contacts would use names
7348 * like "com.android.contacts.ShowAll".
7349 *
7350 * @param name The name of the extra data, with package prefix.
7351 * @param value The ArrayList<Parcelable> data value.
7352 *
7353 * @return Returns the same Intent object, for chaining multiple calls
7354 * into a single statement.
7355 *
7356 * @see #putExtras
7357 * @see #removeExtra
7358 * @see #getParcelableArrayListExtra(String)
7359 */
7360 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7361 if (mExtras == null) {
7362 mExtras = new Bundle();
7363 }
7364 mExtras.putParcelableArrayList(name, value);
7365 return this;
7366 }
7367
7368 /**
7369 * Add extended data to the intent. The name must include a package
7370 * prefix, for example the app com.android.contacts would use names
7371 * like "com.android.contacts.ShowAll".
7372 *
7373 * @param name The name of the extra data, with package prefix.
7374 * @param value The ArrayList<Integer> data value.
7375 *
7376 * @return Returns the same Intent object, for chaining multiple calls
7377 * into a single statement.
7378 *
7379 * @see #putExtras
7380 * @see #removeExtra
7381 * @see #getIntegerArrayListExtra(String)
7382 */
7383 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7384 if (mExtras == null) {
7385 mExtras = new Bundle();
7386 }
7387 mExtras.putIntegerArrayList(name, value);
7388 return this;
7389 }
7390
7391 /**
7392 * Add extended data to the intent. The name must include a package
7393 * prefix, for example the app com.android.contacts would use names
7394 * like "com.android.contacts.ShowAll".
7395 *
7396 * @param name The name of the extra data, with package prefix.
7397 * @param value The ArrayList<String> data value.
7398 *
7399 * @return Returns the same Intent object, for chaining multiple calls
7400 * into a single statement.
7401 *
7402 * @see #putExtras
7403 * @see #removeExtra
7404 * @see #getStringArrayListExtra(String)
7405 */
7406 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7407 if (mExtras == null) {
7408 mExtras = new Bundle();
7409 }
7410 mExtras.putStringArrayList(name, value);
7411 return this;
7412 }
7413
7414 /**
7415 * Add extended data to the intent. The name must include a package
7416 * prefix, for example the app com.android.contacts would use names
7417 * like "com.android.contacts.ShowAll".
7418 *
7419 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007420 * @param value The ArrayList<CharSequence> data value.
7421 *
7422 * @return Returns the same Intent object, for chaining multiple calls
7423 * into a single statement.
7424 *
7425 * @see #putExtras
7426 * @see #removeExtra
7427 * @see #getCharSequenceArrayListExtra(String)
7428 */
7429 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7430 if (mExtras == null) {
7431 mExtras = new Bundle();
7432 }
7433 mExtras.putCharSequenceArrayList(name, value);
7434 return this;
7435 }
7436
7437 /**
7438 * Add extended data to the intent. The name must include a package
7439 * prefix, for example the app com.android.contacts would use names
7440 * like "com.android.contacts.ShowAll".
7441 *
7442 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007443 * @param value The Serializable data value.
7444 *
7445 * @return Returns the same Intent object, for chaining multiple calls
7446 * into a single statement.
7447 *
7448 * @see #putExtras
7449 * @see #removeExtra
7450 * @see #getSerializableExtra(String)
7451 */
7452 public Intent putExtra(String name, Serializable value) {
7453 if (mExtras == null) {
7454 mExtras = new Bundle();
7455 }
7456 mExtras.putSerializable(name, value);
7457 return this;
7458 }
7459
7460 /**
7461 * Add extended data to the intent. The name must include a package
7462 * prefix, for example the app com.android.contacts would use names
7463 * like "com.android.contacts.ShowAll".
7464 *
7465 * @param name The name of the extra data, with package prefix.
7466 * @param value The boolean array data value.
7467 *
7468 * @return Returns the same Intent object, for chaining multiple calls
7469 * into a single statement.
7470 *
7471 * @see #putExtras
7472 * @see #removeExtra
7473 * @see #getBooleanArrayExtra(String)
7474 */
7475 public Intent putExtra(String name, boolean[] value) {
7476 if (mExtras == null) {
7477 mExtras = new Bundle();
7478 }
7479 mExtras.putBooleanArray(name, value);
7480 return this;
7481 }
7482
7483 /**
7484 * Add extended data to the intent. The name must include a package
7485 * prefix, for example the app com.android.contacts would use names
7486 * like "com.android.contacts.ShowAll".
7487 *
7488 * @param name The name of the extra data, with package prefix.
7489 * @param value The byte array data value.
7490 *
7491 * @return Returns the same Intent object, for chaining multiple calls
7492 * into a single statement.
7493 *
7494 * @see #putExtras
7495 * @see #removeExtra
7496 * @see #getByteArrayExtra(String)
7497 */
7498 public Intent putExtra(String name, byte[] value) {
7499 if (mExtras == null) {
7500 mExtras = new Bundle();
7501 }
7502 mExtras.putByteArray(name, value);
7503 return this;
7504 }
7505
7506 /**
7507 * Add extended data to the intent. The name must include a package
7508 * prefix, for example the app com.android.contacts would use names
7509 * like "com.android.contacts.ShowAll".
7510 *
7511 * @param name The name of the extra data, with package prefix.
7512 * @param value The short array data value.
7513 *
7514 * @return Returns the same Intent object, for chaining multiple calls
7515 * into a single statement.
7516 *
7517 * @see #putExtras
7518 * @see #removeExtra
7519 * @see #getShortArrayExtra(String)
7520 */
7521 public Intent putExtra(String name, short[] value) {
7522 if (mExtras == null) {
7523 mExtras = new Bundle();
7524 }
7525 mExtras.putShortArray(name, value);
7526 return this;
7527 }
7528
7529 /**
7530 * Add extended data to the intent. The name must include a package
7531 * prefix, for example the app com.android.contacts would use names
7532 * like "com.android.contacts.ShowAll".
7533 *
7534 * @param name The name of the extra data, with package prefix.
7535 * @param value The char array data value.
7536 *
7537 * @return Returns the same Intent object, for chaining multiple calls
7538 * into a single statement.
7539 *
7540 * @see #putExtras
7541 * @see #removeExtra
7542 * @see #getCharArrayExtra(String)
7543 */
7544 public Intent putExtra(String name, char[] value) {
7545 if (mExtras == null) {
7546 mExtras = new Bundle();
7547 }
7548 mExtras.putCharArray(name, value);
7549 return this;
7550 }
7551
7552 /**
7553 * Add extended data to the intent. The name must include a package
7554 * prefix, for example the app com.android.contacts would use names
7555 * like "com.android.contacts.ShowAll".
7556 *
7557 * @param name The name of the extra data, with package prefix.
7558 * @param value The int array data value.
7559 *
7560 * @return Returns the same Intent object, for chaining multiple calls
7561 * into a single statement.
7562 *
7563 * @see #putExtras
7564 * @see #removeExtra
7565 * @see #getIntArrayExtra(String)
7566 */
7567 public Intent putExtra(String name, int[] value) {
7568 if (mExtras == null) {
7569 mExtras = new Bundle();
7570 }
7571 mExtras.putIntArray(name, value);
7572 return this;
7573 }
7574
7575 /**
7576 * Add extended data to the intent. The name must include a package
7577 * prefix, for example the app com.android.contacts would use names
7578 * like "com.android.contacts.ShowAll".
7579 *
7580 * @param name The name of the extra data, with package prefix.
7581 * @param value The byte array data value.
7582 *
7583 * @return Returns the same Intent object, for chaining multiple calls
7584 * into a single statement.
7585 *
7586 * @see #putExtras
7587 * @see #removeExtra
7588 * @see #getLongArrayExtra(String)
7589 */
7590 public Intent putExtra(String name, long[] value) {
7591 if (mExtras == null) {
7592 mExtras = new Bundle();
7593 }
7594 mExtras.putLongArray(name, value);
7595 return this;
7596 }
7597
7598 /**
7599 * Add extended data to the intent. The name must include a package
7600 * prefix, for example the app com.android.contacts would use names
7601 * like "com.android.contacts.ShowAll".
7602 *
7603 * @param name The name of the extra data, with package prefix.
7604 * @param value The float array data value.
7605 *
7606 * @return Returns the same Intent object, for chaining multiple calls
7607 * into a single statement.
7608 *
7609 * @see #putExtras
7610 * @see #removeExtra
7611 * @see #getFloatArrayExtra(String)
7612 */
7613 public Intent putExtra(String name, float[] value) {
7614 if (mExtras == null) {
7615 mExtras = new Bundle();
7616 }
7617 mExtras.putFloatArray(name, value);
7618 return this;
7619 }
7620
7621 /**
7622 * Add extended data to the intent. The name must include a package
7623 * prefix, for example the app com.android.contacts would use names
7624 * like "com.android.contacts.ShowAll".
7625 *
7626 * @param name The name of the extra data, with package prefix.
7627 * @param value The double array data value.
7628 *
7629 * @return Returns the same Intent object, for chaining multiple calls
7630 * into a single statement.
7631 *
7632 * @see #putExtras
7633 * @see #removeExtra
7634 * @see #getDoubleArrayExtra(String)
7635 */
7636 public Intent putExtra(String name, double[] value) {
7637 if (mExtras == null) {
7638 mExtras = new Bundle();
7639 }
7640 mExtras.putDoubleArray(name, value);
7641 return this;
7642 }
7643
7644 /**
7645 * Add extended data to the intent. The name must include a package
7646 * prefix, for example the app com.android.contacts would use names
7647 * like "com.android.contacts.ShowAll".
7648 *
7649 * @param name The name of the extra data, with package prefix.
7650 * @param value The String array data value.
7651 *
7652 * @return Returns the same Intent object, for chaining multiple calls
7653 * into a single statement.
7654 *
7655 * @see #putExtras
7656 * @see #removeExtra
7657 * @see #getStringArrayExtra(String)
7658 */
7659 public Intent putExtra(String name, String[] value) {
7660 if (mExtras == null) {
7661 mExtras = new Bundle();
7662 }
7663 mExtras.putStringArray(name, value);
7664 return this;
7665 }
7666
7667 /**
7668 * Add extended data to the intent. The name must include a package
7669 * prefix, for example the app com.android.contacts would use names
7670 * like "com.android.contacts.ShowAll".
7671 *
7672 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007673 * @param value The CharSequence array data value.
7674 *
7675 * @return Returns the same Intent object, for chaining multiple calls
7676 * into a single statement.
7677 *
7678 * @see #putExtras
7679 * @see #removeExtra
7680 * @see #getCharSequenceArrayExtra(String)
7681 */
7682 public Intent putExtra(String name, CharSequence[] value) {
7683 if (mExtras == null) {
7684 mExtras = new Bundle();
7685 }
7686 mExtras.putCharSequenceArray(name, value);
7687 return this;
7688 }
7689
7690 /**
7691 * Add extended data to the intent. The name must include a package
7692 * prefix, for example the app com.android.contacts would use names
7693 * like "com.android.contacts.ShowAll".
7694 *
7695 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007696 * @param value The Bundle data value.
7697 *
7698 * @return Returns the same Intent object, for chaining multiple calls
7699 * into a single statement.
7700 *
7701 * @see #putExtras
7702 * @see #removeExtra
7703 * @see #getBundleExtra(String)
7704 */
7705 public Intent putExtra(String name, Bundle value) {
7706 if (mExtras == null) {
7707 mExtras = new Bundle();
7708 }
7709 mExtras.putBundle(name, value);
7710 return this;
7711 }
7712
7713 /**
7714 * Add extended data to the intent. The name must include a package
7715 * prefix, for example the app com.android.contacts would use names
7716 * like "com.android.contacts.ShowAll".
7717 *
7718 * @param name The name of the extra data, with package prefix.
7719 * @param value The IBinder data value.
7720 *
7721 * @return Returns the same Intent object, for chaining multiple calls
7722 * into a single statement.
7723 *
7724 * @see #putExtras
7725 * @see #removeExtra
7726 * @see #getIBinderExtra(String)
7727 *
7728 * @deprecated
7729 * @hide
7730 */
7731 @Deprecated
7732 public Intent putExtra(String name, IBinder value) {
7733 if (mExtras == null) {
7734 mExtras = new Bundle();
7735 }
7736 mExtras.putIBinder(name, value);
7737 return this;
7738 }
7739
7740 /**
7741 * Copy all extras in 'src' in to this intent.
7742 *
7743 * @param src Contains the extras to copy.
7744 *
7745 * @see #putExtra
7746 */
7747 public Intent putExtras(Intent src) {
7748 if (src.mExtras != null) {
7749 if (mExtras == null) {
7750 mExtras = new Bundle(src.mExtras);
7751 } else {
7752 mExtras.putAll(src.mExtras);
7753 }
7754 }
7755 return this;
7756 }
7757
7758 /**
7759 * Add a set of extended data to the intent. The keys must include a package
7760 * prefix, for example the app com.android.contacts would use names
7761 * like "com.android.contacts.ShowAll".
7762 *
7763 * @param extras The Bundle of extras to add to this intent.
7764 *
7765 * @see #putExtra
7766 * @see #removeExtra
7767 */
7768 public Intent putExtras(Bundle extras) {
7769 if (mExtras == null) {
7770 mExtras = new Bundle();
7771 }
7772 mExtras.putAll(extras);
7773 return this;
7774 }
7775
7776 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007777 * Completely replace the extras in the Intent with the extras in the
7778 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007779 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007780 * @param src The exact extras contained in this Intent are copied
7781 * into the target intent, replacing any that were previously there.
7782 */
7783 public Intent replaceExtras(Intent src) {
7784 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7785 return this;
7786 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007787
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007788 /**
7789 * Completely replace the extras in the Intent with the given Bundle of
7790 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007791 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007792 * @param extras The new set of extras in the Intent, or null to erase
7793 * all extras.
7794 */
7795 public Intent replaceExtras(Bundle extras) {
7796 mExtras = extras != null ? new Bundle(extras) : 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 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007801 * Remove extended data from the intent.
7802 *
7803 * @see #putExtra
7804 */
7805 public void removeExtra(String name) {
7806 if (mExtras != null) {
7807 mExtras.remove(name);
7808 if (mExtras.size() == 0) {
7809 mExtras = null;
7810 }
7811 }
7812 }
7813
7814 /**
7815 * Set special flags controlling how this intent is handled. Most values
7816 * here depend on the type of component being executed by the Intent,
7817 * specifically the FLAG_ACTIVITY_* flags are all for use with
7818 * {@link Context#startActivity Context.startActivity()} and the
7819 * FLAG_RECEIVER_* flags are all for use with
7820 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7821 *
Scott Main7aee61f2011-02-08 11:25:01 -08007822 * <p>See the
7823 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7824 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007825 * the behavior of your application.
7826 *
7827 * @param flags The desired flags.
7828 *
7829 * @return Returns the same Intent object, for chaining multiple calls
7830 * into a single statement.
7831 *
7832 * @see #getFlags
7833 * @see #addFlags
7834 *
7835 * @see #FLAG_GRANT_READ_URI_PERMISSION
7836 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007837 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7838 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007839 * @see #FLAG_DEBUG_LOG_RESOLUTION
7840 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007841 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007842 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007843 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007844 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007845 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7846 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007847 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007848 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007849 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007850 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007851 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007852 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007853 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007854 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7855 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007856 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007857 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007858 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007859 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7860 */
7861 public Intent setFlags(int flags) {
7862 mFlags = flags;
7863 return this;
7864 }
7865
7866 /**
7867 * Add additional flags to the intent (or with existing flags
7868 * value).
7869 *
7870 * @param flags The new flags to set.
7871 *
7872 * @return Returns the same Intent object, for chaining multiple calls
7873 * into a single statement.
7874 *
7875 * @see #setFlags
7876 */
7877 public Intent addFlags(int flags) {
7878 mFlags |= flags;
7879 return this;
7880 }
7881
7882 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007883 * (Usually optional) Set an explicit application package name that limits
7884 * the components this Intent will resolve to. If left to the default
7885 * value of null, all components in all applications will considered.
7886 * If non-null, the Intent can only match the components in the given
7887 * application package.
7888 *
7889 * @param packageName The name of the application package to handle the
7890 * intent, or null to allow any application package.
7891 *
7892 * @return Returns the same Intent object, for chaining multiple calls
7893 * into a single statement.
7894 *
7895 * @see #getPackage
7896 * @see #resolveActivity
7897 */
7898 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007899 if (packageName != null && mSelector != null) {
7900 throw new IllegalArgumentException(
7901 "Can't set package name when selector is already set");
7902 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007903 mPackage = packageName;
7904 return this;
7905 }
7906
7907 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007908 * (Usually optional) Explicitly set the component to handle the intent.
7909 * If left with the default value of null, the system will determine the
7910 * appropriate class to use based on the other fields (action, data,
7911 * type, categories) in the Intent. If this class is defined, the
7912 * specified class will always be used regardless of the other fields. You
7913 * should only set this value when you know you absolutely want a specific
7914 * class to be used; otherwise it is better to let the system find the
7915 * appropriate class so that you will respect the installed applications
7916 * and user preferences.
7917 *
7918 * @param component The name of the application component to handle the
7919 * intent, or null to let the system find one for you.
7920 *
7921 * @return Returns the same Intent object, for chaining multiple calls
7922 * into a single statement.
7923 *
7924 * @see #setClass
7925 * @see #setClassName(Context, String)
7926 * @see #setClassName(String, String)
7927 * @see #getComponent
7928 * @see #resolveActivity
7929 */
7930 public Intent setComponent(ComponentName component) {
7931 mComponent = component;
7932 return this;
7933 }
7934
7935 /**
7936 * Convenience for calling {@link #setComponent} with an
7937 * explicit class name.
7938 *
7939 * @param packageContext A Context of the application package implementing
7940 * this class.
7941 * @param className The name of a class inside of the application package
7942 * that will be used as the component for this Intent.
7943 *
7944 * @return Returns the same Intent object, for chaining multiple calls
7945 * into a single statement.
7946 *
7947 * @see #setComponent
7948 * @see #setClass
7949 */
7950 public Intent setClassName(Context packageContext, String className) {
7951 mComponent = new ComponentName(packageContext, className);
7952 return this;
7953 }
7954
7955 /**
7956 * Convenience for calling {@link #setComponent} with an
7957 * explicit application package name and class name.
7958 *
7959 * @param packageName The name of the package implementing the desired
7960 * component.
7961 * @param className The name of a class inside of the application package
7962 * that will be used as the component for this Intent.
7963 *
7964 * @return Returns the same Intent object, for chaining multiple calls
7965 * into a single statement.
7966 *
7967 * @see #setComponent
7968 * @see #setClass
7969 */
7970 public Intent setClassName(String packageName, String className) {
7971 mComponent = new ComponentName(packageName, className);
7972 return this;
7973 }
7974
7975 /**
7976 * Convenience for calling {@link #setComponent(ComponentName)} with the
7977 * name returned by a {@link Class} object.
7978 *
7979 * @param packageContext A Context of the application package implementing
7980 * this class.
7981 * @param cls The class name to set, equivalent to
7982 * <code>setClassName(context, cls.getName())</code>.
7983 *
7984 * @return Returns the same Intent object, for chaining multiple calls
7985 * into a single statement.
7986 *
7987 * @see #setComponent
7988 */
7989 public Intent setClass(Context packageContext, Class<?> cls) {
7990 mComponent = new ComponentName(packageContext, cls);
7991 return this;
7992 }
7993
7994 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007995 * Set the bounds of the sender of this intent, in screen coordinates. This can be
7996 * used as a hint to the receiver for animations and the like. Null means that there
7997 * is no source bounds.
7998 */
7999 public void setSourceBounds(Rect r) {
8000 if (r != null) {
8001 mSourceBounds = new Rect(r);
8002 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008003 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008004 }
8005 }
8006
Tor Norbyed9273d62013-05-30 15:59:53 -07008007 /** @hide */
8008 @IntDef(flag = true,
8009 value = {
8010 FILL_IN_ACTION,
8011 FILL_IN_DATA,
8012 FILL_IN_CATEGORIES,
8013 FILL_IN_COMPONENT,
8014 FILL_IN_PACKAGE,
8015 FILL_IN_SOURCE_BOUNDS,
8016 FILL_IN_SELECTOR,
8017 FILL_IN_CLIP_DATA
8018 })
8019 @Retention(RetentionPolicy.SOURCE)
8020 public @interface FillInFlags {}
8021
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008022 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008023 * Use with {@link #fillIn} to allow the current action value to be
8024 * overwritten, even if it is already set.
8025 */
8026 public static final int FILL_IN_ACTION = 1<<0;
8027
8028 /**
8029 * Use with {@link #fillIn} to allow the current data or type value
8030 * overwritten, even if it is already set.
8031 */
8032 public static final int FILL_IN_DATA = 1<<1;
8033
8034 /**
8035 * Use with {@link #fillIn} to allow the current categories to be
8036 * overwritten, even if they are already set.
8037 */
8038 public static final int FILL_IN_CATEGORIES = 1<<2;
8039
8040 /**
8041 * Use with {@link #fillIn} to allow the current component value to be
8042 * overwritten, even if it is already set.
8043 */
8044 public static final int FILL_IN_COMPONENT = 1<<3;
8045
8046 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008047 * Use with {@link #fillIn} to allow the current package value to be
8048 * overwritten, even if it is already set.
8049 */
8050 public static final int FILL_IN_PACKAGE = 1<<4;
8051
8052 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008053 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008054 * overwritten, even if it is already set.
8055 */
8056 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8057
8058 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008059 * Use with {@link #fillIn} to allow the current selector to be
8060 * overwritten, even if it is already set.
8061 */
8062 public static final int FILL_IN_SELECTOR = 1<<6;
8063
8064 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008065 * Use with {@link #fillIn} to allow the current ClipData to be
8066 * overwritten, even if it is already set.
8067 */
8068 public static final int FILL_IN_CLIP_DATA = 1<<7;
8069
8070 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008071 * Copy the contents of <var>other</var> in to this object, but only
8072 * where fields are not defined by this object. For purposes of a field
8073 * being defined, the following pieces of data in the Intent are
8074 * considered to be separate fields:
8075 *
8076 * <ul>
8077 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008078 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008079 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8080 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008081 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008082 * <li> component, as set by {@link #setComponent(ComponentName)} or
8083 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008084 * <li> source bounds, as set by {@link #setSourceBounds}.
8085 * <li> selector, as set by {@link #setSelector(Intent)}.
8086 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008087 * <li> each top-level name in the associated extras.
8088 * </ul>
8089 *
8090 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008091 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008092 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8093 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8094 * the restriction where the corresponding field will not be replaced if
8095 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008096 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008097 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8098 * is explicitly specified. The selector will only be copied if
8099 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008100 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008101 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8102 * and Intent B with {action="gotit", data-type="some/thing",
8103 * categories="one","two"}.
8104 *
8105 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8106 * containing: {action="gotit", data-type="some/thing",
8107 * categories="bar"}.
8108 *
8109 * @param other Another Intent whose values are to be used to fill in
8110 * the current one.
8111 * @param flags Options to control which fields can be filled in.
8112 *
8113 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008114 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008115 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8116 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8117 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008118 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008119 @FillInFlags
8120 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008121 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008122 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008123 if (other.mAction != null
8124 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008125 mAction = other.mAction;
8126 changes |= FILL_IN_ACTION;
8127 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008128 if ((other.mData != null || other.mType != null)
8129 && ((mData == null && mType == null)
8130 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008131 mData = other.mData;
8132 mType = other.mType;
8133 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008134 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008135 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008136 if (other.mCategories != null
8137 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008138 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008139 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008140 }
8141 changes |= FILL_IN_CATEGORIES;
8142 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008143 if (other.mPackage != null
8144 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008145 // Only do this if mSelector is not set.
8146 if (mSelector == null) {
8147 mPackage = other.mPackage;
8148 changes |= FILL_IN_PACKAGE;
8149 }
8150 }
8151 // Selector is special: it can only be set if explicitly allowed,
8152 // for the same reason as the component name.
8153 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8154 if (mPackage == null) {
8155 mSelector = new Intent(other.mSelector);
8156 mPackage = null;
8157 changes |= FILL_IN_SELECTOR;
8158 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008159 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008160 if (other.mClipData != null
8161 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8162 mClipData = other.mClipData;
8163 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008164 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008165 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008166 // Component is special: it can -only- be set if explicitly allowed,
8167 // since otherwise the sender could force the intent somewhere the
8168 // originator didn't intend.
8169 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008170 mComponent = other.mComponent;
8171 changes |= FILL_IN_COMPONENT;
8172 }
8173 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008174 if (other.mSourceBounds != null
8175 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8176 mSourceBounds = new Rect(other.mSourceBounds);
8177 changes |= FILL_IN_SOURCE_BOUNDS;
8178 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008179 if (mExtras == null) {
8180 if (other.mExtras != null) {
8181 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008182 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008183 }
8184 } else if (other.mExtras != null) {
8185 try {
8186 Bundle newb = new Bundle(other.mExtras);
8187 newb.putAll(mExtras);
8188 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008189 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008190 } catch (RuntimeException e) {
8191 // Modifying the extras can cause us to unparcel the contents
8192 // of the bundle, and if we do this in the system process that
8193 // may fail. We really should handle this (i.e., the Bundle
8194 // impl shouldn't be on top of a plain map), but for now just
8195 // ignore it and keep the original contents. :(
8196 Log.w("Intent", "Failure filling in extras", e);
8197 }
8198 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008199 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8200 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8201 mContentUserHint = other.mContentUserHint;
8202 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008203 return changes;
8204 }
8205
8206 /**
8207 * Wrapper class holding an Intent and implementing comparisons on it for
8208 * the purpose of filtering. The class implements its
8209 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8210 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8211 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8212 * on the wrapped Intent.
8213 */
8214 public static final class FilterComparison {
8215 private final Intent mIntent;
8216 private final int mHashCode;
8217
8218 public FilterComparison(Intent intent) {
8219 mIntent = intent;
8220 mHashCode = intent.filterHashCode();
8221 }
8222
8223 /**
8224 * Return the Intent that this FilterComparison represents.
8225 * @return Returns the Intent held by the FilterComparison. Do
8226 * not modify!
8227 */
8228 public Intent getIntent() {
8229 return mIntent;
8230 }
8231
8232 @Override
8233 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008234 if (obj instanceof FilterComparison) {
8235 Intent other = ((FilterComparison)obj).mIntent;
8236 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008237 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008238 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008239 }
8240
8241 @Override
8242 public int hashCode() {
8243 return mHashCode;
8244 }
8245 }
8246
8247 /**
8248 * Determine if two intents are the same for the purposes of intent
8249 * resolution (filtering). That is, if their action, data, type,
8250 * class, and categories are the same. This does <em>not</em> compare
8251 * any extra data included in the intents.
8252 *
8253 * @param other The other Intent to compare against.
8254 *
8255 * @return Returns true if action, data, type, class, and categories
8256 * are the same.
8257 */
8258 public boolean filterEquals(Intent other) {
8259 if (other == null) {
8260 return false;
8261 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008262 if (!Objects.equals(this.mAction, other.mAction)) return false;
8263 if (!Objects.equals(this.mData, other.mData)) return false;
8264 if (!Objects.equals(this.mType, other.mType)) return false;
8265 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8266 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8267 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008268
8269 return true;
8270 }
8271
8272 /**
8273 * Generate hash code that matches semantics of filterEquals().
8274 *
8275 * @return Returns the hash value of the action, data, type, class, and
8276 * categories.
8277 *
8278 * @see #filterEquals
8279 */
8280 public int filterHashCode() {
8281 int code = 0;
8282 if (mAction != null) {
8283 code += mAction.hashCode();
8284 }
8285 if (mData != null) {
8286 code += mData.hashCode();
8287 }
8288 if (mType != null) {
8289 code += mType.hashCode();
8290 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008291 if (mPackage != null) {
8292 code += mPackage.hashCode();
8293 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008294 if (mComponent != null) {
8295 code += mComponent.hashCode();
8296 }
8297 if (mCategories != null) {
8298 code += mCategories.hashCode();
8299 }
8300 return code;
8301 }
8302
8303 @Override
8304 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008305 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008306
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008307 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008308 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008309 b.append(" }");
8310
8311 return b.toString();
8312 }
8313
8314 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008315 public String toInsecureString() {
8316 StringBuilder b = new StringBuilder(128);
8317
8318 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008319 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008320 b.append(" }");
8321
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008322 return b.toString();
8323 }
Romain Guy4969af72009-06-17 10:53:19 -07008324
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008325 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008326 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008327 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008328
8329 b.append("Intent { ");
8330 toShortString(b, false, true, true, true);
8331 b.append(" }");
8332
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008333 return b.toString();
8334 }
8335
8336 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008337 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8338 StringBuilder b = new StringBuilder(128);
8339 toShortString(b, secure, comp, extras, clip);
8340 return b.toString();
8341 }
8342
8343 /** @hide */
8344 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8345 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008346 boolean first = true;
8347 if (mAction != null) {
8348 b.append("act=").append(mAction);
8349 first = false;
8350 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008351 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008352 if (!first) {
8353 b.append(' ');
8354 }
8355 first = false;
8356 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008357 for (int i=0; i<mCategories.size(); i++) {
8358 if (i > 0) b.append(',');
8359 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008360 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008361 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008362 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008363 if (mData != null) {
8364 if (!first) {
8365 b.append(' ');
8366 }
8367 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008368 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008369 if (secure) {
8370 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008371 } else {
8372 b.append(mData);
8373 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008374 }
8375 if (mType != null) {
8376 if (!first) {
8377 b.append(' ');
8378 }
8379 first = false;
8380 b.append("typ=").append(mType);
8381 }
8382 if (mFlags != 0) {
8383 if (!first) {
8384 b.append(' ');
8385 }
8386 first = false;
8387 b.append("flg=0x").append(Integer.toHexString(mFlags));
8388 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008389 if (mPackage != null) {
8390 if (!first) {
8391 b.append(' ');
8392 }
8393 first = false;
8394 b.append("pkg=").append(mPackage);
8395 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008396 if (comp && mComponent != null) {
8397 if (!first) {
8398 b.append(' ');
8399 }
8400 first = false;
8401 b.append("cmp=").append(mComponent.flattenToShortString());
8402 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008403 if (mSourceBounds != null) {
8404 if (!first) {
8405 b.append(' ');
8406 }
8407 first = false;
8408 b.append("bnds=").append(mSourceBounds.toShortString());
8409 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008410 if (mClipData != null) {
8411 if (!first) {
8412 b.append(' ');
8413 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008414 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008415 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008416 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008417 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008418 if (mClipData.getDescription() != null) {
8419 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8420 } else {
8421 first = true;
8422 }
8423 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008424 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008425 first = false;
8426 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008427 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008428 if (extras && mExtras != null) {
8429 if (!first) {
8430 b.append(' ');
8431 }
8432 first = false;
8433 b.append("(has extras)");
8434 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008435 if (mContentUserHint != UserHandle.USER_CURRENT) {
8436 if (!first) {
8437 b.append(' ');
8438 }
8439 first = false;
8440 b.append("u=").append(mContentUserHint);
8441 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008442 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008443 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008444 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008445 b.append("}");
8446 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008447 }
8448
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008449 /**
8450 * Call {@link #toUri} with 0 flags.
8451 * @deprecated Use {@link #toUri} instead.
8452 */
8453 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008454 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008455 return toUri(0);
8456 }
8457
8458 /**
8459 * Convert this Intent into a String holding a URI representation of it.
8460 * The returned URI string has been properly URI encoded, so it can be
8461 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8462 * Intent's data as the base URI, with an additional fragment describing
8463 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008464 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008465 * <p>You can convert the returned string back to an Intent with
8466 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008467 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008468 * @param flags Additional operating flags. Either 0,
8469 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008470 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008471 * @return Returns a URI encoding URI string describing the entire contents
8472 * of the Intent.
8473 */
8474 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008475 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008476 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8477 if (mPackage == null) {
8478 throw new IllegalArgumentException(
8479 "Intent must include an explicit package name to build an android-app: "
8480 + this);
8481 }
8482 uri.append("android-app://");
8483 uri.append(mPackage);
8484 String scheme = null;
8485 if (mData != null) {
8486 scheme = mData.getScheme();
8487 if (scheme != null) {
8488 uri.append('/');
8489 uri.append(scheme);
8490 String authority = mData.getEncodedAuthority();
8491 if (authority != null) {
8492 uri.append('/');
8493 uri.append(authority);
8494 String path = mData.getEncodedPath();
8495 if (path != null) {
8496 uri.append(path);
8497 }
8498 String queryParams = mData.getEncodedQuery();
8499 if (queryParams != null) {
8500 uri.append('?');
8501 uri.append(queryParams);
8502 }
8503 String fragment = mData.getEncodedFragment();
8504 if (fragment != null) {
8505 uri.append('#');
8506 uri.append(fragment);
8507 }
8508 }
8509 }
8510 }
8511 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8512 mPackage, flags);
8513 return uri.toString();
8514 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008515 String scheme = null;
8516 if (mData != null) {
8517 String data = mData.toString();
8518 if ((flags&URI_INTENT_SCHEME) != 0) {
8519 final int N = data.length();
8520 for (int i=0; i<N; i++) {
8521 char c = data.charAt(i);
8522 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8523 || c == '.' || c == '-') {
8524 continue;
8525 }
8526 if (c == ':' && i > 0) {
8527 // Valid scheme.
8528 scheme = data.substring(0, i);
8529 uri.append("intent:");
8530 data = data.substring(i+1);
8531 break;
8532 }
Tom Taylord4a47292009-12-21 13:59:18 -08008533
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008534 // No scheme.
8535 break;
8536 }
8537 }
8538 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008539
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008540 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8541 uri.append("intent:");
8542 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008543
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008544 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008545
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008546 return uri.toString();
8547 }
8548
8549 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8550 String defPackage, int flags) {
8551 StringBuilder frag = new StringBuilder(128);
8552
8553 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008554 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008555 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008556 // Note that for now we are not going to try to handle the
8557 // data part; not clear how to represent this as a URI, and
8558 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008559 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8560 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008561 }
8562
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008563 if (frag.length() > 0) {
8564 uri.append("#Intent;");
8565 uri.append(frag);
8566 uri.append("end");
8567 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008568 }
8569
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008570 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8571 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008572 if (scheme != null) {
8573 uri.append("scheme=").append(scheme).append(';');
8574 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008575 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008576 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008577 }
8578 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008579 for (int i=0; i<mCategories.size(); i++) {
8580 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008581 }
8582 }
8583 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008584 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008585 }
8586 if (mFlags != 0) {
8587 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8588 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008589 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008590 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8591 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008592 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008593 uri.append("component=").append(Uri.encode(
8594 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008595 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008596 if (mSourceBounds != null) {
8597 uri.append("sourceBounds=")
8598 .append(Uri.encode(mSourceBounds.flattenToString()))
8599 .append(';');
8600 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008601 if (mExtras != null) {
8602 for (String key : mExtras.keySet()) {
8603 final Object value = mExtras.get(key);
8604 char entryType =
8605 value instanceof String ? 'S' :
8606 value instanceof Boolean ? 'B' :
8607 value instanceof Byte ? 'b' :
8608 value instanceof Character ? 'c' :
8609 value instanceof Double ? 'd' :
8610 value instanceof Float ? 'f' :
8611 value instanceof Integer ? 'i' :
8612 value instanceof Long ? 'l' :
8613 value instanceof Short ? 's' :
8614 '\0';
8615
8616 if (entryType != '\0') {
8617 uri.append(entryType);
8618 uri.append('.');
8619 uri.append(Uri.encode(key));
8620 uri.append('=');
8621 uri.append(Uri.encode(value.toString()));
8622 uri.append(';');
8623 }
8624 }
8625 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008626 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008627
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008628 public int describeContents() {
8629 return (mExtras != null) ? mExtras.describeContents() : 0;
8630 }
8631
8632 public void writeToParcel(Parcel out, int flags) {
8633 out.writeString(mAction);
8634 Uri.writeToParcel(out, mData);
8635 out.writeString(mType);
8636 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008637 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008638 ComponentName.writeToParcel(mComponent, out);
8639
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008640 if (mSourceBounds != null) {
8641 out.writeInt(1);
8642 mSourceBounds.writeToParcel(out, flags);
8643 } else {
8644 out.writeInt(0);
8645 }
8646
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008647 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008648 final int N = mCategories.size();
8649 out.writeInt(N);
8650 for (int i=0; i<N; i++) {
8651 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008652 }
8653 } else {
8654 out.writeInt(0);
8655 }
8656
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008657 if (mSelector != null) {
8658 out.writeInt(1);
8659 mSelector.writeToParcel(out, flags);
8660 } else {
8661 out.writeInt(0);
8662 }
8663
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008664 if (mClipData != null) {
8665 out.writeInt(1);
8666 mClipData.writeToParcel(out, flags);
8667 } else {
8668 out.writeInt(0);
8669 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008670 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008671 out.writeBundle(mExtras);
8672 }
8673
8674 public static final Parcelable.Creator<Intent> CREATOR
8675 = new Parcelable.Creator<Intent>() {
8676 public Intent createFromParcel(Parcel in) {
8677 return new Intent(in);
8678 }
8679 public Intent[] newArray(int size) {
8680 return new Intent[size];
8681 }
8682 };
8683
Dianne Hackborneb034652009-09-07 00:49:58 -07008684 /** @hide */
8685 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008686 readFromParcel(in);
8687 }
8688
8689 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008690 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008691 mData = Uri.CREATOR.createFromParcel(in);
8692 mType = in.readString();
8693 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008694 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008695 mComponent = ComponentName.readFromParcel(in);
8696
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008697 if (in.readInt() != 0) {
8698 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8699 }
8700
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008701 int N = in.readInt();
8702 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008703 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008704 int i;
8705 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008706 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008707 }
8708 } else {
8709 mCategories = null;
8710 }
8711
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008712 if (in.readInt() != 0) {
8713 mSelector = new Intent(in);
8714 }
8715
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008716 if (in.readInt() != 0) {
8717 mClipData = new ClipData(in);
8718 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008719 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008720 mExtras = in.readBundle();
8721 }
8722
8723 /**
8724 * Parses the "intent" element (and its children) from XML and instantiates
8725 * an Intent object. The given XML parser should be located at the tag
8726 * where parsing should start (often named "intent"), from which the
8727 * basic action, data, type, and package and class name will be
8728 * retrieved. The function will then parse in to any child elements,
8729 * looking for <category android:name="xxx"> tags to add categories and
8730 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8731 * to the intent.
8732 *
8733 * @param resources The Resources to use when inflating resources.
8734 * @param parser The XML parser pointing at an "intent" tag.
8735 * @param attrs The AttributeSet interface for retrieving extended
8736 * attribute data at the current <var>parser</var> location.
8737 * @return An Intent object matching the XML data.
8738 * @throws XmlPullParserException If there was an XML parsing error.
8739 * @throws IOException If there was an I/O error.
8740 */
8741 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8742 throws XmlPullParserException, IOException {
8743 Intent intent = new Intent();
8744
8745 TypedArray sa = resources.obtainAttributes(attrs,
8746 com.android.internal.R.styleable.Intent);
8747
8748 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8749
8750 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8751 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8752 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8753
8754 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8755 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8756 if (packageName != null && className != null) {
8757 intent.setComponent(new ComponentName(packageName, className));
8758 }
8759
8760 sa.recycle();
8761
8762 int outerDepth = parser.getDepth();
8763 int type;
8764 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8765 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8766 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8767 continue;
8768 }
8769
8770 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008771 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008772 sa = resources.obtainAttributes(attrs,
8773 com.android.internal.R.styleable.IntentCategory);
8774 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8775 sa.recycle();
8776
8777 if (cat != null) {
8778 intent.addCategory(cat);
8779 }
8780 XmlUtils.skipCurrentTag(parser);
8781
Craig Mautner21d24a22014-04-23 11:45:37 -07008782 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008783 if (intent.mExtras == null) {
8784 intent.mExtras = new Bundle();
8785 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008786 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008787 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008788
8789 } else {
8790 XmlUtils.skipCurrentTag(parser);
8791 }
8792 }
8793
8794 return intent;
8795 }
Nick Pellyccae4122012-01-09 14:12:58 -08008796
Craig Mautner21d24a22014-04-23 11:45:37 -07008797 /** @hide */
8798 public void saveToXml(XmlSerializer out) throws IOException {
8799 if (mAction != null) {
8800 out.attribute(null, ATTR_ACTION, mAction);
8801 }
8802 if (mData != null) {
8803 out.attribute(null, ATTR_DATA, mData.toString());
8804 }
8805 if (mType != null) {
8806 out.attribute(null, ATTR_TYPE, mType);
8807 }
8808 if (mComponent != null) {
8809 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8810 }
8811 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8812
8813 if (mCategories != null) {
8814 out.startTag(null, TAG_CATEGORIES);
8815 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8816 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8817 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008818 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008819 }
8820 }
8821
8822 /** @hide */
8823 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8824 XmlPullParserException {
8825 Intent intent = new Intent();
8826 final int outerDepth = in.getDepth();
8827
8828 int attrCount = in.getAttributeCount();
8829 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8830 final String attrName = in.getAttributeName(attrNdx);
8831 final String attrValue = in.getAttributeValue(attrNdx);
8832 if (ATTR_ACTION.equals(attrName)) {
8833 intent.setAction(attrValue);
8834 } else if (ATTR_DATA.equals(attrName)) {
8835 intent.setData(Uri.parse(attrValue));
8836 } else if (ATTR_TYPE.equals(attrName)) {
8837 intent.setType(attrValue);
8838 } else if (ATTR_COMPONENT.equals(attrName)) {
8839 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8840 } else if (ATTR_FLAGS.equals(attrName)) {
8841 intent.setFlags(Integer.valueOf(attrValue, 16));
8842 } else {
8843 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8844 }
8845 }
8846
8847 int event;
8848 String name;
8849 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8850 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8851 if (event == XmlPullParser.START_TAG) {
8852 name = in.getName();
8853 if (TAG_CATEGORIES.equals(name)) {
8854 attrCount = in.getAttributeCount();
8855 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8856 intent.addCategory(in.getAttributeValue(attrNdx));
8857 }
8858 } else {
8859 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8860 XmlUtils.skipCurrentTag(in);
8861 }
8862 }
8863 }
8864
8865 return intent;
8866 }
8867
Nick Pellyccae4122012-01-09 14:12:58 -08008868 /**
8869 * Normalize a MIME data type.
8870 *
8871 * <p>A normalized MIME type has white-space trimmed,
8872 * content-type parameters removed, and is lower-case.
8873 * This aligns the type with Android best practices for
8874 * intent filtering.
8875 *
8876 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8877 * "text/x-vCard" becomes "text/x-vcard".
8878 *
8879 * <p>All MIME types received from outside Android (such as user input,
8880 * or external sources like Bluetooth, NFC, or the Internet) should
8881 * be normalized before they are used to create an Intent.
8882 *
8883 * @param type MIME data type to normalize
8884 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008885 * @see #setType
8886 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008887 */
8888 public static String normalizeMimeType(String type) {
8889 if (type == null) {
8890 return null;
8891 }
8892
Elliott Hughescb64d432013-08-02 10:00:44 -07008893 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008894
8895 final int semicolonIndex = type.indexOf(';');
8896 if (semicolonIndex != -1) {
8897 type = type.substring(0, semicolonIndex);
8898 }
8899 return type;
8900 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008901
8902 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008903 * Prepare this {@link Intent} to leave an app process.
8904 *
8905 * @hide
8906 */
8907 public void prepareToLeaveProcess() {
8908 setAllowFds(false);
8909
8910 if (mSelector != null) {
8911 mSelector.prepareToLeaveProcess();
8912 }
8913 if (mClipData != null) {
8914 mClipData.prepareToLeaveProcess();
8915 }
8916
8917 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
8918 // There are several ACTION_MEDIA_* broadcasts that send file://
8919 // Uris, so only check common actions.
8920 if (ACTION_VIEW.equals(mAction) ||
8921 ACTION_EDIT.equals(mAction) ||
8922 ACTION_ATTACH_DATA.equals(mAction)) {
8923 mData.checkFileUriExposed("Intent.getData()");
8924 }
8925 }
8926 }
8927
8928 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008929 * @hide
8930 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008931 public void prepareToEnterProcess() {
8932 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008933 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8934 fixUris(mContentUserHint);
8935 mContentUserHint = UserHandle.USER_CURRENT;
8936 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008937 }
8938 }
8939
8940 /**
8941 * @hide
8942 */
8943 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008944 Uri data = getData();
8945 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008946 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008947 }
8948 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008949 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008950 }
8951 String action = getAction();
8952 if (ACTION_SEND.equals(action)) {
8953 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8954 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008955 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008956 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008957 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008958 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8959 if (streams != null) {
8960 ArrayList<Uri> newStreams = new ArrayList<Uri>();
8961 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008962 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008963 }
8964 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
8965 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008966 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8967 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8968 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8969 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8970 if (output != null) {
8971 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
8972 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008973 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008974 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008975
8976 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008977 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008978 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
8979 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008980 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008981 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008982 * @hide
8983 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008984 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008985 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008986 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008987
8988 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008989 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008990
8991 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008992 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07008993 // Inspect contained intents to see if we need to migrate extras. We
8994 // don't promote ClipData to the parent, since ChooserActivity will
8995 // already start the picked item as the caller, and we can't combine
8996 // the flags in a safe way.
8997
8998 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07008999 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009000 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9001 if (intent != null) {
9002 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009003 }
9004 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009005 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009006 try {
9007 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9008 if (intents != null) {
9009 for (int i = 0; i < intents.length; i++) {
9010 final Intent intent = (Intent) intents[i];
9011 if (intent != null) {
9012 migrated |= intent.migrateExtraStreamToClipData();
9013 }
9014 }
9015 }
9016 } catch (ClassCastException e) {
9017 }
9018 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009019
9020 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009021 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009022 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9023 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9024 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9025 if (stream != null || text != null || htmlText != null) {
9026 final ClipData clipData = new ClipData(
9027 null, new String[] { getType() },
9028 new ClipData.Item(text, htmlText, null, stream));
9029 setClipData(clipData);
9030 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009031 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009032 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009033 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009034 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009035
9036 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009037 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009038 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9039 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9040 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9041 int num = -1;
9042 if (streams != null) {
9043 num = streams.size();
9044 }
9045 if (texts != null) {
9046 if (num >= 0 && num != texts.size()) {
9047 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009048 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009049 }
9050 num = texts.size();
9051 }
9052 if (htmlTexts != null) {
9053 if (num >= 0 && num != htmlTexts.size()) {
9054 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009055 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009056 }
9057 num = htmlTexts.size();
9058 }
9059 if (num > 0) {
9060 final ClipData clipData = new ClipData(
9061 null, new String[] { getType() },
9062 makeClipItem(streams, texts, htmlTexts, 0));
9063
9064 for (int i = 1; i < num; i++) {
9065 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9066 }
9067
9068 setClipData(clipData);
9069 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009070 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009071 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009072 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009073 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009074 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9075 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9076 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9077 final Uri output;
9078 try {
9079 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9080 } catch (ClassCastException e) {
9081 return false;
9082 }
9083 if (output != null) {
9084 setClipData(ClipData.newRawUri("", output));
9085 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9086 return true;
9087 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009088 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009089
9090 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009091 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009092
9093 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9094 ArrayList<String> htmlTexts, int which) {
9095 Uri uri = streams != null ? streams.get(which) : null;
9096 CharSequence text = texts != null ? texts.get(which) : null;
9097 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9098 return new ClipData.Item(text, htmlText, null, uri);
9099 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009100
9101 /** @hide */
9102 public boolean isDocument() {
9103 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9104 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009105}