blob: f060a1c17d70f800bf8c166b2f914823fed658be [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Tor Norbye7b9c9122013-05-30 16:48:33 -070019import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070020import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070021import android.annotation.SdkConstant;
22import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050023import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070024import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050025import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060026import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.content.pm.PackageManager;
28import android.content.pm.ResolveInfo;
29import android.content.res.Resources;
30import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080031import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060033import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.os.Bundle;
35import android.os.IBinder;
36import android.os.Parcel;
37import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000038import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050039import android.os.ResultReceiver;
40import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070041import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010042import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070043import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070044import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050045import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070046import android.provider.OpenableColumns;
Jason Monk2f68e8a2016-02-23 17:57:28 -050047import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070048import android.util.AttributeSet;
49import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080050import com.android.internal.util.XmlUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050051import org.xmlpull.v1.XmlPullParser;
52import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070053import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054
55import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080056import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070057import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070058import java.lang.annotation.Retention;
59import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070060import java.net.URISyntaxException;
61import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080062import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070063import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080064import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070065import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.util.Set;
67
Jason Monk2f68e8a2016-02-23 17:57:28 -050068import static android.content.ContentProvider.maybeAddUserId;
69
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070070/**
71 * An intent is an abstract description of an operation to be performed. It
72 * can be used with {@link Context#startActivity(Intent) startActivity} to
73 * launch an {@link android.app.Activity},
74 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
75 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
76 * and {@link android.content.Context#startService} or
77 * {@link android.content.Context#bindService} to communicate with a
78 * background {@link android.app.Service}.
79 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070080 * <p>An Intent provides a facility for performing late runtime binding between the code in
81 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070082 * can be thought of as the glue between activities. It is basically a passive data structure
83 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070084 *
85 * <div class="special reference">
86 * <h3>Developer Guides</h3>
87 * <p>For information about how to create and resolve intents, read the
88 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
89 * developer guide.</p>
90 * </div>
91 *
92 * <a name="IntentStructure"></a>
93 * <h3>Intent Structure</h3>
94 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070095 *
96 * <ul>
97 * <li> <p><b>action</b> -- The general action to be performed, such as
98 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
99 * etc.</p>
100 * </li>
101 * <li> <p><b>data</b> -- The data to operate on, such as a person record
102 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
103 * </li>
104 * </ul>
105 *
106 *
107 * <p>Some examples of action/data pairs are:</p>
108 *
109 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700110 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700111 * information about the person whose identifier is "1".</p>
112 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700113 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700114 * the phone dialer with the person filled in.</p>
115 * </li>
116 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
117 * the phone dialer with the given number filled in. Note how the
118 * VIEW action does what what is considered the most reasonable thing for
119 * a particular URI.</p>
120 * </li>
121 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
122 * the phone dialer with the given number filled in.</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * information about the person whose identifier is "1".</p>
126 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700127 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700128 * a list of people, which the user can browse through. This example is a
129 * typical top-level entry into the Contacts application, showing you the
130 * list of people. Selecting a particular person to view would result in a
131 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
132 * being used to start an activity to display that person.</p>
133 * </li>
134 * </ul>
135 *
136 * <p>In addition to these primary attributes, there are a number of secondary
137 * attributes that you can also include with an intent:</p>
138 *
139 * <ul>
140 * <li> <p><b>category</b> -- Gives additional information about the action
141 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
142 * appear in the Launcher as a top-level application, while
143 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
144 * of alternative actions the user can perform on a piece of data.</p>
145 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
146 * intent data. Normally the type is inferred from the data itself.
147 * By setting this attribute, you disable that evaluation and force
148 * an explicit type.</p>
149 * <li> <p><b>component</b> -- Specifies an explicit name of a component
150 * class to use for the intent. Normally this is determined by looking
151 * at the other information in the intent (the action, data/type, and
152 * categories) and matching that with a component that can handle it.
153 * If this attribute is set then none of the evaluation is performed,
154 * and this component is used exactly as is. By specifying this attribute,
155 * all of the other Intent attributes become optional.</p>
156 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
157 * This can be used to provide extended information to the component.
158 * For example, if we have a action to send an e-mail message, we could
159 * also include extra pieces of data here to supply a subject, body,
160 * etc.</p>
161 * </ul>
162 *
163 * <p>Here are some examples of other operations you can specify as intents
164 * using these additional parameters:</p>
165 *
166 * <ul>
167 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
168 * Launch the home screen.</p>
169 * </li>
170 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
171 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
172 * vnd.android.cursor.item/phone}</i></b>
173 * -- Display the list of people's phone numbers, allowing the user to
174 * browse through them and pick one and return it to the parent activity.</p>
175 * </li>
176 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
177 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
178 * -- Display all pickers for data that can be opened with
179 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
180 * allowing the user to pick one of them and then some data inside of it
181 * and returning the resulting URI to the caller. This can be used,
182 * for example, in an e-mail application to allow the user to pick some
183 * data to include as an attachment.</p>
184 * </li>
185 * </ul>
186 *
187 * <p>There are a variety of standard Intent action and category constants
188 * defined in the Intent class, but applications can also define their own.
189 * These strings use java style scoping, to ensure they are unique -- for
190 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700191 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700192 *
193 * <p>Put together, the set of actions, data types, categories, and extra data
194 * defines a language for the system allowing for the expression of phrases
195 * such as "call john smith's cell". As applications are added to the system,
196 * they can extend this language by adding new actions, types, and categories, or
197 * they can modify the behavior of existing phrases by supplying their own
198 * activities that handle them.</p>
199 *
200 * <a name="IntentResolution"></a>
201 * <h3>Intent Resolution</h3>
202 *
203 * <p>There are two primary forms of intents you will use.
204 *
205 * <ul>
206 * <li> <p><b>Explicit Intents</b> have specified a component (via
207 * {@link #setComponent} or {@link #setClass}), which provides the exact
208 * class to be run. Often these will not include any other information,
209 * simply being a way for an application to launch various internal
210 * activities it has as the user interacts with the application.
211 *
212 * <li> <p><b>Implicit Intents</b> have not specified a component;
213 * instead, they must include enough information for the system to
214 * determine which of the available components is best to run for that
215 * intent.
216 * </ul>
217 *
218 * <p>When using implicit intents, given such an arbitrary intent we need to
219 * know what to do with it. This is handled by the process of <em>Intent
220 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
221 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
222 * more activities/receivers) that can handle it.</p>
223 *
224 * <p>The intent resolution mechanism basically revolves around matching an
225 * Intent against all of the &lt;intent-filter&gt; descriptions in the
226 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
227 * objects explicitly registered with {@link Context#registerReceiver}.) More
228 * details on this can be found in the documentation on the {@link
229 * IntentFilter} class.</p>
230 *
231 * <p>There are three pieces of information in the Intent that are used for
232 * resolution: the action, type, and category. Using this information, a query
233 * is done on the {@link PackageManager} for a component that can handle the
234 * intent. The appropriate component is determined based on the intent
235 * information supplied in the <code>AndroidManifest.xml</code> file as
236 * follows:</p>
237 *
238 * <ul>
239 * <li> <p>The <b>action</b>, if given, must be listed by the component as
240 * one it handles.</p>
241 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
242 * already supplied in the Intent. Like the action, if a type is
243 * included in the intent (either explicitly or implicitly in its
244 * data), then this must be listed by the component as one it handles.</p>
245 * <li> For data that is not a <code>content:</code> URI and where no explicit
246 * type is included in the Intent, instead the <b>scheme</b> of the
247 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
248 * considered. Again like the action, if we are matching a scheme it
249 * must be listed by the component as one it can handle.
250 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
251 * by the activity as categories it handles. That is, if you include
252 * the categories {@link #CATEGORY_LAUNCHER} and
253 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
254 * with an intent that lists <em>both</em> of those categories.
255 * Activities will very often need to support the
256 * {@link #CATEGORY_DEFAULT} so that they can be found by
257 * {@link Context#startActivity Context.startActivity()}.</p>
258 * </ul>
259 *
260 * <p>For example, consider the Note Pad sample application that
261 * allows user to browse through a list of notes data and view details about
262 * individual items. Text in italics indicate places were you would replace a
263 * name with one specific to your own package.</p>
264 *
265 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
266 * package="<i>com.android.notepad</i>"&gt;
267 * &lt;application android:icon="@drawable/app_notes"
268 * android:label="@string/app_name"&gt;
269 *
270 * &lt;provider class=".NotePadProvider"
271 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
272 *
273 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
274 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700275 * &lt;action android:name="android.intent.action.MAIN" /&gt;
276 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="android.intent.action.VIEW" /&gt;
280 * &lt;action android:name="android.intent.action.EDIT" /&gt;
281 * &lt;action android:name="android.intent.action.PICK" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700286 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
287 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
288 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700289 * &lt;/intent-filter&gt;
290 * &lt;/activity&gt;
291 *
292 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
293 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700294 * &lt;action android:name="android.intent.action.VIEW" /&gt;
295 * &lt;action android:name="android.intent.action.EDIT" /&gt;
296 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
297 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700298 * &lt;/intent-filter&gt;
299 *
300 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700301 * &lt;action android:name="android.intent.action.INSERT" /&gt;
302 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
303 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700304 * &lt;/intent-filter&gt;
305 *
306 * &lt;/activity&gt;
307 *
308 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
309 * android:theme="@android:style/Theme.Dialog"&gt;
310 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700311 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
312 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
313 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
314 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
315 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700316 * &lt;/intent-filter&gt;
317 * &lt;/activity&gt;
318 *
319 * &lt;/application&gt;
320 * &lt;/manifest&gt;</pre>
321 *
322 * <p>The first activity,
323 * <code>com.android.notepad.NotesList</code>, serves as our main
324 * entry into the app. It can do three things as described by its three intent
325 * templates:
326 * <ol>
327 * <li><pre>
328 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700329 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
330 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700331 * &lt;/intent-filter&gt;</pre>
332 * <p>This provides a top-level entry into the NotePad application: the standard
333 * MAIN action is a main entry point (not requiring any other information in
334 * the Intent), and the LAUNCHER category says that this entry point should be
335 * listed in the application launcher.</p>
336 * <li><pre>
337 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700338 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
339 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
340 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
341 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
342 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700343 * &lt;/intent-filter&gt;</pre>
344 * <p>This declares the things that the activity can do on a directory of
345 * notes. The type being supported is given with the &lt;type&gt; tag, where
346 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
347 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
348 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
349 * The activity allows the user to view or edit the directory of data (via
350 * the VIEW and EDIT actions), or to pick a particular note and return it
351 * to the caller (via the PICK action). Note also the DEFAULT category
352 * supplied here: this is <em>required</em> for the
353 * {@link Context#startActivity Context.startActivity} method to resolve your
354 * activity when its component name is not explicitly specified.</p>
355 * <li><pre>
356 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700357 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
358 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
359 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700360 * &lt;/intent-filter&gt;</pre>
361 * <p>This filter describes the ability return to the caller a note selected by
362 * the user without needing to know where it came from. The data type
363 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
364 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
365 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
366 * The GET_CONTENT action is similar to the PICK action, where the activity
367 * will return to its caller a piece of data selected by the user. Here,
368 * however, the caller specifies the type of data they desire instead of
369 * the type of data the user will be picking from.</p>
370 * </ol>
371 *
372 * <p>Given these capabilities, the following intents will resolve to the
373 * NotesList activity:</p>
374 *
375 * <ul>
376 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
377 * activities that can be used as top-level entry points into an
378 * application.</p>
379 * <li> <p><b>{ action=android.app.action.MAIN,
380 * category=android.app.category.LAUNCHER }</b> is the actual intent
381 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700382 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700383 * data=content://com.google.provider.NotePad/notes }</b>
384 * displays a list of all the notes under
385 * "content://com.google.provider.NotePad/notes", which
386 * the user can browse through and see the details on.</p>
387 * <li> <p><b>{ action=android.app.action.PICK
388 * data=content://com.google.provider.NotePad/notes }</b>
389 * provides a list of the notes under
390 * "content://com.google.provider.NotePad/notes", from which
391 * the user can pick a note whose data URL is returned back to the caller.</p>
392 * <li> <p><b>{ action=android.app.action.GET_CONTENT
393 * type=vnd.android.cursor.item/vnd.google.note }</b>
394 * is similar to the pick action, but allows the caller to specify the
395 * kind of data they want back so that the system can find the appropriate
396 * activity to pick something of that data type.</p>
397 * </ul>
398 *
399 * <p>The second activity,
400 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
401 * note entry and allows them to edit it. It can do two things as described
402 * by its two intent templates:
403 * <ol>
404 * <li><pre>
405 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700406 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
407 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
408 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
409 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700410 * &lt;/intent-filter&gt;</pre>
411 * <p>The first, primary, purpose of this activity is to let the user interact
412 * with a single note, as decribed by the MIME type
413 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
414 * either VIEW a note or allow the user to EDIT it. Again we support the
415 * DEFAULT category to allow the activity to be launched without explicitly
416 * specifying its component.</p>
417 * <li><pre>
418 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700419 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
420 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
421 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700422 * &lt;/intent-filter&gt;</pre>
423 * <p>The secondary use of this activity is to insert a new note entry into
424 * an existing directory of notes. This is used when the user creates a new
425 * note: the INSERT action is executed on the directory of notes, causing
426 * this activity to run and have the user create the new note data which
427 * it then adds to the content provider.</p>
428 * </ol>
429 *
430 * <p>Given these capabilities, the following intents will resolve to the
431 * NoteEditor activity:</p>
432 *
433 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700434 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700435 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
436 * shows the user the content of note <var>{ID}</var>.</p>
437 * <li> <p><b>{ action=android.app.action.EDIT
438 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
439 * allows the user to edit the content of note <var>{ID}</var>.</p>
440 * <li> <p><b>{ action=android.app.action.INSERT
441 * data=content://com.google.provider.NotePad/notes }</b>
442 * creates a new, empty note in the notes list at
443 * "content://com.google.provider.NotePad/notes"
444 * and allows the user to edit it. If they keep their changes, the URI
445 * of the newly created note is returned to the caller.</p>
446 * </ul>
447 *
448 * <p>The last activity,
449 * <code>com.android.notepad.TitleEditor</code>, allows the user to
450 * edit the title of a note. This could be implemented as a class that the
451 * application directly invokes (by explicitly setting its component in
452 * the Intent), but here we show a way you can publish alternative
453 * operations on existing data:</p>
454 *
455 * <pre>
456 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700457 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
458 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
459 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
460 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
461 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700462 * &lt;/intent-filter&gt;</pre>
463 *
464 * <p>In the single intent template here, we
465 * have created our own private action called
466 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
467 * edit the title of a note. It must be invoked on a specific note
468 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
469 * view and edit actions, but here displays and edits the title contained
470 * in the note data.
471 *
472 * <p>In addition to supporting the default category as usual, our title editor
473 * also supports two other standard categories: ALTERNATIVE and
474 * SELECTED_ALTERNATIVE. Implementing
475 * these categories allows others to find the special action it provides
476 * without directly knowing about it, through the
477 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
478 * more often to build dynamic menu items with
479 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
480 * template here was also supply an explicit name for the template
481 * (via <code>android:label="@string/resolve_title"</code>) to better control
482 * what the user sees when presented with this activity as an alternative
483 * action to the data they are viewing.
484 *
485 * <p>Given these capabilities, the following intent will resolve to the
486 * TitleEditor activity:</p>
487 *
488 * <ul>
489 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
490 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
491 * displays and allows the user to edit the title associated
492 * with note <var>{ID}</var>.</p>
493 * </ul>
494 *
495 * <h3>Standard Activity Actions</h3>
496 *
497 * <p>These are the current standard actions that Intent defines for launching
498 * activities (usually through {@link Context#startActivity}. The most
499 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
500 * {@link #ACTION_EDIT}.
501 *
502 * <ul>
503 * <li> {@link #ACTION_MAIN}
504 * <li> {@link #ACTION_VIEW}
505 * <li> {@link #ACTION_ATTACH_DATA}
506 * <li> {@link #ACTION_EDIT}
507 * <li> {@link #ACTION_PICK}
508 * <li> {@link #ACTION_CHOOSER}
509 * <li> {@link #ACTION_GET_CONTENT}
510 * <li> {@link #ACTION_DIAL}
511 * <li> {@link #ACTION_CALL}
512 * <li> {@link #ACTION_SEND}
513 * <li> {@link #ACTION_SENDTO}
514 * <li> {@link #ACTION_ANSWER}
515 * <li> {@link #ACTION_INSERT}
516 * <li> {@link #ACTION_DELETE}
517 * <li> {@link #ACTION_RUN}
518 * <li> {@link #ACTION_SYNC}
519 * <li> {@link #ACTION_PICK_ACTIVITY}
520 * <li> {@link #ACTION_SEARCH}
521 * <li> {@link #ACTION_WEB_SEARCH}
522 * <li> {@link #ACTION_FACTORY_TEST}
523 * </ul>
524 *
525 * <h3>Standard Broadcast Actions</h3>
526 *
527 * <p>These are the current standard actions that Intent defines for receiving
528 * broadcasts (usually through {@link Context#registerReceiver} or a
529 * &lt;receiver&gt; tag in a manifest).
530 *
531 * <ul>
532 * <li> {@link #ACTION_TIME_TICK}
533 * <li> {@link #ACTION_TIME_CHANGED}
534 * <li> {@link #ACTION_TIMEZONE_CHANGED}
535 * <li> {@link #ACTION_BOOT_COMPLETED}
536 * <li> {@link #ACTION_PACKAGE_ADDED}
537 * <li> {@link #ACTION_PACKAGE_CHANGED}
538 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #ACTION_PACKAGE_RESTARTED}
540 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000541 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
542 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * <li> {@link #ACTION_UID_REMOVED}
544 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700545 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700546 * <li> {@link #ACTION_POWER_DISCONNECTED}
547 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700548 * </ul>
549 *
550 * <h3>Standard Categories</h3>
551 *
552 * <p>These are the current standard categories that can be used to further
553 * clarify an Intent via {@link #addCategory}.
554 *
555 * <ul>
556 * <li> {@link #CATEGORY_DEFAULT}
557 * <li> {@link #CATEGORY_BROWSABLE}
558 * <li> {@link #CATEGORY_TAB}
559 * <li> {@link #CATEGORY_ALTERNATIVE}
560 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
561 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800562 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700563 * <li> {@link #CATEGORY_HOME}
564 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700565 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400566 * <li> {@link #CATEGORY_CAR_DOCK}
567 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500568 * <li> {@link #CATEGORY_LE_DESK_DOCK}
569 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200570 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700571 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700572 * </ul>
573 *
574 * <h3>Standard Extra Data</h3>
575 *
576 * <p>These are the current standard fields that can be used as extra data via
577 * {@link #putExtra}.
578 *
579 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800580 * <li> {@link #EXTRA_ALARM_COUNT}
581 * <li> {@link #EXTRA_BCC}
582 * <li> {@link #EXTRA_CC}
583 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
584 * <li> {@link #EXTRA_DATA_REMOVED}
585 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500586 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
587 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800588 * <li> {@link #EXTRA_DOCK_STATE_CAR}
589 * <li> {@link #EXTRA_DOCK_STATE_DESK}
590 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
591 * <li> {@link #EXTRA_DONT_KILL_APP}
592 * <li> {@link #EXTRA_EMAIL}
593 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700594 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700596 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800597 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700598 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800599 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
600 * <li> {@link #EXTRA_REPLACING}
601 * <li> {@link #EXTRA_SHORTCUT_ICON}
602 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
603 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700604 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800605 * <li> {@link #EXTRA_SHORTCUT_NAME}
606 * <li> {@link #EXTRA_SUBJECT}
607 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800609 * <li> {@link #EXTRA_TITLE}
610 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700611 * </ul>
612 *
613 * <h3>Flags</h3>
614 *
615 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800616 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
617 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800619public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700620 private static final String ATTR_ACTION = "action";
621 private static final String TAG_CATEGORIES = "categories";
622 private static final String ATTR_CATEGORY = "category";
623 private static final String TAG_EXTRA = "extra";
624 private static final String ATTR_TYPE = "type";
625 private static final String ATTR_COMPONENT = "component";
626 private static final String ATTR_DATA = "data";
627 private static final String ATTR_FLAGS = "flags";
628
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700629 // ---------------------------------------------------------------------
630 // ---------------------------------------------------------------------
631 // Standard intent activity actions (see action variable).
632
633 /**
634 * Activity Action: Start as a main entry point, does not expect to
635 * receive data.
636 * <p>Input: nothing
637 * <p>Output: nothing
638 */
639 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
640 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700642 /**
643 * Activity Action: Display the data to the user. This is the most common
644 * action performed on data -- it is the generic action you can use on
645 * a piece of data to get the most reasonable thing to occur. For example,
646 * when used on a contacts entry it will view the entry; when used on a
647 * mailto: URI it will bring up a compose window filled with the information
648 * supplied by the URI; when used with a tel: URI it will invoke the
649 * dialer.
650 * <p>Input: {@link #getData} is URI from which to retrieve data.
651 * <p>Output: nothing.
652 */
653 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
654 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800655
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700656 /**
657 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
658 * performed on a piece of data.
659 */
660 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800661
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700662 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900663 * Activity Action: Quick view the data. Launches a quick viewer for
664 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900665 * <p>Activities handling this intent action should handle the vast majority of
666 * MIME types rather than only specific ones.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900667 * <p>Input: {@link #getData} is a mandatory content URI of the item to
668 * preview. {@link #getClipData} contains an optional list of content URIs
669 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
670 * optional index of the URI in the clip data to show first.
Steve McKayc78bcb82015-07-31 14:35:22 -0700671 * <p>Output: nothing.
Steve McKayc78bcb82015-07-31 14:35:22 -0700672 */
673 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
674 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
675
676 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 * Used to indicate that some piece of data should be attached to some other
678 * place. For example, image data could be attached to a contact. It is up
679 * to the recipient to decide where the data should be attached; the intent
680 * does not specify the ultimate destination.
681 * <p>Input: {@link #getData} is URI of data to be attached.
682 * <p>Output: nothing.
683 */
684 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
685 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800686
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700687 /**
688 * Activity Action: Provide explicit editable access to the given data.
689 * <p>Input: {@link #getData} is URI of data to be edited.
690 * <p>Output: nothing.
691 */
692 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
693 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800694
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700695 /**
696 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
697 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
698 * The extras can contain type specific data to pass through to the editing/creating
699 * activity.
700 * <p>Output: The URI of the item that was picked. This must be a content:
701 * URI so that any receiver can access it.
702 */
703 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
704 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800705
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700706 /**
707 * Activity Action: Pick an item from the data, returning what was selected.
708 * <p>Input: {@link #getData} is URI containing a directory of data
709 * (vnd.android.cursor.dir/*) from which to pick an item.
710 * <p>Output: The URI of the item that was picked.
711 */
712 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
713 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 /**
716 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800717 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700718 * <p>Output: An Intent representing the shortcut. The intent must contain three
719 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
720 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800721 * (value: ShortcutIconResource).</p>
722 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700723 * @see #EXTRA_SHORTCUT_INTENT
724 * @see #EXTRA_SHORTCUT_NAME
725 * @see #EXTRA_SHORTCUT_ICON
726 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
727 * @see android.content.Intent.ShortcutIconResource
728 */
729 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
730 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
731
732 /**
733 * The name of the extra used to define the Intent of a shortcut.
734 *
735 * @see #ACTION_CREATE_SHORTCUT
736 */
737 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
738 /**
739 * The name of the extra used to define the name of a shortcut.
740 *
741 * @see #ACTION_CREATE_SHORTCUT
742 */
743 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
744 /**
745 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
746 *
747 * @see #ACTION_CREATE_SHORTCUT
748 */
749 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
750 /**
751 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
752 *
753 * @see #ACTION_CREATE_SHORTCUT
754 * @see android.content.Intent.ShortcutIconResource
755 */
756 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
757 "android.intent.extra.shortcut.ICON_RESOURCE";
758
759 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500760 * An activity that provides a user interface for adjusting application preferences.
761 * Optional but recommended settings for all applications which have settings.
762 */
763 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
764 public static final String ACTION_APPLICATION_PREFERENCES
765 = "android.intent.action.APPLICATION_PREFERENCES";
766
767 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800768 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700769 *
770 * @see Intent#ACTION_CREATE_SHORTCUT
771 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800772 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
773 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700774 */
775 public static class ShortcutIconResource implements Parcelable {
776 /**
777 * The package name of the application containing the icon.
778 */
779 public String packageName;
780
781 /**
782 * The resource name of the icon, including package, name and type.
783 */
784 public String resourceName;
785
786 /**
787 * Creates a new ShortcutIconResource for the specified context and resource
788 * identifier.
789 *
790 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700791 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700792 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700793 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700794 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700795 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700796 ShortcutIconResource icon = new ShortcutIconResource();
797 icon.packageName = context.getPackageName();
798 icon.resourceName = context.getResources().getResourceName(resourceId);
799 return icon;
800 }
801
802 /**
803 * Used to read a ShortcutIconResource from a Parcel.
804 */
805 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
806 new Parcelable.Creator<ShortcutIconResource>() {
807
808 public ShortcutIconResource createFromParcel(Parcel source) {
809 ShortcutIconResource icon = new ShortcutIconResource();
810 icon.packageName = source.readString();
811 icon.resourceName = source.readString();
812 return icon;
813 }
814
815 public ShortcutIconResource[] newArray(int size) {
816 return new ShortcutIconResource[size];
817 }
818 };
819
820 /**
821 * No special parcel contents.
822 */
823 public int describeContents() {
824 return 0;
825 }
826
827 public void writeToParcel(Parcel dest, int flags) {
828 dest.writeString(packageName);
829 dest.writeString(resourceName);
830 }
831
832 @Override
833 public String toString() {
834 return resourceName;
835 }
836 }
837
838 /**
839 * Activity Action: Display an activity chooser, allowing the user to pick
840 * what they want to before proceeding. This can be used as an alternative
841 * to the standard activity picker that is displayed by the system when
842 * you try to start an activity with multiple possible matches, with these
843 * differences in behavior:
844 * <ul>
845 * <li>You can specify the title that will appear in the activity chooser.
846 * <li>The user does not have the option to make one of the matching
847 * activities a preferred activity, and all possible activities will
848 * always be shown even if one of them is currently marked as the
849 * preferred activity.
850 * </ul>
851 * <p>
852 * This action should be used when the user will naturally expect to
853 * select an activity in order to proceed. An example if when not to use
854 * it is when the user clicks on a "mailto:" link. They would naturally
855 * expect to go directly to their mail app, so startActivity() should be
856 * called directly: it will
857 * either launch the current preferred app, or put up a dialog allowing the
858 * user to pick an app to use and optionally marking that as preferred.
859 * <p>
860 * In contrast, if the user is selecting a menu item to send a picture
861 * they are viewing to someone else, there are many different things they
862 * may want to do at this point: send it through e-mail, upload it to a
863 * web service, etc. In this case the CHOOSER action should be used, to
864 * always present to the user a list of the things they can do, with a
865 * nice title given by the caller such as "Send this photo with:".
866 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700867 * If you need to grant URI permissions through a chooser, you must specify
868 * the permissions to be granted on the ACTION_CHOOSER Intent
869 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
870 * {@link #setClipData} to specify the URIs to be granted as well as
871 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
872 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
873 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700874 * As a convenience, an Intent of this form can be created with the
875 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700876 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700877 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700878 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
879 * and can optionally have a {@link #EXTRA_TITLE} field containing the
880 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700881 * <p>
882 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700883 */
884 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
885 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
886
887 /**
888 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
889 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700890 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
891 * target intent, also optionally supplying a title. If the target
892 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
893 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
894 * set in the returned chooser intent, with its ClipData set appropriately:
895 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500896 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700897 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700898 * @param target The Intent that the user will be selecting an activity
899 * to perform.
900 * @param title Optional title that will be displayed in the chooser.
901 * @return Return a new Intent object that you can hand to
902 * {@link Context#startActivity(Intent) Context.startActivity()} and
903 * related methods.
904 */
905 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700906 return createChooser(target, title, null);
907 }
908
909 /**
910 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
911 *
912 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
913 * target intent, also optionally supplying a title. If the target
914 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
915 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
916 * set in the returned chooser intent, with its ClipData set appropriately:
917 * either a direct reflection of {@link #getClipData()} if that is non-null,
918 * or a new ClipData built from {@link #getData()}.</p>
919 *
920 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
921 * when the user makes a choice. This can be useful if the calling application wants
922 * to remember the last chosen target and surface it as a more prominent or one-touch
923 * affordance elsewhere in the UI for next time.</p>
924 *
925 * @param target The Intent that the user will be selecting an activity
926 * to perform.
927 * @param title Optional title that will be displayed in the chooser.
928 * @param sender Optional IntentSender to be called when a choice is made.
929 * @return Return a new Intent object that you can hand to
930 * {@link Context#startActivity(Intent) Context.startActivity()} and
931 * related methods.
932 */
933 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700934 Intent intent = new Intent(ACTION_CHOOSER);
935 intent.putExtra(EXTRA_INTENT, target);
936 if (title != null) {
937 intent.putExtra(EXTRA_TITLE, title);
938 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700939
Adam Powell0b3c1122014-10-09 12:50:14 -0700940 if (sender != null) {
941 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
942 }
943
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700944 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700945 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
946 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
947 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700948 if (permFlags != 0) {
949 ClipData targetClipData = target.getClipData();
950 if (targetClipData == null && target.getData() != null) {
951 ClipData.Item item = new ClipData.Item(target.getData());
952 String[] mimeTypes;
953 if (target.getType() != null) {
954 mimeTypes = new String[] { target.getType() };
955 } else {
956 mimeTypes = new String[] { };
957 }
958 targetClipData = new ClipData(null, mimeTypes, item);
959 }
960 if (targetClipData != null) {
961 intent.setClipData(targetClipData);
962 intent.addFlags(permFlags);
963 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700964 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700965
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700966 return intent;
967 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700968
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700969 /**
970 * Activity Action: Allow the user to select a particular kind of data and
971 * return it. This is different than {@link #ACTION_PICK} in that here we
972 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800973 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700974 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900975 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700976 * etc.
977 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900978 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700979 * of data, such as a person contact, you set the MIME type to the kind of
980 * data you want and launch it with {@link Context#startActivity(Intent)}.
981 * The system will then launch the best application to select that kind
982 * of data for you.
983 * <p>
984 * You may also be interested in any of a set of types of content the user
985 * can pick. For example, an e-mail application that wants to allow the
986 * user to add an attachment to an e-mail message can use this action to
987 * bring up a list of all of the types of content the user can attach.
988 * <p>
989 * In this case, you should wrap the GET_CONTENT intent with a chooser
990 * (through {@link #createChooser}), which will give the proper interface
991 * for the user to pick how to send your data and allow you to specify
992 * a prompt indicating what they are doing. You will usually specify a
993 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
994 * broad range of content types the user can select from.
995 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900996 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700997 * only pick from data that can be represented as a stream. This is
998 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
999 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001000 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001001 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001002 * is locally available on the device. For example, if this extra is set
1003 * to true then an image picker should not show any pictures that are available
1004 * from a remote server but not already on the local device (thus requiring
1005 * they be downloaded when opened).
1006 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001007 * If the caller can handle multiple returned items (the user performing
1008 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1009 * to indicate this.
1010 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001011 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1012 * that no URI is supplied in the intent, as there are no constraints on
1013 * where the returned data originally comes from. You may also include the
1014 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001015 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001016 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1017 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001018 * <p>
1019 * Output: The URI of the item that was picked. This must be a content:
1020 * URI so that any receiver can access it.
1021 */
1022 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1023 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1024 /**
1025 * Activity Action: Dial a number as specified by the data. This shows a
1026 * UI with the number being dialed, allowing the user to explicitly
1027 * initiate the call.
1028 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1029 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1030 * number.
1031 * <p>Output: nothing.
1032 */
1033 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1034 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1035 /**
1036 * Activity Action: Perform a call to someone specified by the data.
1037 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1038 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1039 * number.
1040 * <p>Output: nothing.
1041 *
1042 * <p>Note: there will be restrictions on which applications can initiate a
1043 * call; most applications should use the {@link #ACTION_DIAL}.
1044 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1045 * numbers. Applications can <strong>dial</strong> emergency numbers using
1046 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001047 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001048 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001049 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001050 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001051 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001052 */
1053 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1054 public static final String ACTION_CALL = "android.intent.action.CALL";
1055 /**
1056 * Activity Action: Perform a call to an emergency number specified by the
1057 * data.
1058 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1059 * tel: URI of an explicit phone number.
1060 * <p>Output: nothing.
1061 * @hide
1062 */
1063 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1064 /**
1065 * Activity action: Perform a call to any number (emergency or not)
1066 * specified by the data.
1067 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1068 * tel: URI of an explicit phone number.
1069 * <p>Output: nothing.
1070 * @hide
1071 */
1072 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1073 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001074 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1075 * sending this intent is a no-op.
1076 * <p>Input: No data should be specified. get*Extra may have an optional
1077 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1078 * send the activation result.
1079 * <p>Output: nothing.
1080 * @hide
1081 */
1082 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1083 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1084 "android.intent.action.SIM_ACTIVATION_REQUEST";
1085 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001086 * Activity Action: Send a message to someone specified by the data.
1087 * <p>Input: {@link #getData} is URI describing the target.
1088 * <p>Output: nothing.
1089 */
1090 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1091 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1092 /**
1093 * Activity Action: Deliver some data to someone else. Who the data is
1094 * being delivered to is not specified; it is up to the receiver of this
1095 * action to ask the user where the data should be sent.
1096 * <p>
1097 * When launching a SEND intent, you should usually wrap it in a chooser
1098 * (through {@link #createChooser}), which will give the proper interface
1099 * for the user to pick how to send your data and allow you to specify
1100 * a prompt indicating what they are doing.
1101 * <p>
1102 * Input: {@link #getType} is the MIME type of the data being sent.
1103 * get*Extra can have either a {@link #EXTRA_TEXT}
1104 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1105 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1106 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1107 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001108 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1109 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1110 * your text with HTML formatting.
1111 * <p>
1112 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1113 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1114 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1115 * content: URIs and other advanced features of {@link ClipData}. If
1116 * using this approach, you still must supply the same data through the
1117 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1118 * for compatibility with old applications. If you don't set a ClipData,
1119 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001120 * <p>
1121 * Optional standard extras, which may be interpreted by some recipients as
1122 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1123 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1124 * <p>
1125 * Output: nothing.
1126 */
1127 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1128 public static final String ACTION_SEND = "android.intent.action.SEND";
1129 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001130 * Activity Action: Deliver multiple data to someone else.
1131 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001132 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001133 * <p>
1134 * Input: {@link #getType} is the MIME type of the data being sent.
1135 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001136 * #EXTRA_STREAM} field, containing the data to be sent. If using
1137 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1138 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001139 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001140 * Multiple types are supported, and receivers should handle mixed types
1141 * whenever possible. The right way for the receiver to check them is to
1142 * use the content resolver on each URI. The intent sender should try to
1143 * put the most concrete mime type in the intent type, but it can fall
1144 * back to {@literal <type>/*} or {@literal *}/* as needed.
1145 * <p>
1146 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1147 * be image/jpg, but if you are sending image/jpg and image/png, then the
1148 * intent's type should be image/*.
1149 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001150 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1151 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1152 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1153 * content: URIs and other advanced features of {@link ClipData}. If
1154 * using this approach, you still must supply the same data through the
1155 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1156 * for compatibility with old applications. If you don't set a ClipData,
1157 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1158 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001159 * Optional standard extras, which may be interpreted by some recipients as
1160 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1161 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1162 * <p>
1163 * Output: nothing.
1164 */
1165 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1166 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1167 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001168 * Activity Action: Handle an incoming phone call.
1169 * <p>Input: nothing.
1170 * <p>Output: nothing.
1171 */
1172 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1173 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1174 /**
1175 * Activity Action: Insert an empty item into the given container.
1176 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1177 * in which to place the data.
1178 * <p>Output: URI of the new data that was created.
1179 */
1180 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1181 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1182 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001183 * Activity Action: Create a new item in the given container, initializing it
1184 * from the current contents of the clipboard.
1185 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1186 * in which to place the data.
1187 * <p>Output: URI of the new data that was created.
1188 */
1189 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1190 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1191 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001192 * Activity Action: Delete the given data from its container.
1193 * <p>Input: {@link #getData} is URI of data to be deleted.
1194 * <p>Output: nothing.
1195 */
1196 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1197 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1198 /**
1199 * Activity Action: Run the data, whatever that means.
1200 * <p>Input: ? (Note: this is currently specific to the test harness.)
1201 * <p>Output: nothing.
1202 */
1203 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1204 public static final String ACTION_RUN = "android.intent.action.RUN";
1205 /**
1206 * Activity Action: Perform a data synchronization.
1207 * <p>Input: ?
1208 * <p>Output: ?
1209 */
1210 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1211 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1212 /**
1213 * Activity Action: Pick an activity given an intent, returning the class
1214 * selected.
1215 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1216 * used with {@link PackageManager#queryIntentActivities} to determine the
1217 * set of activities from which to pick.
1218 * <p>Output: Class name of the activity that was selected.
1219 */
1220 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1221 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1222 /**
1223 * Activity Action: Perform a search.
1224 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1225 * is the text to search for. If empty, simply
1226 * enter your search results Activity with the search UI activated.
1227 * <p>Output: nothing.
1228 */
1229 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1230 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1231 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001232 * Activity Action: Start the platform-defined tutorial
1233 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1234 * is the text to search for. If empty, simply
1235 * enter your search results Activity with the search UI activated.
1236 * <p>Output: nothing.
1237 */
1238 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1239 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1240 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001241 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001242 * <p>
1243 * Input: {@link android.app.SearchManager#QUERY
1244 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1245 * a url starts with http or https, the site will be opened. If it is plain
1246 * text, Google search will be applied.
1247 * <p>
1248 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001249 */
1250 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1251 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001252
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001253 /**
Jim Miller07994402012-05-02 14:22:27 -07001254 * Activity Action: Perform assist action.
1255 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001256 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1257 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001258 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1259 * information.
Jim Miller07994402012-05-02 14:22:27 -07001260 * Output: nothing.
1261 */
1262 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1263 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001264
1265 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001266 * Activity Action: Perform voice assist action.
1267 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001268 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1269 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001270 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001271 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001272 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001273 */
1274 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1275 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1276
1277 /**
Adam Skory7140a252013-09-11 12:04:58 +01001278 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1279 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001280 */
1281 public static final String EXTRA_ASSIST_PACKAGE
1282 = "android.intent.extra.ASSIST_PACKAGE";
1283
1284 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001285 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1286 * application package at the time the assist was invoked.
1287 */
1288 public static final String EXTRA_ASSIST_UID
1289 = "android.intent.extra.ASSIST_UID";
1290
1291 /**
Adam Skory7140a252013-09-11 12:04:58 +01001292 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1293 * information supplied by the current foreground app at the time of the assist request.
1294 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001295 */
1296 public static final String EXTRA_ASSIST_CONTEXT
1297 = "android.intent.extra.ASSIST_CONTEXT";
1298
Jim Miller07994402012-05-02 14:22:27 -07001299 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001300 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1301 * keyboard as the primary input device for assistance.
1302 */
1303 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1304 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1305
1306 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001307 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1308 * that was used to invoke the assist.
1309 */
1310 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1311 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1312
1313 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001314 * Activity Action: List all available applications
1315 * <p>Input: Nothing.
1316 * <p>Output: nothing.
1317 */
1318 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1319 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1320 /**
1321 * Activity Action: Show settings for choosing wallpaper
1322 * <p>Input: Nothing.
1323 * <p>Output: Nothing.
1324 */
1325 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1326 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1327
1328 /**
1329 * Activity Action: Show activity for reporting a bug.
1330 * <p>Input: Nothing.
1331 * <p>Output: Nothing.
1332 */
1333 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1334 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1335
1336 /**
1337 * Activity Action: Main entry point for factory tests. Only used when
1338 * the device is booting in factory test node. The implementing package
1339 * must be installed in the system image.
1340 * <p>Input: nothing
1341 * <p>Output: nothing
1342 */
1343 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1344
1345 /**
1346 * Activity Action: The user pressed the "call" button to go to the dialer
1347 * or other appropriate UI for placing a call.
1348 * <p>Input: Nothing.
1349 * <p>Output: Nothing.
1350 */
1351 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1352 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1353
1354 /**
1355 * Activity Action: Start Voice Command.
1356 * <p>Input: Nothing.
1357 * <p>Output: Nothing.
1358 */
1359 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1360 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001361
1362 /**
1363 * Activity Action: Start action associated with long pressing on the
1364 * search key.
1365 * <p>Input: Nothing.
1366 * <p>Output: Nothing.
1367 */
1368 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1369 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001370
Jacek Surazski86b6c532009-05-13 14:38:28 +02001371 /**
1372 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1373 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001374 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001375 * <p>Input: No data is specified. The bug report is passed in using
1376 * an {@link #EXTRA_BUG_REPORT} field.
1377 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001378 *
1379 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001380 */
1381 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1382 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001383
1384 /**
1385 * Activity Action: Show power usage information to the user.
1386 * <p>Input: Nothing.
1387 * <p>Output: Nothing.
1388 */
1389 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1390 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001391
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001392 /**
1393 * Activity Action: Setup wizard to launch after a platform update. This
1394 * activity should have a string meta-data field associated with it,
1395 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1396 * the platform for setup. The activity will be launched only if
1397 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1398 * same value.
1399 * <p>Input: Nothing.
1400 * <p>Output: Nothing.
1401 * @hide
1402 */
1403 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1404 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001405
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001406 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001407 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1408 * <p>Input: Nothing.
1409 * <p>Output: Nothing.
1410 * @hide
1411 */
1412 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1413 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
1414 "android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
1415
1416 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001417 * Activity Action: Show settings for managing network data usage of a
1418 * specific application. Applications should define an activity that offers
1419 * options to control data usage.
1420 */
1421 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1422 public static final String ACTION_MANAGE_NETWORK_USAGE =
1423 "android.intent.action.MANAGE_NETWORK_USAGE";
1424
1425 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001426 * Activity Action: Launch application installer.
1427 * <p>
1428 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001429 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1430 * you can also use "package:<package-name>" to install an application for the
1431 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001432 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1433 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1434 * <p>
1435 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1436 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001437 * <p>
1438 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1439 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1440 * in order to launch the application installer.
1441 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001442 *
1443 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1444 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1445 * @see #EXTRA_RETURN_RESULT
1446 */
1447 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1448 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1449
1450 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001451 * Activity Action: Launch ephemeral installer.
1452 * <p>
1453 * Input: The data must be a http: URI that the ephemeral application is registered
1454 * to handle.
1455 * <p class="note">
1456 * This is a protected intent that can only be sent by the system.
1457 * </p>
1458 *
1459 * @hide
1460 */
1461 @SystemApi
1462 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1463 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1464 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1465
1466 /**
1467 * Service Action: Resolve ephemeral application.
1468 * <p>
1469 * The system will have a persistent connection to this service.
1470 * This is a protected intent that can only be sent by the system.
1471 * </p>
1472 *
1473 * @hide
1474 */
1475 @SystemApi
1476 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1477 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1478 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1479
1480 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001481 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1482 * package. Specifies the installer package name; this package will receive the
1483 * {@link #ACTION_APP_ERROR} intent.
1484 */
1485 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1486 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1487
1488 /**
1489 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1490 * package. Specifies that the application being installed should not be
1491 * treated as coming from an unknown source, but as coming from the app
1492 * invoking the Intent. For this to work you must start the installer with
1493 * startActivityForResult().
1494 */
1495 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1496 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1497
1498 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001499 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1500 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001501 * data field originated from.
1502 */
rich cannings706e8ba2012-08-20 13:20:14 -07001503 public static final String EXTRA_ORIGINATING_URI
1504 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001505
1506 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001507 * This extra can be used with any Intent used to launch an activity, supplying information
1508 * about who is launching that activity. This field contains a {@link android.net.Uri}
1509 * object, typically an http: or https: URI of the web site that the referral came from;
1510 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1511 * a native application that it came from.
1512 *
1513 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1514 * instead of directly retrieving the extra. It is also valid for applications to
1515 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1516 * a string, not a Uri; the field here, if supplied, will always take precedence,
1517 * however.</p>
1518 *
1519 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001520 */
1521 public static final String EXTRA_REFERRER
1522 = "android.intent.extra.REFERRER";
1523
1524 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001525 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1526 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1527 * not be created, in particular when Intent extras are supplied through the
1528 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1529 * schemes.
1530 *
1531 * @see #EXTRA_REFERRER
1532 */
1533 public static final String EXTRA_REFERRER_NAME
1534 = "android.intent.extra.REFERRER_NAME";
1535
1536 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001537 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1538 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1539 * @hide
1540 */
1541 public static final String EXTRA_ORIGINATING_UID
1542 = "android.intent.extra.ORIGINATING_UID";
1543
1544 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001545 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1546 * package. Tells the installer UI to skip the confirmation with the user
1547 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001548 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1549 * will no longer show an interstitial message about updating existing
1550 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001551 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001552 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001553 public static final String EXTRA_ALLOW_REPLACE
1554 = "android.intent.extra.ALLOW_REPLACE";
1555
1556 /**
1557 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1558 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1559 * return to the application the result code of the install/uninstall. The returned result
1560 * code will be {@link android.app.Activity#RESULT_OK} on success or
1561 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1562 */
1563 public static final String EXTRA_RETURN_RESULT
1564 = "android.intent.extra.RETURN_RESULT";
1565
1566 /**
1567 * Package manager install result code. @hide because result codes are not
1568 * yet ready to be exposed.
1569 */
1570 public static final String EXTRA_INSTALL_RESULT
1571 = "android.intent.extra.INSTALL_RESULT";
1572
1573 /**
1574 * Activity Action: Launch application uninstaller.
1575 * <p>
1576 * Input: The data must be a package: URI whose scheme specific part is
1577 * the package name of the current installed package to be uninstalled.
1578 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1579 * <p>
1580 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1581 * succeeded.
1582 */
1583 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1584 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1585
1586 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001587 * Specify whether the package should be uninstalled for all users.
1588 * @hide because these should not be part of normal application flow.
1589 */
1590 public static final String EXTRA_UNINSTALL_ALL_USERS
1591 = "android.intent.extra.UNINSTALL_ALL_USERS";
1592
1593 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001594 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1595 * describing the last run version of the platform that was setup.
1596 * @hide
1597 */
1598 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1599
Svet Ganov3695b8a2015-03-24 16:30:25 -07001600 /**
1601 * Activity action: Launch UI to manage the permissions of an app.
1602 * <p>
1603 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1604 * will be managed by the launched UI.
1605 * </p>
1606 * <p>
1607 * Output: Nothing.
1608 * </p>
1609 *
1610 * @see #EXTRA_PACKAGE_NAME
1611 *
1612 * @hide
1613 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001614 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1615 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1616 "android.intent.action.MANAGE_APP_PERMISSIONS";
1617
1618 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001619 * Activity action: Launch UI to manage permissions.
1620 * <p>
1621 * Input: Nothing.
1622 * </p>
1623 * <p>
1624 * Output: Nothing.
1625 * </p>
1626 *
1627 * @hide
1628 */
Svet Ganov321f0152015-05-16 22:51:50 -07001629 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1630 public static final String ACTION_MANAGE_PERMISSIONS =
1631 "android.intent.action.MANAGE_PERMISSIONS";
1632
1633 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001634 * Activity action: Launch UI to review permissions for an app.
1635 * The system uses this intent if permission review for apps not
1636 * supporting the new runtime permissions model is enabled. In
1637 * this mode a permission review is required before any of the
1638 * app components can run.
1639 * <p>
1640 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1641 * permissions will be reviewed (mandatory).
1642 * </p>
1643 * <p>
1644 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1645 * be fired after the permission review (optional).
1646 * </p>
1647 * <p>
1648 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1649 * be invoked after the permission review (optional).
1650 * </p>
1651 * <p>
1652 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1653 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1654 * </p>
1655 * <p>
1656 * Output: Nothing.
1657 * </p>
1658 *
1659 * @see #EXTRA_PACKAGE_NAME
1660 * @see #EXTRA_INTENT
1661 * @see #EXTRA_REMOTE_CALLBACK
1662 * @see #EXTRA_RESULT_NEEDED
1663 *
1664 * @hide
1665 */
1666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1667 public static final String ACTION_REVIEW_PERMISSIONS =
1668 "android.intent.action.REVIEW_PERMISSIONS";
1669
1670 /**
1671 * Intent extra: A callback for reporting remote result as a bundle.
1672 * <p>
1673 * Type: IRemoteCallback
1674 * </p>
1675 *
1676 * @hide
1677 */
1678 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1679
1680 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001681 * Intent extra: An app package name.
1682 * <p>
1683 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001684 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001685 *
1686 * @hide
1687 */
1688 @SystemApi
1689 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1690
1691 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001692 * Intent extra: An extra for specifying whether a result is needed.
1693 * <p>
1694 * Type: boolean
1695 * </p>
1696 *
1697 * @hide
1698 */
1699 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1700
1701 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001702 * Broadcast action that requests current permission granted information. It will respond
1703 * to the request by sending a broadcast with action defined by
1704 * {@link #EXTRA_GET_PERMISSIONS_RESPONSE_INTENT}. The response will contain
Makoto Onukibbb912a2015-06-05 16:27:23 -07001705 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}, as well as
1706 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}, with contents described below or
1707 * a null upon failure.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001708 *
Makoto Onukibbb912a2015-06-05 16:27:23 -07001709 * <p>If {@link #EXTRA_PACKAGE_NAME} is included then the number of permissions granted, the
1710 * number of permissions requested and the number of granted additional permissions
1711 * by that package will be calculated and included as the first
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001712 * and second elements respectively of an int[] in the response as
Makoto Onukibbb912a2015-06-05 16:27:23 -07001713 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}. The response will also deliver the list
1714 * of localized permission group names that are granted in
1715 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001716 *
1717 * <p>If {@link #EXTRA_PACKAGE_NAME} is not included then the number of apps granted any runtime
1718 * permissions and the total number of apps requesting runtime permissions will be the first
1719 * and second elements respectively of an int[] in the response as
1720 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1721 *
1722 * @hide
1723 */
1724 public static final String ACTION_GET_PERMISSIONS_COUNT
1725 = "android.intent.action.GET_PERMISSIONS_COUNT";
1726
1727 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001728 * Broadcast action that requests list of all apps that have runtime permissions. It will
1729 * respond to the request by sending a broadcast with action defined by
1730 * {@link #EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT}. The response will contain
1731 * {@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT}, as well as
1732 * {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}, with contents described below or
1733 * a null upon failure.
1734 *
1735 * <p>{@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT} will contain a list of package names of
1736 * apps that have runtime permissions. {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}
1737 * will contain the list of app labels corresponding ot the apps in the first list.
1738 *
1739 * @hide
1740 */
1741 public static final String ACTION_GET_PERMISSIONS_PACKAGES
1742 = "android.intent.action.GET_PERMISSIONS_PACKAGES";
1743
1744 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001745 * Extra included in response to {@link #ACTION_GET_PERMISSIONS_COUNT}.
1746 * @hide
1747 */
1748 public static final String EXTRA_GET_PERMISSIONS_COUNT_RESULT
1749 = "android.intent.extra.GET_PERMISSIONS_COUNT_RESULT";
1750
1751 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001752 * List of CharSequence of localized permission group labels.
1753 * @hide
1754 */
1755 public static final String EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT
1756 = "android.intent.extra.GET_PERMISSIONS_GROUP_LIST_RESULT";
1757
1758 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001759 * String list of apps that have one or more runtime permissions.
1760 * @hide
1761 */
1762 public static final String EXTRA_GET_PERMISSIONS_APP_LIST_RESULT
1763 = "android.intent.extra.GET_PERMISSIONS_APP_LIST_RESULT";
1764
1765 /**
1766 * String list of app labels for apps that have one or more runtime permissions.
1767 * @hide
1768 */
1769 public static final String EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT
1770 = "android.intent.extra.GET_PERMISSIONS_APP_LABEL_LIST_RESULT";
1771
1772 /**
Anthony Hugh3575a402015-10-26 17:47:05 -07001773 * Boolean list describing if the app is a system app for apps that have one or more runtime
1774 * permissions.
1775 * @hide
1776 */
1777 public static final String EXTRA_GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT
1778 = "android.intent.extra.GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT";
1779
1780 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001781 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_COUNT} broadcasts.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001782 * @hide
1783 */
1784 public static final String EXTRA_GET_PERMISSIONS_RESPONSE_INTENT
1785 = "android.intent.extra.GET_PERMISSIONS_RESONSE_INTENT";
1786
1787 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001788 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_PACKAGES} broadcasts.
1789 * @hide
1790 */
1791 public static final String EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT
1792 = "android.intent.extra.GET_PERMISSIONS_PACKAGES_RESONSE_INTENT";
1793
1794 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001795 * Activity action: Launch UI to manage which apps have a given permission.
1796 * <p>
1797 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1798 * to which will be managed by the launched UI.
1799 * </p>
1800 * <p>
1801 * Output: Nothing.
1802 * </p>
1803 *
1804 * @see #EXTRA_PERMISSION_NAME
1805 *
1806 * @hide
1807 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001808 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1809 public static final String ACTION_MANAGE_PERMISSION_APPS =
1810 "android.intent.action.MANAGE_PERMISSION_APPS";
1811
1812 /**
1813 * Intent extra: The name of a permission.
1814 * <p>
1815 * Type: String
1816 * </p>
1817 *
1818 * @hide
1819 */
1820 @SystemApi
1821 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1822
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001823 // ---------------------------------------------------------------------
1824 // ---------------------------------------------------------------------
1825 // Standard intent broadcast actions (see action variable).
1826
1827 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001828 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1829 * <p>
1830 * For historical reasons, the name of this broadcast action refers to the power
1831 * state of the screen but it is actually sent in response to changes in the
1832 * overall interactive state of the device.
1833 * </p><p>
1834 * This broadcast is sent when the device becomes non-interactive which may have
1835 * nothing to do with the screen turning off. To determine the
1836 * actual state of the screen, use {@link android.view.Display#getState}.
1837 * </p><p>
1838 * See {@link android.os.PowerManager#isInteractive} for details.
1839 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001840 * You <em>cannot</em> receive this through components declared in
1841 * manifests, only by explicitly registering for it with
1842 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1843 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001844 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001845 * <p class="note">This is a protected intent that can only be sent
1846 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001847 */
1848 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1849 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001850
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001851 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001852 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1853 * <p>
1854 * For historical reasons, the name of this broadcast action refers to the power
1855 * state of the screen but it is actually sent in response to changes in the
1856 * overall interactive state of the device.
1857 * </p><p>
1858 * This broadcast is sent when the device becomes interactive which may have
1859 * nothing to do with the screen turning on. To determine the
1860 * actual state of the screen, use {@link android.view.Display#getState}.
1861 * </p><p>
1862 * See {@link android.os.PowerManager#isInteractive} for details.
1863 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001864 * You <em>cannot</em> receive this through components declared in
1865 * manifests, only by explicitly registering for it with
1866 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1867 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001868 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001869 * <p class="note">This is a protected intent that can only be sent
1870 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001871 */
1872 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1873 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001874
1875 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001876 * Broadcast Action: Sent after the system stops dreaming.
1877 *
1878 * <p class="note">This is a protected intent that can only be sent by the system.
1879 * It is only sent to registered receivers.</p>
1880 */
1881 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1882 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1883
1884 /**
1885 * Broadcast Action: Sent after the system starts dreaming.
1886 *
1887 * <p class="note">This is a protected intent that can only be sent by the system.
1888 * It is only sent to registered receivers.</p>
1889 */
1890 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1891 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1892
1893 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001894 * 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 -07001895 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001896 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001897 * <p class="note">This is a protected intent that can only be sent
1898 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001899 */
1900 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001901 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001902
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001903 /**
1904 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001905 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001906 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001907 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1908 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001909 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001910 * <p class="note">This is a protected intent that can only be sent
1911 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001912 */
1913 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1914 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1915 /**
1916 * Broadcast Action: The time was set.
1917 */
1918 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1919 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1920 /**
1921 * Broadcast Action: The date has changed.
1922 */
1923 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1924 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1925 /**
1926 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1927 * <ul>
1928 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1929 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001930 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001931 * <p class="note">This is a protected intent that can only be sent
1932 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001933 */
1934 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1935 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1936 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001937 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1938 * DNS entries should be tossed.
1939 * @hide
1940 */
1941 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1942 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1943 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001944 * Alarm Changed Action: This is broadcast when the AlarmClock
1945 * application's alarm is set or unset. It is used by the
1946 * AlarmClock application and the StatusBar service.
1947 * @hide
1948 */
1949 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1950 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001951
1952 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001953 * Broadcast Action: This is broadcast once, after the user has finished
1954 * booting, but while still in the "locked" state. It can be used to perform
1955 * application-specific initialization, such as installing alarms. You must
1956 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1957 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001958 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001959 * This broadcast is sent immediately at boot by all devices (regardless of
1960 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1961 * higher. Upon receipt of this broadcast, the user is still locked and only
1962 * device-protected storage can be accessed safely. If you want to access
1963 * credential-protected storage, you need to wait for the user to be
1964 * unlocked (typically by entering their lock pattern or PIN for the first
1965 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1966 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1967 * <p>
1968 * To receive this broadcast, your receiver component must be marked as
1969 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001970 * <p class="note">
1971 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001972 *
1973 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001974 */
1975 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1976 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1977
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001978 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001979 * Broadcast Action: This is broadcast once, after the user has finished
1980 * booting. It can be used to perform application-specific initialization,
1981 * such as installing alarms. You must hold the
1982 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1983 * order to receive this broadcast.
1984 * <p>
1985 * This broadcast is sent at boot by all devices (both with and without
1986 * direct boot support). Upon receipt of this broadcast, the user is
1987 * unlocked and both device-protected and credential-protected storage can
1988 * accessed safely.
1989 * <p>
1990 * If you need to run while the user is still locked (before they've entered
1991 * their lock pattern or PIN for the first time), you can listen for the
1992 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1993 * <p class="note">
1994 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001995 */
1996 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1997 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001998
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001999 /**
2000 * Broadcast Action: This is broadcast when a user action should request a
2001 * temporary system dialog to dismiss. Some examples of temporary system
2002 * dialogs are the notification window-shade and the recent tasks dialog.
2003 */
2004 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2005 /**
2006 * Broadcast Action: Trigger the download and eventual installation
2007 * of a package.
2008 * <p>Input: {@link #getData} is the URI of the package file to download.
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.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002012 *
2013 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002014 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002015 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002016 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2017 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2018 /**
2019 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002020 * device. The data contains the name of the package. Note that the
2021 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002022 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002023 * <ul>
2024 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2025 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
2026 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2027 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002028 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002029 * <p class="note">This is a protected intent that can only be sent
2030 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002031 */
2032 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2033 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2034 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002035 * Broadcast Action: A new version of an application package has been
2036 * installed, replacing an existing version that was previously installed.
2037 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002038 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002039 * <ul>
2040 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2041 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002042 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002043 * <p class="note">This is a protected intent that can only be sent
2044 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002045 */
2046 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2047 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2048 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002049 * Broadcast Action: A new version of your application has been installed
2050 * over an existing one. This is only sent to the application that was
2051 * replaced. It does not contain any additional data; to receive it, just
2052 * use an intent filter for this action.
2053 *
2054 * <p class="note">This is a protected intent that can only be sent
2055 * by the system.
2056 */
2057 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2058 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2059 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002060 * Broadcast Action: An existing application package has been removed from
2061 * the device. The data contains the name of the package. The package
2062 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002063 * <ul>
2064 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2065 * to the package.
2066 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2067 * application -- data and code -- is being removed.
2068 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2069 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2070 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002071 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002072 * <p class="note">This is a protected intent that can only be sent
2073 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002074 */
2075 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2076 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2077 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002078 * Broadcast Action: An existing application package has been completely
2079 * removed from the device. The data contains the name of the package.
2080 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2081 * {@link #EXTRA_DATA_REMOVED} is true and
2082 * {@link #EXTRA_REPLACING} is false of that broadcast.
2083 *
2084 * <ul>
2085 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2086 * to the package.
2087 * </ul>
2088 *
2089 * <p class="note">This is a protected intent that can only be sent
2090 * by the system.
2091 */
2092 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2093 public static final String ACTION_PACKAGE_FULLY_REMOVED
2094 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2095 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002096 * Broadcast Action: An existing application package has been changed (e.g.
2097 * a component has been enabled or disabled). The data contains the name of
2098 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002099 * <ul>
2100 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002101 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002102 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002103 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2104 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002105 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002106 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002107 * <p class="note">This is a protected intent that can only be sent
2108 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002109 */
2110 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2111 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2112 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002113 * @hide
2114 * Broadcast Action: Ask system services if there is any reason to
2115 * restart the given package. The data contains the name of the
2116 * package.
2117 * <ul>
2118 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2119 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2120 * </ul>
2121 *
2122 * <p class="note">This is a protected intent that can only be sent
2123 * by the system.
2124 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002125 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002126 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2127 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2128 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002129 * Broadcast Action: The user has restarted a package, and all of its
2130 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002131 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002132 * be removed. Note that the restarted package does <em>not</em>
2133 * receive this broadcast.
2134 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002135 * <ul>
2136 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2137 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002138 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002139 * <p class="note">This is a protected intent that can only be sent
2140 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002141 */
2142 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2143 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2144 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002145 * Broadcast Action: The user has cleared the data of a package. This should
2146 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002147 * its persistent data is erased and this broadcast sent.
2148 * Note that the cleared package does <em>not</em>
2149 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002150 * <ul>
2151 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2152 * </ul>
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 Project9066cfe2009-03-03 19:31:44 -08002156 */
2157 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2158 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2159 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002160 * Broadcast Action: Packages have been suspended.
2161 * <p>Includes the following extras:
2162 * <ul>
2163 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2164 * </ul>
2165 *
2166 * <p class="note">This is a protected intent that can only be sent
2167 * by the system. It is only sent to registered receivers.
2168 */
2169 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2170 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2171 /**
2172 * Broadcast Action: Packages have been unsuspended.
2173 * <p>Includes the following extras:
2174 * <ul>
2175 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2176 * </ul>
2177 *
2178 * <p class="note">This is a protected intent that can only be sent
2179 * by the system. It is only sent to registered receivers.
2180 */
2181 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2182 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2183 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002184 * Broadcast Action: A user ID has been removed from the system. The user
2185 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002186 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002187 * <p class="note">This is a protected intent that can only be sent
2188 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002189 */
2190 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2191 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002192
2193 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002194 * Broadcast Action: Sent to the installer package of an application
2195 * when that application is first launched (that is the first time it
2196 * is moved out of the stopped state). The data contains the name of the package.
2197 *
2198 * <p class="note">This is a protected intent that can only be sent
2199 * by the system.
2200 */
2201 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2202 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2203
2204 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002205 * Broadcast Action: Sent to the system package verifier when a package
2206 * needs to be verified. The data contains the package URI.
2207 * <p class="note">
2208 * This is a protected intent that can only be sent by the system.
2209 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002210 */
2211 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2212 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2213
2214 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002215 * Broadcast Action: Sent to the system package verifier when a package is
2216 * verified. The data contains the package URI.
2217 * <p class="note">
2218 * This is a protected intent that can only be sent by the system.
2219 */
2220 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2221 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2222
2223 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002224 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
2225 * needs to be verified. The data contains the filter data hosts to be verified against.
2226 * <p class="note">
2227 * This is a protected intent that can only be sent by the system.
2228 * </p>
2229 *
2230 * @hide
2231 */
2232 @SystemApi
2233 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2234 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2235
2236 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002237 * Broadcast Action: Resources for a set of packages (which were
2238 * previously unavailable) are currently
2239 * available since the media on which they exist is available.
2240 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2241 * list of packages whose availability changed.
2242 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2243 * list of uids of packages whose availability changed.
2244 * Note that the
2245 * packages in this list do <em>not</em> receive this broadcast.
2246 * The specified set of packages are now available on the system.
2247 * <p>Includes the following extras:
2248 * <ul>
2249 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2250 * whose resources(were previously unavailable) are currently available.
2251 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2252 * packages whose resources(were previously unavailable)
2253 * are currently available.
2254 * </ul>
2255 *
2256 * <p class="note">This is a protected intent that can only be sent
2257 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002258 */
2259 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002260 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2261 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002262
2263 /**
2264 * Broadcast Action: Resources for a set of packages are currently
2265 * unavailable since the media on which they exist is unavailable.
2266 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2267 * list of packages whose availability changed.
2268 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2269 * list of uids of packages whose availability changed.
2270 * The specified set of packages can no longer be
2271 * launched and are practically unavailable on the system.
2272 * <p>Inclues the following extras:
2273 * <ul>
2274 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2275 * whose resources are no longer available.
2276 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2277 * whose resources are no longer available.
2278 * </ul>
2279 *
2280 * <p class="note">This is a protected intent that can only be sent
2281 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002282 */
2283 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002284 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002285 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002286
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002287 /**
2288 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002289 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002290 * This should <em>only</em> be used to determine when the wallpaper
2291 * has changed to show the new wallpaper to the user. You should certainly
2292 * never, in response to this, change the wallpaper or other attributes of
2293 * it such as the suggested size. That would be crazy, right? You'd cause
2294 * all kinds of loops, especially if other apps are doing similar things,
2295 * right? Of course. So please don't do this.
2296 *
2297 * @deprecated Modern applications should use
2298 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2299 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2300 * shown behind their UI, rather than watching for this broadcast and
2301 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002302 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002303 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002304 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2305 /**
2306 * Broadcast Action: The current device {@link android.content.res.Configuration}
2307 * (orientation, locale, etc) has changed. When such a change happens, the
2308 * UIs (view hierarchy) will need to be rebuilt based on this new
2309 * information; for the most part, applications don't need to worry about
2310 * this, because the system will take care of stopping and restarting the
2311 * application to make sure it sees the new changes. Some system code that
2312 * can not be restarted will need to watch for this action and handle it
2313 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002314 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002315 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002316 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002317 * in manifests, only by explicitly registering for it with
2318 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2319 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002320 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002321 * <p class="note">This is a protected intent that can only be sent
2322 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002323 *
2324 * @see android.content.res.Configuration
2325 */
2326 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2327 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2328 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002329 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002330 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002331 * <p class="note">This is a protected intent that can only be sent
2332 * by the system.
2333 */
2334 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2335 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2336 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002337 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2338 * charging state, level, and other information about the battery.
2339 * See {@link android.os.BatteryManager} for documentation on the
2340 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002341 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002342 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002343 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002344 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002345 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002346 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2347 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2348 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2349 * broadcasts that are sent and can be received through manifest
2350 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002351 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002352 * <p class="note">This is a protected intent that can only be sent
2353 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002354 */
2355 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2356 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2357 /**
2358 * Broadcast Action: Indicates low battery condition on the device.
2359 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002360 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002361 * <p class="note">This is a protected intent that can only be sent
2362 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002363 */
2364 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2365 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2366 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002367 * Broadcast Action: Indicates the battery is now okay after being low.
2368 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2369 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002370 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002371 * <p class="note">This is a protected intent that can only be sent
2372 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002373 */
2374 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2375 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2376 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002377 * Broadcast Action: External power has been connected to the device.
2378 * This is intended for applications that wish to register specifically to this notification.
2379 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2380 * stay active to receive this notification. This action can be used to implement actions
2381 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002382 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002383 * <p class="note">This is a protected intent that can only be sent
2384 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002385 */
2386 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002387 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002388 /**
2389 * Broadcast Action: External power has been removed from the device.
2390 * This is intended for applications that wish to register specifically to this notification.
2391 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2392 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002393 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002394 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002395 * <p class="note">This is a protected intent that can only be sent
2396 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002397 */
2398 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002399 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002400 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002401 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002402 * Broadcast Action: Device is shutting down.
2403 * This is broadcast when the device is being shut down (completely turned
2404 * off, not sleeping). Once the broadcast is complete, the final shutdown
2405 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002406 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002407 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002408 * <p class="note">This is a protected intent that can only be sent
2409 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002410 * <p>May include the following extras:
2411 * <ul>
2412 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2413 * shutdown is only for userspace processes. If not set, assumed to be false.
2414 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002415 */
2416 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002417 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002418 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002419 * Activity Action: Start this activity to request system shutdown.
2420 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002421 * to request confirmation from the user before shutting down. The optional boolean
2422 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2423 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002424 *
2425 * <p class="note">This is a protected intent that can only be sent
2426 * by the system.
2427 *
2428 * {@hide}
2429 */
2430 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2431 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002432 * Broadcast Action: A sticky broadcast that indicates low memory
2433 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002434 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002435 * <p class="note">This is a protected intent that can only be sent
2436 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002437 */
2438 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2439 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2440 /**
2441 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002442 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002443 * <p class="note">This is a protected intent that can only be sent
2444 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002445 */
2446 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2447 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2448 /**
Jake Hambybb371632010-08-23 18:16:48 -07002449 * Broadcast Action: A sticky broadcast that indicates a memory full
2450 * condition on the device. This is intended for activities that want
2451 * to be able to fill the data partition completely, leaving only
2452 * enough free space to prevent system-wide SQLite failures.
2453 *
2454 * <p class="note">This is a protected intent that can only be sent
2455 * by the system.
2456 *
2457 * {@hide}
2458 */
2459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2460 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2461 /**
2462 * Broadcast Action: Indicates memory full condition on the device
2463 * no longer exists.
2464 *
2465 * <p class="note">This is a protected intent that can only be sent
2466 * by the system.
2467 *
2468 * {@hide}
2469 */
2470 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2471 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2472 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002473 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2474 * and package management should be started.
2475 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2476 * notification.
2477 */
2478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2479 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2480 /**
2481 * Broadcast Action: The device has entered USB Mass Storage mode.
2482 * This is used mainly for the USB Settings panel.
2483 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2484 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002485 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002486 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002487 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002488 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2489
2490 /**
2491 * Broadcast Action: The device has exited USB Mass Storage mode.
2492 * This is used mainly for the USB Settings panel.
2493 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2494 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002495 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002496 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002497 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002498 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2499
2500 /**
2501 * Broadcast Action: External media has been removed.
2502 * The path to the mount point for the removed media is contained in the Intent.mData field.
2503 */
2504 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2505 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2506
2507 /**
2508 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002509 * 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 -07002510 */
2511 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2512 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2513
2514 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002515 * Broadcast Action: External media is present, and being disk-checked
2516 * 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 -08002517 */
2518 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2519 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2520
2521 /**
2522 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2523 * 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 -08002524 */
2525 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2526 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2527
2528 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002529 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002530 * 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 -07002531 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2532 * media was mounted read only.
2533 */
2534 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2535 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2536
2537 /**
2538 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002539 * 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 -07002540 */
2541 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2542 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2543
2544 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002545 * Broadcast Action: External media is no longer being shared via USB mass storage.
2546 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2547 *
2548 * @hide
2549 */
2550 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2551
2552 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002553 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2554 * The path to the mount point for the removed media is contained in the Intent.mData field.
2555 */
2556 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2557 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2558
2559 /**
2560 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002561 * 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 -07002562 */
2563 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2564 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2565
2566 /**
2567 * Broadcast Action: User has expressed the desire to remove the external storage media.
2568 * Applications should close all files they have open within the mount point when they receive this intent.
2569 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2570 */
2571 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2572 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2573
2574 /**
2575 * Broadcast Action: The media scanner has started scanning a directory.
2576 * The path to the directory being scanned is contained in the Intent.mData field.
2577 */
2578 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2579 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2580
2581 /**
2582 * Broadcast Action: The media scanner has finished scanning a directory.
2583 * The path to the scanned directory is contained in the Intent.mData field.
2584 */
2585 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2586 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2587
2588 /**
2589 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2590 * The path to the file is contained in the Intent.mData field.
2591 */
2592 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2593 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2594
2595 /**
2596 * Broadcast Action: The "Media Button" was pressed. Includes a single
2597 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2598 * caused the broadcast.
2599 */
2600 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2601 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2602
2603 /**
2604 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2605 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2606 * caused the broadcast.
2607 */
2608 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2609 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2610
2611 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2612 // location; they are not general-purpose actions.
2613
2614 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002615 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002616 */
2617 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2618 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2619 "android.intent.action.GTALK_CONNECTED";
2620
2621 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002622 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002623 */
2624 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2625 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2626 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002627
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002628 /**
2629 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002630 */
2631 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2632 public static final String ACTION_INPUT_METHOD_CHANGED =
2633 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002634
2635 /**
2636 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2637 * more radios have been turned off or on. The intent will have the following extra value:</p>
2638 * <ul>
2639 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2640 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2641 * turned off</li>
2642 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002643 *
Peng Xua35b5532016-01-20 00:05:45 -08002644 * <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 -07002645 */
2646 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2647 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2648
2649 /**
2650 * Broadcast Action: Some content providers have parts of their namespace
2651 * where they publish new events or items that the user may be especially
2652 * interested in. For these things, they may broadcast this action when the
2653 * set of interesting items change.
2654 *
2655 * For example, GmailProvider sends this notification when the set of unread
2656 * mail in the inbox changes.
2657 *
2658 * <p>The data of the intent identifies which part of which provider
2659 * changed. When queried through the content resolver, the data URI will
2660 * return the data set in question.
2661 *
2662 * <p>The intent will have the following extra values:
2663 * <ul>
2664 * <li><em>count</em> - The number of items in the data set. This is the
2665 * same as the number of items in the cursor returned by querying the
2666 * data URI. </li>
2667 * </ul>
2668 *
2669 * This intent will be sent at boot (if the count is non-zero) and when the
2670 * data set changes. It is possible for the data set to change without the
2671 * count changing (for example, if a new unread message arrives in the same
2672 * sync operation in which a message is archived). The phone should still
2673 * ring/vibrate/etc as normal in this case.
2674 */
2675 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2676 public static final String ACTION_PROVIDER_CHANGED =
2677 "android.intent.action.PROVIDER_CHANGED";
2678
2679 /**
2680 * Broadcast Action: Wired Headset plugged in or unplugged.
2681 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002682 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2683 * and documentation.
2684 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002685 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002686 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002687 */
2688 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002689 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002690
2691 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002692 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2693 * <ul>
2694 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2695 * </ul>
2696 *
2697 * <p class="note">This is a protected intent that can only be sent
2698 * by the system.
2699 *
2700 * @hide
2701 */
2702 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2703 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2704 = "android.intent.action.ADVANCED_SETTINGS";
2705
2706 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002707 * Broadcast Action: Sent after application restrictions are changed.
2708 *
2709 * <p class="note">This is a protected intent that can only be sent
2710 * by the system.</p>
2711 */
2712 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2713 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2714 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2715
2716 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002717 * Broadcast Action: An outgoing call is about to be placed.
2718 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002719 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002720 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002721 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002722 * the phone number originally intended to be dialed.</li>
2723 * </ul>
2724 * <p>Once the broadcast is finished, the resultData is used as the actual
2725 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002726 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002727 * outgoing call in turn: for example, a parental control application
2728 * might verify that the user is authorized to place the call at that
2729 * time, then a number-rewriting application might add an area code if
2730 * one was not specified.</p>
2731 * <p>For consistency, any receiver whose purpose is to prohibit phone
2732 * calls should have a priority of 0, to ensure it will see the final
2733 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002734 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002735 * should have a positive priority.
2736 * Negative priorities are reserved for the system for this broadcast;
2737 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002738 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2739 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002740 * <p>Emergency calls cannot be intercepted using this mechanism, and
2741 * other calls cannot be modified to call emergency numbers using this
2742 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002743 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2744 * call to use their own service instead. Those apps should first prevent
2745 * the call from being placed by setting resultData to <code>null</code>
2746 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002747 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002748 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2749 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002750 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002751 * <p class="note">This is a protected intent that can only be sent
2752 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002753 */
2754 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2755 public static final String ACTION_NEW_OUTGOING_CALL =
2756 "android.intent.action.NEW_OUTGOING_CALL";
2757
2758 /**
2759 * Broadcast Action: Have the device reboot. This is only for use by
2760 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002761 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002762 * <p class="note">This is a protected intent that can only be sent
2763 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002764 */
2765 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2766 public static final String ACTION_REBOOT =
2767 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002768
Wei Huang97ecc9c2009-05-11 17:44:20 -07002769 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002770 * Broadcast Action: A sticky broadcast for changes in the physical
2771 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002772 *
2773 * <p>The intent will have the following extra values:
2774 * <ul>
2775 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002776 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002777 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002778 * <p>This is intended for monitoring the current physical dock state.
2779 * See {@link android.app.UiModeManager} for the normal API dealing with
2780 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002781 */
2782 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2783 public static final String ACTION_DOCK_EVENT =
2784 "android.intent.action.DOCK_EVENT";
2785
2786 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002787 * Broadcast Action: A broadcast when idle maintenance can be started.
2788 * This means that the user is not interacting with the device and is
2789 * not expected to do so soon. Typical use of the idle maintenance is
2790 * to perform somehow expensive tasks that can be postponed at a moment
2791 * when they will not degrade user experience.
2792 * <p>
2793 * <p class="note">In order to keep the device responsive in case of an
2794 * unexpected user interaction, implementations of a maintenance task
2795 * should be interruptible. In such a scenario a broadcast with action
2796 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2797 * should not do the maintenance work in
2798 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2799 * maintenance service by {@link Context#startService(Intent)}. Also
2800 * you should hold a wake lock while your maintenance service is running
2801 * to prevent the device going to sleep.
2802 * </p>
2803 * <p>
2804 * <p class="note">This is a protected intent that can only be sent by
2805 * the system.
2806 * </p>
2807 *
2808 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002809 *
2810 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002811 */
2812 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2813 public static final String ACTION_IDLE_MAINTENANCE_START =
2814 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2815
2816 /**
2817 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2818 * This means that the user was not interacting with the device as a result
2819 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2820 * was sent and now the user started interacting with the device. Typical
2821 * use of the idle maintenance is to perform somehow expensive tasks that
2822 * can be postponed at a moment when they will not degrade user experience.
2823 * <p>
2824 * <p class="note">In order to keep the device responsive in case of an
2825 * unexpected user interaction, implementations of a maintenance task
2826 * should be interruptible. Hence, on receiving a broadcast with this
2827 * action, the maintenance task should be interrupted as soon as possible.
2828 * In other words, you should not do the maintenance work in
2829 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2830 * maintenance service that was started on receiving of
2831 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2832 * lock you acquired when your maintenance service started.
2833 * </p>
2834 * <p class="note">This is a protected intent that can only be sent
2835 * by the system.
2836 *
2837 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002838 *
2839 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002840 */
2841 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2842 public static final String ACTION_IDLE_MAINTENANCE_END =
2843 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2844
2845 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002846 * Broadcast Action: a remote intent is to be broadcasted.
2847 *
2848 * A remote intent is used for remote RPC between devices. The remote intent
2849 * is serialized and sent from one device to another device. The receiving
2850 * device parses the remote intent and broadcasts it. Note that anyone can
2851 * broadcast a remote intent. However, if the intent receiver of the remote intent
2852 * does not trust intent broadcasts from arbitrary intent senders, it should require
2853 * the sender to hold certain permissions so only trusted sender's broadcast will be
2854 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002855 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002856 */
2857 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002858 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002859
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002860 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002861 * Broadcast Action: This is broadcast once when the user is booting after a
2862 * system update. It can be used to perform cleanup or upgrades after a
2863 * system update.
2864 * <p>
2865 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2866 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2867 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2868 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002869 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002870 * @hide
2871 */
2872 public static final String ACTION_PRE_BOOT_COMPLETED =
2873 "android.intent.action.PRE_BOOT_COMPLETED";
2874
Amith Yamasani13593602012-03-22 16:16:17 -07002875 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002876 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002877 * on restricted users. The broadcast intent contains an extra
2878 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2879 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2880 * String[] depending on the restriction type.<p/>
2881 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002882 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2883 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2884 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002885 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2886 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002887 * @see RestrictionEntry
2888 */
2889 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2890 "android.intent.action.GET_RESTRICTION_ENTRIES";
2891
2892 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002893 * Sent the first time a user is starting, to allow system apps to
2894 * perform one time initialization. (This will not be seen by third
2895 * party applications because a newly initialized user does not have any
2896 * third party applications installed for it.) This is sent early in
2897 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002898 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2899 * broadcast, since it is part of a visible user interaction; be as quick
2900 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002901 */
2902 public static final String ACTION_USER_INITIALIZE =
2903 "android.intent.action.USER_INITIALIZE";
2904
2905 /**
2906 * Sent when a user switch is happening, causing the process's user to be
2907 * brought to the foreground. This is only sent to receivers registered
2908 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2909 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002910 * foreground. This is sent as a foreground
2911 * broadcast, since it is part of a visible user interaction; be as quick
2912 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002913 */
2914 public static final String ACTION_USER_FOREGROUND =
2915 "android.intent.action.USER_FOREGROUND";
2916
2917 /**
2918 * Sent when a user switch is happening, causing the process's user to be
2919 * sent to the background. This is only sent to receivers registered
2920 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2921 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002922 * background. This is sent as a foreground
2923 * broadcast, since it is part of a visible user interaction; be as quick
2924 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002925 */
2926 public static final String ACTION_USER_BACKGROUND =
2927 "android.intent.action.USER_BACKGROUND";
2928
2929 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002930 * Broadcast sent to the system when a user is added. Carries an extra
2931 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2932 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002933 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002934 * @hide
2935 */
2936 public static final String ACTION_USER_ADDED =
2937 "android.intent.action.USER_ADDED";
2938
2939 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002940 * Broadcast sent by the system when a user is started. Carries an extra
2941 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002942 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002943 * that has been started. This is sent as a foreground
2944 * broadcast, since it is part of a visible user interaction; be as quick
2945 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002946 * @hide
2947 */
2948 public static final String ACTION_USER_STARTED =
2949 "android.intent.action.USER_STARTED";
2950
2951 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002952 * Broadcast sent when a user is in the process of starting. Carries an extra
2953 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2954 * sent to registered receivers, not manifest receivers. It is sent to all
2955 * users (including the one that is being started). You must hold
2956 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2957 * this broadcast. This is sent as a background broadcast, since
2958 * its result is not part of the primary UX flow; to safely keep track of
2959 * started/stopped state of a user you can use this in conjunction with
2960 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2961 * other user state broadcasts since those are foreground broadcasts so can
2962 * execute in a different order.
2963 * @hide
2964 */
2965 public static final String ACTION_USER_STARTING =
2966 "android.intent.action.USER_STARTING";
2967
2968 /**
2969 * Broadcast sent when a user is going to be stopped. Carries an extra
2970 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2971 * sent to registered receivers, not manifest receivers. It is sent to all
2972 * users (including the one that is being stopped). You must hold
2973 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2974 * this broadcast. The user will not stop until all receivers have
2975 * handled the broadcast. This is sent as a background broadcast, since
2976 * its result is not part of the primary UX flow; to safely keep track of
2977 * started/stopped state of a user you can use this in conjunction with
2978 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2979 * other user state broadcasts since those are foreground broadcasts so can
2980 * execute in a different order.
2981 * @hide
2982 */
2983 public static final String ACTION_USER_STOPPING =
2984 "android.intent.action.USER_STOPPING";
2985
2986 /**
2987 * Broadcast sent to the system when a user is stopped. Carries an extra
2988 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2989 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2990 * specific package. This is only sent to registered receivers, not manifest
2991 * receivers. It is sent to all running users <em>except</em> the one that
2992 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002993 * @hide
2994 */
2995 public static final String ACTION_USER_STOPPED =
2996 "android.intent.action.USER_STOPPED";
2997
2998 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002999 * 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 -07003000 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003001 * one that has been removed. The user will not be completely removed until all receivers have
3002 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003003 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003004 * @hide
3005 */
3006 public static final String ACTION_USER_REMOVED =
3007 "android.intent.action.USER_REMOVED";
3008
3009 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003010 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003011 * the userHandle of the user to become the current one. This is only sent to
3012 * registered receivers, not manifest receivers. It is sent to all running users.
3013 * You must hold
3014 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003015 * @hide
3016 */
3017 public static final String ACTION_USER_SWITCHED =
3018 "android.intent.action.USER_SWITCHED";
3019
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003020 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003021 * Broadcast Action: Sent when the credential-encrypted private storage has
3022 * become unlocked for the target user. This is only sent to registered
3023 * receivers, not manifest receivers.
3024 */
3025 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3026 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3027
3028 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003029 * Broadcast sent to the system when a user's information changes. Carries an extra
3030 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003031 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003032 * @hide
3033 */
3034 public static final String ACTION_USER_INFO_CHANGED =
3035 "android.intent.action.USER_INFO_CHANGED";
3036
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003037 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003038 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3039 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003040 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3041 * that need to display merged content across both primary and managed profiles need to
3042 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003043 * not manifest receivers.
3044 */
3045 public static final String ACTION_MANAGED_PROFILE_ADDED =
3046 "android.intent.action.MANAGED_PROFILE_ADDED";
3047
3048 /**
3049 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003050 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3051 * Only applications (for example Launchers) that need to display merged content across both
3052 * primary and managed profiles need to worry about this broadcast. This is only sent to
3053 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003054 */
3055 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3056 "android.intent.action.MANAGED_PROFILE_REMOVED";
3057
3058 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003059 * Broadcast sent to the primary user when the credential-encrypted private storage for
3060 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3061 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3062 * Launchers) that need to display merged content across both primary and managed profiles
3063 * need to worry about this broadcast. This is only sent to registered receivers,
3064 * not manifest receivers.
3065 */
3066 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3067 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3068
Rubin Xue95057a2016-04-01 16:49:25 +01003069 /** @hide */
3070 public static final String ACTION_MANAGED_PROFILE_AVAILABILITY_CHANGED =
3071 "android.intent.action.MANAGED_PROFILE_AVAILABILITY_CHANGED";
3072
Kenny Guyb1b30262016-02-09 16:02:35 +00003073 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003074 * Broadcast sent to the primary user when an associated managed profile has become available.
3075 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003076 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3077 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3078 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003079 */
Rubin Xue95057a2016-04-01 16:49:25 +01003080 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3081 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3082
3083 /**
3084 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3085 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3086 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3087 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3088 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3089 */
3090 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3091 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003092
3093 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003094 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3095 */
3096 public static final String ACTION_QUICK_CLOCK =
3097 "android.intent.action.QUICK_CLOCK";
3098
Michael Wright0087a142013-02-05 16:29:39 -08003099 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003100 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003101 * @hide
3102 */
3103 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3104 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3105
Justin Kohd378ad72013-04-01 12:18:26 -07003106 /**
3107 * Broadcast Action: A global button was pressed. Includes a single
3108 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3109 * caused the broadcast.
3110 * @hide
3111 */
3112 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3113
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003114 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003115 * Broadcast Action: Sent when media resource is granted.
3116 * <p>
3117 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3118 * granted.
3119 * </p>
3120 * <p class="note">
3121 * This is a protected intent that can only be sent by the system.
3122 * </p>
3123 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003124 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003125 * </p>
3126 *
3127 * @hide
3128 */
3129 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3130 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3131
3132 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003133 * Activity Action: Allow the user to select and return one or more existing
3134 * documents. When invoked, the system will display the various
3135 * {@link DocumentsProvider} instances installed on the device, letting the
3136 * user interactively navigate through them. These documents include local
3137 * media, such as photos and video, and documents provided by installed
3138 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003139 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003140 * Each document is represented as a {@code content://} URI backed by a
3141 * {@link DocumentsProvider}, which can be opened as a stream with
3142 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3143 * {@link android.provider.DocumentsContract.Document} metadata.
3144 * <p>
3145 * All selected documents are returned to the calling application with
3146 * persistable read and write permission grants. If you want to maintain
3147 * access to the documents across device reboots, you need to explicitly
3148 * take the persistable permissions using
3149 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3150 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003151 * Callers must indicate the acceptable document MIME types through
3152 * {@link #setType(String)}. For example, to select photos, use
3153 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3154 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3155 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003156 * <p>
3157 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003158 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3159 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003160 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003161 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3162 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003163 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003164 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003165 * Output: The URI of the item that was picked, returned in
3166 * {@link #getData()}. This must be a {@code content://} URI so that any
3167 * receiver can access it. If multiple documents were selected, they are
3168 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003169 *
3170 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003171 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003172 * @see #ACTION_CREATE_DOCUMENT
3173 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003174 */
3175 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3176 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3177
3178 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003179 * Activity Action: Allow the user to create a new document. When invoked,
3180 * the system will display the various {@link DocumentsProvider} instances
3181 * installed on the device, letting the user navigate through them. The
3182 * returned document may be a newly created document with no content, or it
3183 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003184 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003185 * Each document is represented as a {@code content://} URI backed by a
3186 * {@link DocumentsProvider}, which can be opened as a stream with
3187 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3188 * {@link android.provider.DocumentsContract.Document} metadata.
3189 * <p>
3190 * Callers must indicate the concrete MIME type of the document being
3191 * created by setting {@link #setType(String)}. This MIME type cannot be
3192 * changed after the document is created.
3193 * <p>
3194 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3195 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003196 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003197 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3198 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003199 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003200 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003201 * Output: The URI of the item that was created. This must be a
3202 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003203 *
3204 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003205 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003206 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003207 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003208 */
3209 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3210 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3211
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003212 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003213 * Activity Action: Allow the user to pick a directory subtree. When
3214 * invoked, the system will display the various {@link DocumentsProvider}
3215 * instances installed on the device, letting the user navigate through
3216 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003217 * <p>
3218 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003219 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3220 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3221 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003222 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003223 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003224 *
3225 * @see DocumentsContract
3226 */
3227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003228 public static final String
3229 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003230
Felipe Lemec7b1f892016-01-15 15:02:31 -08003231 /**
Peng Xua35b5532016-01-20 00:05:45 -08003232 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3233 * exisiting sensor being disconnected.
3234 *
3235 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3236 *
3237 * {@hide}
3238 */
3239 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3240 public static final String
3241 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3242
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003243 /** {@hide} */
3244 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3245
Christopher Tate6597e342015-02-17 12:15:25 -08003246 /**
3247 * Broadcast action: report that a settings element is being restored from backup. The intent
3248 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3249 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3250 * is the value of that settings entry prior to the restore operation. All of these values are
3251 * represented as strings.
3252 *
3253 * <p>This broadcast is sent only for settings provider entries known to require special handling
3254 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3255 * the provider's backup agent implementation.
3256 *
3257 * @see #EXTRA_SETTING_NAME
3258 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3259 * @see #EXTRA_SETTING_NEW_VALUE
3260 * {@hide}
3261 */
3262 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3263
3264 /** {@hide} */
3265 public static final String EXTRA_SETTING_NAME = "setting_name";
3266 /** {@hide} */
3267 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3268 /** {@hide} */
3269 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3270
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003271 /**
3272 * Activity Action: Process a piece of text.
3273 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3274 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3275 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3276 */
3277 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3278 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3279 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003280 * The name of the extra used to define the text to be processed, as a
3281 * CharSequence. Note that this may be a styled CharSequence, so you must use
3282 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003283 */
3284 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3285 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003286 * 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 +00003287 */
3288 public static final String EXTRA_PROCESS_TEXT_READONLY =
3289 "android.intent.extra.PROCESS_TEXT_READONLY";
3290
Bryce Leebc58f592015-09-25 16:43:01 -07003291 /**
3292 * Broadcast action: reports when a new thermal event has been reached. When the device
3293 * is reaching its maximum temperatue, the thermal level reported
3294 * {@hide}
3295 */
3296 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3297 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3298
3299 /** {@hide} */
3300 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3301
3302 /**
3303 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003304 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003305 * {@hide}
3306 */
3307 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3308
3309 /**
3310 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003311 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003312 * {@hide}
3313 */
3314 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3315
3316 /**
3317 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003318 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003319 * {@hide}
3320 */
3321 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3322
3323
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003324 // ---------------------------------------------------------------------
3325 // ---------------------------------------------------------------------
3326 // Standard intent categories (see addCategory()).
3327
3328 /**
3329 * Set if the activity should be an option for the default action
3330 * (center press) to perform on a piece of data. Setting this will
3331 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003332 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003333 * Intent when initiating an action -- it is for use in intent filters
3334 * specified in packages.
3335 */
3336 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3337 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3338 /**
3339 * Activities that can be safely invoked from a browser must support this
3340 * category. For example, if the user is viewing a web page or an e-mail
3341 * and clicks on a link in the text, the Intent generated execute that
3342 * link will require the BROWSABLE category, so that only activities
3343 * supporting this category will be considered as possible actions. By
3344 * supporting this category, you are promising that there is nothing
3345 * damaging (without user intervention) that can happen by invoking any
3346 * matching Intent.
3347 */
3348 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3349 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3350 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003351 * Categories for activities that can participate in voice interaction.
3352 * An activity that supports this category must be prepared to run with
3353 * no UI shown at all (though in some case it may have a UI shown), and
3354 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3355 */
3356 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3357 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3358 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003359 * Set if the activity should be considered as an alternative action to
3360 * the data the user is currently viewing. See also
3361 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3362 * applies to the selection in a list of items.
3363 *
3364 * <p>Supporting this category means that you would like your activity to be
3365 * displayed in the set of alternative things the user can do, usually as
3366 * part of the current activity's options menu. You will usually want to
3367 * include a specific label in the &lt;intent-filter&gt; of this action
3368 * describing to the user what it does.
3369 *
3370 * <p>The action of IntentFilter with this category is important in that it
3371 * describes the specific action the target will perform. This generally
3372 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3373 * a specific name such as "com.android.camera.action.CROP. Only one
3374 * alternative of any particular action will be shown to the user, so using
3375 * a specific action like this makes sure that your alternative will be
3376 * displayed while also allowing other applications to provide their own
3377 * overrides of that particular action.
3378 */
3379 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3380 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3381 /**
3382 * Set if the activity should be considered as an alternative selection
3383 * action to the data the user has currently selected. This is like
3384 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3385 * of items from which the user can select, giving them alternatives to the
3386 * default action that will be performed on it.
3387 */
3388 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3389 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3390 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003391 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003392 */
3393 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3394 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3395 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003396 * Should be displayed in the top-level launcher.
3397 */
3398 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3399 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3400 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003401 * Indicates an activity optimized for Leanback mode, and that should
3402 * be displayed in the Leanback launcher.
3403 */
3404 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3405 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3406 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003407 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3408 * @hide
3409 */
3410 @SystemApi
3411 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3412 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003413 * Provides information about the package it is in; typically used if
3414 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3415 * a front-door to the user without having to be shown in the all apps list.
3416 */
3417 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3418 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3419 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003420 * This is the home activity, that is the first activity that is displayed
3421 * when the device boots.
3422 */
3423 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3424 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3425 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003426 * This is the home activity that is displayed when the device is finished setting up and ready
3427 * for use.
3428 * @hide
3429 */
3430 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3431 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3432 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003433 * This is the setup wizard activity, that is the first activity that is displayed
3434 * when the user sets up the device for the first time.
3435 * @hide
3436 */
3437 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3438 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3439 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003440 * This activity is a preference panel.
3441 */
3442 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3443 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3444 /**
3445 * This activity is a development preference panel.
3446 */
3447 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3448 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3449 /**
3450 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003451 */
3452 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3453 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3454 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003455 * This activity allows the user to browse and download new applications.
3456 */
3457 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3458 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3459 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003460 * This activity may be exercised by the monkey or other automated test tools.
3461 */
3462 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3463 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3464 /**
3465 * To be used as a test (not part of the normal user experience).
3466 */
3467 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3468 /**
3469 * To be used as a unit test (run through the Test Harness).
3470 */
3471 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3472 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003473 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003474 * experience).
3475 */
3476 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003477
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003478 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003479 * Used to indicate that an intent only wants URIs that can be opened with
3480 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3481 * must support at least the columns defined in {@link OpenableColumns} when
3482 * queried.
3483 *
3484 * @see #ACTION_GET_CONTENT
3485 * @see #ACTION_OPEN_DOCUMENT
3486 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003487 */
3488 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3489 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3490
3491 /**
3492 * To be used as code under test for framework instrumentation tests.
3493 */
3494 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3495 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003496 /**
3497 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003498 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3499 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003500 */
3501 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3502 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3503 /**
3504 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003505 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3506 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003507 */
3508 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3509 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003510 /**
3511 * An activity to run when device is inserted into a analog (low end) dock.
3512 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3513 * information, see {@link android.app.UiModeManager}.
3514 */
3515 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3516 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3517
3518 /**
3519 * An activity to run when device is inserted into a digital (high end) dock.
3520 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3521 * information, see {@link android.app.UiModeManager}.
3522 */
3523 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3524 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003525
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003526 /**
3527 * Used to indicate that the activity can be used in a car environment.
3528 */
3529 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3530 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3531
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003532 // ---------------------------------------------------------------------
3533 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003534 // Application launch intent categories (see addCategory()).
3535
3536 /**
3537 * Used with {@link #ACTION_MAIN} to launch the browser application.
3538 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003539 * <p>NOTE: This should not be used as the primary key of an Intent,
3540 * since it will not result in the app launching with the correct
3541 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003542 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003543 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003544 */
3545 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3546 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3547
3548 /**
3549 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3550 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003551 * <p>NOTE: This should not be used as the primary key of an Intent,
3552 * since it will not result in the app launching with the correct
3553 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003554 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003555 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003556 */
3557 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3558 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3559
3560 /**
3561 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3562 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003563 * <p>NOTE: This should not be used as the primary key of an Intent,
3564 * since it will not result in the app launching with the correct
3565 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003566 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003567 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003568 */
3569 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3570 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3571
3572 /**
3573 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3574 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003575 * <p>NOTE: This should not be used as the primary key of an Intent,
3576 * since it will not result in the app launching with the correct
3577 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003578 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003579 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003580 */
3581 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3582 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3583
3584 /**
3585 * Used with {@link #ACTION_MAIN} to launch the email application.
3586 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003587 * <p>NOTE: This should not be used as the primary key of an Intent,
3588 * since it will not result in the app launching with the correct
3589 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003590 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003591 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003592 */
3593 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3594 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3595
3596 /**
3597 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3598 * The activity should be able to view and manipulate image and video files
3599 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003600 * <p>NOTE: This should not be used as the primary key of an Intent,
3601 * since it will not result in the app launching with the correct
3602 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003603 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003604 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003605 */
3606 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3607 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3608
3609 /**
3610 * Used with {@link #ACTION_MAIN} to launch the maps application.
3611 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003612 * <p>NOTE: This should not be used as the primary key of an Intent,
3613 * since it will not result in the app launching with the correct
3614 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003615 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003616 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003617 */
3618 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3619 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3620
3621 /**
3622 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3623 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003624 * <p>NOTE: This should not be used as the primary key of an Intent,
3625 * since it will not result in the app launching with the correct
3626 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003627 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003628 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003629 */
3630 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3631 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3632
3633 /**
3634 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003635 * The activity should be able to play, browse, or manipulate music files
3636 * stored on the device.
3637 * <p>NOTE: This should not be used as the primary key of an Intent,
3638 * since it will not result in the app launching with the correct
3639 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003640 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003641 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003642 */
3643 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3644 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3645
3646 // ---------------------------------------------------------------------
3647 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003648 // Standard extra data keys.
3649
3650 /**
3651 * The initial data to place in a newly created record. Use with
3652 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3653 * fields as would be given to the underlying ContentProvider.insert()
3654 * call.
3655 */
3656 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3657
3658 /**
3659 * A constant CharSequence that is associated with the Intent, used with
3660 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3661 * this may be a styled CharSequence, so you must use
3662 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3663 * retrieve it.
3664 */
3665 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3666
3667 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003668 * A constant String that is associated with the Intent, used with
3669 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3670 * as HTML formatted text. Note that you <em>must</em> also supply
3671 * {@link #EXTRA_TEXT}.
3672 */
3673 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3674
3675 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003676 * A content: URI holding a stream of data associated with the Intent,
3677 * used with {@link #ACTION_SEND} to supply the data being sent.
3678 */
3679 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3680
3681 /**
3682 * A String[] holding e-mail addresses that should be delivered to.
3683 */
3684 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3685
3686 /**
3687 * A String[] holding e-mail addresses that should be carbon copied.
3688 */
3689 public static final String EXTRA_CC = "android.intent.extra.CC";
3690
3691 /**
3692 * A String[] holding e-mail addresses that should be blind carbon copied.
3693 */
3694 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3695
3696 /**
3697 * A constant string holding the desired subject line of a message.
3698 */
3699 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3700
3701 /**
3702 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003703 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003704 */
3705 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3706
3707 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003708 * An int representing the user id to be used.
3709 *
3710 * @hide
3711 */
3712 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3713
3714 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003715 * An int representing the task id to be retrieved. This is used when a launch from recents is
3716 * intercepted by another action such as credentials confirmation to remember which task should
3717 * be resumed when complete.
3718 *
3719 * @hide
3720 */
3721 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3722
3723 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003724 * An Intent[] describing additional, alternate choices you would like shown with
3725 * {@link #ACTION_CHOOSER}.
3726 *
3727 * <p>An app may be capable of providing several different payload types to complete a
3728 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3729 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3730 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3731 * photo data or a hosted link where the photos can be viewed.</p>
3732 *
3733 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3734 * first/primary/preferred intent in the set. Additional intents specified in
3735 * this extra are ordered; by default intents that appear earlier in the array will be
3736 * preferred over intents that appear later in the array as matches for the same
3737 * target component. To alter this preference, a calling app may also supply
3738 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3739 */
3740 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3741
3742 /**
3743 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3744 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3745 *
3746 * <p>An app preparing an action for another app to complete may wish to allow the user to
3747 * disambiguate between several options for completing the action based on the chosen target
3748 * or otherwise refine the action before it is invoked.
3749 * </p>
3750 *
3751 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3752 * <ul>
3753 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3754 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3755 * chosen target beyond the first</li>
3756 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3757 * should fill in and send once the disambiguation is complete</li>
3758 * </ul>
3759 */
3760 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3761 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3762
3763 /**
3764 * A {@link ResultReceiver} used to return data back to the sender.
3765 *
3766 * <p>Used to complete an app-specific
3767 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3768 *
3769 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3770 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3771 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3772 * when the user selects a target component from the chooser. It is up to the recipient
3773 * to send a result to this ResultReceiver to signal that disambiguation is complete
3774 * and that the chooser should invoke the user's choice.</p>
3775 *
3776 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3777 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3778 * to match and fill in the final Intent or ChooserTarget before starting it.
3779 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3780 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3781 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3782 *
3783 * <p>The result code passed to the ResultReceiver should be
3784 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3785 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3786 * the chooser should finish without starting a target.</p>
3787 */
3788 public static final String EXTRA_RESULT_RECEIVER
3789 = "android.intent.extra.RESULT_RECEIVER";
3790
3791 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003792 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003793 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003794 */
3795 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3796
3797 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003798 * A Parcelable[] of {@link Intent} or
3799 * {@link android.content.pm.LabeledIntent} objects as set with
3800 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3801 * a the front of the list of choices, when shown to the user with a
3802 * {@link #ACTION_CHOOSER}.
3803 */
3804 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3805
3806 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003807 * A {@link IntentSender} to start after ephemeral installation success.
3808 * @hide
3809 */
3810 @SystemApi
3811 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3812
3813 /**
3814 * A {@link IntentSender} to start after ephemeral installation failure.
3815 * @hide
3816 */
3817 @SystemApi
3818 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3819
3820 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003821 * A Bundle forming a mapping of potential target package names to different extras Bundles
3822 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3823 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3824 * be currently installed on the device.
3825 *
3826 * <p>An application may choose to provide alternate extras for the case where a user
3827 * selects an activity from a predetermined set of target packages. If the activity
3828 * the user selects from the chooser belongs to a package with its package name as
3829 * a key in this bundle, the corresponding extras for that package will be merged with
3830 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3831 * extra has the same key as an extra already present in the intent it will overwrite
3832 * the extra from the intent.</p>
3833 *
3834 * <p><em>Examples:</em>
3835 * <ul>
3836 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3837 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3838 * parameters for that target.</li>
3839 * <li>An application may offer additional metadata for known targets of a given intent
3840 * to pass along information only relevant to that target such as account or content
3841 * identifiers already known to that application.</li>
3842 * </ul></p>
3843 */
3844 public static final String EXTRA_REPLACEMENT_EXTRAS =
3845 "android.intent.extra.REPLACEMENT_EXTRAS";
3846
3847 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003848 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3849 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3850 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3851 * {@link ComponentName} of the chosen component.
3852 *
3853 * <p>In some situations this callback may never come, for example if the user abandons
3854 * the chooser, switches to another task or any number of other reasons. Apps should not
3855 * be written assuming that this callback will always occur.</p>
3856 */
3857 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3858 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3859
3860 /**
3861 * The {@link ComponentName} chosen by the user to complete an action.
3862 *
3863 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3864 */
3865 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3866
3867 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003868 * A {@link android.view.KeyEvent} object containing the event that
3869 * triggered the creation of the Intent it is in.
3870 */
3871 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3872
3873 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003874 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3875 * before shutting down.
3876 *
3877 * {@hide}
3878 */
3879 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3880
3881 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003882 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3883 * requested by the user.
3884 *
3885 * {@hide}
3886 */
3887 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3888 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3889
3890 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003891 * 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 -07003892 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3893 * of restarting the application.
3894 */
3895 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3896
3897 /**
3898 * A String holding the phone number originally entered in
3899 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3900 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3901 */
3902 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003903
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003904 /**
3905 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3906 * intents to supply the uid the package had been assigned. Also an optional
3907 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3908 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3909 * purpose.
3910 */
3911 public static final String EXTRA_UID = "android.intent.extra.UID";
3912
3913 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003914 * @hide String array of package names.
3915 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003916 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003917 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3918
3919 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003920 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3921 * intents to indicate whether this represents a full uninstall (removing
3922 * both the code and its data) or a partial uninstall (leaving its data,
3923 * implying that this is an update).
3924 */
3925 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003926
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003927 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003928 * @hide
3929 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3930 * intents to indicate that at this point the package has been removed for
3931 * all users on the device.
3932 */
3933 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3934 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3935
3936 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003937 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3938 * intents to indicate that this is a replacement of the package, so this
3939 * broadcast will immediately be followed by an add broadcast for a
3940 * different version of the same package.
3941 */
3942 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003943
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003944 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003945 * Used as an int extra field in {@link android.app.AlarmManager} intents
3946 * to tell the application being invoked how many pending alarms are being
3947 * delievered with the intent. For one-shot alarms this will always be 1.
3948 * For recurring alarms, this might be greater than 1 if the device was
3949 * asleep or powered off at the time an earlier alarm would have been
3950 * delivered.
3951 */
3952 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003953
Jacek Surazski86b6c532009-05-13 14:38:28 +02003954 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003955 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3956 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003957 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3958 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003959 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3960 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3961 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003962 */
3963 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3964
3965 /**
3966 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3967 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003968 */
3969 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3970
3971 /**
3972 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3973 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003974 */
3975 public static final int EXTRA_DOCK_STATE_DESK = 1;
3976
3977 /**
3978 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3979 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003980 */
3981 public static final int EXTRA_DOCK_STATE_CAR = 2;
3982
3983 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003984 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3985 * to represent that the phone is in a analog (low end) dock.
3986 */
3987 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3988
3989 /**
3990 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3991 * to represent that the phone is in a digital (high end) dock.
3992 */
3993 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3994
3995 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003996 * Boolean that can be supplied as meta-data with a dock activity, to
3997 * indicate that the dock should take over the home key when it is active.
3998 */
3999 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004000
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004001 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004002 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4003 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004004 */
4005 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4006
4007 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004008 * Used in the extra field in the remote intent. It's astring token passed with the
4009 * remote intent.
4010 */
4011 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4012 "android.intent.extra.remote_intent_token";
4013
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004014 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004015 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004016 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004017 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004018 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004019 "android.intent.extra.changed_component_name";
4020
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004021 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004022 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004023 * and contains a string array of all of the components that have changed. If
4024 * the state of the overall package has changed, then it will contain an entry
4025 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004026 */
4027 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4028 "android.intent.extra.changed_component_name_list";
4029
4030 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004031 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004032 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004033 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4034 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4035 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004036 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004037 */
4038 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4039 "android.intent.extra.changed_package_list";
4040
4041 /**
4042 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004043 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4044 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004045 * and contains an integer array of uids of all of the components
4046 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004047 */
4048 public static final String EXTRA_CHANGED_UID_LIST =
4049 "android.intent.extra.changed_uid_list";
4050
4051 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004052 * @hide
4053 * Magic extra system code can use when binding, to give a label for
4054 * who it is that has bound to a service. This is an integer giving
4055 * a framework string resource that can be displayed to the user.
4056 */
4057 public static final String EXTRA_CLIENT_LABEL =
4058 "android.intent.extra.client_label";
4059
4060 /**
4061 * @hide
4062 * Magic extra system code can use when binding, to give a PendingIntent object
4063 * that can be launched for the user to disable the system's use of this
4064 * service.
4065 */
4066 public static final String EXTRA_CLIENT_INTENT =
4067 "android.intent.extra.client_intent";
4068
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004069 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004070 * Extra used to indicate that an intent should only return data that is on
4071 * the local device. This is a boolean extra; the default is false. If true,
4072 * an implementation should only allow the user to select data that is
4073 * already on the device, not requiring it be downloaded from a remote
4074 * service when opened.
4075 *
4076 * @see #ACTION_GET_CONTENT
4077 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004078 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004079 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004080 */
4081 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004082 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004083
Amith Yamasani13593602012-03-22 16:16:17 -07004084 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004085 * Extra used to indicate that an intent can allow the user to select and
4086 * return multiple items. This is a boolean extra; the default is false. If
4087 * true, an implementation is allowed to present the user with a UI where
4088 * they can pick multiple items that are all returned to the caller. When
4089 * this happens, they should be returned as the {@link #getClipData()} part
4090 * of the result Intent.
4091 *
4092 * @see #ACTION_GET_CONTENT
4093 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004094 */
4095 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004096 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004097
4098 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004099 * The integer userHandle carried with broadcast intents related to addition, removal and
4100 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4101 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4102 *
Amith Yamasani13593602012-03-22 16:16:17 -07004103 * @hide
4104 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004105 public static final String EXTRA_USER_HANDLE =
4106 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004107
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004108 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004109 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4110 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4111 */
4112 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004113 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004114
4115 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004116 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004117 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4118 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004119 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004120 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4121
4122 /**
4123 * Extra sent in the intent to the BroadcastReceiver that handles
4124 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4125 * the restrictions as key/value pairs.
4126 */
4127 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4128 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004129
Amith Yamasani86118ba2013-03-28 14:33:16 -07004130 /**
4131 * Extra used in the response from a BroadcastReceiver that handles
4132 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4133 */
4134 public static final String EXTRA_RESTRICTIONS_INTENT =
4135 "android.intent.extra.restrictions_intent";
4136
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004137 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004138 * Extra used to communicate a set of acceptable MIME types. The type of the
4139 * extra is {@code String[]}. Values may be a combination of concrete MIME
4140 * types (such as "image/png") and/or partial MIME types (such as
4141 * "audio/*").
4142 *
4143 * @see #ACTION_GET_CONTENT
4144 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004145 */
4146 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4147
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004148 /**
4149 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4150 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004151 * When this is true, hardware devices can use this information to determine that
4152 * they shouldn't do a complete shutdown of their device since this is not a
4153 * complete shutdown down to the kernel, but only user space restarting.
4154 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004155 */
4156 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4157 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4158
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004159 /**
4160 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4161 * user has set their time format preferences to the 24 hour format.
4162 *
4163 * @hide for internal use only.
4164 */
4165 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4166 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4167
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004168 /** {@hide} */
4169 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4170
Rubin Xue8490f12015-06-25 12:17:48 +01004171 /** {@hide} */
4172 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4173
Santos Cordon15a13782015-03-31 18:32:31 -07004174 /**
4175 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4176 * activation request.
4177 * TODO: Add information about the structure and response data used with the pending intent.
4178 * @hide
4179 */
4180 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4181 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4182
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004183 /**
4184 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004185 *
4186 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004187 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004188 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4189
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004190 /**
4191 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004192 * When a profile goes into quiet mode, all apps in the profile are killed and the
4193 * profile user is stopped. Widgets originating from the profile are masked, and app
4194 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004195 */
4196 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004197
4198 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004199 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004200 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004201 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4202 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004203 *
4204 * @hide
4205 */
4206 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4207 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4208
4209 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004210 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004211 * to represent that a video codec is allowed to use.
4212 *
4213 * @hide
4214 */
4215 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4216
4217 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004218 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004219 * to represent that a audio codec is allowed to use.
4220 *
4221 * @hide
4222 */
4223 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4224
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004225 // ---------------------------------------------------------------------
4226 // ---------------------------------------------------------------------
4227 // Intent flags (see mFlags variable).
4228
Tor Norbyed9273d62013-05-30 15:59:53 -07004229 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004230 @IntDef(flag = true, value = {
4231 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4232 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004233 @Retention(RetentionPolicy.SOURCE)
4234 public @interface GrantUriMode {}
4235
Jeff Sharkey846318a2014-04-04 12:12:41 -07004236 /** @hide */
4237 @IntDef(flag = true, value = {
4238 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4239 @Retention(RetentionPolicy.SOURCE)
4240 public @interface AccessUriMode {}
4241
4242 /**
4243 * Test if given mode flags specify an access mode, which must be at least
4244 * read and/or write.
4245 *
4246 * @hide
4247 */
4248 public static boolean isAccessUriMode(int modeFlags) {
4249 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4250 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4251 }
4252
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004253 /**
4254 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004255 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004256 * specified in its ClipData. When applying to an Intent's ClipData,
4257 * all URIs as well as recursive traversals through data or other ClipData
4258 * in Intent items will be granted; only the grant flags of the top-level
4259 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004260 */
4261 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4262 /**
4263 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004264 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004265 * specified in its ClipData. When applying to an Intent's ClipData,
4266 * all URIs as well as recursive traversals through data or other ClipData
4267 * in Intent items will be granted; only the grant flags of the top-level
4268 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004269 */
4270 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4271 /**
4272 * Can be set by the caller to indicate that this Intent is coming from
4273 * a background operation, not from direct user interaction.
4274 */
4275 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4276 /**
4277 * A flag you can enable for debugging: when set, log messages will be
4278 * printed during the resolution of this intent to show you what has
4279 * been found to create the final resolved list.
4280 */
4281 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004282 /**
4283 * If set, this intent will not match any components in packages that
4284 * are currently stopped. If this is not set, then the default behavior
4285 * is to include such applications in the result.
4286 */
4287 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4288 /**
4289 * If set, this intent will always match any components in packages that
4290 * are currently stopped. This is the default behavior when
4291 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4292 * flags are set, this one wins (it allows overriding of exclude for
4293 * places where the framework may automatically set the exclude flag).
4294 */
4295 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004296
4297 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004298 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004299 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004300 * persisted across device reboots until explicitly revoked with
4301 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4302 * grant for possible persisting; the receiving application must call
4303 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4304 * actually persist.
4305 *
4306 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4307 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4308 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004309 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004310 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004311 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004312
4313 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004314 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4315 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4316 * applies to any URI that is a prefix match against the original granted
4317 * URI. (Without this flag, the URI must match exactly for access to be
4318 * granted.) Another URI is considered a prefix match only when scheme,
4319 * authority, and all path segments defined by the prefix are an exact
4320 * match.
4321 */
4322 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4323
4324 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004325 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004326 * homework and verified that they correctly handle packages and components
4327 * that come and go over time. In particular:
4328 * <ul>
4329 * <li>Apps installed on external storage, which will appear to be
4330 * uninstalled while the the device is ejected.
4331 * <li>Apps with encryption unaware components, which will appear to not
4332 * exist while the device is locked.
4333 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004334 *
4335 * @hide
4336 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004337 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004338
4339 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004340 * If set, the new activity is not kept in the history stack. As soon as
4341 * the user navigates away from it, the activity is finished. This may also
4342 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4343 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004344 *
4345 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4346 * is never invoked when the current activity starts a new activity which
4347 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004348 */
4349 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4350 /**
4351 * If set, the activity will not be launched if it is already running
4352 * at the top of the history stack.
4353 */
4354 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4355 /**
4356 * If set, this activity will become the start of a new task on this
4357 * history stack. A task (from the activity that started it to the
4358 * next task activity) defines an atomic group of activities that the
4359 * user can move to. Tasks can be moved to the foreground and background;
4360 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004361 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004362 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4363 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004364 *
4365 * <p>This flag is generally used by activities that want
4366 * to present a "launcher" style behavior: they give the user a list of
4367 * separate things that can be done, which otherwise run completely
4368 * independently of the activity launching them.
4369 *
4370 * <p>When using this flag, if a task is already running for the activity
4371 * you are now starting, then a new activity will not be started; instead,
4372 * the current task will simply be brought to the front of the screen with
4373 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4374 * to disable this behavior.
4375 *
4376 * <p>This flag can not be used when the caller is requesting a result from
4377 * the activity being launched.
4378 */
4379 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4380 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004381 * This flag is used to create a new task and launch an activity into it.
4382 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4383 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4384 * search through existing tasks for ones matching this Intent. Only if no such
4385 * task is found would a new task be created. When paired with
4386 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4387 * the search for a matching task and unconditionally start a new task.
4388 *
4389 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4390 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004391 * top-level application launcher.</strong> Used in conjunction with
4392 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4393 * behavior of bringing an existing task to the foreground. When set,
4394 * a new task is <em>always</em> started to host the Activity for the
4395 * Intent, regardless of whether there is already an existing task running
4396 * the same thing.
4397 *
4398 * <p><strong>Because the default system does not include graphical task management,
4399 * you should not use this flag unless you provide some way for a user to
4400 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004401 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004402 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4403 * creating new document tasks.
4404 *
4405 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004406 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004407 *
Scott Main7aee61f2011-02-08 11:25:01 -08004408 * <p>See
4409 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4410 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004411 *
4412 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4413 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004414 */
4415 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4416 /**
4417 * If set, and the activity being launched is already running in the
4418 * current task, then instead of launching a new instance of that activity,
4419 * all of the other activities on top of it will be closed and this Intent
4420 * will be delivered to the (now on top) old activity as a new Intent.
4421 *
4422 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4423 * If D calls startActivity() with an Intent that resolves to the component
4424 * of activity B, then C and D will be finished and B receive the given
4425 * Intent, resulting in the stack now being: A, B.
4426 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004427 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004428 * either receive the new intent you are starting here in its
4429 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004430 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004431 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4432 * the same intent, then it will be finished and re-created; for all other
4433 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4434 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004435 *
4436 * <p>This launch mode can also be used to good effect in conjunction with
4437 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4438 * of a task, it will bring any currently running instance of that task
4439 * to the foreground, and then clear it to its root state. This is
4440 * especially useful, for example, when launching an activity from the
4441 * notification manager.
4442 *
Scott Main7aee61f2011-02-08 11:25:01 -08004443 * <p>See
4444 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4445 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004446 */
4447 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4448 /**
4449 * If set and this intent is being used to launch a new activity from an
4450 * existing one, then the reply target of the existing activity will be
4451 * transfered to the new activity. This way the new activity can call
4452 * {@link android.app.Activity#setResult} and have that result sent back to
4453 * the reply target of the original activity.
4454 */
4455 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4456 /**
4457 * If set and this intent is being used to launch a new activity from an
4458 * existing one, the current activity will not be counted as the top
4459 * activity for deciding whether the new intent should be delivered to
4460 * the top instead of starting a new one. The previous activity will
4461 * be used as the top, with the assumption being that the current activity
4462 * will finish itself immediately.
4463 */
4464 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4465 /**
4466 * If set, the new activity is not kept in the list of recently launched
4467 * activities.
4468 */
4469 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4470 /**
4471 * This flag is not normally set by application code, but set for you by
4472 * the system as described in the
4473 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4474 * launchMode} documentation for the singleTask mode.
4475 */
4476 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4477 /**
4478 * If set, and this activity is either being started in a new task or
4479 * bringing to the top an existing task, then it will be launched as
4480 * the front door of the task. This will result in the application of
4481 * any affinities needed to have that task in the proper state (either
4482 * moving activities to or from it), or simply resetting that task to
4483 * its initial state if needed.
4484 */
4485 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4486 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004487 * This flag is not normally set by application code, but set for you by
4488 * the system if this activity is being launched from history
4489 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004490 */
4491 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004492 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004493 * @deprecated As of API 21 this performs identically to
4494 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004495 */
4496 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004497 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004498 * This flag is used to open a document into a new task rooted at the activity launched
4499 * by this Intent. Through the use of this flag, or its equivalent attribute,
4500 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004501 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004502 *
Craig Mautner026596b2014-05-21 15:35:44 -07004503 * <p>The use of the activity attribute form of this,
4504 * {@link android.R.attr#documentLaunchMode}, is
4505 * preferred over the Intent flag described here. The attribute form allows the
4506 * Activity to specify multiple document behavior for all launchers of the Activity
4507 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004508 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004509 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4510 * it is kept after the activity is finished is different than the use of
4511 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4512 * this flag is being used to create a new recents entry, then by default that entry
4513 * will be removed once the activity is finished. You can modify this behavior with
4514 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4515 *
Craig Mautner026596b2014-05-21 15:35:44 -07004516 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4517 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4518 * equivalent of the Activity manifest specifying {@link
4519 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4520 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4521 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004522 *
Craig Mautner026596b2014-05-21 15:35:44 -07004523 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004524 *
Craig Mautner026596b2014-05-21 15:35:44 -07004525 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004526 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4527 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004528 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004529 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004530 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004531 * callback from occurring on the current frontmost activity before it is
4532 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004533 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004534 * <p>Typically, an activity can rely on that callback to indicate that an
4535 * explicit user action has caused their activity to be moved out of the
4536 * foreground. The callback marks an appropriate point in the activity's
4537 * lifecycle for it to dismiss any notifications that it intends to display
4538 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004539 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004540 * <p>If an activity is ever started via any non-user-driven events such as
4541 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4542 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004543 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004544 */
4545 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004546 /**
4547 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4548 * this flag will cause the launched activity to be brought to the front of its
4549 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004550 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004551 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4552 * If D calls startActivity() with an Intent that resolves to the component
4553 * of activity B, then B will be brought to the front of the history stack,
4554 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004555 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004556 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004557 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004558 */
4559 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004560 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004561 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4562 * this flag will prevent the system from applying an activity transition
4563 * animation to go to the next activity state. This doesn't mean an
4564 * animation will never run -- if another activity change happens that doesn't
4565 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004566 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004567 * when you are going to do a series of activity operations but the
4568 * animation seen by the user shouldn't be driven by the first activity
4569 * change but rather a later one.
4570 */
4571 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4572 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004573 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4574 * this flag will cause any existing task that would be associated with the
4575 * activity to be cleared before the activity is started. That is, the activity
4576 * becomes the new root of an otherwise empty task, and any old activities
4577 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4578 */
4579 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4580 /**
4581 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4582 * this flag will cause a newly launching task to be placed on top of the current
4583 * home activity task (if there is one). That is, pressing back from the task
4584 * will always return the user to home even if that was not the last activity they
4585 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4586 */
4587 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4588 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004589 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4590 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004591 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004592 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004593 * this flag. When set and the task's activity is finished, the recents
4594 * entry will remain in the interface for the user to re-launch it, like a
4595 * recents entry for a top-level application.
4596 * <p>
4597 * The receiving activity can override this request with
4598 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4599 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004600 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004601 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004602 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004603
4604 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004605 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4606 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004607 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4608 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004609 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004610 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004611
4612 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004613 * If set, when sending a broadcast only registered receivers will be
4614 * called -- no BroadcastReceiver components will be launched.
4615 */
4616 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004617 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004618 * If set, when sending a broadcast the new broadcast will replace
4619 * any existing pending broadcast that matches it. Matching is defined
4620 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4621 * true for the intents of the two broadcasts. When a match is found,
4622 * the new broadcast (and receivers associated with it) will replace the
4623 * existing one in the pending broadcast list, remaining at the same
4624 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004625 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004626 * <p>This flag is most typically used with sticky broadcasts, which
4627 * only care about delivering the most recent values of the broadcast
4628 * to their receivers.
4629 */
4630 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4631 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004632 * If set, when sending a broadcast the recipient is allowed to run at
4633 * foreground priority, with a shorter timeout interval. During normal
4634 * broadcasts the receivers are not automatically hoisted out of the
4635 * background priority class.
4636 */
4637 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4638 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004639 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4640 * They can still propagate results through to later receivers, but they can not prevent
4641 * later receivers from seeing the broadcast.
4642 */
4643 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4644 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004645 * If set, when sending a broadcast <i>before boot has completed</i> only
4646 * registered receivers will be called -- no BroadcastReceiver components
4647 * will be launched. Sticky intent state will be recorded properly even
4648 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4649 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004650 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004651 * <p>This flag is only for use by system sevices as a convenience to
4652 * avoid having to implement a more complex mechanism around detection
4653 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004654 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004655 * @hide
4656 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004657 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004658 /**
4659 * Set when this broadcast is for a boot upgrade, a special mode that
4660 * allows the broadcast to be sent before the system is ready and launches
4661 * the app process with no providers running in it.
4662 * @hide
4663 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004664 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004665 /**
4666 * If set, the broadcast will always go to manifest receivers in background (cached
4667 * or not running) apps, regardless of whether that would be done by default. By
4668 * default they will only receive broadcasts if the broadcast has specified an
4669 * explicit component or package name.
4670 * @hide
4671 */
4672 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4673 /**
4674 * If set, the broadcast will never go to manifest receivers in background (cached
4675 * or not running) apps, regardless of whether that would be done by default. By
4676 * default they will receive broadcasts if the broadcast has specified an
4677 * explicit component or package name.
4678 * @hide
4679 */
4680 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004681
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004682 /**
4683 * @hide Flags that can't be changed with PendingIntent.
4684 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004685 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4686 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4687 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004688
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004689 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004690 // ---------------------------------------------------------------------
4691 // toUri() and parseUri() options.
4692
4693 /**
4694 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4695 * always has the "intent:" scheme. This syntax can be used when you want
4696 * to later disambiguate between URIs that are intended to describe an
4697 * Intent vs. all others that should be treated as raw URIs. When used
4698 * with {@link #parseUri}, any other scheme will result in a generic
4699 * VIEW action for that raw URI.
4700 */
4701 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004702
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004703 /**
4704 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4705 * always has the "android-app:" scheme. This is a variation of
4706 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4707 * http/https URI being delivered to a specific package name. The format
4708 * is:
4709 *
4710 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004711 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004712 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004713 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4714 * you must also include a scheme; including a path also requires both a host and a scheme.
4715 * The final #Intent; fragment can be used without a scheme, host, or path.
4716 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004717 * used with intents that have a {@link #setSelector}, since the base intent
4718 * will always have an explicit package name.</p>
4719 *
4720 * <p>Some examples of how this scheme maps to Intent objects:</p>
4721 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4722 * <colgroup align="left" />
4723 * <colgroup align="left" />
4724 * <thead>
4725 * <tr><th>URI</th> <th>Intent</th></tr>
4726 * </thead>
4727 *
4728 * <tbody>
4729 * <tr><td><code>android-app://com.example.app</code></td>
4730 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4731 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4732 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4733 * </table></td>
4734 * </tr>
4735 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4736 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4737 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4738 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4739 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4740 * </table></td>
4741 * </tr>
4742 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4743 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4744 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4745 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4746 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4747 * </table></td>
4748 * </tr>
4749 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4750 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4751 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4752 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4753 * </table></td>
4754 * </tr>
4755 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4756 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4757 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4758 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4759 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4760 * </table></td>
4761 * </tr>
4762 * <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>
4763 * <td><table border="" style="margin:0" >
4764 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4765 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4766 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4767 * </table></td>
4768 * </tr>
4769 * </tbody>
4770 * </table>
4771 */
4772 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4773
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004774 /**
4775 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4776 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4777 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4778 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4779 * generated Intent can not cause unexpected data access to happen.
4780 *
4781 * <p>If you do not trust the source of the URI being parsed, you should still do further
4782 * processing to protect yourself from it. In particular, when using it to start an
4783 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4784 * that can handle it.</p>
4785 */
4786 public static final int URI_ALLOW_UNSAFE = 1<<2;
4787
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004788 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004789
4790 private String mAction;
4791 private Uri mData;
4792 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004793 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004794 private ComponentName mComponent;
4795 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004796 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004797 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004798 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004799 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004800 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004801 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004802
4803 // ---------------------------------------------------------------------
4804
4805 /**
4806 * Create an empty intent.
4807 */
4808 public Intent() {
4809 }
4810
4811 /**
4812 * Copy constructor.
4813 */
4814 public Intent(Intent o) {
4815 this.mAction = o.mAction;
4816 this.mData = o.mData;
4817 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004818 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004819 this.mComponent = o.mComponent;
4820 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004821 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004822 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004823 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004824 }
4825 if (o.mExtras != null) {
4826 this.mExtras = new Bundle(o.mExtras);
4827 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004828 if (o.mSourceBounds != null) {
4829 this.mSourceBounds = new Rect(o.mSourceBounds);
4830 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004831 if (o.mSelector != null) {
4832 this.mSelector = new Intent(o.mSelector);
4833 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004834 if (o.mClipData != null) {
4835 this.mClipData = new ClipData(o.mClipData);
4836 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004837 }
4838
4839 @Override
4840 public Object clone() {
4841 return new Intent(this);
4842 }
4843
4844 private Intent(Intent o, boolean all) {
4845 this.mAction = o.mAction;
4846 this.mData = o.mData;
4847 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004848 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004849 this.mComponent = o.mComponent;
4850 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004851 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004852 }
4853 }
4854
4855 /**
4856 * Make a clone of only the parts of the Intent that are relevant for
4857 * filter matching: the action, data, type, component, and categories.
4858 */
4859 public Intent cloneFilter() {
4860 return new Intent(this, false);
4861 }
4862
4863 /**
4864 * Create an intent with a given action. All other fields (data, type,
4865 * class) are null. Note that the action <em>must</em> be in a
4866 * namespace because Intents are used globally in the system -- for
4867 * example the system VIEW action is android.intent.action.VIEW; an
4868 * application's custom action would be something like
4869 * com.google.app.myapp.CUSTOM_ACTION.
4870 *
4871 * @param action The Intent action, such as ACTION_VIEW.
4872 */
4873 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004874 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004875 }
4876
4877 /**
4878 * Create an intent with a given action and for a given data url. Note
4879 * that the action <em>must</em> be in a namespace because Intents are
4880 * used globally in the system -- for example the system VIEW action is
4881 * android.intent.action.VIEW; an application's custom action would be
4882 * something like com.google.app.myapp.CUSTOM_ACTION.
4883 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004884 * <p><em>Note: scheme and host name matching in the Android framework is
4885 * case-sensitive, unlike the formal RFC. As a result,
4886 * you should always ensure that you write your Uri with these elements
4887 * using lower case letters, and normalize any Uris you receive from
4888 * outside of Android to ensure the scheme and host is lower case.</em></p>
4889 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004890 * @param action The Intent action, such as ACTION_VIEW.
4891 * @param uri The Intent data URI.
4892 */
4893 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004894 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004895 mData = uri;
4896 }
4897
4898 /**
4899 * Create an intent for a specific component. All other fields (action, data,
4900 * type, class) are null, though they can be modified later with explicit
4901 * calls. This provides a convenient way to create an intent that is
4902 * intended to execute a hard-coded class name, rather than relying on the
4903 * system to find an appropriate class for you; see {@link #setComponent}
4904 * for more information on the repercussions of this.
4905 *
4906 * @param packageContext A Context of the application package implementing
4907 * this class.
4908 * @param cls The component class that is to be used for the intent.
4909 *
4910 * @see #setClass
4911 * @see #setComponent
4912 * @see #Intent(String, android.net.Uri , Context, Class)
4913 */
4914 public Intent(Context packageContext, Class<?> cls) {
4915 mComponent = new ComponentName(packageContext, cls);
4916 }
4917
4918 /**
4919 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004920 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004921 * construct the Intent and then calling {@link #setClass} to set its
4922 * class.
4923 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004924 * <p><em>Note: scheme and host name matching in the Android framework is
4925 * case-sensitive, unlike the formal RFC. As a result,
4926 * you should always ensure that you write your Uri with these elements
4927 * using lower case letters, and normalize any Uris you receive from
4928 * outside of Android to ensure the scheme and host is lower case.</em></p>
4929 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004930 * @param action The Intent action, such as ACTION_VIEW.
4931 * @param uri The Intent data URI.
4932 * @param packageContext A Context of the application package implementing
4933 * this class.
4934 * @param cls The component class that is to be used for the intent.
4935 *
4936 * @see #Intent(String, android.net.Uri)
4937 * @see #Intent(Context, Class)
4938 * @see #setClass
4939 * @see #setComponent
4940 */
4941 public Intent(String action, Uri uri,
4942 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004943 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004944 mData = uri;
4945 mComponent = new ComponentName(packageContext, cls);
4946 }
4947
4948 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004949 * Create an intent to launch the main (root) activity of a task. This
4950 * is the Intent that is started when the application's is launched from
4951 * Home. For anything else that wants to launch an application in the
4952 * same way, it is important that they use an Intent structured the same
4953 * way, and can use this function to ensure this is the case.
4954 *
4955 * <p>The returned Intent has the given Activity component as its explicit
4956 * component, {@link #ACTION_MAIN} as its action, and includes the
4957 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4958 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4959 * to do that through {@link #addFlags(int)} on the returned Intent.
4960 *
4961 * @param mainActivity The main activity component that this Intent will
4962 * launch.
4963 * @return Returns a newly created Intent that can be used to launch the
4964 * activity as a main application entry.
4965 *
4966 * @see #setClass
4967 * @see #setComponent
4968 */
4969 public static Intent makeMainActivity(ComponentName mainActivity) {
4970 Intent intent = new Intent(ACTION_MAIN);
4971 intent.setComponent(mainActivity);
4972 intent.addCategory(CATEGORY_LAUNCHER);
4973 return intent;
4974 }
4975
4976 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004977 * Make an Intent for the main activity of an application, without
4978 * specifying a specific activity to run but giving a selector to find
4979 * the activity. This results in a final Intent that is structured
4980 * the same as when the application is launched from
4981 * Home. For anything else that wants to launch an application in the
4982 * same way, it is important that they use an Intent structured the same
4983 * way, and can use this function to ensure this is the case.
4984 *
4985 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4986 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4987 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4988 * to do that through {@link #addFlags(int)} on the returned Intent.
4989 *
4990 * @param selectorAction The action name of the Intent's selector.
4991 * @param selectorCategory The name of a category to add to the Intent's
4992 * selector.
4993 * @return Returns a newly created Intent that can be used to launch the
4994 * activity as a main application entry.
4995 *
4996 * @see #setSelector(Intent)
4997 */
4998 public static Intent makeMainSelectorActivity(String selectorAction,
4999 String selectorCategory) {
5000 Intent intent = new Intent(ACTION_MAIN);
5001 intent.addCategory(CATEGORY_LAUNCHER);
5002 Intent selector = new Intent();
5003 selector.setAction(selectorAction);
5004 selector.addCategory(selectorCategory);
5005 intent.setSelector(selector);
5006 return intent;
5007 }
5008
5009 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005010 * Make an Intent that can be used to re-launch an application's task
5011 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5012 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5013 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5014 *
5015 * @param mainActivity The activity component that is the root of the
5016 * task; this is the activity that has been published in the application's
5017 * manifest as the main launcher icon.
5018 *
5019 * @return Returns a newly created Intent that can be used to relaunch the
5020 * activity's task in its root state.
5021 */
5022 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5023 Intent intent = makeMainActivity(mainActivity);
5024 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5025 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5026 return intent;
5027 }
5028
5029 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005030 * Call {@link #parseUri} with 0 flags.
5031 * @deprecated Use {@link #parseUri} instead.
5032 */
5033 @Deprecated
5034 public static Intent getIntent(String uri) throws URISyntaxException {
5035 return parseUri(uri, 0);
5036 }
Tom Taylord4a47292009-12-21 13:59:18 -08005037
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005038 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005039 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005040 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005041 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005042 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005043 *
5044 * <p>The URI given here must not be relative -- that is, it must include
5045 * the scheme and full path.
5046 *
5047 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005048 * @param flags Additional processing flags. Either 0,
5049 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005050 *
5051 * @return Intent The newly created Intent object.
5052 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005053 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5054 * it bad (as parsed by the Uri class) or the Intent data within the
5055 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005056 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005057 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005058 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005059 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005060 int i = 0;
5061 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005062 final boolean androidApp = uri.startsWith("android-app:");
5063
5064 // Validate intent scheme if requested.
5065 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5066 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005067 Intent intent = new Intent(ACTION_VIEW);
5068 try {
5069 intent.setData(Uri.parse(uri));
5070 } catch (IllegalArgumentException e) {
5071 throw new URISyntaxException(uri, e.getMessage());
5072 }
5073 return intent;
5074 }
5075 }
Tom Taylord4a47292009-12-21 13:59:18 -08005076
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005077 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005078 // simple case
5079 if (i == -1) {
5080 if (!androidApp) {
5081 return new Intent(ACTION_VIEW, Uri.parse(uri));
5082 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005083
5084 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005085 } else if (!uri.startsWith("#Intent;", i)) {
5086 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005087 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005088 } else {
5089 i = -1;
5090 }
5091 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005092
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005093 // new format
5094 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005095 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005096 boolean explicitAction = false;
5097 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005098
5099 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005100 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005101 String data;
5102 if (i >= 0) {
5103 data = uri.substring(0, i);
5104 i += 8; // length of "#Intent;"
5105 } else {
5106 data = uri;
5107 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005108
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005109 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005110 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005111 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005112 if (eq < 0) eq = i-1;
5113 int semi = uri.indexOf(';', i);
5114 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005115
5116 // action
5117 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005118 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005119 if (!inSelector) {
5120 explicitAction = true;
5121 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005122 }
5123
5124 // categories
5125 else if (uri.startsWith("category=", i)) {
5126 intent.addCategory(value);
5127 }
5128
5129 // type
5130 else if (uri.startsWith("type=", i)) {
5131 intent.mType = value;
5132 }
5133
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005134 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005135 else if (uri.startsWith("launchFlags=", i)) {
5136 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005137 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5138 intent.mFlags &= ~IMMUTABLE_FLAGS;
5139 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005140 }
5141
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005142 // package
5143 else if (uri.startsWith("package=", i)) {
5144 intent.mPackage = value;
5145 }
5146
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005147 // component
5148 else if (uri.startsWith("component=", i)) {
5149 intent.mComponent = ComponentName.unflattenFromString(value);
5150 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005151
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005152 // scheme
5153 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005154 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005155 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005156 } else {
5157 scheme = value;
5158 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005159 }
5160
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005161 // source bounds
5162 else if (uri.startsWith("sourceBounds=", i)) {
5163 intent.mSourceBounds = Rect.unflattenFromString(value);
5164 }
5165
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005166 // selector
5167 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5168 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005169 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005170 }
5171
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005172 // extra
5173 else {
5174 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005175 // create Bundle if it doesn't already exist
5176 if (intent.mExtras == null) intent.mExtras = new Bundle();
5177 Bundle b = intent.mExtras;
5178 // add EXTRA
5179 if (uri.startsWith("S.", i)) b.putString(key, value);
5180 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5181 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5182 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5183 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5184 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5185 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5186 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5187 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5188 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5189 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005190
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005191 // move to the next item
5192 i = semi + 1;
5193 }
5194
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005195 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005196 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005197 if (baseIntent.mPackage == null) {
5198 baseIntent.setSelector(intent);
5199 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005200 intent = baseIntent;
5201 }
5202
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005203 if (data != null) {
5204 if (data.startsWith("intent:")) {
5205 data = data.substring(7);
5206 if (scheme != null) {
5207 data = scheme + ':' + data;
5208 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005209 } else if (data.startsWith("android-app:")) {
5210 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5211 // Correctly formed android-app, first part is package name.
5212 int end = data.indexOf('/', 14);
5213 if (end < 0) {
5214 // All we have is a package name.
5215 intent.mPackage = data.substring(14);
5216 if (!explicitAction) {
5217 intent.setAction(ACTION_MAIN);
5218 }
5219 data = "";
5220 } else {
5221 // Target the Intent at the given package name always.
5222 String authority = null;
5223 intent.mPackage = data.substring(14, end);
5224 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005225 if ((end+1) < data.length()) {
5226 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5227 // Found a scheme, remember it.
5228 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005229 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005230 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5231 // Found a authority, remember it.
5232 authority = data.substring(end+1, newEnd);
5233 end = newEnd;
5234 }
5235 } else {
5236 // All we have is a scheme.
5237 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005238 }
5239 }
5240 if (scheme == null) {
5241 // If there was no scheme, then this just targets the package.
5242 if (!explicitAction) {
5243 intent.setAction(ACTION_MAIN);
5244 }
5245 data = "";
5246 } else if (authority == null) {
5247 data = scheme + ":";
5248 } else {
5249 data = scheme + "://" + authority + data.substring(end);
5250 }
5251 }
5252 } else {
5253 data = "";
5254 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005255 }
Tom Taylord4a47292009-12-21 13:59:18 -08005256
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005257 if (data.length() > 0) {
5258 try {
5259 intent.mData = Uri.parse(data);
5260 } catch (IllegalArgumentException e) {
5261 throw new URISyntaxException(uri, e.getMessage());
5262 }
5263 }
5264 }
Tom Taylord4a47292009-12-21 13:59:18 -08005265
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005266 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005267
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005268 } catch (IndexOutOfBoundsException e) {
5269 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5270 }
5271 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005272
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005273 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005274 return getIntentOld(uri, 0);
5275 }
5276
5277 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005278 Intent intent;
5279
5280 int i = uri.lastIndexOf('#');
5281 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005282 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005283 final int intentFragmentStart = i;
5284 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005285
5286 i++;
5287
5288 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005289 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005290 i += 7;
5291 int j = uri.indexOf(')', i);
5292 action = uri.substring(i, j);
5293 i = j + 1;
5294 }
5295
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005296 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005297
5298 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005299 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005300 i += 11;
5301 int j = uri.indexOf(')', i);
5302 while (i < j) {
5303 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005304 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005305 if (i < sep) {
5306 intent.addCategory(uri.substring(i, sep));
5307 }
5308 i = sep + 1;
5309 }
5310 i = j + 1;
5311 }
5312
5313 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005314 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005315 i += 5;
5316 int j = uri.indexOf(')', i);
5317 intent.mType = uri.substring(i, j);
5318 i = j + 1;
5319 }
5320
5321 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005322 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005323 i += 12;
5324 int j = uri.indexOf(')', i);
5325 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005326 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5327 intent.mFlags &= ~IMMUTABLE_FLAGS;
5328 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005329 i = j + 1;
5330 }
5331
5332 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005333 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005334 i += 10;
5335 int j = uri.indexOf(')', i);
5336 int sep = uri.indexOf('!', i);
5337 if (sep >= 0 && sep < j) {
5338 String pkg = uri.substring(i, sep);
5339 String cls = uri.substring(sep + 1, j);
5340 intent.mComponent = new ComponentName(pkg, cls);
5341 }
5342 i = j + 1;
5343 }
5344
5345 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005346 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005347 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005348
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005349 final int closeParen = uri.indexOf(')', i);
5350 if (closeParen == -1) throw new URISyntaxException(uri,
5351 "EXTRA missing trailing ')'", i);
5352
5353 while (i < closeParen) {
5354 // fetch the key value
5355 int j = uri.indexOf('=', i);
5356 if (j <= i + 1 || i >= closeParen) {
5357 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5358 }
5359 char type = uri.charAt(i);
5360 i++;
5361 String key = uri.substring(i, j);
5362 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005363
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005364 // get type-value
5365 j = uri.indexOf('!', i);
5366 if (j == -1 || j >= closeParen) j = closeParen;
5367 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5368 String value = uri.substring(i, j);
5369 i = j;
5370
5371 // create Bundle if it doesn't already exist
5372 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005373
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005374 // add item to bundle
5375 try {
5376 switch (type) {
5377 case 'S':
5378 intent.mExtras.putString(key, Uri.decode(value));
5379 break;
5380 case 'B':
5381 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5382 break;
5383 case 'b':
5384 intent.mExtras.putByte(key, Byte.parseByte(value));
5385 break;
5386 case 'c':
5387 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5388 break;
5389 case 'd':
5390 intent.mExtras.putDouble(key, Double.parseDouble(value));
5391 break;
5392 case 'f':
5393 intent.mExtras.putFloat(key, Float.parseFloat(value));
5394 break;
5395 case 'i':
5396 intent.mExtras.putInt(key, Integer.parseInt(value));
5397 break;
5398 case 'l':
5399 intent.mExtras.putLong(key, Long.parseLong(value));
5400 break;
5401 case 's':
5402 intent.mExtras.putShort(key, Short.parseShort(value));
5403 break;
5404 default:
5405 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5406 }
5407 } catch (NumberFormatException e) {
5408 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5409 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005410
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005411 char ch = uri.charAt(i);
5412 if (ch == ')') break;
5413 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5414 i++;
5415 }
5416 }
5417
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005418 if (isIntentFragment) {
5419 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5420 } else {
5421 intent.mData = Uri.parse(uri);
5422 }
Tom Taylord4a47292009-12-21 13:59:18 -08005423
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005424 if (intent.mAction == null) {
5425 // By default, if no action is specified, then use VIEW.
5426 intent.mAction = ACTION_VIEW;
5427 }
5428
5429 } else {
5430 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5431 }
5432
5433 return intent;
5434 }
5435
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005436 /** @hide */
5437 public interface CommandOptionHandler {
5438 boolean handleOption(String opt, ShellCommand cmd);
5439 }
5440
5441 /** @hide */
5442 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5443 throws URISyntaxException {
5444 Intent intent = new Intent();
5445 Intent baseIntent = intent;
5446 boolean hasIntentInfo = false;
5447
5448 Uri data = null;
5449 String type = null;
5450
5451 String opt;
5452 while ((opt=cmd.getNextOption()) != null) {
5453 switch (opt) {
5454 case "-a":
5455 intent.setAction(cmd.getNextArgRequired());
5456 if (intent == baseIntent) {
5457 hasIntentInfo = true;
5458 }
5459 break;
5460 case "-d":
5461 data = Uri.parse(cmd.getNextArgRequired());
5462 if (intent == baseIntent) {
5463 hasIntentInfo = true;
5464 }
5465 break;
5466 case "-t":
5467 type = cmd.getNextArgRequired();
5468 if (intent == baseIntent) {
5469 hasIntentInfo = true;
5470 }
5471 break;
5472 case "-c":
5473 intent.addCategory(cmd.getNextArgRequired());
5474 if (intent == baseIntent) {
5475 hasIntentInfo = true;
5476 }
5477 break;
5478 case "-e":
5479 case "--es": {
5480 String key = cmd.getNextArgRequired();
5481 String value = cmd.getNextArgRequired();
5482 intent.putExtra(key, value);
5483 }
5484 break;
5485 case "--esn": {
5486 String key = cmd.getNextArgRequired();
5487 intent.putExtra(key, (String) null);
5488 }
5489 break;
5490 case "--ei": {
5491 String key = cmd.getNextArgRequired();
5492 String value = cmd.getNextArgRequired();
5493 intent.putExtra(key, Integer.decode(value));
5494 }
5495 break;
5496 case "--eu": {
5497 String key = cmd.getNextArgRequired();
5498 String value = cmd.getNextArgRequired();
5499 intent.putExtra(key, Uri.parse(value));
5500 }
5501 break;
5502 case "--ecn": {
5503 String key = cmd.getNextArgRequired();
5504 String value = cmd.getNextArgRequired();
5505 ComponentName cn = ComponentName.unflattenFromString(value);
5506 if (cn == null)
5507 throw new IllegalArgumentException("Bad component name: " + value);
5508 intent.putExtra(key, cn);
5509 }
5510 break;
5511 case "--eia": {
5512 String key = cmd.getNextArgRequired();
5513 String value = cmd.getNextArgRequired();
5514 String[] strings = value.split(",");
5515 int[] list = new int[strings.length];
5516 for (int i = 0; i < strings.length; i++) {
5517 list[i] = Integer.decode(strings[i]);
5518 }
5519 intent.putExtra(key, list);
5520 }
5521 break;
5522 case "--eial": {
5523 String key = cmd.getNextArgRequired();
5524 String value = cmd.getNextArgRequired();
5525 String[] strings = value.split(",");
5526 ArrayList<Integer> list = new ArrayList<>(strings.length);
5527 for (int i = 0; i < strings.length; i++) {
5528 list.add(Integer.decode(strings[i]));
5529 }
5530 intent.putExtra(key, list);
5531 }
5532 break;
5533 case "--el": {
5534 String key = cmd.getNextArgRequired();
5535 String value = cmd.getNextArgRequired();
5536 intent.putExtra(key, Long.valueOf(value));
5537 }
5538 break;
5539 case "--ela": {
5540 String key = cmd.getNextArgRequired();
5541 String value = cmd.getNextArgRequired();
5542 String[] strings = value.split(",");
5543 long[] list = new long[strings.length];
5544 for (int i = 0; i < strings.length; i++) {
5545 list[i] = Long.valueOf(strings[i]);
5546 }
5547 intent.putExtra(key, list);
5548 hasIntentInfo = true;
5549 }
5550 break;
5551 case "--elal": {
5552 String key = cmd.getNextArgRequired();
5553 String value = cmd.getNextArgRequired();
5554 String[] strings = value.split(",");
5555 ArrayList<Long> list = new ArrayList<>(strings.length);
5556 for (int i = 0; i < strings.length; i++) {
5557 list.add(Long.valueOf(strings[i]));
5558 }
5559 intent.putExtra(key, list);
5560 hasIntentInfo = true;
5561 }
5562 break;
5563 case "--ef": {
5564 String key = cmd.getNextArgRequired();
5565 String value = cmd.getNextArgRequired();
5566 intent.putExtra(key, Float.valueOf(value));
5567 hasIntentInfo = true;
5568 }
5569 break;
5570 case "--efa": {
5571 String key = cmd.getNextArgRequired();
5572 String value = cmd.getNextArgRequired();
5573 String[] strings = value.split(",");
5574 float[] list = new float[strings.length];
5575 for (int i = 0; i < strings.length; i++) {
5576 list[i] = Float.valueOf(strings[i]);
5577 }
5578 intent.putExtra(key, list);
5579 hasIntentInfo = true;
5580 }
5581 break;
5582 case "--efal": {
5583 String key = cmd.getNextArgRequired();
5584 String value = cmd.getNextArgRequired();
5585 String[] strings = value.split(",");
5586 ArrayList<Float> list = new ArrayList<>(strings.length);
5587 for (int i = 0; i < strings.length; i++) {
5588 list.add(Float.valueOf(strings[i]));
5589 }
5590 intent.putExtra(key, list);
5591 hasIntentInfo = true;
5592 }
5593 break;
5594 case "--esa": {
5595 String key = cmd.getNextArgRequired();
5596 String value = cmd.getNextArgRequired();
5597 // Split on commas unless they are preceeded by an escape.
5598 // The escape character must be escaped for the string and
5599 // again for the regex, thus four escape characters become one.
5600 String[] strings = value.split("(?<!\\\\),");
5601 intent.putExtra(key, strings);
5602 hasIntentInfo = true;
5603 }
5604 break;
5605 case "--esal": {
5606 String key = cmd.getNextArgRequired();
5607 String value = cmd.getNextArgRequired();
5608 // Split on commas unless they are preceeded by an escape.
5609 // The escape character must be escaped for the string and
5610 // again for the regex, thus four escape characters become one.
5611 String[] strings = value.split("(?<!\\\\),");
5612 ArrayList<String> list = new ArrayList<>(strings.length);
5613 for (int i = 0; i < strings.length; i++) {
5614 list.add(strings[i]);
5615 }
5616 intent.putExtra(key, list);
5617 hasIntentInfo = true;
5618 }
5619 break;
5620 case "--ez": {
5621 String key = cmd.getNextArgRequired();
5622 String value = cmd.getNextArgRequired().toLowerCase();
5623 // Boolean.valueOf() results in false for anything that is not "true", which is
5624 // error-prone in shell commands
5625 boolean arg;
5626 if ("true".equals(value) || "t".equals(value)) {
5627 arg = true;
5628 } else if ("false".equals(value) || "f".equals(value)) {
5629 arg = false;
5630 } else {
5631 try {
5632 arg = Integer.decode(value) != 0;
5633 } catch (NumberFormatException ex) {
5634 throw new IllegalArgumentException("Invalid boolean value: " + value);
5635 }
5636 }
5637
5638 intent.putExtra(key, arg);
5639 }
5640 break;
5641 case "-n": {
5642 String str = cmd.getNextArgRequired();
5643 ComponentName cn = ComponentName.unflattenFromString(str);
5644 if (cn == null)
5645 throw new IllegalArgumentException("Bad component name: " + str);
5646 intent.setComponent(cn);
5647 if (intent == baseIntent) {
5648 hasIntentInfo = true;
5649 }
5650 }
5651 break;
5652 case "-p": {
5653 String str = cmd.getNextArgRequired();
5654 intent.setPackage(str);
5655 if (intent == baseIntent) {
5656 hasIntentInfo = true;
5657 }
5658 }
5659 break;
5660 case "-f":
5661 String str = cmd.getNextArgRequired();
5662 intent.setFlags(Integer.decode(str).intValue());
5663 break;
5664 case "--grant-read-uri-permission":
5665 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5666 break;
5667 case "--grant-write-uri-permission":
5668 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5669 break;
5670 case "--grant-persistable-uri-permission":
5671 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5672 break;
5673 case "--grant-prefix-uri-permission":
5674 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5675 break;
5676 case "--exclude-stopped-packages":
5677 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5678 break;
5679 case "--include-stopped-packages":
5680 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5681 break;
5682 case "--debug-log-resolution":
5683 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5684 break;
5685 case "--activity-brought-to-front":
5686 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5687 break;
5688 case "--activity-clear-top":
5689 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5690 break;
5691 case "--activity-clear-when-task-reset":
5692 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5693 break;
5694 case "--activity-exclude-from-recents":
5695 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5696 break;
5697 case "--activity-launched-from-history":
5698 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5699 break;
5700 case "--activity-multiple-task":
5701 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5702 break;
5703 case "--activity-no-animation":
5704 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5705 break;
5706 case "--activity-no-history":
5707 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5708 break;
5709 case "--activity-no-user-action":
5710 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5711 break;
5712 case "--activity-previous-is-top":
5713 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5714 break;
5715 case "--activity-reorder-to-front":
5716 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5717 break;
5718 case "--activity-reset-task-if-needed":
5719 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5720 break;
5721 case "--activity-single-top":
5722 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5723 break;
5724 case "--activity-clear-task":
5725 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5726 break;
5727 case "--activity-task-on-home":
5728 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5729 break;
5730 case "--receiver-registered-only":
5731 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5732 break;
5733 case "--receiver-replace-pending":
5734 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5735 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005736 case "--receiver-foreground":
5737 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5738 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005739 case "--selector":
5740 intent.setDataAndType(data, type);
5741 intent = new Intent();
5742 break;
5743 default:
5744 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5745 // Okay, caller handled this option.
5746 } else {
5747 throw new IllegalArgumentException("Unknown option: " + opt);
5748 }
5749 break;
5750 }
5751 }
5752 intent.setDataAndType(data, type);
5753
5754 final boolean hasSelector = intent != baseIntent;
5755 if (hasSelector) {
5756 // A selector was specified; fix up.
5757 baseIntent.setSelector(intent);
5758 intent = baseIntent;
5759 }
5760
5761 String arg = cmd.getNextArg();
5762 baseIntent = null;
5763 if (arg == null) {
5764 if (hasSelector) {
5765 // If a selector has been specified, and no arguments
5766 // have been supplied for the main Intent, then we can
5767 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5768 // need to have a component name specified yet, the
5769 // selector will take care of that.
5770 baseIntent = new Intent(Intent.ACTION_MAIN);
5771 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5772 }
5773 } else if (arg.indexOf(':') >= 0) {
5774 // The argument is a URI. Fully parse it, and use that result
5775 // to fill in any data not specified so far.
5776 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5777 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5778 } else if (arg.indexOf('/') >= 0) {
5779 // The argument is a component name. Build an Intent to launch
5780 // it.
5781 baseIntent = new Intent(Intent.ACTION_MAIN);
5782 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5783 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5784 } else {
5785 // Assume the argument is a package name.
5786 baseIntent = new Intent(Intent.ACTION_MAIN);
5787 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5788 baseIntent.setPackage(arg);
5789 }
5790 if (baseIntent != null) {
5791 Bundle extras = intent.getExtras();
5792 intent.replaceExtras((Bundle)null);
5793 Bundle uriExtras = baseIntent.getExtras();
5794 baseIntent.replaceExtras((Bundle)null);
5795 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5796 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5797 for (String c : cats) {
5798 baseIntent.removeCategory(c);
5799 }
5800 }
5801 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5802 if (extras == null) {
5803 extras = uriExtras;
5804 } else if (uriExtras != null) {
5805 uriExtras.putAll(extras);
5806 extras = uriExtras;
5807 }
5808 intent.replaceExtras(extras);
5809 hasIntentInfo = true;
5810 }
5811
5812 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5813 return intent;
5814 }
5815
5816 /** @hide */
5817 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5818 final String[] lines = new String[] {
5819 "<INTENT> specifications include these flags and arguments:",
5820 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5821 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5822 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5823 " [--esn <EXTRA_KEY> ...]",
5824 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5825 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5826 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5827 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5828 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5829 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5830 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5831 " (mutiple extras passed as Integer[])",
5832 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5833 " (mutiple extras passed as List<Integer>)",
5834 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5835 " (mutiple extras passed as Long[])",
5836 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5837 " (mutiple extras passed as List<Long>)",
5838 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5839 " (mutiple extras passed as Float[])",
5840 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5841 " (mutiple extras passed as List<Float>)",
5842 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5843 " (mutiple extras passed as String[]; to embed a comma into a string,",
5844 " escape it using \"\\,\")",
5845 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5846 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5847 " escape it using \"\\,\")",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005848 " [--f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005849 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5850 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5851 " [--debug-log-resolution] [--exclude-stopped-packages]",
5852 " [--include-stopped-packages]",
5853 " [--activity-brought-to-front] [--activity-clear-top]",
5854 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5855 " [--activity-launched-from-history] [--activity-multiple-task]",
5856 " [--activity-no-animation] [--activity-no-history]",
5857 " [--activity-no-user-action] [--activity-previous-is-top]",
5858 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5859 " [--activity-single-top] [--activity-clear-task]",
5860 " [--activity-task-on-home]",
5861 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005862 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005863 " [--selector]",
5864 " [<URI> | <PACKAGE> | <COMPONENT>]"
5865 };
5866 for (String line : lines) {
5867 pw.print(prefix);
5868 pw.println(line);
5869 }
5870 }
5871
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005872 /**
5873 * Retrieve the general action to be performed, such as
5874 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5875 * the information in the intent should be interpreted -- most importantly,
5876 * what to do with the data returned by {@link #getData}.
5877 *
5878 * @return The action of this intent or null if none is specified.
5879 *
5880 * @see #setAction
5881 */
5882 public String getAction() {
5883 return mAction;
5884 }
5885
5886 /**
5887 * Retrieve data this intent is operating on. This URI specifies the name
5888 * of the data; often it uses the content: scheme, specifying data in a
5889 * content provider. Other schemes may be handled by specific activities,
5890 * such as http: by the web browser.
5891 *
5892 * @return The URI of the data this intent is targeting or null.
5893 *
5894 * @see #getScheme
5895 * @see #setData
5896 */
5897 public Uri getData() {
5898 return mData;
5899 }
5900
5901 /**
5902 * The same as {@link #getData()}, but returns the URI as an encoded
5903 * String.
5904 */
5905 public String getDataString() {
5906 return mData != null ? mData.toString() : null;
5907 }
5908
5909 /**
5910 * Return the scheme portion of the intent's data. If the data is null or
5911 * does not include a scheme, null is returned. Otherwise, the scheme
5912 * prefix without the final ':' is returned, i.e. "http".
5913 *
5914 * <p>This is the same as calling getData().getScheme() (and checking for
5915 * null data).
5916 *
5917 * @return The scheme of this intent.
5918 *
5919 * @see #getData
5920 */
5921 public String getScheme() {
5922 return mData != null ? mData.getScheme() : null;
5923 }
5924
5925 /**
5926 * Retrieve any explicit MIME type included in the intent. This is usually
5927 * null, as the type is determined by the intent data.
5928 *
5929 * @return If a type was manually set, it is returned; else null is
5930 * returned.
5931 *
5932 * @see #resolveType(ContentResolver)
5933 * @see #setType
5934 */
5935 public String getType() {
5936 return mType;
5937 }
5938
5939 /**
5940 * Return the MIME data type of this intent. If the type field is
5941 * explicitly set, that is simply returned. Otherwise, if the data is set,
5942 * the type of that data is returned. If neither fields are set, a null is
5943 * returned.
5944 *
5945 * @return The MIME type of this intent.
5946 *
5947 * @see #getType
5948 * @see #resolveType(ContentResolver)
5949 */
5950 public String resolveType(Context context) {
5951 return resolveType(context.getContentResolver());
5952 }
5953
5954 /**
5955 * Return the MIME data type of this intent. If the type field is
5956 * explicitly set, that is simply returned. Otherwise, if the data is set,
5957 * the type of that data is returned. If neither fields are set, a null is
5958 * returned.
5959 *
5960 * @param resolver A ContentResolver that can be used to determine the MIME
5961 * type of the intent's data.
5962 *
5963 * @return The MIME type of this intent.
5964 *
5965 * @see #getType
5966 * @see #resolveType(Context)
5967 */
5968 public String resolveType(ContentResolver resolver) {
5969 if (mType != null) {
5970 return mType;
5971 }
5972 if (mData != null) {
5973 if ("content".equals(mData.getScheme())) {
5974 return resolver.getType(mData);
5975 }
5976 }
5977 return null;
5978 }
5979
5980 /**
5981 * Return the MIME data type of this intent, only if it will be needed for
5982 * intent resolution. This is not generally useful for application code;
5983 * it is used by the frameworks for communicating with back-end system
5984 * services.
5985 *
5986 * @param resolver A ContentResolver that can be used to determine the MIME
5987 * type of the intent's data.
5988 *
5989 * @return The MIME type of this intent, or null if it is unknown or not
5990 * needed.
5991 */
5992 public String resolveTypeIfNeeded(ContentResolver resolver) {
5993 if (mComponent != null) {
5994 return mType;
5995 }
5996 return resolveType(resolver);
5997 }
5998
5999 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006000 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006001 *
6002 * @param category The category to check.
6003 *
6004 * @return boolean True if the intent contains the category, else false.
6005 *
6006 * @see #getCategories
6007 * @see #addCategory
6008 */
6009 public boolean hasCategory(String category) {
6010 return mCategories != null && mCategories.contains(category);
6011 }
6012
6013 /**
6014 * Return the set of all categories in the intent. If there are no categories,
6015 * returns NULL.
6016 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006017 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006018 *
6019 * @see #hasCategory
6020 * @see #addCategory
6021 */
6022 public Set<String> getCategories() {
6023 return mCategories;
6024 }
6025
6026 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006027 * Return the specific selector associated with this Intent. If there is
6028 * none, returns null. See {@link #setSelector} for more information.
6029 *
6030 * @see #setSelector
6031 */
6032 public Intent getSelector() {
6033 return mSelector;
6034 }
6035
6036 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006037 * Return the {@link ClipData} associated with this Intent. If there is
6038 * none, returns null. See {@link #setClipData} for more information.
6039 *
John Spurlock125d1332013-11-25 11:58:37 -05006040 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006041 */
6042 public ClipData getClipData() {
6043 return mClipData;
6044 }
6045
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006046 /** @hide */
6047 public int getContentUserHint() {
6048 return mContentUserHint;
6049 }
6050
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006051 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006052 * Sets the ClassLoader that will be used when unmarshalling
6053 * any Parcelable values from the extras of this Intent.
6054 *
6055 * @param loader a ClassLoader, or null to use the default loader
6056 * at the time of unmarshalling.
6057 */
6058 public void setExtrasClassLoader(ClassLoader loader) {
6059 if (mExtras != null) {
6060 mExtras.setClassLoader(loader);
6061 }
6062 }
6063
6064 /**
6065 * Returns true if an extra value is associated with the given name.
6066 * @param name the extra's name
6067 * @return true if the given extra is present.
6068 */
6069 public boolean hasExtra(String name) {
6070 return mExtras != null && mExtras.containsKey(name);
6071 }
6072
6073 /**
6074 * Returns true if the Intent's extras contain a parcelled file descriptor.
6075 * @return true if the Intent contains a parcelled file descriptor.
6076 */
6077 public boolean hasFileDescriptors() {
6078 return mExtras != null && mExtras.hasFileDescriptors();
6079 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006080
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006081 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006082 public void setAllowFds(boolean allowFds) {
6083 if (mExtras != null) {
6084 mExtras.setAllowFds(allowFds);
6085 }
6086 }
6087
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006088 /** {@hide} */
6089 public void setDefusable(boolean defusable) {
6090 if (mExtras != null) {
6091 mExtras.setDefusable(defusable);
6092 }
6093 }
6094
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006095 /**
6096 * Retrieve extended data from the intent.
6097 *
6098 * @param name The name of the desired item.
6099 *
6100 * @return the value of an item that previously added with putExtra()
6101 * or null if none was found.
6102 *
6103 * @deprecated
6104 * @hide
6105 */
6106 @Deprecated
6107 public Object getExtra(String name) {
6108 return getExtra(name, null);
6109 }
6110
6111 /**
6112 * Retrieve extended data from the intent.
6113 *
6114 * @param name The name of the desired item.
6115 * @param defaultValue the value to be returned if no value of the desired
6116 * type is stored with the given name.
6117 *
6118 * @return the value of an item that previously added with putExtra()
6119 * or the default value if none was found.
6120 *
6121 * @see #putExtra(String, boolean)
6122 */
6123 public boolean getBooleanExtra(String name, boolean defaultValue) {
6124 return mExtras == null ? defaultValue :
6125 mExtras.getBoolean(name, defaultValue);
6126 }
6127
6128 /**
6129 * Retrieve extended data from the intent.
6130 *
6131 * @param name The name of the desired item.
6132 * @param defaultValue the value to be returned if no value of the desired
6133 * type is stored with the given name.
6134 *
6135 * @return the value of an item that previously added with putExtra()
6136 * or the default value if none was found.
6137 *
6138 * @see #putExtra(String, byte)
6139 */
6140 public byte getByteExtra(String name, byte defaultValue) {
6141 return mExtras == null ? defaultValue :
6142 mExtras.getByte(name, defaultValue);
6143 }
6144
6145 /**
6146 * Retrieve extended data from the intent.
6147 *
6148 * @param name The name of the desired item.
6149 * @param defaultValue the value to be returned if no value of the desired
6150 * type is stored with the given name.
6151 *
6152 * @return the value of an item that previously added with putExtra()
6153 * or the default value if none was found.
6154 *
6155 * @see #putExtra(String, short)
6156 */
6157 public short getShortExtra(String name, short defaultValue) {
6158 return mExtras == null ? defaultValue :
6159 mExtras.getShort(name, defaultValue);
6160 }
6161
6162 /**
6163 * Retrieve extended data from the intent.
6164 *
6165 * @param name The name of the desired item.
6166 * @param defaultValue the value to be returned if no value of the desired
6167 * type is stored with the given name.
6168 *
6169 * @return the value of an item that previously added with putExtra()
6170 * or the default value if none was found.
6171 *
6172 * @see #putExtra(String, char)
6173 */
6174 public char getCharExtra(String name, char defaultValue) {
6175 return mExtras == null ? defaultValue :
6176 mExtras.getChar(name, defaultValue);
6177 }
6178
6179 /**
6180 * Retrieve extended data from the intent.
6181 *
6182 * @param name The name of the desired item.
6183 * @param defaultValue the value to be returned if no value of the desired
6184 * type is stored with the given name.
6185 *
6186 * @return the value of an item that previously added with putExtra()
6187 * or the default value if none was found.
6188 *
6189 * @see #putExtra(String, int)
6190 */
6191 public int getIntExtra(String name, int defaultValue) {
6192 return mExtras == null ? defaultValue :
6193 mExtras.getInt(name, defaultValue);
6194 }
6195
6196 /**
6197 * Retrieve extended data from the intent.
6198 *
6199 * @param name The name of the desired item.
6200 * @param defaultValue the value to be returned if no value of the desired
6201 * type is stored with the given name.
6202 *
6203 * @return the value of an item that previously added with putExtra()
6204 * or the default value if none was found.
6205 *
6206 * @see #putExtra(String, long)
6207 */
6208 public long getLongExtra(String name, long defaultValue) {
6209 return mExtras == null ? defaultValue :
6210 mExtras.getLong(name, defaultValue);
6211 }
6212
6213 /**
6214 * Retrieve extended data from the intent.
6215 *
6216 * @param name The name of the desired item.
6217 * @param defaultValue the value to be returned if no value of the desired
6218 * type is stored with the given name.
6219 *
6220 * @return the value of an item that previously added with putExtra(),
6221 * or the default value if no such item is present
6222 *
6223 * @see #putExtra(String, float)
6224 */
6225 public float getFloatExtra(String name, float defaultValue) {
6226 return mExtras == null ? defaultValue :
6227 mExtras.getFloat(name, defaultValue);
6228 }
6229
6230 /**
6231 * Retrieve extended data from the intent.
6232 *
6233 * @param name The name of the desired item.
6234 * @param defaultValue the value to be returned if no value of the desired
6235 * type is stored with the given name.
6236 *
6237 * @return the value of an item that previously added with putExtra()
6238 * or the default value if none was found.
6239 *
6240 * @see #putExtra(String, double)
6241 */
6242 public double getDoubleExtra(String name, double defaultValue) {
6243 return mExtras == null ? defaultValue :
6244 mExtras.getDouble(name, defaultValue);
6245 }
6246
6247 /**
6248 * Retrieve extended data from the intent.
6249 *
6250 * @param name The name of the desired item.
6251 *
6252 * @return the value of an item that previously added with putExtra()
6253 * or null if no String value was found.
6254 *
6255 * @see #putExtra(String, String)
6256 */
6257 public String getStringExtra(String name) {
6258 return mExtras == null ? null : mExtras.getString(name);
6259 }
6260
6261 /**
6262 * Retrieve extended data from the intent.
6263 *
6264 * @param name The name of the desired item.
6265 *
6266 * @return the value of an item that previously added with putExtra()
6267 * or null if no CharSequence value was found.
6268 *
6269 * @see #putExtra(String, CharSequence)
6270 */
6271 public CharSequence getCharSequenceExtra(String name) {
6272 return mExtras == null ? null : mExtras.getCharSequence(name);
6273 }
6274
6275 /**
6276 * Retrieve extended data from the intent.
6277 *
6278 * @param name The name of the desired item.
6279 *
6280 * @return the value of an item that previously added with putExtra()
6281 * or null if no Parcelable value was found.
6282 *
6283 * @see #putExtra(String, Parcelable)
6284 */
6285 public <T extends Parcelable> T getParcelableExtra(String name) {
6286 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6287 }
6288
6289 /**
6290 * Retrieve extended data from the intent.
6291 *
6292 * @param name The name of the desired item.
6293 *
6294 * @return the value of an item that previously added with putExtra()
6295 * or null if no Parcelable[] value was found.
6296 *
6297 * @see #putExtra(String, Parcelable[])
6298 */
6299 public Parcelable[] getParcelableArrayExtra(String name) {
6300 return mExtras == null ? null : mExtras.getParcelableArray(name);
6301 }
6302
6303 /**
6304 * Retrieve extended data from the intent.
6305 *
6306 * @param name The name of the desired item.
6307 *
6308 * @return the value of an item that previously added with putExtra()
6309 * or null if no ArrayList<Parcelable> value was found.
6310 *
6311 * @see #putParcelableArrayListExtra(String, ArrayList)
6312 */
6313 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6314 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6315 }
6316
6317 /**
6318 * Retrieve extended data from the intent.
6319 *
6320 * @param name The name of the desired item.
6321 *
6322 * @return the value of an item that previously added with putExtra()
6323 * or null if no Serializable value was found.
6324 *
6325 * @see #putExtra(String, Serializable)
6326 */
6327 public Serializable getSerializableExtra(String name) {
6328 return mExtras == null ? null : mExtras.getSerializable(name);
6329 }
6330
6331 /**
6332 * Retrieve extended data from the intent.
6333 *
6334 * @param name The name of the desired item.
6335 *
6336 * @return the value of an item that previously added with putExtra()
6337 * or null if no ArrayList<Integer> value was found.
6338 *
6339 * @see #putIntegerArrayListExtra(String, ArrayList)
6340 */
6341 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6342 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6343 }
6344
6345 /**
6346 * Retrieve extended data from the intent.
6347 *
6348 * @param name The name of the desired item.
6349 *
6350 * @return the value of an item that previously added with putExtra()
6351 * or null if no ArrayList<String> value was found.
6352 *
6353 * @see #putStringArrayListExtra(String, ArrayList)
6354 */
6355 public ArrayList<String> getStringArrayListExtra(String name) {
6356 return mExtras == null ? null : mExtras.getStringArrayList(name);
6357 }
6358
6359 /**
6360 * Retrieve extended data from the intent.
6361 *
6362 * @param name The name of the desired item.
6363 *
6364 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006365 * or null if no ArrayList<CharSequence> value was found.
6366 *
6367 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6368 */
6369 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6370 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6371 }
6372
6373 /**
6374 * Retrieve extended data from the intent.
6375 *
6376 * @param name The name of the desired item.
6377 *
6378 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006379 * or null if no boolean array value was found.
6380 *
6381 * @see #putExtra(String, boolean[])
6382 */
6383 public boolean[] getBooleanArrayExtra(String name) {
6384 return mExtras == null ? null : mExtras.getBooleanArray(name);
6385 }
6386
6387 /**
6388 * Retrieve extended data from the intent.
6389 *
6390 * @param name The name of the desired item.
6391 *
6392 * @return the value of an item that previously added with putExtra()
6393 * or null if no byte array value was found.
6394 *
6395 * @see #putExtra(String, byte[])
6396 */
6397 public byte[] getByteArrayExtra(String name) {
6398 return mExtras == null ? null : mExtras.getByteArray(name);
6399 }
6400
6401 /**
6402 * Retrieve extended data from the intent.
6403 *
6404 * @param name The name of the desired item.
6405 *
6406 * @return the value of an item that previously added with putExtra()
6407 * or null if no short array value was found.
6408 *
6409 * @see #putExtra(String, short[])
6410 */
6411 public short[] getShortArrayExtra(String name) {
6412 return mExtras == null ? null : mExtras.getShortArray(name);
6413 }
6414
6415 /**
6416 * Retrieve extended data from the intent.
6417 *
6418 * @param name The name of the desired item.
6419 *
6420 * @return the value of an item that previously added with putExtra()
6421 * or null if no char array value was found.
6422 *
6423 * @see #putExtra(String, char[])
6424 */
6425 public char[] getCharArrayExtra(String name) {
6426 return mExtras == null ? null : mExtras.getCharArray(name);
6427 }
6428
6429 /**
6430 * Retrieve extended data from the intent.
6431 *
6432 * @param name The name of the desired item.
6433 *
6434 * @return the value of an item that previously added with putExtra()
6435 * or null if no int array value was found.
6436 *
6437 * @see #putExtra(String, int[])
6438 */
6439 public int[] getIntArrayExtra(String name) {
6440 return mExtras == null ? null : mExtras.getIntArray(name);
6441 }
6442
6443 /**
6444 * Retrieve extended data from the intent.
6445 *
6446 * @param name The name of the desired item.
6447 *
6448 * @return the value of an item that previously added with putExtra()
6449 * or null if no long array value was found.
6450 *
6451 * @see #putExtra(String, long[])
6452 */
6453 public long[] getLongArrayExtra(String name) {
6454 return mExtras == null ? null : mExtras.getLongArray(name);
6455 }
6456
6457 /**
6458 * Retrieve extended data from the intent.
6459 *
6460 * @param name The name of the desired item.
6461 *
6462 * @return the value of an item that previously added with putExtra()
6463 * or null if no float array value was found.
6464 *
6465 * @see #putExtra(String, float[])
6466 */
6467 public float[] getFloatArrayExtra(String name) {
6468 return mExtras == null ? null : mExtras.getFloatArray(name);
6469 }
6470
6471 /**
6472 * Retrieve extended data from the intent.
6473 *
6474 * @param name The name of the desired item.
6475 *
6476 * @return the value of an item that previously added with putExtra()
6477 * or null if no double array value was found.
6478 *
6479 * @see #putExtra(String, double[])
6480 */
6481 public double[] getDoubleArrayExtra(String name) {
6482 return mExtras == null ? null : mExtras.getDoubleArray(name);
6483 }
6484
6485 /**
6486 * Retrieve extended data from the intent.
6487 *
6488 * @param name The name of the desired item.
6489 *
6490 * @return the value of an item that previously added with putExtra()
6491 * or null if no String array value was found.
6492 *
6493 * @see #putExtra(String, String[])
6494 */
6495 public String[] getStringArrayExtra(String name) {
6496 return mExtras == null ? null : mExtras.getStringArray(name);
6497 }
6498
6499 /**
6500 * Retrieve extended data from the intent.
6501 *
6502 * @param name The name of the desired item.
6503 *
6504 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006505 * or null if no CharSequence array value was found.
6506 *
6507 * @see #putExtra(String, CharSequence[])
6508 */
6509 public CharSequence[] getCharSequenceArrayExtra(String name) {
6510 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6511 }
6512
6513 /**
6514 * Retrieve extended data from the intent.
6515 *
6516 * @param name The name of the desired item.
6517 *
6518 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006519 * or null if no Bundle value was found.
6520 *
6521 * @see #putExtra(String, Bundle)
6522 */
6523 public Bundle getBundleExtra(String name) {
6524 return mExtras == null ? null : mExtras.getBundle(name);
6525 }
6526
6527 /**
6528 * Retrieve extended data from the intent.
6529 *
6530 * @param name The name of the desired item.
6531 *
6532 * @return the value of an item that previously added with putExtra()
6533 * or null if no IBinder value was found.
6534 *
6535 * @see #putExtra(String, IBinder)
6536 *
6537 * @deprecated
6538 * @hide
6539 */
6540 @Deprecated
6541 public IBinder getIBinderExtra(String name) {
6542 return mExtras == null ? null : mExtras.getIBinder(name);
6543 }
6544
6545 /**
6546 * Retrieve extended data from the intent.
6547 *
6548 * @param name The name of the desired item.
6549 * @param defaultValue The default value to return in case no item is
6550 * associated with the key 'name'
6551 *
6552 * @return the value of an item that previously added with putExtra()
6553 * or defaultValue if none was found.
6554 *
6555 * @see #putExtra
6556 *
6557 * @deprecated
6558 * @hide
6559 */
6560 @Deprecated
6561 public Object getExtra(String name, Object defaultValue) {
6562 Object result = defaultValue;
6563 if (mExtras != null) {
6564 Object result2 = mExtras.get(name);
6565 if (result2 != null) {
6566 result = result2;
6567 }
6568 }
6569
6570 return result;
6571 }
6572
6573 /**
6574 * Retrieves a map of extended data from the intent.
6575 *
6576 * @return the map of all extras previously added with putExtra(),
6577 * or null if none have been added.
6578 */
6579 public Bundle getExtras() {
6580 return (mExtras != null)
6581 ? new Bundle(mExtras)
6582 : null;
6583 }
6584
6585 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006586 * Filter extras to only basic types.
6587 * @hide
6588 */
6589 public void removeUnsafeExtras() {
6590 if (mExtras != null) {
6591 mExtras.filterValues();
6592 }
6593 }
6594
6595 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006596 * Retrieve any special flags associated with this intent. You will
6597 * normally just set them with {@link #setFlags} and let the system
6598 * take the appropriate action with them.
6599 *
6600 * @return int The currently set flags.
6601 *
6602 * @see #setFlags
6603 */
6604 public int getFlags() {
6605 return mFlags;
6606 }
6607
Dianne Hackborne7f97212011-02-24 14:40:20 -08006608 /** @hide */
6609 public boolean isExcludingStopped() {
6610 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6611 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6612 }
6613
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006614 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006615 * Retrieve the application package name this Intent is limited to. When
6616 * resolving an Intent, if non-null this limits the resolution to only
6617 * components in the given application package.
6618 *
6619 * @return The name of the application package for the Intent.
6620 *
6621 * @see #resolveActivity
6622 * @see #setPackage
6623 */
6624 public String getPackage() {
6625 return mPackage;
6626 }
6627
6628 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006629 * Retrieve the concrete component associated with the intent. When receiving
6630 * an intent, this is the component that was found to best handle it (that is,
6631 * yourself) and will always be non-null; in all other cases it will be
6632 * null unless explicitly set.
6633 *
6634 * @return The name of the application component to handle the intent.
6635 *
6636 * @see #resolveActivity
6637 * @see #setComponent
6638 */
6639 public ComponentName getComponent() {
6640 return mComponent;
6641 }
6642
6643 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006644 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6645 * used as a hint to the receiver for animations and the like. Null means that there
6646 * is no source bounds.
6647 */
6648 public Rect getSourceBounds() {
6649 return mSourceBounds;
6650 }
6651
6652 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006653 * Return the Activity component that should be used to handle this intent.
6654 * The appropriate component is determined based on the information in the
6655 * intent, evaluated as follows:
6656 *
6657 * <p>If {@link #getComponent} returns an explicit class, that is returned
6658 * without any further consideration.
6659 *
6660 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6661 * category to be considered.
6662 *
6663 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6664 * action.
6665 *
6666 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6667 * this type.
6668 *
6669 * <p>If {@link #addCategory} has added any categories, the activity must
6670 * handle ALL of the categories specified.
6671 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006672 * <p>If {@link #getPackage} is non-NULL, only activity components in
6673 * that application package will be considered.
6674 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006675 * <p>If there are no activities that satisfy all of these conditions, a
6676 * null string is returned.
6677 *
6678 * <p>If multiple activities are found to satisfy the intent, the one with
6679 * the highest priority will be used. If there are multiple activities
6680 * with the same priority, the system will either pick the best activity
6681 * based on user preference, or resolve to a system class that will allow
6682 * the user to pick an activity and forward from there.
6683 *
6684 * <p>This method is implemented simply by calling
6685 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6686 * true.</p>
6687 * <p> This API is called for you as part of starting an activity from an
6688 * intent. You do not normally need to call it yourself.</p>
6689 *
6690 * @param pm The package manager with which to resolve the Intent.
6691 *
6692 * @return Name of the component implementing an activity that can
6693 * display the intent.
6694 *
6695 * @see #setComponent
6696 * @see #getComponent
6697 * @see #resolveActivityInfo
6698 */
6699 public ComponentName resolveActivity(PackageManager pm) {
6700 if (mComponent != null) {
6701 return mComponent;
6702 }
6703
6704 ResolveInfo info = pm.resolveActivity(
6705 this, PackageManager.MATCH_DEFAULT_ONLY);
6706 if (info != null) {
6707 return new ComponentName(
6708 info.activityInfo.applicationInfo.packageName,
6709 info.activityInfo.name);
6710 }
6711
6712 return null;
6713 }
6714
6715 /**
6716 * Resolve the Intent into an {@link ActivityInfo}
6717 * describing the activity that should execute the intent. Resolution
6718 * follows the same rules as described for {@link #resolveActivity}, but
6719 * you get back the completely information about the resolved activity
6720 * instead of just its class name.
6721 *
6722 * @param pm The package manager with which to resolve the Intent.
6723 * @param flags Addition information to retrieve as per
6724 * {@link PackageManager#getActivityInfo(ComponentName, int)
6725 * PackageManager.getActivityInfo()}.
6726 *
6727 * @return PackageManager.ActivityInfo
6728 *
6729 * @see #resolveActivity
6730 */
6731 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6732 ActivityInfo ai = null;
6733 if (mComponent != null) {
6734 try {
6735 ai = pm.getActivityInfo(mComponent, flags);
6736 } catch (PackageManager.NameNotFoundException e) {
6737 // ignore
6738 }
6739 } else {
6740 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006741 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006742 if (info != null) {
6743 ai = info.activityInfo;
6744 }
6745 }
6746
6747 return ai;
6748 }
6749
6750 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006751 * Special function for use by the system to resolve service
6752 * intents to system apps. Throws an exception if there are
6753 * multiple potential matches to the Intent. Returns null if
6754 * there are no matches.
6755 * @hide
6756 */
6757 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6758 if (mComponent != null) {
6759 return mComponent;
6760 }
6761
6762 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6763 if (results == null) {
6764 return null;
6765 }
6766 ComponentName comp = null;
6767 for (int i=0; i<results.size(); i++) {
6768 ResolveInfo ri = results.get(i);
6769 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6770 continue;
6771 }
6772 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6773 ri.serviceInfo.name);
6774 if (comp != null) {
6775 throw new IllegalStateException("Multiple system services handle " + this
6776 + ": " + comp + ", " + foundComp);
6777 }
6778 comp = foundComp;
6779 }
6780 return comp;
6781 }
6782
6783 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006784 * Set the general action to be performed.
6785 *
6786 * @param action An action name, such as ACTION_VIEW. Application-specific
6787 * actions should be prefixed with the vendor's package name.
6788 *
6789 * @return Returns the same Intent object, for chaining multiple calls
6790 * into a single statement.
6791 *
6792 * @see #getAction
6793 */
6794 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006795 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006796 return this;
6797 }
6798
6799 /**
6800 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006801 * clears any type that was previously set by {@link #setType} or
6802 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006803 *
Nick Pellyccae4122012-01-09 14:12:58 -08006804 * <p><em>Note: scheme matching in the Android framework is
6805 * case-sensitive, unlike the formal RFC. As a result,
6806 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006807 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006808 * {@link #setDataAndNormalize}
6809 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006810 *
Nick Pellyccae4122012-01-09 14:12:58 -08006811 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006812 *
6813 * @return Returns the same Intent object, for chaining multiple calls
6814 * into a single statement.
6815 *
6816 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006817 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006818 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006819 */
6820 public Intent setData(Uri data) {
6821 mData = data;
6822 mType = null;
6823 return this;
6824 }
6825
6826 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006827 * Normalize and set the data this intent is operating on.
6828 *
6829 * <p>This method automatically clears any type that was
6830 * previously set (for example, by {@link #setType}).
6831 *
6832 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006833 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006834 * so really this is just a convenience method for
6835 * <pre>
6836 * setData(data.normalize())
6837 * </pre>
6838 *
6839 * @param data The Uri of the data this intent is now targeting.
6840 *
6841 * @return Returns the same Intent object, for chaining multiple calls
6842 * into a single statement.
6843 *
6844 * @see #getData
6845 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006846 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006847 */
6848 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006849 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006850 }
6851
6852 /**
6853 * Set an explicit MIME data type.
6854 *
6855 * <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.
6857 *
6858 * <p>This method automatically clears any data that was
6859 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006860 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006861 * <p><em>Note: MIME type matching in the Android framework is
6862 * case-sensitive, unlike formal RFC MIME types. As a result,
6863 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006864 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6865 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006866 *
6867 * @param type The MIME type of the data being handled by this intent.
6868 *
6869 * @return Returns the same Intent object, for chaining multiple calls
6870 * into a single statement.
6871 *
6872 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006873 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006874 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006875 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006876 */
6877 public Intent setType(String type) {
6878 mData = null;
6879 mType = type;
6880 return this;
6881 }
6882
6883 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006884 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006885 *
Nick Pellyccae4122012-01-09 14:12:58 -08006886 * <p>This is used to create intents that only specify a type and not data,
6887 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006888 *
Nick Pellyccae4122012-01-09 14:12:58 -08006889 * <p>This method automatically clears any data that was
6890 * previously set (for example by {@link #setData}).
6891 *
6892 * <p>The MIME type is normalized using
6893 * {@link #normalizeMimeType} before it is set,
6894 * so really this is just a convenience method for
6895 * <pre>
6896 * setType(Intent.normalizeMimeType(type))
6897 * </pre>
6898 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006899 * @param type The MIME type of the data being handled by this intent.
6900 *
6901 * @return Returns the same Intent object, for chaining multiple calls
6902 * into a single statement.
6903 *
Nick Pellyccae4122012-01-09 14:12:58 -08006904 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006905 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006906 * @see #normalizeMimeType
6907 */
6908 public Intent setTypeAndNormalize(String type) {
6909 return setType(normalizeMimeType(type));
6910 }
6911
6912 /**
6913 * (Usually optional) Set the data for the intent along with 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><em>Note: MIME type and Uri scheme matching in the
6919 * Android framework is case-sensitive, unlike the formal RFC definitions.
6920 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006921 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006922 * {@link #setDataAndTypeAndNormalize}
6923 * to ensure that they are converted to lower case.</em>
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 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006931 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006932 * @see #setData
6933 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006934 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006935 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006936 */
6937 public Intent setDataAndType(Uri data, String type) {
6938 mData = data;
6939 mType = type;
6940 return this;
6941 }
6942
6943 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006944 * (Usually optional) Normalize and set both the data Uri and an explicit
6945 * MIME data type. This method should very rarely be used -- it allows you
6946 * to override the MIME type that would ordinarily be inferred from the
6947 * data with your own type given here.
6948 *
6949 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006950 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006951 * before they are set, so really this is just a convenience method for
6952 * <pre>
6953 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6954 * </pre>
6955 *
6956 * @param data The Uri of the data this intent is now targeting.
6957 * @param type The MIME type of the data being handled by this intent.
6958 *
6959 * @return Returns the same Intent object, for chaining multiple calls
6960 * into a single statement.
6961 *
6962 * @see #setType
6963 * @see #setData
6964 * @see #setDataAndType
6965 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006966 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006967 */
6968 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006969 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006970 }
6971
6972 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006973 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006974 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006975 * activities that provide <em>all</em> of the requested categories will be
6976 * used.
6977 *
6978 * @param category The desired category. This can be either one of the
6979 * predefined Intent categories, or a custom category in your own
6980 * namespace.
6981 *
6982 * @return Returns the same Intent object, for chaining multiple calls
6983 * into a single statement.
6984 *
6985 * @see #hasCategory
6986 * @see #removeCategory
6987 */
6988 public Intent addCategory(String category) {
6989 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006990 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006991 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006992 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006993 return this;
6994 }
6995
6996 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006997 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006998 *
6999 * @param category The category to remove.
7000 *
7001 * @see #addCategory
7002 */
7003 public void removeCategory(String category) {
7004 if (mCategories != null) {
7005 mCategories.remove(category);
7006 if (mCategories.size() == 0) {
7007 mCategories = null;
7008 }
7009 }
7010 }
7011
7012 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007013 * Set a selector for this Intent. This is a modification to the kinds of
7014 * things the Intent will match. If the selector is set, it will be used
7015 * when trying to find entities that can handle the Intent, instead of the
7016 * main contents of the Intent. This allows you build an Intent containing
7017 * a generic protocol while targeting it more specifically.
7018 *
7019 * <p>An example of where this may be used is with things like
7020 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7021 * Intent that will launch the Browser application. However, the correct
7022 * main entry point of an application is actually {@link #ACTION_MAIN}
7023 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7024 * used to specify the actual Activity to launch. If you launch the browser
7025 * with something different, undesired behavior may happen if the user has
7026 * previously or later launches it the normal way, since they do not match.
7027 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7028 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7029 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7030 *
7031 * <p>Setting a selector does not impact the behavior of
7032 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7033 * desired behavior of a selector -- it does not impact the base meaning
7034 * of the Intent, just what kinds of things will be matched against it
7035 * when determining who can handle it.</p>
7036 *
7037 * <p>You can not use both a selector and {@link #setPackage(String)} on
7038 * the same base Intent.</p>
7039 *
7040 * @param selector The desired selector Intent; set to null to not use
7041 * a special selector.
7042 */
7043 public void setSelector(Intent selector) {
7044 if (selector == this) {
7045 throw new IllegalArgumentException(
7046 "Intent being set as a selector of itself");
7047 }
7048 if (selector != null && mPackage != null) {
7049 throw new IllegalArgumentException(
7050 "Can't set selector when package name is already set");
7051 }
7052 mSelector = selector;
7053 }
7054
7055 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007056 * Set a {@link ClipData} associated with this Intent. This replaces any
7057 * previously set ClipData.
7058 *
7059 * <p>The ClipData in an intent is not used for Intent matching or other
7060 * such operations. Semantically it is like extras, used to transmit
7061 * additional data with the Intent. The main feature of using this over
7062 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7063 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7064 * items included in the clip data. This is useful, in particular, if
7065 * you want to transmit an Intent containing multiple <code>content:</code>
7066 * URIs for which the recipient may not have global permission to access the
7067 * content provider.
7068 *
7069 * <p>If the ClipData contains items that are themselves Intents, any
7070 * grant flags in those Intents will be ignored. Only the top-level flags
7071 * of the main Intent are respected, and will be applied to all Uri or
7072 * Intent items in the clip (or sub-items of the clip).
7073 *
7074 * <p>The MIME type, label, and icon in the ClipData object are not
7075 * directly used by Intent. Applications should generally rely on the
7076 * MIME type of the Intent itself, not what it may find in the ClipData.
7077 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007078 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007079 *
7080 * @param clip The new clip to set. May be null to clear the current clip.
7081 */
7082 public void setClipData(ClipData clip) {
7083 mClipData = clip;
7084 }
7085
7086 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007087 * This is NOT a secure mechanism to identify the user who sent the intent.
7088 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7089 * who sent the intent.
7090 * @hide
7091 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007092 public void prepareToLeaveUser(int userId) {
7093 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7094 // We want mContentUserHint to refer to the original user, so don't do anything.
7095 if (mContentUserHint == UserHandle.USER_CURRENT) {
7096 mContentUserHint = userId;
7097 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007098 }
7099
7100 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007101 * Add extended data to the intent. The name must include a package
7102 * prefix, for example the app com.android.contacts would use names
7103 * like "com.android.contacts.ShowAll".
7104 *
7105 * @param name The name of the extra data, with package prefix.
7106 * @param value The boolean data value.
7107 *
7108 * @return Returns the same Intent object, for chaining multiple calls
7109 * into a single statement.
7110 *
7111 * @see #putExtras
7112 * @see #removeExtra
7113 * @see #getBooleanExtra(String, boolean)
7114 */
7115 public Intent putExtra(String name, boolean value) {
7116 if (mExtras == null) {
7117 mExtras = new Bundle();
7118 }
7119 mExtras.putBoolean(name, value);
7120 return this;
7121 }
7122
7123 /**
7124 * Add extended data to the intent. The name must include a package
7125 * prefix, for example the app com.android.contacts would use names
7126 * like "com.android.contacts.ShowAll".
7127 *
7128 * @param name The name of the extra data, with package prefix.
7129 * @param value The byte data value.
7130 *
7131 * @return Returns the same Intent object, for chaining multiple calls
7132 * into a single statement.
7133 *
7134 * @see #putExtras
7135 * @see #removeExtra
7136 * @see #getByteExtra(String, byte)
7137 */
7138 public Intent putExtra(String name, byte value) {
7139 if (mExtras == null) {
7140 mExtras = new Bundle();
7141 }
7142 mExtras.putByte(name, value);
7143 return this;
7144 }
7145
7146 /**
7147 * Add extended data to the intent. The name must include a package
7148 * prefix, for example the app com.android.contacts would use names
7149 * like "com.android.contacts.ShowAll".
7150 *
7151 * @param name The name of the extra data, with package prefix.
7152 * @param value The char data value.
7153 *
7154 * @return Returns the same Intent object, for chaining multiple calls
7155 * into a single statement.
7156 *
7157 * @see #putExtras
7158 * @see #removeExtra
7159 * @see #getCharExtra(String, char)
7160 */
7161 public Intent putExtra(String name, char value) {
7162 if (mExtras == null) {
7163 mExtras = new Bundle();
7164 }
7165 mExtras.putChar(name, value);
7166 return this;
7167 }
7168
7169 /**
7170 * Add extended data to the intent. The name must include a package
7171 * prefix, for example the app com.android.contacts would use names
7172 * like "com.android.contacts.ShowAll".
7173 *
7174 * @param name The name of the extra data, with package prefix.
7175 * @param value The short data value.
7176 *
7177 * @return Returns the same Intent object, for chaining multiple calls
7178 * into a single statement.
7179 *
7180 * @see #putExtras
7181 * @see #removeExtra
7182 * @see #getShortExtra(String, short)
7183 */
7184 public Intent putExtra(String name, short value) {
7185 if (mExtras == null) {
7186 mExtras = new Bundle();
7187 }
7188 mExtras.putShort(name, value);
7189 return this;
7190 }
7191
7192 /**
7193 * Add extended data to the intent. The name must include a package
7194 * prefix, for example the app com.android.contacts would use names
7195 * like "com.android.contacts.ShowAll".
7196 *
7197 * @param name The name of the extra data, with package prefix.
7198 * @param value The integer data value.
7199 *
7200 * @return Returns the same Intent object, for chaining multiple calls
7201 * into a single statement.
7202 *
7203 * @see #putExtras
7204 * @see #removeExtra
7205 * @see #getIntExtra(String, int)
7206 */
7207 public Intent putExtra(String name, int value) {
7208 if (mExtras == null) {
7209 mExtras = new Bundle();
7210 }
7211 mExtras.putInt(name, value);
7212 return this;
7213 }
7214
7215 /**
7216 * Add extended data to the intent. The name must include a package
7217 * prefix, for example the app com.android.contacts would use names
7218 * like "com.android.contacts.ShowAll".
7219 *
7220 * @param name The name of the extra data, with package prefix.
7221 * @param value The long data value.
7222 *
7223 * @return Returns the same Intent object, for chaining multiple calls
7224 * into a single statement.
7225 *
7226 * @see #putExtras
7227 * @see #removeExtra
7228 * @see #getLongExtra(String, long)
7229 */
7230 public Intent putExtra(String name, long value) {
7231 if (mExtras == null) {
7232 mExtras = new Bundle();
7233 }
7234 mExtras.putLong(name, value);
7235 return this;
7236 }
7237
7238 /**
7239 * Add extended data to the intent. The name must include a package
7240 * prefix, for example the app com.android.contacts would use names
7241 * like "com.android.contacts.ShowAll".
7242 *
7243 * @param name The name of the extra data, with package prefix.
7244 * @param value The float data value.
7245 *
7246 * @return Returns the same Intent object, for chaining multiple calls
7247 * into a single statement.
7248 *
7249 * @see #putExtras
7250 * @see #removeExtra
7251 * @see #getFloatExtra(String, float)
7252 */
7253 public Intent putExtra(String name, float value) {
7254 if (mExtras == null) {
7255 mExtras = new Bundle();
7256 }
7257 mExtras.putFloat(name, value);
7258 return this;
7259 }
7260
7261 /**
7262 * Add extended data to the intent. The name must include a package
7263 * prefix, for example the app com.android.contacts would use names
7264 * like "com.android.contacts.ShowAll".
7265 *
7266 * @param name The name of the extra data, with package prefix.
7267 * @param value The double data value.
7268 *
7269 * @return Returns the same Intent object, for chaining multiple calls
7270 * into a single statement.
7271 *
7272 * @see #putExtras
7273 * @see #removeExtra
7274 * @see #getDoubleExtra(String, double)
7275 */
7276 public Intent putExtra(String name, double value) {
7277 if (mExtras == null) {
7278 mExtras = new Bundle();
7279 }
7280 mExtras.putDouble(name, value);
7281 return this;
7282 }
7283
7284 /**
7285 * Add extended data to the intent. The name must include a package
7286 * prefix, for example the app com.android.contacts would use names
7287 * like "com.android.contacts.ShowAll".
7288 *
7289 * @param name The name of the extra data, with package prefix.
7290 * @param value The String data value.
7291 *
7292 * @return Returns the same Intent object, for chaining multiple calls
7293 * into a single statement.
7294 *
7295 * @see #putExtras
7296 * @see #removeExtra
7297 * @see #getStringExtra(String)
7298 */
7299 public Intent putExtra(String name, String value) {
7300 if (mExtras == null) {
7301 mExtras = new Bundle();
7302 }
7303 mExtras.putString(name, value);
7304 return this;
7305 }
7306
7307 /**
7308 * Add extended data to the intent. The name must include a package
7309 * prefix, for example the app com.android.contacts would use names
7310 * like "com.android.contacts.ShowAll".
7311 *
7312 * @param name The name of the extra data, with package prefix.
7313 * @param value The CharSequence data value.
7314 *
7315 * @return Returns the same Intent object, for chaining multiple calls
7316 * into a single statement.
7317 *
7318 * @see #putExtras
7319 * @see #removeExtra
7320 * @see #getCharSequenceExtra(String)
7321 */
7322 public Intent putExtra(String name, CharSequence value) {
7323 if (mExtras == null) {
7324 mExtras = new Bundle();
7325 }
7326 mExtras.putCharSequence(name, value);
7327 return this;
7328 }
7329
7330 /**
7331 * Add extended data to the intent. The name must include a package
7332 * prefix, for example the app com.android.contacts would use names
7333 * like "com.android.contacts.ShowAll".
7334 *
7335 * @param name The name of the extra data, with package prefix.
7336 * @param value The Parcelable data value.
7337 *
7338 * @return Returns the same Intent object, for chaining multiple calls
7339 * into a single statement.
7340 *
7341 * @see #putExtras
7342 * @see #removeExtra
7343 * @see #getParcelableExtra(String)
7344 */
7345 public Intent putExtra(String name, Parcelable value) {
7346 if (mExtras == null) {
7347 mExtras = new Bundle();
7348 }
7349 mExtras.putParcelable(name, value);
7350 return this;
7351 }
7352
7353 /**
7354 * Add extended data to the intent. The name must include a package
7355 * prefix, for example the app com.android.contacts would use names
7356 * like "com.android.contacts.ShowAll".
7357 *
7358 * @param name The name of the extra data, with package prefix.
7359 * @param value The Parcelable[] data value.
7360 *
7361 * @return Returns the same Intent object, for chaining multiple calls
7362 * into a single statement.
7363 *
7364 * @see #putExtras
7365 * @see #removeExtra
7366 * @see #getParcelableArrayExtra(String)
7367 */
7368 public Intent putExtra(String name, Parcelable[] value) {
7369 if (mExtras == null) {
7370 mExtras = new Bundle();
7371 }
7372 mExtras.putParcelableArray(name, value);
7373 return this;
7374 }
7375
7376 /**
7377 * Add extended data to the intent. The name must include a package
7378 * prefix, for example the app com.android.contacts would use names
7379 * like "com.android.contacts.ShowAll".
7380 *
7381 * @param name The name of the extra data, with package prefix.
7382 * @param value The ArrayList<Parcelable> data value.
7383 *
7384 * @return Returns the same Intent object, for chaining multiple calls
7385 * into a single statement.
7386 *
7387 * @see #putExtras
7388 * @see #removeExtra
7389 * @see #getParcelableArrayListExtra(String)
7390 */
7391 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7392 if (mExtras == null) {
7393 mExtras = new Bundle();
7394 }
7395 mExtras.putParcelableArrayList(name, value);
7396 return this;
7397 }
7398
7399 /**
7400 * Add extended data to the intent. The name must include a package
7401 * prefix, for example the app com.android.contacts would use names
7402 * like "com.android.contacts.ShowAll".
7403 *
7404 * @param name The name of the extra data, with package prefix.
7405 * @param value The ArrayList<Integer> data value.
7406 *
7407 * @return Returns the same Intent object, for chaining multiple calls
7408 * into a single statement.
7409 *
7410 * @see #putExtras
7411 * @see #removeExtra
7412 * @see #getIntegerArrayListExtra(String)
7413 */
7414 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7415 if (mExtras == null) {
7416 mExtras = new Bundle();
7417 }
7418 mExtras.putIntegerArrayList(name, value);
7419 return this;
7420 }
7421
7422 /**
7423 * Add extended data to the intent. The name must include a package
7424 * prefix, for example the app com.android.contacts would use names
7425 * like "com.android.contacts.ShowAll".
7426 *
7427 * @param name The name of the extra data, with package prefix.
7428 * @param value The ArrayList<String> data value.
7429 *
7430 * @return Returns the same Intent object, for chaining multiple calls
7431 * into a single statement.
7432 *
7433 * @see #putExtras
7434 * @see #removeExtra
7435 * @see #getStringArrayListExtra(String)
7436 */
7437 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7438 if (mExtras == null) {
7439 mExtras = new Bundle();
7440 }
7441 mExtras.putStringArrayList(name, value);
7442 return this;
7443 }
7444
7445 /**
7446 * Add extended data to the intent. The name must include a package
7447 * prefix, for example the app com.android.contacts would use names
7448 * like "com.android.contacts.ShowAll".
7449 *
7450 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007451 * @param value The ArrayList<CharSequence> data value.
7452 *
7453 * @return Returns the same Intent object, for chaining multiple calls
7454 * into a single statement.
7455 *
7456 * @see #putExtras
7457 * @see #removeExtra
7458 * @see #getCharSequenceArrayListExtra(String)
7459 */
7460 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7461 if (mExtras == null) {
7462 mExtras = new Bundle();
7463 }
7464 mExtras.putCharSequenceArrayList(name, value);
7465 return this;
7466 }
7467
7468 /**
7469 * Add extended data to the intent. The name must include a package
7470 * prefix, for example the app com.android.contacts would use names
7471 * like "com.android.contacts.ShowAll".
7472 *
7473 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007474 * @param value The Serializable data value.
7475 *
7476 * @return Returns the same Intent object, for chaining multiple calls
7477 * into a single statement.
7478 *
7479 * @see #putExtras
7480 * @see #removeExtra
7481 * @see #getSerializableExtra(String)
7482 */
7483 public Intent putExtra(String name, Serializable value) {
7484 if (mExtras == null) {
7485 mExtras = new Bundle();
7486 }
7487 mExtras.putSerializable(name, value);
7488 return this;
7489 }
7490
7491 /**
7492 * Add extended data to the intent. The name must include a package
7493 * prefix, for example the app com.android.contacts would use names
7494 * like "com.android.contacts.ShowAll".
7495 *
7496 * @param name The name of the extra data, with package prefix.
7497 * @param value The boolean array data value.
7498 *
7499 * @return Returns the same Intent object, for chaining multiple calls
7500 * into a single statement.
7501 *
7502 * @see #putExtras
7503 * @see #removeExtra
7504 * @see #getBooleanArrayExtra(String)
7505 */
7506 public Intent putExtra(String name, boolean[] value) {
7507 if (mExtras == null) {
7508 mExtras = new Bundle();
7509 }
7510 mExtras.putBooleanArray(name, value);
7511 return this;
7512 }
7513
7514 /**
7515 * Add extended data to the intent. The name must include a package
7516 * prefix, for example the app com.android.contacts would use names
7517 * like "com.android.contacts.ShowAll".
7518 *
7519 * @param name The name of the extra data, with package prefix.
7520 * @param value The byte array data value.
7521 *
7522 * @return Returns the same Intent object, for chaining multiple calls
7523 * into a single statement.
7524 *
7525 * @see #putExtras
7526 * @see #removeExtra
7527 * @see #getByteArrayExtra(String)
7528 */
7529 public Intent putExtra(String name, byte[] value) {
7530 if (mExtras == null) {
7531 mExtras = new Bundle();
7532 }
7533 mExtras.putByteArray(name, value);
7534 return this;
7535 }
7536
7537 /**
7538 * Add extended data to the intent. The name must include a package
7539 * prefix, for example the app com.android.contacts would use names
7540 * like "com.android.contacts.ShowAll".
7541 *
7542 * @param name The name of the extra data, with package prefix.
7543 * @param value The short array data value.
7544 *
7545 * @return Returns the same Intent object, for chaining multiple calls
7546 * into a single statement.
7547 *
7548 * @see #putExtras
7549 * @see #removeExtra
7550 * @see #getShortArrayExtra(String)
7551 */
7552 public Intent putExtra(String name, short[] value) {
7553 if (mExtras == null) {
7554 mExtras = new Bundle();
7555 }
7556 mExtras.putShortArray(name, value);
7557 return this;
7558 }
7559
7560 /**
7561 * Add extended data to the intent. The name must include a package
7562 * prefix, for example the app com.android.contacts would use names
7563 * like "com.android.contacts.ShowAll".
7564 *
7565 * @param name The name of the extra data, with package prefix.
7566 * @param value The char array data value.
7567 *
7568 * @return Returns the same Intent object, for chaining multiple calls
7569 * into a single statement.
7570 *
7571 * @see #putExtras
7572 * @see #removeExtra
7573 * @see #getCharArrayExtra(String)
7574 */
7575 public Intent putExtra(String name, char[] value) {
7576 if (mExtras == null) {
7577 mExtras = new Bundle();
7578 }
7579 mExtras.putCharArray(name, value);
7580 return this;
7581 }
7582
7583 /**
7584 * Add extended data to the intent. The name must include a package
7585 * prefix, for example the app com.android.contacts would use names
7586 * like "com.android.contacts.ShowAll".
7587 *
7588 * @param name The name of the extra data, with package prefix.
7589 * @param value The int array data value.
7590 *
7591 * @return Returns the same Intent object, for chaining multiple calls
7592 * into a single statement.
7593 *
7594 * @see #putExtras
7595 * @see #removeExtra
7596 * @see #getIntArrayExtra(String)
7597 */
7598 public Intent putExtra(String name, int[] value) {
7599 if (mExtras == null) {
7600 mExtras = new Bundle();
7601 }
7602 mExtras.putIntArray(name, value);
7603 return this;
7604 }
7605
7606 /**
7607 * Add extended data to the intent. The name must include a package
7608 * prefix, for example the app com.android.contacts would use names
7609 * like "com.android.contacts.ShowAll".
7610 *
7611 * @param name The name of the extra data, with package prefix.
7612 * @param value The byte array data value.
7613 *
7614 * @return Returns the same Intent object, for chaining multiple calls
7615 * into a single statement.
7616 *
7617 * @see #putExtras
7618 * @see #removeExtra
7619 * @see #getLongArrayExtra(String)
7620 */
7621 public Intent putExtra(String name, long[] value) {
7622 if (mExtras == null) {
7623 mExtras = new Bundle();
7624 }
7625 mExtras.putLongArray(name, value);
7626 return this;
7627 }
7628
7629 /**
7630 * Add extended data to the intent. The name must include a package
7631 * prefix, for example the app com.android.contacts would use names
7632 * like "com.android.contacts.ShowAll".
7633 *
7634 * @param name The name of the extra data, with package prefix.
7635 * @param value The float array data value.
7636 *
7637 * @return Returns the same Intent object, for chaining multiple calls
7638 * into a single statement.
7639 *
7640 * @see #putExtras
7641 * @see #removeExtra
7642 * @see #getFloatArrayExtra(String)
7643 */
7644 public Intent putExtra(String name, float[] value) {
7645 if (mExtras == null) {
7646 mExtras = new Bundle();
7647 }
7648 mExtras.putFloatArray(name, value);
7649 return this;
7650 }
7651
7652 /**
7653 * Add extended data to the intent. The name must include a package
7654 * prefix, for example the app com.android.contacts would use names
7655 * like "com.android.contacts.ShowAll".
7656 *
7657 * @param name The name of the extra data, with package prefix.
7658 * @param value The double array data value.
7659 *
7660 * @return Returns the same Intent object, for chaining multiple calls
7661 * into a single statement.
7662 *
7663 * @see #putExtras
7664 * @see #removeExtra
7665 * @see #getDoubleArrayExtra(String)
7666 */
7667 public Intent putExtra(String name, double[] value) {
7668 if (mExtras == null) {
7669 mExtras = new Bundle();
7670 }
7671 mExtras.putDoubleArray(name, value);
7672 return this;
7673 }
7674
7675 /**
7676 * Add extended data to the intent. The name must include a package
7677 * prefix, for example the app com.android.contacts would use names
7678 * like "com.android.contacts.ShowAll".
7679 *
7680 * @param name The name of the extra data, with package prefix.
7681 * @param value The String array data value.
7682 *
7683 * @return Returns the same Intent object, for chaining multiple calls
7684 * into a single statement.
7685 *
7686 * @see #putExtras
7687 * @see #removeExtra
7688 * @see #getStringArrayExtra(String)
7689 */
7690 public Intent putExtra(String name, String[] value) {
7691 if (mExtras == null) {
7692 mExtras = new Bundle();
7693 }
7694 mExtras.putStringArray(name, value);
7695 return this;
7696 }
7697
7698 /**
7699 * Add extended data to the intent. The name must include a package
7700 * prefix, for example the app com.android.contacts would use names
7701 * like "com.android.contacts.ShowAll".
7702 *
7703 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007704 * @param value The CharSequence array data value.
7705 *
7706 * @return Returns the same Intent object, for chaining multiple calls
7707 * into a single statement.
7708 *
7709 * @see #putExtras
7710 * @see #removeExtra
7711 * @see #getCharSequenceArrayExtra(String)
7712 */
7713 public Intent putExtra(String name, CharSequence[] value) {
7714 if (mExtras == null) {
7715 mExtras = new Bundle();
7716 }
7717 mExtras.putCharSequenceArray(name, value);
7718 return this;
7719 }
7720
7721 /**
7722 * Add extended data to the intent. The name must include a package
7723 * prefix, for example the app com.android.contacts would use names
7724 * like "com.android.contacts.ShowAll".
7725 *
7726 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007727 * @param value The Bundle data value.
7728 *
7729 * @return Returns the same Intent object, for chaining multiple calls
7730 * into a single statement.
7731 *
7732 * @see #putExtras
7733 * @see #removeExtra
7734 * @see #getBundleExtra(String)
7735 */
7736 public Intent putExtra(String name, Bundle value) {
7737 if (mExtras == null) {
7738 mExtras = new Bundle();
7739 }
7740 mExtras.putBundle(name, value);
7741 return this;
7742 }
7743
7744 /**
7745 * Add extended data to the intent. The name must include a package
7746 * prefix, for example the app com.android.contacts would use names
7747 * like "com.android.contacts.ShowAll".
7748 *
7749 * @param name The name of the extra data, with package prefix.
7750 * @param value The IBinder data value.
7751 *
7752 * @return Returns the same Intent object, for chaining multiple calls
7753 * into a single statement.
7754 *
7755 * @see #putExtras
7756 * @see #removeExtra
7757 * @see #getIBinderExtra(String)
7758 *
7759 * @deprecated
7760 * @hide
7761 */
7762 @Deprecated
7763 public Intent putExtra(String name, IBinder value) {
7764 if (mExtras == null) {
7765 mExtras = new Bundle();
7766 }
7767 mExtras.putIBinder(name, value);
7768 return this;
7769 }
7770
7771 /**
7772 * Copy all extras in 'src' in to this intent.
7773 *
7774 * @param src Contains the extras to copy.
7775 *
7776 * @see #putExtra
7777 */
7778 public Intent putExtras(Intent src) {
7779 if (src.mExtras != null) {
7780 if (mExtras == null) {
7781 mExtras = new Bundle(src.mExtras);
7782 } else {
7783 mExtras.putAll(src.mExtras);
7784 }
7785 }
7786 return this;
7787 }
7788
7789 /**
7790 * Add a set of extended data to the intent. The keys must include a package
7791 * prefix, for example the app com.android.contacts would use names
7792 * like "com.android.contacts.ShowAll".
7793 *
7794 * @param extras The Bundle of extras to add to this intent.
7795 *
7796 * @see #putExtra
7797 * @see #removeExtra
7798 */
7799 public Intent putExtras(Bundle extras) {
7800 if (mExtras == null) {
7801 mExtras = new Bundle();
7802 }
7803 mExtras.putAll(extras);
7804 return this;
7805 }
7806
7807 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007808 * Completely replace the extras in the Intent with the extras in the
7809 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007810 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007811 * @param src The exact extras contained in this Intent are copied
7812 * into the target intent, replacing any that were previously there.
7813 */
7814 public Intent replaceExtras(Intent src) {
7815 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7816 return this;
7817 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007818
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007819 /**
7820 * Completely replace the extras in the Intent with the given Bundle of
7821 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007822 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007823 * @param extras The new set of extras in the Intent, or null to erase
7824 * all extras.
7825 */
7826 public Intent replaceExtras(Bundle extras) {
7827 mExtras = extras != null ? new Bundle(extras) : null;
7828 return this;
7829 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007830
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007831 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007832 * Remove extended data from the intent.
7833 *
7834 * @see #putExtra
7835 */
7836 public void removeExtra(String name) {
7837 if (mExtras != null) {
7838 mExtras.remove(name);
7839 if (mExtras.size() == 0) {
7840 mExtras = null;
7841 }
7842 }
7843 }
7844
7845 /**
7846 * Set special flags controlling how this intent is handled. Most values
7847 * here depend on the type of component being executed by the Intent,
7848 * specifically the FLAG_ACTIVITY_* flags are all for use with
7849 * {@link Context#startActivity Context.startActivity()} and the
7850 * FLAG_RECEIVER_* flags are all for use with
7851 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7852 *
Scott Main7aee61f2011-02-08 11:25:01 -08007853 * <p>See the
7854 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7855 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007856 * the behavior of your application.
7857 *
7858 * @param flags The desired flags.
7859 *
7860 * @return Returns the same Intent object, for chaining multiple calls
7861 * into a single statement.
7862 *
7863 * @see #getFlags
7864 * @see #addFlags
7865 *
7866 * @see #FLAG_GRANT_READ_URI_PERMISSION
7867 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007868 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7869 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007870 * @see #FLAG_DEBUG_LOG_RESOLUTION
7871 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007872 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007873 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007874 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007875 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007876 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7877 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007878 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007879 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007880 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007881 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007882 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007883 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007884 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007885 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7886 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007887 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007888 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007889 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007890 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7891 */
7892 public Intent setFlags(int flags) {
7893 mFlags = flags;
7894 return this;
7895 }
7896
7897 /**
7898 * Add additional flags to the intent (or with existing flags
7899 * value).
7900 *
7901 * @param flags The new flags to set.
7902 *
7903 * @return Returns the same Intent object, for chaining multiple calls
7904 * into a single statement.
7905 *
7906 * @see #setFlags
7907 */
7908 public Intent addFlags(int flags) {
7909 mFlags |= flags;
7910 return this;
7911 }
7912
7913 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007914 * (Usually optional) Set an explicit application package name that limits
7915 * the components this Intent will resolve to. If left to the default
7916 * value of null, all components in all applications will considered.
7917 * If non-null, the Intent can only match the components in the given
7918 * application package.
7919 *
7920 * @param packageName The name of the application package to handle the
7921 * intent, or null to allow any application package.
7922 *
7923 * @return Returns the same Intent object, for chaining multiple calls
7924 * into a single statement.
7925 *
7926 * @see #getPackage
7927 * @see #resolveActivity
7928 */
7929 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007930 if (packageName != null && mSelector != null) {
7931 throw new IllegalArgumentException(
7932 "Can't set package name when selector is already set");
7933 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007934 mPackage = packageName;
7935 return this;
7936 }
7937
7938 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007939 * (Usually optional) Explicitly set the component to handle the intent.
7940 * If left with the default value of null, the system will determine the
7941 * appropriate class to use based on the other fields (action, data,
7942 * type, categories) in the Intent. If this class is defined, the
7943 * specified class will always be used regardless of the other fields. You
7944 * should only set this value when you know you absolutely want a specific
7945 * class to be used; otherwise it is better to let the system find the
7946 * appropriate class so that you will respect the installed applications
7947 * and user preferences.
7948 *
7949 * @param component The name of the application component to handle the
7950 * intent, or null to let the system find one for you.
7951 *
7952 * @return Returns the same Intent object, for chaining multiple calls
7953 * into a single statement.
7954 *
7955 * @see #setClass
7956 * @see #setClassName(Context, String)
7957 * @see #setClassName(String, String)
7958 * @see #getComponent
7959 * @see #resolveActivity
7960 */
7961 public Intent setComponent(ComponentName component) {
7962 mComponent = component;
7963 return this;
7964 }
7965
7966 /**
7967 * Convenience for calling {@link #setComponent} with an
7968 * explicit class name.
7969 *
7970 * @param packageContext A Context of the application package implementing
7971 * this class.
7972 * @param className The name of a class inside of the application package
7973 * that will be used as the component for this Intent.
7974 *
7975 * @return Returns the same Intent object, for chaining multiple calls
7976 * into a single statement.
7977 *
7978 * @see #setComponent
7979 * @see #setClass
7980 */
7981 public Intent setClassName(Context packageContext, String className) {
7982 mComponent = new ComponentName(packageContext, className);
7983 return this;
7984 }
7985
7986 /**
7987 * Convenience for calling {@link #setComponent} with an
7988 * explicit application package name and class name.
7989 *
7990 * @param packageName The name of the package implementing the desired
7991 * component.
7992 * @param className The name of a class inside of the application package
7993 * that will be used as the component for this Intent.
7994 *
7995 * @return Returns the same Intent object, for chaining multiple calls
7996 * into a single statement.
7997 *
7998 * @see #setComponent
7999 * @see #setClass
8000 */
8001 public Intent setClassName(String packageName, String className) {
8002 mComponent = new ComponentName(packageName, className);
8003 return this;
8004 }
8005
8006 /**
8007 * Convenience for calling {@link #setComponent(ComponentName)} with the
8008 * name returned by a {@link Class} object.
8009 *
8010 * @param packageContext A Context of the application package implementing
8011 * this class.
8012 * @param cls The class name to set, equivalent to
8013 * <code>setClassName(context, cls.getName())</code>.
8014 *
8015 * @return Returns the same Intent object, for chaining multiple calls
8016 * into a single statement.
8017 *
8018 * @see #setComponent
8019 */
8020 public Intent setClass(Context packageContext, Class<?> cls) {
8021 mComponent = new ComponentName(packageContext, cls);
8022 return this;
8023 }
8024
8025 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008026 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8027 * used as a hint to the receiver for animations and the like. Null means that there
8028 * is no source bounds.
8029 */
8030 public void setSourceBounds(Rect r) {
8031 if (r != null) {
8032 mSourceBounds = new Rect(r);
8033 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008034 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008035 }
8036 }
8037
Tor Norbyed9273d62013-05-30 15:59:53 -07008038 /** @hide */
8039 @IntDef(flag = true,
8040 value = {
8041 FILL_IN_ACTION,
8042 FILL_IN_DATA,
8043 FILL_IN_CATEGORIES,
8044 FILL_IN_COMPONENT,
8045 FILL_IN_PACKAGE,
8046 FILL_IN_SOURCE_BOUNDS,
8047 FILL_IN_SELECTOR,
8048 FILL_IN_CLIP_DATA
8049 })
8050 @Retention(RetentionPolicy.SOURCE)
8051 public @interface FillInFlags {}
8052
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008053 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008054 * Use with {@link #fillIn} to allow the current action value to be
8055 * overwritten, even if it is already set.
8056 */
8057 public static final int FILL_IN_ACTION = 1<<0;
8058
8059 /**
8060 * Use with {@link #fillIn} to allow the current data or type value
8061 * overwritten, even if it is already set.
8062 */
8063 public static final int FILL_IN_DATA = 1<<1;
8064
8065 /**
8066 * Use with {@link #fillIn} to allow the current categories to be
8067 * overwritten, even if they are already set.
8068 */
8069 public static final int FILL_IN_CATEGORIES = 1<<2;
8070
8071 /**
8072 * Use with {@link #fillIn} to allow the current component value to be
8073 * overwritten, even if it is already set.
8074 */
8075 public static final int FILL_IN_COMPONENT = 1<<3;
8076
8077 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008078 * Use with {@link #fillIn} to allow the current package value to be
8079 * overwritten, even if it is already set.
8080 */
8081 public static final int FILL_IN_PACKAGE = 1<<4;
8082
8083 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008084 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008085 * overwritten, even if it is already set.
8086 */
8087 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8088
8089 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008090 * Use with {@link #fillIn} to allow the current selector to be
8091 * overwritten, even if it is already set.
8092 */
8093 public static final int FILL_IN_SELECTOR = 1<<6;
8094
8095 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008096 * Use with {@link #fillIn} to allow the current ClipData to be
8097 * overwritten, even if it is already set.
8098 */
8099 public static final int FILL_IN_CLIP_DATA = 1<<7;
8100
8101 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008102 * Copy the contents of <var>other</var> in to this object, but only
8103 * where fields are not defined by this object. For purposes of a field
8104 * being defined, the following pieces of data in the Intent are
8105 * considered to be separate fields:
8106 *
8107 * <ul>
8108 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008109 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008110 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8111 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008112 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008113 * <li> component, as set by {@link #setComponent(ComponentName)} or
8114 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008115 * <li> source bounds, as set by {@link #setSourceBounds}.
8116 * <li> selector, as set by {@link #setSelector(Intent)}.
8117 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008118 * <li> each top-level name in the associated extras.
8119 * </ul>
8120 *
8121 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008122 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008123 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8124 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8125 * the restriction where the corresponding field will not be replaced if
8126 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008127 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008128 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8129 * is explicitly specified. The selector will only be copied if
8130 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008131 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008132 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8133 * and Intent B with {action="gotit", data-type="some/thing",
8134 * categories="one","two"}.
8135 *
8136 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8137 * containing: {action="gotit", data-type="some/thing",
8138 * categories="bar"}.
8139 *
8140 * @param other Another Intent whose values are to be used to fill in
8141 * the current one.
8142 * @param flags Options to control which fields can be filled in.
8143 *
8144 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008145 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008146 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8147 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8148 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008149 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008150 @FillInFlags
8151 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008152 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008153 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008154 if (other.mAction != null
8155 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008156 mAction = other.mAction;
8157 changes |= FILL_IN_ACTION;
8158 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008159 if ((other.mData != null || other.mType != null)
8160 && ((mData == null && mType == null)
8161 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008162 mData = other.mData;
8163 mType = other.mType;
8164 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008165 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008166 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008167 if (other.mCategories != null
8168 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008169 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008170 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008171 }
8172 changes |= FILL_IN_CATEGORIES;
8173 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008174 if (other.mPackage != null
8175 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008176 // Only do this if mSelector is not set.
8177 if (mSelector == null) {
8178 mPackage = other.mPackage;
8179 changes |= FILL_IN_PACKAGE;
8180 }
8181 }
8182 // Selector is special: it can only be set if explicitly allowed,
8183 // for the same reason as the component name.
8184 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8185 if (mPackage == null) {
8186 mSelector = new Intent(other.mSelector);
8187 mPackage = null;
8188 changes |= FILL_IN_SELECTOR;
8189 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008190 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008191 if (other.mClipData != null
8192 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8193 mClipData = other.mClipData;
8194 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008195 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008196 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008197 // Component is special: it can -only- be set if explicitly allowed,
8198 // since otherwise the sender could force the intent somewhere the
8199 // originator didn't intend.
8200 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008201 mComponent = other.mComponent;
8202 changes |= FILL_IN_COMPONENT;
8203 }
8204 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008205 if (other.mSourceBounds != null
8206 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8207 mSourceBounds = new Rect(other.mSourceBounds);
8208 changes |= FILL_IN_SOURCE_BOUNDS;
8209 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008210 if (mExtras == null) {
8211 if (other.mExtras != null) {
8212 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008213 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008214 }
8215 } else if (other.mExtras != null) {
8216 try {
8217 Bundle newb = new Bundle(other.mExtras);
8218 newb.putAll(mExtras);
8219 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008220 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008221 } catch (RuntimeException e) {
8222 // Modifying the extras can cause us to unparcel the contents
8223 // of the bundle, and if we do this in the system process that
8224 // may fail. We really should handle this (i.e., the Bundle
8225 // impl shouldn't be on top of a plain map), but for now just
8226 // ignore it and keep the original contents. :(
8227 Log.w("Intent", "Failure filling in extras", e);
8228 }
8229 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008230 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8231 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8232 mContentUserHint = other.mContentUserHint;
8233 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008234 return changes;
8235 }
8236
8237 /**
8238 * Wrapper class holding an Intent and implementing comparisons on it for
8239 * the purpose of filtering. The class implements its
8240 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8241 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8242 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8243 * on the wrapped Intent.
8244 */
8245 public static final class FilterComparison {
8246 private final Intent mIntent;
8247 private final int mHashCode;
8248
8249 public FilterComparison(Intent intent) {
8250 mIntent = intent;
8251 mHashCode = intent.filterHashCode();
8252 }
8253
8254 /**
8255 * Return the Intent that this FilterComparison represents.
8256 * @return Returns the Intent held by the FilterComparison. Do
8257 * not modify!
8258 */
8259 public Intent getIntent() {
8260 return mIntent;
8261 }
8262
8263 @Override
8264 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008265 if (obj instanceof FilterComparison) {
8266 Intent other = ((FilterComparison)obj).mIntent;
8267 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008268 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008269 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008270 }
8271
8272 @Override
8273 public int hashCode() {
8274 return mHashCode;
8275 }
8276 }
8277
8278 /**
8279 * Determine if two intents are the same for the purposes of intent
8280 * resolution (filtering). That is, if their action, data, type,
8281 * class, and categories are the same. This does <em>not</em> compare
8282 * any extra data included in the intents.
8283 *
8284 * @param other The other Intent to compare against.
8285 *
8286 * @return Returns true if action, data, type, class, and categories
8287 * are the same.
8288 */
8289 public boolean filterEquals(Intent other) {
8290 if (other == null) {
8291 return false;
8292 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008293 if (!Objects.equals(this.mAction, other.mAction)) return false;
8294 if (!Objects.equals(this.mData, other.mData)) return false;
8295 if (!Objects.equals(this.mType, other.mType)) return false;
8296 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8297 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8298 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008299
8300 return true;
8301 }
8302
8303 /**
8304 * Generate hash code that matches semantics of filterEquals().
8305 *
8306 * @return Returns the hash value of the action, data, type, class, and
8307 * categories.
8308 *
8309 * @see #filterEquals
8310 */
8311 public int filterHashCode() {
8312 int code = 0;
8313 if (mAction != null) {
8314 code += mAction.hashCode();
8315 }
8316 if (mData != null) {
8317 code += mData.hashCode();
8318 }
8319 if (mType != null) {
8320 code += mType.hashCode();
8321 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008322 if (mPackage != null) {
8323 code += mPackage.hashCode();
8324 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008325 if (mComponent != null) {
8326 code += mComponent.hashCode();
8327 }
8328 if (mCategories != null) {
8329 code += mCategories.hashCode();
8330 }
8331 return code;
8332 }
8333
8334 @Override
8335 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008336 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008337
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008338 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008339 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008340 b.append(" }");
8341
8342 return b.toString();
8343 }
8344
8345 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008346 public String toInsecureString() {
8347 StringBuilder b = new StringBuilder(128);
8348
8349 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008350 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008351 b.append(" }");
8352
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008353 return b.toString();
8354 }
Romain Guy4969af72009-06-17 10:53:19 -07008355
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008356 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008357 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008358 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008359
8360 b.append("Intent { ");
8361 toShortString(b, false, true, true, true);
8362 b.append(" }");
8363
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008364 return b.toString();
8365 }
8366
8367 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008368 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8369 StringBuilder b = new StringBuilder(128);
8370 toShortString(b, secure, comp, extras, clip);
8371 return b.toString();
8372 }
8373
8374 /** @hide */
8375 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8376 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008377 boolean first = true;
8378 if (mAction != null) {
8379 b.append("act=").append(mAction);
8380 first = false;
8381 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008382 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008383 if (!first) {
8384 b.append(' ');
8385 }
8386 first = false;
8387 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008388 for (int i=0; i<mCategories.size(); i++) {
8389 if (i > 0) b.append(',');
8390 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008391 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008392 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008393 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008394 if (mData != null) {
8395 if (!first) {
8396 b.append(' ');
8397 }
8398 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008399 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008400 if (secure) {
8401 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008402 } else {
8403 b.append(mData);
8404 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008405 }
8406 if (mType != null) {
8407 if (!first) {
8408 b.append(' ');
8409 }
8410 first = false;
8411 b.append("typ=").append(mType);
8412 }
8413 if (mFlags != 0) {
8414 if (!first) {
8415 b.append(' ');
8416 }
8417 first = false;
8418 b.append("flg=0x").append(Integer.toHexString(mFlags));
8419 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008420 if (mPackage != null) {
8421 if (!first) {
8422 b.append(' ');
8423 }
8424 first = false;
8425 b.append("pkg=").append(mPackage);
8426 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008427 if (comp && mComponent != null) {
8428 if (!first) {
8429 b.append(' ');
8430 }
8431 first = false;
8432 b.append("cmp=").append(mComponent.flattenToShortString());
8433 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008434 if (mSourceBounds != null) {
8435 if (!first) {
8436 b.append(' ');
8437 }
8438 first = false;
8439 b.append("bnds=").append(mSourceBounds.toShortString());
8440 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008441 if (mClipData != null) {
8442 if (!first) {
8443 b.append(' ');
8444 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008445 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008446 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008447 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008448 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008449 if (mClipData.getDescription() != null) {
8450 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8451 } else {
8452 first = true;
8453 }
8454 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008455 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008456 first = false;
8457 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008458 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008459 if (extras && mExtras != null) {
8460 if (!first) {
8461 b.append(' ');
8462 }
8463 first = false;
8464 b.append("(has extras)");
8465 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008466 if (mContentUserHint != UserHandle.USER_CURRENT) {
8467 if (!first) {
8468 b.append(' ');
8469 }
8470 first = false;
8471 b.append("u=").append(mContentUserHint);
8472 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008473 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008474 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008475 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008476 b.append("}");
8477 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008478 }
8479
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008480 /**
8481 * Call {@link #toUri} with 0 flags.
8482 * @deprecated Use {@link #toUri} instead.
8483 */
8484 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008485 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008486 return toUri(0);
8487 }
8488
8489 /**
8490 * Convert this Intent into a String holding a URI representation of it.
8491 * The returned URI string has been properly URI encoded, so it can be
8492 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8493 * Intent's data as the base URI, with an additional fragment describing
8494 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008495 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008496 * <p>You can convert the returned string back to an Intent with
8497 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008498 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008499 * @param flags Additional operating flags. Either 0,
8500 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008501 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008502 * @return Returns a URI encoding URI string describing the entire contents
8503 * of the Intent.
8504 */
8505 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008506 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008507 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8508 if (mPackage == null) {
8509 throw new IllegalArgumentException(
8510 "Intent must include an explicit package name to build an android-app: "
8511 + this);
8512 }
8513 uri.append("android-app://");
8514 uri.append(mPackage);
8515 String scheme = null;
8516 if (mData != null) {
8517 scheme = mData.getScheme();
8518 if (scheme != null) {
8519 uri.append('/');
8520 uri.append(scheme);
8521 String authority = mData.getEncodedAuthority();
8522 if (authority != null) {
8523 uri.append('/');
8524 uri.append(authority);
8525 String path = mData.getEncodedPath();
8526 if (path != null) {
8527 uri.append(path);
8528 }
8529 String queryParams = mData.getEncodedQuery();
8530 if (queryParams != null) {
8531 uri.append('?');
8532 uri.append(queryParams);
8533 }
8534 String fragment = mData.getEncodedFragment();
8535 if (fragment != null) {
8536 uri.append('#');
8537 uri.append(fragment);
8538 }
8539 }
8540 }
8541 }
8542 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8543 mPackage, flags);
8544 return uri.toString();
8545 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008546 String scheme = null;
8547 if (mData != null) {
8548 String data = mData.toString();
8549 if ((flags&URI_INTENT_SCHEME) != 0) {
8550 final int N = data.length();
8551 for (int i=0; i<N; i++) {
8552 char c = data.charAt(i);
8553 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8554 || c == '.' || c == '-') {
8555 continue;
8556 }
8557 if (c == ':' && i > 0) {
8558 // Valid scheme.
8559 scheme = data.substring(0, i);
8560 uri.append("intent:");
8561 data = data.substring(i+1);
8562 break;
8563 }
Tom Taylord4a47292009-12-21 13:59:18 -08008564
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008565 // No scheme.
8566 break;
8567 }
8568 }
8569 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008570
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008571 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8572 uri.append("intent:");
8573 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008574
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008575 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008576
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008577 return uri.toString();
8578 }
8579
8580 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8581 String defPackage, int flags) {
8582 StringBuilder frag = new StringBuilder(128);
8583
8584 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008585 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008586 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008587 // Note that for now we are not going to try to handle the
8588 // data part; not clear how to represent this as a URI, and
8589 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008590 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8591 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008592 }
8593
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008594 if (frag.length() > 0) {
8595 uri.append("#Intent;");
8596 uri.append(frag);
8597 uri.append("end");
8598 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008599 }
8600
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008601 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8602 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008603 if (scheme != null) {
8604 uri.append("scheme=").append(scheme).append(';');
8605 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008606 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008607 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008608 }
8609 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008610 for (int i=0; i<mCategories.size(); i++) {
8611 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008612 }
8613 }
8614 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008615 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008616 }
8617 if (mFlags != 0) {
8618 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8619 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008620 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008621 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8622 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008623 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008624 uri.append("component=").append(Uri.encode(
8625 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008626 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008627 if (mSourceBounds != null) {
8628 uri.append("sourceBounds=")
8629 .append(Uri.encode(mSourceBounds.flattenToString()))
8630 .append(';');
8631 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008632 if (mExtras != null) {
8633 for (String key : mExtras.keySet()) {
8634 final Object value = mExtras.get(key);
8635 char entryType =
8636 value instanceof String ? 'S' :
8637 value instanceof Boolean ? 'B' :
8638 value instanceof Byte ? 'b' :
8639 value instanceof Character ? 'c' :
8640 value instanceof Double ? 'd' :
8641 value instanceof Float ? 'f' :
8642 value instanceof Integer ? 'i' :
8643 value instanceof Long ? 'l' :
8644 value instanceof Short ? 's' :
8645 '\0';
8646
8647 if (entryType != '\0') {
8648 uri.append(entryType);
8649 uri.append('.');
8650 uri.append(Uri.encode(key));
8651 uri.append('=');
8652 uri.append(Uri.encode(value.toString()));
8653 uri.append(';');
8654 }
8655 }
8656 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008657 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008658
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008659 public int describeContents() {
8660 return (mExtras != null) ? mExtras.describeContents() : 0;
8661 }
8662
8663 public void writeToParcel(Parcel out, int flags) {
8664 out.writeString(mAction);
8665 Uri.writeToParcel(out, mData);
8666 out.writeString(mType);
8667 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008668 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008669 ComponentName.writeToParcel(mComponent, out);
8670
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008671 if (mSourceBounds != null) {
8672 out.writeInt(1);
8673 mSourceBounds.writeToParcel(out, flags);
8674 } else {
8675 out.writeInt(0);
8676 }
8677
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008678 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008679 final int N = mCategories.size();
8680 out.writeInt(N);
8681 for (int i=0; i<N; i++) {
8682 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008683 }
8684 } else {
8685 out.writeInt(0);
8686 }
8687
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008688 if (mSelector != null) {
8689 out.writeInt(1);
8690 mSelector.writeToParcel(out, flags);
8691 } else {
8692 out.writeInt(0);
8693 }
8694
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008695 if (mClipData != null) {
8696 out.writeInt(1);
8697 mClipData.writeToParcel(out, flags);
8698 } else {
8699 out.writeInt(0);
8700 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008701 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008702 out.writeBundle(mExtras);
8703 }
8704
8705 public static final Parcelable.Creator<Intent> CREATOR
8706 = new Parcelable.Creator<Intent>() {
8707 public Intent createFromParcel(Parcel in) {
8708 return new Intent(in);
8709 }
8710 public Intent[] newArray(int size) {
8711 return new Intent[size];
8712 }
8713 };
8714
Dianne Hackborneb034652009-09-07 00:49:58 -07008715 /** @hide */
8716 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008717 readFromParcel(in);
8718 }
8719
8720 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008721 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008722 mData = Uri.CREATOR.createFromParcel(in);
8723 mType = in.readString();
8724 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008725 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008726 mComponent = ComponentName.readFromParcel(in);
8727
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008728 if (in.readInt() != 0) {
8729 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8730 }
8731
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008732 int N = in.readInt();
8733 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008734 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008735 int i;
8736 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008737 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008738 }
8739 } else {
8740 mCategories = null;
8741 }
8742
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008743 if (in.readInt() != 0) {
8744 mSelector = new Intent(in);
8745 }
8746
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008747 if (in.readInt() != 0) {
8748 mClipData = new ClipData(in);
8749 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008750 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008751 mExtras = in.readBundle();
8752 }
8753
8754 /**
8755 * Parses the "intent" element (and its children) from XML and instantiates
8756 * an Intent object. The given XML parser should be located at the tag
8757 * where parsing should start (often named "intent"), from which the
8758 * basic action, data, type, and package and class name will be
8759 * retrieved. The function will then parse in to any child elements,
8760 * looking for <category android:name="xxx"> tags to add categories and
8761 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8762 * to the intent.
8763 *
8764 * @param resources The Resources to use when inflating resources.
8765 * @param parser The XML parser pointing at an "intent" tag.
8766 * @param attrs The AttributeSet interface for retrieving extended
8767 * attribute data at the current <var>parser</var> location.
8768 * @return An Intent object matching the XML data.
8769 * @throws XmlPullParserException If there was an XML parsing error.
8770 * @throws IOException If there was an I/O error.
8771 */
8772 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8773 throws XmlPullParserException, IOException {
8774 Intent intent = new Intent();
8775
8776 TypedArray sa = resources.obtainAttributes(attrs,
8777 com.android.internal.R.styleable.Intent);
8778
8779 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8780
8781 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8782 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8783 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8784
8785 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8786 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8787 if (packageName != null && className != null) {
8788 intent.setComponent(new ComponentName(packageName, className));
8789 }
8790
8791 sa.recycle();
8792
8793 int outerDepth = parser.getDepth();
8794 int type;
8795 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8796 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8797 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8798 continue;
8799 }
8800
8801 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008802 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008803 sa = resources.obtainAttributes(attrs,
8804 com.android.internal.R.styleable.IntentCategory);
8805 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8806 sa.recycle();
8807
8808 if (cat != null) {
8809 intent.addCategory(cat);
8810 }
8811 XmlUtils.skipCurrentTag(parser);
8812
Craig Mautner21d24a22014-04-23 11:45:37 -07008813 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008814 if (intent.mExtras == null) {
8815 intent.mExtras = new Bundle();
8816 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008817 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008818 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008819
8820 } else {
8821 XmlUtils.skipCurrentTag(parser);
8822 }
8823 }
8824
8825 return intent;
8826 }
Nick Pellyccae4122012-01-09 14:12:58 -08008827
Craig Mautner21d24a22014-04-23 11:45:37 -07008828 /** @hide */
8829 public void saveToXml(XmlSerializer out) throws IOException {
8830 if (mAction != null) {
8831 out.attribute(null, ATTR_ACTION, mAction);
8832 }
8833 if (mData != null) {
8834 out.attribute(null, ATTR_DATA, mData.toString());
8835 }
8836 if (mType != null) {
8837 out.attribute(null, ATTR_TYPE, mType);
8838 }
8839 if (mComponent != null) {
8840 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8841 }
8842 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8843
8844 if (mCategories != null) {
8845 out.startTag(null, TAG_CATEGORIES);
8846 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8847 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8848 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008849 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008850 }
8851 }
8852
8853 /** @hide */
8854 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8855 XmlPullParserException {
8856 Intent intent = new Intent();
8857 final int outerDepth = in.getDepth();
8858
8859 int attrCount = in.getAttributeCount();
8860 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8861 final String attrName = in.getAttributeName(attrNdx);
8862 final String attrValue = in.getAttributeValue(attrNdx);
8863 if (ATTR_ACTION.equals(attrName)) {
8864 intent.setAction(attrValue);
8865 } else if (ATTR_DATA.equals(attrName)) {
8866 intent.setData(Uri.parse(attrValue));
8867 } else if (ATTR_TYPE.equals(attrName)) {
8868 intent.setType(attrValue);
8869 } else if (ATTR_COMPONENT.equals(attrName)) {
8870 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8871 } else if (ATTR_FLAGS.equals(attrName)) {
8872 intent.setFlags(Integer.valueOf(attrValue, 16));
8873 } else {
8874 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8875 }
8876 }
8877
8878 int event;
8879 String name;
8880 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8881 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8882 if (event == XmlPullParser.START_TAG) {
8883 name = in.getName();
8884 if (TAG_CATEGORIES.equals(name)) {
8885 attrCount = in.getAttributeCount();
8886 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8887 intent.addCategory(in.getAttributeValue(attrNdx));
8888 }
8889 } else {
8890 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8891 XmlUtils.skipCurrentTag(in);
8892 }
8893 }
8894 }
8895
8896 return intent;
8897 }
8898
Nick Pellyccae4122012-01-09 14:12:58 -08008899 /**
8900 * Normalize a MIME data type.
8901 *
8902 * <p>A normalized MIME type has white-space trimmed,
8903 * content-type parameters removed, and is lower-case.
8904 * This aligns the type with Android best practices for
8905 * intent filtering.
8906 *
8907 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8908 * "text/x-vCard" becomes "text/x-vcard".
8909 *
8910 * <p>All MIME types received from outside Android (such as user input,
8911 * or external sources like Bluetooth, NFC, or the Internet) should
8912 * be normalized before they are used to create an Intent.
8913 *
8914 * @param type MIME data type to normalize
8915 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008916 * @see #setType
8917 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008918 */
8919 public static String normalizeMimeType(String type) {
8920 if (type == null) {
8921 return null;
8922 }
8923
Elliott Hughescb64d432013-08-02 10:00:44 -07008924 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008925
8926 final int semicolonIndex = type.indexOf(';');
8927 if (semicolonIndex != -1) {
8928 type = type.substring(0, semicolonIndex);
8929 }
8930 return type;
8931 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008932
8933 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008934 * Prepare this {@link Intent} to leave an app process.
8935 *
8936 * @hide
8937 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07008938 public void prepareToLeaveProcess(Context context) {
8939 final boolean leavingPackage = (mComponent == null)
8940 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
8941 prepareToLeaveProcess(leavingPackage);
8942 }
8943
8944 /**
8945 * Prepare this {@link Intent} to leave an app process.
8946 *
8947 * @hide
8948 */
8949 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008950 setAllowFds(false);
8951
8952 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008953 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008954 }
8955 if (mClipData != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008956 mClipData.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008957 }
8958
Jeff Sharkeya8b42782016-01-30 17:58:09 -07008959 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
8960 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008961 switch (mAction) {
8962 case ACTION_MEDIA_REMOVED:
8963 case ACTION_MEDIA_UNMOUNTED:
8964 case ACTION_MEDIA_CHECKING:
8965 case ACTION_MEDIA_NOFS:
8966 case ACTION_MEDIA_MOUNTED:
8967 case ACTION_MEDIA_SHARED:
8968 case ACTION_MEDIA_UNSHARED:
8969 case ACTION_MEDIA_BAD_REMOVAL:
8970 case ACTION_MEDIA_UNMOUNTABLE:
8971 case ACTION_MEDIA_EJECT:
8972 case ACTION_MEDIA_SCANNER_STARTED:
8973 case ACTION_MEDIA_SCANNER_FINISHED:
8974 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07008975 case ACTION_PACKAGE_NEEDS_VERIFICATION:
8976 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07008977 // Ignore legacy actions
8978 break;
8979 default:
8980 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008981 }
8982 }
8983 }
8984
8985 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008986 * @hide
8987 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008988 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07008989 // We just entered destination process, so we should be able to read all
8990 // parcelables inside.
8991 setDefusable(true);
8992
8993 if (mSelector != null) {
8994 mSelector.prepareToEnterProcess();
8995 }
8996 if (mClipData != null) {
8997 mClipData.prepareToEnterProcess();
8998 }
8999
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009000 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009001 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9002 fixUris(mContentUserHint);
9003 mContentUserHint = UserHandle.USER_CURRENT;
9004 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009005 }
9006 }
9007
9008 /**
9009 * @hide
9010 */
9011 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009012 Uri data = getData();
9013 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009014 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009015 }
9016 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009017 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009018 }
9019 String action = getAction();
9020 if (ACTION_SEND.equals(action)) {
9021 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9022 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009023 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009024 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009025 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009026 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9027 if (streams != null) {
9028 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9029 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009030 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009031 }
9032 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9033 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009034 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9035 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9036 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9037 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9038 if (output != null) {
9039 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9040 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009041 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009042 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009043
9044 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009045 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009046 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9047 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009048 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009049 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009050 * @hide
9051 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009052 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009053 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009054 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009055
9056 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009057 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009058
9059 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009060 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009061 // Inspect contained intents to see if we need to migrate extras. We
9062 // don't promote ClipData to the parent, since ChooserActivity will
9063 // already start the picked item as the caller, and we can't combine
9064 // the flags in a safe way.
9065
9066 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009067 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009068 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9069 if (intent != null) {
9070 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009071 }
9072 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009073 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009074 try {
9075 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9076 if (intents != null) {
9077 for (int i = 0; i < intents.length; i++) {
9078 final Intent intent = (Intent) intents[i];
9079 if (intent != null) {
9080 migrated |= intent.migrateExtraStreamToClipData();
9081 }
9082 }
9083 }
9084 } catch (ClassCastException e) {
9085 }
9086 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009087
9088 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009089 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009090 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9091 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9092 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9093 if (stream != null || text != null || htmlText != null) {
9094 final ClipData clipData = new ClipData(
9095 null, new String[] { getType() },
9096 new ClipData.Item(text, htmlText, null, stream));
9097 setClipData(clipData);
9098 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009099 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009100 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009101 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009102 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009103
9104 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009105 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009106 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9107 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9108 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9109 int num = -1;
9110 if (streams != null) {
9111 num = streams.size();
9112 }
9113 if (texts != null) {
9114 if (num >= 0 && num != texts.size()) {
9115 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009116 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009117 }
9118 num = texts.size();
9119 }
9120 if (htmlTexts != null) {
9121 if (num >= 0 && num != htmlTexts.size()) {
9122 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009123 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009124 }
9125 num = htmlTexts.size();
9126 }
9127 if (num > 0) {
9128 final ClipData clipData = new ClipData(
9129 null, new String[] { getType() },
9130 makeClipItem(streams, texts, htmlTexts, 0));
9131
9132 for (int i = 1; i < num; i++) {
9133 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9134 }
9135
9136 setClipData(clipData);
9137 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009138 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009139 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009140 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009141 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009142 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9143 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9144 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9145 final Uri output;
9146 try {
9147 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9148 } catch (ClassCastException e) {
9149 return false;
9150 }
9151 if (output != null) {
9152 setClipData(ClipData.newRawUri("", output));
9153 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9154 return true;
9155 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009156 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009157
9158 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009159 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009160
9161 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9162 ArrayList<String> htmlTexts, int which) {
9163 Uri uri = streams != null ? streams.get(which) : null;
9164 CharSequence text = texts != null ? texts.get(which) : null;
9165 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9166 return new ClipData.Item(text, htmlText, null, uri);
9167 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009168
9169 /** @hide */
9170 public boolean isDocument() {
9171 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9172 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009173}