blob: 1eb101ca73f6c15b407d730e2850d8a357020ea5 [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 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700768 * Activity Action: Launch an activity showing the app information.
769 * For applications which install other applications (such as app stores), it is recommended
770 * to handle this action for providing the app information to the user.
771 *
772 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
773 * to be displayed.
774 * <p>Output: Nothing.
775 */
776 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
777 public static final String ACTION_SHOW_APP_INFO
778 = "android.intent.action.SHOW_APP_INFO";
779
780 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800781 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700782 *
783 * @see Intent#ACTION_CREATE_SHORTCUT
784 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800785 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
786 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700787 */
788 public static class ShortcutIconResource implements Parcelable {
789 /**
790 * The package name of the application containing the icon.
791 */
792 public String packageName;
793
794 /**
795 * The resource name of the icon, including package, name and type.
796 */
797 public String resourceName;
798
799 /**
800 * Creates a new ShortcutIconResource for the specified context and resource
801 * identifier.
802 *
803 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700804 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700805 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700806 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700807 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700808 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700809 ShortcutIconResource icon = new ShortcutIconResource();
810 icon.packageName = context.getPackageName();
811 icon.resourceName = context.getResources().getResourceName(resourceId);
812 return icon;
813 }
814
815 /**
816 * Used to read a ShortcutIconResource from a Parcel.
817 */
818 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
819 new Parcelable.Creator<ShortcutIconResource>() {
820
821 public ShortcutIconResource createFromParcel(Parcel source) {
822 ShortcutIconResource icon = new ShortcutIconResource();
823 icon.packageName = source.readString();
824 icon.resourceName = source.readString();
825 return icon;
826 }
827
828 public ShortcutIconResource[] newArray(int size) {
829 return new ShortcutIconResource[size];
830 }
831 };
832
833 /**
834 * No special parcel contents.
835 */
836 public int describeContents() {
837 return 0;
838 }
839
840 public void writeToParcel(Parcel dest, int flags) {
841 dest.writeString(packageName);
842 dest.writeString(resourceName);
843 }
844
845 @Override
846 public String toString() {
847 return resourceName;
848 }
849 }
850
851 /**
852 * Activity Action: Display an activity chooser, allowing the user to pick
853 * what they want to before proceeding. This can be used as an alternative
854 * to the standard activity picker that is displayed by the system when
855 * you try to start an activity with multiple possible matches, with these
856 * differences in behavior:
857 * <ul>
858 * <li>You can specify the title that will appear in the activity chooser.
859 * <li>The user does not have the option to make one of the matching
860 * activities a preferred activity, and all possible activities will
861 * always be shown even if one of them is currently marked as the
862 * preferred activity.
863 * </ul>
864 * <p>
865 * This action should be used when the user will naturally expect to
866 * select an activity in order to proceed. An example if when not to use
867 * it is when the user clicks on a "mailto:" link. They would naturally
868 * expect to go directly to their mail app, so startActivity() should be
869 * called directly: it will
870 * either launch the current preferred app, or put up a dialog allowing the
871 * user to pick an app to use and optionally marking that as preferred.
872 * <p>
873 * In contrast, if the user is selecting a menu item to send a picture
874 * they are viewing to someone else, there are many different things they
875 * may want to do at this point: send it through e-mail, upload it to a
876 * web service, etc. In this case the CHOOSER action should be used, to
877 * always present to the user a list of the things they can do, with a
878 * nice title given by the caller such as "Send this photo with:".
879 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700880 * If you need to grant URI permissions through a chooser, you must specify
881 * the permissions to be granted on the ACTION_CHOOSER Intent
882 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
883 * {@link #setClipData} to specify the URIs to be granted as well as
884 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
885 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
886 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700887 * As a convenience, an Intent of this form can be created with the
888 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700889 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700890 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700891 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
892 * and can optionally have a {@link #EXTRA_TITLE} field containing the
893 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700894 * <p>
895 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700896 */
897 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
898 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
899
900 /**
901 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
902 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700903 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
904 * target intent, also optionally supplying a title. If the target
905 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
906 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
907 * set in the returned chooser intent, with its ClipData set appropriately:
908 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500909 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700910 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700911 * @param target The Intent that the user will be selecting an activity
912 * to perform.
913 * @param title Optional title that will be displayed in the chooser.
914 * @return Return a new Intent object that you can hand to
915 * {@link Context#startActivity(Intent) Context.startActivity()} and
916 * related methods.
917 */
918 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700919 return createChooser(target, title, null);
920 }
921
922 /**
923 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
924 *
925 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
926 * target intent, also optionally supplying a title. If the target
927 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
928 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
929 * set in the returned chooser intent, with its ClipData set appropriately:
930 * either a direct reflection of {@link #getClipData()} if that is non-null,
931 * or a new ClipData built from {@link #getData()}.</p>
932 *
933 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
934 * when the user makes a choice. This can be useful if the calling application wants
935 * to remember the last chosen target and surface it as a more prominent or one-touch
936 * affordance elsewhere in the UI for next time.</p>
937 *
938 * @param target The Intent that the user will be selecting an activity
939 * to perform.
940 * @param title Optional title that will be displayed in the chooser.
941 * @param sender Optional IntentSender to be called when a choice is made.
942 * @return Return a new Intent object that you can hand to
943 * {@link Context#startActivity(Intent) Context.startActivity()} and
944 * related methods.
945 */
946 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700947 Intent intent = new Intent(ACTION_CHOOSER);
948 intent.putExtra(EXTRA_INTENT, target);
949 if (title != null) {
950 intent.putExtra(EXTRA_TITLE, title);
951 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700952
Adam Powell0b3c1122014-10-09 12:50:14 -0700953 if (sender != null) {
954 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
955 }
956
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700957 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700958 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
959 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
960 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700961 if (permFlags != 0) {
962 ClipData targetClipData = target.getClipData();
963 if (targetClipData == null && target.getData() != null) {
964 ClipData.Item item = new ClipData.Item(target.getData());
965 String[] mimeTypes;
966 if (target.getType() != null) {
967 mimeTypes = new String[] { target.getType() };
968 } else {
969 mimeTypes = new String[] { };
970 }
971 targetClipData = new ClipData(null, mimeTypes, item);
972 }
973 if (targetClipData != null) {
974 intent.setClipData(targetClipData);
975 intent.addFlags(permFlags);
976 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700977 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700978
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700979 return intent;
980 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700981
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700982 /**
983 * Activity Action: Allow the user to select a particular kind of data and
984 * return it. This is different than {@link #ACTION_PICK} in that here we
985 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800986 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700987 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900988 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700989 * etc.
990 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900991 * 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 -0700992 * of data, such as a person contact, you set the MIME type to the kind of
993 * data you want and launch it with {@link Context#startActivity(Intent)}.
994 * The system will then launch the best application to select that kind
995 * of data for you.
996 * <p>
997 * You may also be interested in any of a set of types of content the user
998 * can pick. For example, an e-mail application that wants to allow the
999 * user to add an attachment to an e-mail message can use this action to
1000 * bring up a list of all of the types of content the user can attach.
1001 * <p>
1002 * In this case, you should wrap the GET_CONTENT intent with a chooser
1003 * (through {@link #createChooser}), which will give the proper interface
1004 * for the user to pick how to send your data and allow you to specify
1005 * a prompt indicating what they are doing. You will usually specify a
1006 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1007 * broad range of content types the user can select from.
1008 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001009 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001010 * only pick from data that can be represented as a stream. This is
1011 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1012 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001013 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001014 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001015 * is locally available on the device. For example, if this extra is set
1016 * to true then an image picker should not show any pictures that are available
1017 * from a remote server but not already on the local device (thus requiring
1018 * they be downloaded when opened).
1019 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001020 * If the caller can handle multiple returned items (the user performing
1021 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1022 * to indicate this.
1023 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001024 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1025 * that no URI is supplied in the intent, as there are no constraints on
1026 * where the returned data originally comes from. You may also include the
1027 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001028 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001029 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1030 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001031 * <p>
1032 * Output: The URI of the item that was picked. This must be a content:
1033 * URI so that any receiver can access it.
1034 */
1035 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1036 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1037 /**
1038 * Activity Action: Dial a number as specified by the data. This shows a
1039 * UI with the number being dialed, allowing the user to explicitly
1040 * initiate the call.
1041 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1042 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1043 * number.
1044 * <p>Output: nothing.
1045 */
1046 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1047 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1048 /**
1049 * Activity Action: Perform a call to someone specified by the data.
1050 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1051 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1052 * number.
1053 * <p>Output: nothing.
1054 *
1055 * <p>Note: there will be restrictions on which applications can initiate a
1056 * call; most applications should use the {@link #ACTION_DIAL}.
1057 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1058 * numbers. Applications can <strong>dial</strong> emergency numbers using
1059 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001060 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001061 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001062 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001063 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001064 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001065 */
1066 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1067 public static final String ACTION_CALL = "android.intent.action.CALL";
1068 /**
1069 * Activity Action: Perform a call to an emergency number specified by the
1070 * data.
1071 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1072 * tel: URI of an explicit phone number.
1073 * <p>Output: nothing.
1074 * @hide
1075 */
1076 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1077 /**
1078 * Activity action: Perform a call to any number (emergency or not)
1079 * specified by the data.
1080 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1081 * tel: URI of an explicit phone number.
1082 * <p>Output: nothing.
1083 * @hide
1084 */
1085 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1086 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001087 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1088 * sending this intent is a no-op.
1089 * <p>Input: No data should be specified. get*Extra may have an optional
1090 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1091 * send the activation result.
1092 * <p>Output: nothing.
1093 * @hide
1094 */
1095 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1096 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1097 "android.intent.action.SIM_ACTIVATION_REQUEST";
1098 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001099 * Activity Action: Send a message to someone specified by the data.
1100 * <p>Input: {@link #getData} is URI describing the target.
1101 * <p>Output: nothing.
1102 */
1103 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1104 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1105 /**
1106 * Activity Action: Deliver some data to someone else. Who the data is
1107 * being delivered to is not specified; it is up to the receiver of this
1108 * action to ask the user where the data should be sent.
1109 * <p>
1110 * When launching a SEND intent, you should usually wrap it in a chooser
1111 * (through {@link #createChooser}), which will give the proper interface
1112 * for the user to pick how to send your data and allow you to specify
1113 * a prompt indicating what they are doing.
1114 * <p>
1115 * Input: {@link #getType} is the MIME type of the data being sent.
1116 * get*Extra can have either a {@link #EXTRA_TEXT}
1117 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1118 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1119 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1120 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001121 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1122 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1123 * your text with HTML formatting.
1124 * <p>
1125 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1126 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1127 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1128 * content: URIs and other advanced features of {@link ClipData}. If
1129 * using this approach, you still must supply the same data through the
1130 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1131 * for compatibility with old applications. If you don't set a ClipData,
1132 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001133 * <p>
1134 * Optional standard extras, which may be interpreted by some recipients as
1135 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1136 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1137 * <p>
1138 * Output: nothing.
1139 */
1140 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1141 public static final String ACTION_SEND = "android.intent.action.SEND";
1142 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001143 * Activity Action: Deliver multiple data to someone else.
1144 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001145 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001146 * <p>
1147 * Input: {@link #getType} is the MIME type of the data being sent.
1148 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001149 * #EXTRA_STREAM} field, containing the data to be sent. If using
1150 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1151 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001152 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001153 * Multiple types are supported, and receivers should handle mixed types
1154 * whenever possible. The right way for the receiver to check them is to
1155 * use the content resolver on each URI. The intent sender should try to
1156 * put the most concrete mime type in the intent type, but it can fall
1157 * back to {@literal <type>/*} or {@literal *}/* as needed.
1158 * <p>
1159 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1160 * be image/jpg, but if you are sending image/jpg and image/png, then the
1161 * intent's type should be image/*.
1162 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001163 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1164 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1165 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1166 * content: URIs and other advanced features of {@link ClipData}. If
1167 * using this approach, you still must supply the same data through the
1168 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1169 * for compatibility with old applications. If you don't set a ClipData,
1170 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1171 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001172 * Optional standard extras, which may be interpreted by some recipients as
1173 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1174 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1175 * <p>
1176 * Output: nothing.
1177 */
1178 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1179 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1180 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001181 * Activity Action: Handle an incoming phone call.
1182 * <p>Input: nothing.
1183 * <p>Output: nothing.
1184 */
1185 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1186 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1187 /**
1188 * Activity Action: Insert an empty item into the given container.
1189 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1190 * in which to place the data.
1191 * <p>Output: URI of the new data that was created.
1192 */
1193 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1194 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1195 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001196 * Activity Action: Create a new item in the given container, initializing it
1197 * from the current contents of the clipboard.
1198 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1199 * in which to place the data.
1200 * <p>Output: URI of the new data that was created.
1201 */
1202 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1203 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1204 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001205 * Activity Action: Delete the given data from its container.
1206 * <p>Input: {@link #getData} is URI of data to be deleted.
1207 * <p>Output: nothing.
1208 */
1209 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1210 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1211 /**
1212 * Activity Action: Run the data, whatever that means.
1213 * <p>Input: ? (Note: this is currently specific to the test harness.)
1214 * <p>Output: nothing.
1215 */
1216 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1217 public static final String ACTION_RUN = "android.intent.action.RUN";
1218 /**
1219 * Activity Action: Perform a data synchronization.
1220 * <p>Input: ?
1221 * <p>Output: ?
1222 */
1223 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1224 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1225 /**
1226 * Activity Action: Pick an activity given an intent, returning the class
1227 * selected.
1228 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1229 * used with {@link PackageManager#queryIntentActivities} to determine the
1230 * set of activities from which to pick.
1231 * <p>Output: Class name of the activity that was selected.
1232 */
1233 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1234 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1235 /**
1236 * Activity Action: Perform a search.
1237 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1238 * is the text to search for. If empty, simply
1239 * enter your search results Activity with the search UI activated.
1240 * <p>Output: nothing.
1241 */
1242 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1243 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1244 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001245 * Activity Action: Start the platform-defined tutorial
1246 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1247 * is the text to search for. If empty, simply
1248 * enter your search results Activity with the search UI activated.
1249 * <p>Output: nothing.
1250 */
1251 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1252 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1253 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001254 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001255 * <p>
1256 * Input: {@link android.app.SearchManager#QUERY
1257 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1258 * a url starts with http or https, the site will be opened. If it is plain
1259 * text, Google search will be applied.
1260 * <p>
1261 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001262 */
1263 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1264 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001265
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001266 /**
Jim Miller07994402012-05-02 14:22:27 -07001267 * Activity Action: Perform assist action.
1268 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001269 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1270 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001271 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1272 * information.
Jim Miller07994402012-05-02 14:22:27 -07001273 * Output: nothing.
1274 */
1275 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1276 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001277
1278 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001279 * Activity Action: Perform voice assist action.
1280 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001281 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1282 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001283 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001284 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001285 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001286 */
1287 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1288 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1289
1290 /**
Adam Skory7140a252013-09-11 12:04:58 +01001291 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1292 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001293 */
1294 public static final String EXTRA_ASSIST_PACKAGE
1295 = "android.intent.extra.ASSIST_PACKAGE";
1296
1297 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001298 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1299 * application package at the time the assist was invoked.
1300 */
1301 public static final String EXTRA_ASSIST_UID
1302 = "android.intent.extra.ASSIST_UID";
1303
1304 /**
Adam Skory7140a252013-09-11 12:04:58 +01001305 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1306 * information supplied by the current foreground app at the time of the assist request.
1307 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001308 */
1309 public static final String EXTRA_ASSIST_CONTEXT
1310 = "android.intent.extra.ASSIST_CONTEXT";
1311
Jim Miller07994402012-05-02 14:22:27 -07001312 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001313 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1314 * keyboard as the primary input device for assistance.
1315 */
1316 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1317 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1318
1319 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001320 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1321 * that was used to invoke the assist.
1322 */
1323 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1324 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1325
1326 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001327 * Activity Action: List all available applications
1328 * <p>Input: Nothing.
1329 * <p>Output: nothing.
1330 */
1331 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1332 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1333 /**
1334 * Activity Action: Show settings for choosing wallpaper
1335 * <p>Input: Nothing.
1336 * <p>Output: Nothing.
1337 */
1338 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1339 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1340
1341 /**
1342 * Activity Action: Show activity for reporting a bug.
1343 * <p>Input: Nothing.
1344 * <p>Output: Nothing.
1345 */
1346 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1347 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1348
1349 /**
1350 * Activity Action: Main entry point for factory tests. Only used when
1351 * the device is booting in factory test node. The implementing package
1352 * must be installed in the system image.
1353 * <p>Input: nothing
1354 * <p>Output: nothing
1355 */
1356 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1357
1358 /**
1359 * Activity Action: The user pressed the "call" button to go to the dialer
1360 * or other appropriate UI for placing a call.
1361 * <p>Input: Nothing.
1362 * <p>Output: Nothing.
1363 */
1364 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1365 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1366
1367 /**
1368 * Activity Action: Start Voice Command.
1369 * <p>Input: Nothing.
1370 * <p>Output: Nothing.
1371 */
1372 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1373 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001374
1375 /**
1376 * Activity Action: Start action associated with long pressing on the
1377 * search key.
1378 * <p>Input: Nothing.
1379 * <p>Output: Nothing.
1380 */
1381 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1382 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001383
Jacek Surazski86b6c532009-05-13 14:38:28 +02001384 /**
1385 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1386 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001387 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001388 * <p>Input: No data is specified. The bug report is passed in using
1389 * an {@link #EXTRA_BUG_REPORT} field.
1390 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001391 *
1392 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001393 */
1394 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1395 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001396
1397 /**
1398 * Activity Action: Show power usage information to the user.
1399 * <p>Input: Nothing.
1400 * <p>Output: Nothing.
1401 */
1402 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1403 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001404
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001405 /**
1406 * Activity Action: Setup wizard to launch after a platform update. This
1407 * activity should have a string meta-data field associated with it,
1408 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1409 * the platform for setup. The activity will be launched only if
1410 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1411 * same value.
1412 * <p>Input: Nothing.
1413 * <p>Output: Nothing.
1414 * @hide
1415 */
1416 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1417 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001418
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001419 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001420 * Activity Action: Show settings for managing network data usage of a
1421 * specific application. Applications should define an activity that offers
1422 * options to control data usage.
1423 */
1424 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1425 public static final String ACTION_MANAGE_NETWORK_USAGE =
1426 "android.intent.action.MANAGE_NETWORK_USAGE";
1427
1428 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001429 * Activity Action: Launch application installer.
1430 * <p>
1431 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001432 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1433 * you can also use "package:<package-name>" to install an application for the
1434 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001435 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1436 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1437 * <p>
1438 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1439 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001440 * <p>
1441 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1442 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1443 * in order to launch the application installer.
1444 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001445 *
1446 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1447 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1448 * @see #EXTRA_RETURN_RESULT
1449 */
1450 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1451 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1452
1453 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001454 * Activity Action: Launch ephemeral installer.
1455 * <p>
1456 * Input: The data must be a http: URI that the ephemeral application is registered
1457 * to handle.
1458 * <p class="note">
1459 * This is a protected intent that can only be sent by the system.
1460 * </p>
1461 *
1462 * @hide
1463 */
1464 @SystemApi
1465 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1466 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1467 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1468
1469 /**
1470 * Service Action: Resolve ephemeral application.
1471 * <p>
1472 * The system will have a persistent connection to this service.
1473 * This is a protected intent that can only be sent by the system.
1474 * </p>
1475 *
1476 * @hide
1477 */
1478 @SystemApi
1479 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1480 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1481 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1482
1483 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001484 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1485 * package. Specifies the installer package name; this package will receive the
1486 * {@link #ACTION_APP_ERROR} intent.
1487 */
1488 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1489 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1490
1491 /**
1492 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1493 * package. Specifies that the application being installed should not be
1494 * treated as coming from an unknown source, but as coming from the app
1495 * invoking the Intent. For this to work you must start the installer with
1496 * startActivityForResult().
1497 */
1498 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1499 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1500
1501 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001502 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1503 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001504 * data field originated from.
1505 */
rich cannings706e8ba2012-08-20 13:20:14 -07001506 public static final String EXTRA_ORIGINATING_URI
1507 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001508
1509 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001510 * This extra can be used with any Intent used to launch an activity, supplying information
1511 * about who is launching that activity. This field contains a {@link android.net.Uri}
1512 * object, typically an http: or https: URI of the web site that the referral came from;
1513 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1514 * a native application that it came from.
1515 *
1516 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1517 * instead of directly retrieving the extra. It is also valid for applications to
1518 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1519 * a string, not a Uri; the field here, if supplied, will always take precedence,
1520 * however.</p>
1521 *
1522 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001523 */
1524 public static final String EXTRA_REFERRER
1525 = "android.intent.extra.REFERRER";
1526
1527 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001528 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1529 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1530 * not be created, in particular when Intent extras are supplied through the
1531 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1532 * schemes.
1533 *
1534 * @see #EXTRA_REFERRER
1535 */
1536 public static final String EXTRA_REFERRER_NAME
1537 = "android.intent.extra.REFERRER_NAME";
1538
1539 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001540 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1541 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1542 * @hide
1543 */
1544 public static final String EXTRA_ORIGINATING_UID
1545 = "android.intent.extra.ORIGINATING_UID";
1546
1547 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001548 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1549 * package. Tells the installer UI to skip the confirmation with the user
1550 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001551 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1552 * will no longer show an interstitial message about updating existing
1553 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001554 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001555 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001556 public static final String EXTRA_ALLOW_REPLACE
1557 = "android.intent.extra.ALLOW_REPLACE";
1558
1559 /**
1560 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1561 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1562 * return to the application the result code of the install/uninstall. The returned result
1563 * code will be {@link android.app.Activity#RESULT_OK} on success or
1564 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1565 */
1566 public static final String EXTRA_RETURN_RESULT
1567 = "android.intent.extra.RETURN_RESULT";
1568
1569 /**
1570 * Package manager install result code. @hide because result codes are not
1571 * yet ready to be exposed.
1572 */
1573 public static final String EXTRA_INSTALL_RESULT
1574 = "android.intent.extra.INSTALL_RESULT";
1575
1576 /**
1577 * Activity Action: Launch application uninstaller.
1578 * <p>
1579 * Input: The data must be a package: URI whose scheme specific part is
1580 * the package name of the current installed package to be uninstalled.
1581 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1582 * <p>
1583 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1584 * succeeded.
1585 */
1586 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1587 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1588
1589 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001590 * Specify whether the package should be uninstalled for all users.
1591 * @hide because these should not be part of normal application flow.
1592 */
1593 public static final String EXTRA_UNINSTALL_ALL_USERS
1594 = "android.intent.extra.UNINSTALL_ALL_USERS";
1595
1596 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001597 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1598 * describing the last run version of the platform that was setup.
1599 * @hide
1600 */
1601 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1602
Svet Ganov3695b8a2015-03-24 16:30:25 -07001603 /**
1604 * Activity action: Launch UI to manage the permissions of an app.
1605 * <p>
1606 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1607 * will be managed by the launched UI.
1608 * </p>
1609 * <p>
1610 * Output: Nothing.
1611 * </p>
1612 *
1613 * @see #EXTRA_PACKAGE_NAME
1614 *
1615 * @hide
1616 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001617 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1618 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1619 "android.intent.action.MANAGE_APP_PERMISSIONS";
1620
1621 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001622 * Activity action: Launch UI to manage permissions.
1623 * <p>
1624 * Input: Nothing.
1625 * </p>
1626 * <p>
1627 * Output: Nothing.
1628 * </p>
1629 *
1630 * @hide
1631 */
Svet Ganov321f0152015-05-16 22:51:50 -07001632 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1633 public static final String ACTION_MANAGE_PERMISSIONS =
1634 "android.intent.action.MANAGE_PERMISSIONS";
1635
1636 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001637 * Activity action: Launch UI to review permissions for an app.
1638 * The system uses this intent if permission review for apps not
1639 * supporting the new runtime permissions model is enabled. In
1640 * this mode a permission review is required before any of the
1641 * app components can run.
1642 * <p>
1643 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1644 * permissions will be reviewed (mandatory).
1645 * </p>
1646 * <p>
1647 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1648 * be fired after the permission review (optional).
1649 * </p>
1650 * <p>
1651 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1652 * be invoked after the permission review (optional).
1653 * </p>
1654 * <p>
1655 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1656 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1657 * </p>
1658 * <p>
1659 * Output: Nothing.
1660 * </p>
1661 *
1662 * @see #EXTRA_PACKAGE_NAME
1663 * @see #EXTRA_INTENT
1664 * @see #EXTRA_REMOTE_CALLBACK
1665 * @see #EXTRA_RESULT_NEEDED
1666 *
1667 * @hide
1668 */
1669 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1670 public static final String ACTION_REVIEW_PERMISSIONS =
1671 "android.intent.action.REVIEW_PERMISSIONS";
1672
1673 /**
1674 * Intent extra: A callback for reporting remote result as a bundle.
1675 * <p>
1676 * Type: IRemoteCallback
1677 * </p>
1678 *
1679 * @hide
1680 */
1681 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1682
1683 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001684 * Intent extra: An app package name.
1685 * <p>
1686 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001687 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001688 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001689 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001690 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1691
1692 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001693 * Intent extra: An extra for specifying whether a result is needed.
1694 * <p>
1695 * Type: boolean
1696 * </p>
1697 *
1698 * @hide
1699 */
1700 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1701
1702 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001703 * Broadcast action that requests current permission granted information. It will respond
1704 * to the request by sending a broadcast with action defined by
1705 * {@link #EXTRA_GET_PERMISSIONS_RESPONSE_INTENT}. The response will contain
Makoto Onukibbb912a2015-06-05 16:27:23 -07001706 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}, as well as
1707 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}, with contents described below or
1708 * a null upon failure.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001709 *
Makoto Onukibbb912a2015-06-05 16:27:23 -07001710 * <p>If {@link #EXTRA_PACKAGE_NAME} is included then the number of permissions granted, the
1711 * number of permissions requested and the number of granted additional permissions
1712 * by that package will be calculated and included as the first
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001713 * and second elements respectively of an int[] in the response as
Makoto Onukibbb912a2015-06-05 16:27:23 -07001714 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}. The response will also deliver the list
1715 * of localized permission group names that are granted in
1716 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001717 *
1718 * <p>If {@link #EXTRA_PACKAGE_NAME} is not included then the number of apps granted any runtime
1719 * permissions and the total number of apps requesting runtime permissions will be the first
1720 * and second elements respectively of an int[] in the response as
1721 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1722 *
1723 * @hide
1724 */
1725 public static final String ACTION_GET_PERMISSIONS_COUNT
1726 = "android.intent.action.GET_PERMISSIONS_COUNT";
1727
1728 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001729 * Broadcast action that requests list of all apps that have runtime permissions. It will
1730 * respond to the request by sending a broadcast with action defined by
1731 * {@link #EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT}. The response will contain
1732 * {@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT}, as well as
1733 * {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}, with contents described below or
1734 * a null upon failure.
1735 *
1736 * <p>{@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT} will contain a list of package names of
1737 * apps that have runtime permissions. {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}
1738 * will contain the list of app labels corresponding ot the apps in the first list.
1739 *
1740 * @hide
1741 */
1742 public static final String ACTION_GET_PERMISSIONS_PACKAGES
1743 = "android.intent.action.GET_PERMISSIONS_PACKAGES";
1744
1745 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001746 * Extra included in response to {@link #ACTION_GET_PERMISSIONS_COUNT}.
1747 * @hide
1748 */
1749 public static final String EXTRA_GET_PERMISSIONS_COUNT_RESULT
1750 = "android.intent.extra.GET_PERMISSIONS_COUNT_RESULT";
1751
1752 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001753 * List of CharSequence of localized permission group labels.
1754 * @hide
1755 */
1756 public static final String EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT
1757 = "android.intent.extra.GET_PERMISSIONS_GROUP_LIST_RESULT";
1758
1759 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001760 * String list of apps that have one or more runtime permissions.
1761 * @hide
1762 */
1763 public static final String EXTRA_GET_PERMISSIONS_APP_LIST_RESULT
1764 = "android.intent.extra.GET_PERMISSIONS_APP_LIST_RESULT";
1765
1766 /**
1767 * String list of app labels for apps that have one or more runtime permissions.
1768 * @hide
1769 */
1770 public static final String EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT
1771 = "android.intent.extra.GET_PERMISSIONS_APP_LABEL_LIST_RESULT";
1772
1773 /**
Anthony Hugh3575a402015-10-26 17:47:05 -07001774 * Boolean list describing if the app is a system app for apps that have one or more runtime
1775 * permissions.
1776 * @hide
1777 */
1778 public static final String EXTRA_GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT
1779 = "android.intent.extra.GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT";
1780
1781 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001782 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_COUNT} broadcasts.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001783 * @hide
1784 */
1785 public static final String EXTRA_GET_PERMISSIONS_RESPONSE_INTENT
1786 = "android.intent.extra.GET_PERMISSIONS_RESONSE_INTENT";
1787
1788 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001789 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_PACKAGES} broadcasts.
1790 * @hide
1791 */
1792 public static final String EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT
1793 = "android.intent.extra.GET_PERMISSIONS_PACKAGES_RESONSE_INTENT";
1794
1795 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001796 * Activity action: Launch UI to manage which apps have a given permission.
1797 * <p>
1798 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1799 * to which will be managed by the launched UI.
1800 * </p>
1801 * <p>
1802 * Output: Nothing.
1803 * </p>
1804 *
1805 * @see #EXTRA_PERMISSION_NAME
1806 *
1807 * @hide
1808 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001809 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1810 public static final String ACTION_MANAGE_PERMISSION_APPS =
1811 "android.intent.action.MANAGE_PERMISSION_APPS";
1812
1813 /**
1814 * Intent extra: The name of a permission.
1815 * <p>
1816 * Type: String
1817 * </p>
1818 *
1819 * @hide
1820 */
1821 @SystemApi
1822 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1823
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001824 // ---------------------------------------------------------------------
1825 // ---------------------------------------------------------------------
1826 // Standard intent broadcast actions (see action variable).
1827
1828 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001829 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1830 * <p>
1831 * For historical reasons, the name of this broadcast action refers to the power
1832 * state of the screen but it is actually sent in response to changes in the
1833 * overall interactive state of the device.
1834 * </p><p>
1835 * This broadcast is sent when the device becomes non-interactive which may have
1836 * nothing to do with the screen turning off. To determine the
1837 * actual state of the screen, use {@link android.view.Display#getState}.
1838 * </p><p>
1839 * See {@link android.os.PowerManager#isInteractive} for details.
1840 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001841 * You <em>cannot</em> receive this through components declared in
1842 * manifests, only by explicitly registering for it with
1843 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1844 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001845 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001846 * <p class="note">This is a protected intent that can only be sent
1847 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001848 */
1849 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1850 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001851
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001852 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001853 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1854 * <p>
1855 * For historical reasons, the name of this broadcast action refers to the power
1856 * state of the screen but it is actually sent in response to changes in the
1857 * overall interactive state of the device.
1858 * </p><p>
1859 * This broadcast is sent when the device becomes interactive which may have
1860 * nothing to do with the screen turning on. To determine the
1861 * actual state of the screen, use {@link android.view.Display#getState}.
1862 * </p><p>
1863 * See {@link android.os.PowerManager#isInteractive} for details.
1864 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001865 * You <em>cannot</em> receive this through components declared in
1866 * manifests, only by explicitly registering for it with
1867 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1868 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001869 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001870 * <p class="note">This is a protected intent that can only be sent
1871 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001872 */
1873 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1874 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001875
1876 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001877 * Broadcast Action: Sent after the system stops dreaming.
1878 *
1879 * <p class="note">This is a protected intent that can only be sent by the system.
1880 * It is only sent to registered receivers.</p>
1881 */
1882 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1883 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1884
1885 /**
1886 * Broadcast Action: Sent after the system starts dreaming.
1887 *
1888 * <p class="note">This is a protected intent that can only be sent by the system.
1889 * It is only sent to registered receivers.</p>
1890 */
1891 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1892 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1893
1894 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001895 * 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 -07001896 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001897 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001898 * <p class="note">This is a protected intent that can only be sent
1899 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001900 */
1901 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001902 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001903
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001904 /**
1905 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001906 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001907 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001908 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1909 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001910 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001911 * <p class="note">This is a protected intent that can only be sent
1912 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001913 */
1914 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1915 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1916 /**
1917 * Broadcast Action: The time was set.
1918 */
1919 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1920 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1921 /**
1922 * Broadcast Action: The date has changed.
1923 */
1924 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1925 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1926 /**
1927 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1928 * <ul>
1929 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1930 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001931 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001932 * <p class="note">This is a protected intent that can only be sent
1933 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001934 */
1935 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1936 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1937 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001938 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1939 * DNS entries should be tossed.
1940 * @hide
1941 */
1942 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1943 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1944 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001945 * Alarm Changed Action: This is broadcast when the AlarmClock
1946 * application's alarm is set or unset. It is used by the
1947 * AlarmClock application and the StatusBar service.
1948 * @hide
1949 */
1950 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1951 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001952
1953 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001954 * Broadcast Action: This is broadcast once, after the user has finished
1955 * booting, but while still in the "locked" state. It can be used to perform
1956 * application-specific initialization, such as installing alarms. You must
1957 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1958 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001959 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001960 * This broadcast is sent immediately at boot by all devices (regardless of
1961 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1962 * higher. Upon receipt of this broadcast, the user is still locked and only
1963 * device-protected storage can be accessed safely. If you want to access
1964 * credential-protected storage, you need to wait for the user to be
1965 * unlocked (typically by entering their lock pattern or PIN for the first
1966 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1967 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1968 * <p>
1969 * To receive this broadcast, your receiver component must be marked as
1970 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001971 * <p class="note">
1972 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001973 *
1974 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001975 */
1976 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1977 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1978
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001979 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001980 * Broadcast Action: This is broadcast once, after the user has finished
1981 * booting. It can be used to perform application-specific initialization,
1982 * such as installing alarms. You must hold the
1983 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1984 * order to receive this broadcast.
1985 * <p>
1986 * This broadcast is sent at boot by all devices (both with and without
1987 * direct boot support). Upon receipt of this broadcast, the user is
1988 * unlocked and both device-protected and credential-protected storage can
1989 * accessed safely.
1990 * <p>
1991 * If you need to run while the user is still locked (before they've entered
1992 * their lock pattern or PIN for the first time), you can listen for the
1993 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1994 * <p class="note">
1995 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001996 */
1997 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1998 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001999
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002000 /**
2001 * Broadcast Action: This is broadcast when a user action should request a
2002 * temporary system dialog to dismiss. Some examples of temporary system
2003 * dialogs are the notification window-shade and the recent tasks dialog.
2004 */
2005 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2006 /**
2007 * Broadcast Action: Trigger the download and eventual installation
2008 * of a package.
2009 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002010 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002011 * <p class="note">This is a protected intent that can only be sent
2012 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002013 *
2014 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002015 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002016 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002017 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2018 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2019 /**
2020 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002021 * device. The data contains the name of the package. Note that the
2022 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002023 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002024 * <ul>
2025 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2026 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
2027 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2028 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002029 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002030 * <p class="note">This is a protected intent that can only be sent
2031 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002032 */
2033 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2034 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2035 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002036 * Broadcast Action: A new version of an application package has been
2037 * installed, replacing an existing version that was previously installed.
2038 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002039 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002040 * <ul>
2041 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2042 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002043 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002044 * <p class="note">This is a protected intent that can only be sent
2045 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002046 */
2047 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2048 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2049 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002050 * Broadcast Action: A new version of your application has been installed
2051 * over an existing one. This is only sent to the application that was
2052 * replaced. It does not contain any additional data; to receive it, just
2053 * use an intent filter for this action.
2054 *
2055 * <p class="note">This is a protected intent that can only be sent
2056 * by the system.
2057 */
2058 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2059 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2060 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002061 * Broadcast Action: An existing application package has been removed from
2062 * the device. The data contains the name of the package. The package
2063 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002064 * <ul>
2065 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2066 * to the package.
2067 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2068 * application -- data and code -- is being removed.
2069 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2070 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2071 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002072 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002073 * <p class="note">This is a protected intent that can only be sent
2074 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002075 */
2076 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2077 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2078 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002079 * Broadcast Action: An existing application package has been completely
2080 * removed from the device. The data contains the name of the package.
2081 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2082 * {@link #EXTRA_DATA_REMOVED} is true and
2083 * {@link #EXTRA_REPLACING} is false of that broadcast.
2084 *
2085 * <ul>
2086 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2087 * to the package.
2088 * </ul>
2089 *
2090 * <p class="note">This is a protected intent that can only be sent
2091 * by the system.
2092 */
2093 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2094 public static final String ACTION_PACKAGE_FULLY_REMOVED
2095 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2096 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002097 * Broadcast Action: An existing application package has been changed (e.g.
2098 * a component has been enabled or disabled). The data contains the name of
2099 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002100 * <ul>
2101 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002102 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002103 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002104 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2105 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002106 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002107 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002108 * <p class="note">This is a protected intent that can only be sent
2109 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002110 */
2111 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2112 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2113 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002114 * @hide
2115 * Broadcast Action: Ask system services if there is any reason to
2116 * restart the given package. The data contains the name of the
2117 * package.
2118 * <ul>
2119 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2120 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2121 * </ul>
2122 *
2123 * <p class="note">This is a protected intent that can only be sent
2124 * by the system.
2125 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002126 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002127 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2128 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2129 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002130 * Broadcast Action: The user has restarted a package, and all of its
2131 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002132 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002133 * be removed. Note that the restarted package does <em>not</em>
2134 * receive this broadcast.
2135 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002136 * <ul>
2137 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2138 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002139 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002140 * <p class="note">This is a protected intent that can only be sent
2141 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002142 */
2143 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2144 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2145 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002146 * Broadcast Action: The user has cleared the data of a package. This should
2147 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002148 * its persistent data is erased and this broadcast sent.
2149 * Note that the cleared package does <em>not</em>
2150 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002151 * <ul>
2152 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2153 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002154 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002155 * <p class="note">This is a protected intent that can only be sent
2156 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002157 */
2158 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2159 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2160 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002161 * Broadcast Action: Packages have been suspended.
2162 * <p>Includes the following extras:
2163 * <ul>
2164 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2165 * </ul>
2166 *
2167 * <p class="note">This is a protected intent that can only be sent
2168 * by the system. It is only sent to registered receivers.
2169 */
2170 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2171 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2172 /**
2173 * Broadcast Action: Packages have been unsuspended.
2174 * <p>Includes the following extras:
2175 * <ul>
2176 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2177 * </ul>
2178 *
2179 * <p class="note">This is a protected intent that can only be sent
2180 * by the system. It is only sent to registered receivers.
2181 */
2182 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2183 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2184 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002185 * Broadcast Action: A user ID has been removed from the system. The user
2186 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002187 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002188 * <p class="note">This is a protected intent that can only be sent
2189 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002190 */
2191 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2192 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002193
2194 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002195 * Broadcast Action: Sent to the installer package of an application
2196 * when that application is first launched (that is the first time it
2197 * is moved out of the stopped state). The data contains the name of the package.
2198 *
2199 * <p class="note">This is a protected intent that can only be sent
2200 * by the system.
2201 */
2202 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2203 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2204
2205 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002206 * Broadcast Action: Sent to the system package verifier when a package
2207 * needs to be verified. The data contains the package URI.
2208 * <p class="note">
2209 * This is a protected intent that can only be sent by the system.
2210 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002211 */
2212 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2213 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2214
2215 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002216 * Broadcast Action: Sent to the system package verifier when a package is
2217 * verified. The data contains the package URI.
2218 * <p class="note">
2219 * This is a protected intent that can only be sent by the system.
2220 */
2221 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2222 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2223
2224 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002225 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
2226 * needs to be verified. The data contains the filter data hosts to be verified against.
2227 * <p class="note">
2228 * This is a protected intent that can only be sent by the system.
2229 * </p>
2230 *
2231 * @hide
2232 */
2233 @SystemApi
2234 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2235 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2236
2237 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002238 * Broadcast Action: Resources for a set of packages (which were
2239 * previously unavailable) are currently
2240 * available since the media on which they exist is available.
2241 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2242 * list of packages whose availability changed.
2243 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2244 * list of uids of packages whose availability changed.
2245 * Note that the
2246 * packages in this list do <em>not</em> receive this broadcast.
2247 * The specified set of packages are now available on the system.
2248 * <p>Includes the following extras:
2249 * <ul>
2250 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2251 * whose resources(were previously unavailable) are currently available.
2252 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2253 * packages whose resources(were previously unavailable)
2254 * are currently available.
2255 * </ul>
2256 *
2257 * <p class="note">This is a protected intent that can only be sent
2258 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002259 */
2260 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002261 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2262 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002263
2264 /**
2265 * Broadcast Action: Resources for a set of packages are currently
2266 * unavailable since the media on which they exist is unavailable.
2267 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2268 * list of packages whose availability changed.
2269 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2270 * list of uids of packages whose availability changed.
2271 * The specified set of packages can no longer be
2272 * launched and are practically unavailable on the system.
2273 * <p>Inclues the following extras:
2274 * <ul>
2275 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2276 * whose resources are no longer available.
2277 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2278 * whose resources are no longer available.
2279 * </ul>
2280 *
2281 * <p class="note">This is a protected intent that can only be sent
2282 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002283 */
2284 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002285 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002286 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002287
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002288 /**
2289 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002290 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002291 * This should <em>only</em> be used to determine when the wallpaper
2292 * has changed to show the new wallpaper to the user. You should certainly
2293 * never, in response to this, change the wallpaper or other attributes of
2294 * it such as the suggested size. That would be crazy, right? You'd cause
2295 * all kinds of loops, especially if other apps are doing similar things,
2296 * right? Of course. So please don't do this.
2297 *
2298 * @deprecated Modern applications should use
2299 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2300 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2301 * shown behind their UI, rather than watching for this broadcast and
2302 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002303 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002304 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002305 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2306 /**
2307 * Broadcast Action: The current device {@link android.content.res.Configuration}
2308 * (orientation, locale, etc) has changed. When such a change happens, the
2309 * UIs (view hierarchy) will need to be rebuilt based on this new
2310 * information; for the most part, applications don't need to worry about
2311 * this, because the system will take care of stopping and restarting the
2312 * application to make sure it sees the new changes. Some system code that
2313 * can not be restarted will need to watch for this action and handle it
2314 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002315 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002316 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002317 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002318 * in manifests, only by explicitly registering for it with
2319 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2320 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002321 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002322 * <p class="note">This is a protected intent that can only be sent
2323 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002324 *
2325 * @see android.content.res.Configuration
2326 */
2327 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2328 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2329 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002330 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002331 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002332 * <p class="note">This is a protected intent that can only be sent
2333 * by the system.
2334 */
2335 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2336 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2337 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002338 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2339 * charging state, level, and other information about the battery.
2340 * See {@link android.os.BatteryManager} for documentation on the
2341 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002342 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002343 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002344 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002345 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002346 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002347 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2348 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2349 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2350 * broadcasts that are sent and can be received through manifest
2351 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002352 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002353 * <p class="note">This is a protected intent that can only be sent
2354 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002355 */
2356 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2357 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2358 /**
2359 * Broadcast Action: Indicates low battery condition on the device.
2360 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002361 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002362 * <p class="note">This is a protected intent that can only be sent
2363 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002364 */
2365 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2366 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2367 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002368 * Broadcast Action: Indicates the battery is now okay after being low.
2369 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2370 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002371 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002372 * <p class="note">This is a protected intent that can only be sent
2373 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002374 */
2375 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2376 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2377 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002378 * Broadcast Action: External power has been connected to the device.
2379 * This is intended for applications that wish to register specifically to this notification.
2380 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2381 * stay active to receive this notification. This action can be used to implement actions
2382 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002383 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002384 * <p class="note">This is a protected intent that can only be sent
2385 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002386 */
2387 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002388 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002389 /**
2390 * Broadcast Action: External power has been removed from the device.
2391 * This is intended for applications that wish to register specifically to this notification.
2392 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2393 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002394 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002395 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002396 * <p class="note">This is a protected intent that can only be sent
2397 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002398 */
2399 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002400 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002401 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002402 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002403 * Broadcast Action: Device is shutting down.
2404 * This is broadcast when the device is being shut down (completely turned
2405 * off, not sleeping). Once the broadcast is complete, the final shutdown
2406 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002407 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002408 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002409 * <p class="note">This is a protected intent that can only be sent
2410 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002411 * <p>May include the following extras:
2412 * <ul>
2413 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2414 * shutdown is only for userspace processes. If not set, assumed to be false.
2415 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002416 */
2417 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002418 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002419 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002420 * Activity Action: Start this activity to request system shutdown.
2421 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002422 * to request confirmation from the user before shutting down. The optional boolean
2423 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2424 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002425 *
2426 * <p class="note">This is a protected intent that can only be sent
2427 * by the system.
2428 *
2429 * {@hide}
2430 */
2431 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2432 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002433 * Broadcast Action: A sticky broadcast that indicates low memory
2434 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002435 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002436 * <p class="note">This is a protected intent that can only be sent
2437 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002438 */
2439 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2440 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2441 /**
2442 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002443 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002444 * <p class="note">This is a protected intent that can only be sent
2445 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002446 */
2447 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2448 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2449 /**
Jake Hambybb371632010-08-23 18:16:48 -07002450 * Broadcast Action: A sticky broadcast that indicates a memory full
2451 * condition on the device. This is intended for activities that want
2452 * to be able to fill the data partition completely, leaving only
2453 * enough free space to prevent system-wide SQLite failures.
2454 *
2455 * <p class="note">This is a protected intent that can only be sent
2456 * by the system.
2457 *
2458 * {@hide}
2459 */
2460 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2461 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2462 /**
2463 * Broadcast Action: Indicates memory full condition on the device
2464 * no longer exists.
2465 *
2466 * <p class="note">This is a protected intent that can only be sent
2467 * by the system.
2468 *
2469 * {@hide}
2470 */
2471 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2472 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2473 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002474 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2475 * and package management should be started.
2476 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2477 * notification.
2478 */
2479 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2480 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2481 /**
2482 * Broadcast Action: The device has entered USB Mass Storage mode.
2483 * This is used mainly for the USB Settings panel.
2484 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2485 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002486 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002487 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002488 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002489 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2490
2491 /**
2492 * Broadcast Action: The device has exited USB Mass Storage mode.
2493 * This is used mainly for the USB Settings panel.
2494 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2495 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002496 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002497 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002498 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002499 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2500
2501 /**
2502 * Broadcast Action: External media has been removed.
2503 * The path to the mount point for the removed media is contained in the Intent.mData field.
2504 */
2505 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2506 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2507
2508 /**
2509 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002510 * 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 -07002511 */
2512 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2513 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2514
2515 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002516 * Broadcast Action: External media is present, and being disk-checked
2517 * 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 -08002518 */
2519 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2520 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2521
2522 /**
2523 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2524 * 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 -08002525 */
2526 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2527 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2528
2529 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002530 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002531 * 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 -07002532 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2533 * media was mounted read only.
2534 */
2535 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2536 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2537
2538 /**
2539 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002540 * 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 -07002541 */
2542 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2543 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2544
2545 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002546 * Broadcast Action: External media is no longer being shared via USB mass storage.
2547 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2548 *
2549 * @hide
2550 */
2551 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2552
2553 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002554 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2555 * The path to the mount point for the removed media is contained in the Intent.mData field.
2556 */
2557 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2558 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2559
2560 /**
2561 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002562 * 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 -07002563 */
2564 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2565 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2566
2567 /**
2568 * Broadcast Action: User has expressed the desire to remove the external storage media.
2569 * Applications should close all files they have open within the mount point when they receive this intent.
2570 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2571 */
2572 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2573 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2574
2575 /**
2576 * Broadcast Action: The media scanner has started scanning a directory.
2577 * The path to the directory being scanned is contained in the Intent.mData field.
2578 */
2579 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2580 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2581
2582 /**
2583 * Broadcast Action: The media scanner has finished scanning a directory.
2584 * The path to the scanned directory is contained in the Intent.mData field.
2585 */
2586 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2587 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2588
2589 /**
2590 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2591 * The path to the file is contained in the Intent.mData field.
2592 */
2593 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2594 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2595
2596 /**
2597 * Broadcast Action: The "Media Button" was pressed. Includes a single
2598 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2599 * caused the broadcast.
2600 */
2601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2602 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2603
2604 /**
2605 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2606 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2607 * caused the broadcast.
2608 */
2609 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2610 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2611
2612 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2613 // location; they are not general-purpose actions.
2614
2615 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002616 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002617 */
2618 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2619 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2620 "android.intent.action.GTALK_CONNECTED";
2621
2622 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002623 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002624 */
2625 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2626 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2627 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002628
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002629 /**
2630 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002631 */
2632 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2633 public static final String ACTION_INPUT_METHOD_CHANGED =
2634 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002635
2636 /**
2637 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2638 * more radios have been turned off or on. The intent will have the following extra value:</p>
2639 * <ul>
2640 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2641 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2642 * turned off</li>
2643 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002644 *
Peng Xua35b5532016-01-20 00:05:45 -08002645 * <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 -07002646 */
2647 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2648 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2649
2650 /**
2651 * Broadcast Action: Some content providers have parts of their namespace
2652 * where they publish new events or items that the user may be especially
2653 * interested in. For these things, they may broadcast this action when the
2654 * set of interesting items change.
2655 *
2656 * For example, GmailProvider sends this notification when the set of unread
2657 * mail in the inbox changes.
2658 *
2659 * <p>The data of the intent identifies which part of which provider
2660 * changed. When queried through the content resolver, the data URI will
2661 * return the data set in question.
2662 *
2663 * <p>The intent will have the following extra values:
2664 * <ul>
2665 * <li><em>count</em> - The number of items in the data set. This is the
2666 * same as the number of items in the cursor returned by querying the
2667 * data URI. </li>
2668 * </ul>
2669 *
2670 * This intent will be sent at boot (if the count is non-zero) and when the
2671 * data set changes. It is possible for the data set to change without the
2672 * count changing (for example, if a new unread message arrives in the same
2673 * sync operation in which a message is archived). The phone should still
2674 * ring/vibrate/etc as normal in this case.
2675 */
2676 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2677 public static final String ACTION_PROVIDER_CHANGED =
2678 "android.intent.action.PROVIDER_CHANGED";
2679
2680 /**
2681 * Broadcast Action: Wired Headset plugged in or unplugged.
2682 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002683 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2684 * and documentation.
2685 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002686 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002687 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002688 */
2689 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002690 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002691
2692 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002693 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2694 * <ul>
2695 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2696 * </ul>
2697 *
2698 * <p class="note">This is a protected intent that can only be sent
2699 * by the system.
2700 *
2701 * @hide
2702 */
2703 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2704 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2705 = "android.intent.action.ADVANCED_SETTINGS";
2706
2707 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002708 * Broadcast Action: Sent after application restrictions are changed.
2709 *
2710 * <p class="note">This is a protected intent that can only be sent
2711 * by the system.</p>
2712 */
2713 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2714 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2715 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2716
2717 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002718 * Broadcast Action: An outgoing call is about to be placed.
2719 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002720 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002721 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002722 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002723 * the phone number originally intended to be dialed.</li>
2724 * </ul>
2725 * <p>Once the broadcast is finished, the resultData is used as the actual
2726 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002727 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002728 * outgoing call in turn: for example, a parental control application
2729 * might verify that the user is authorized to place the call at that
2730 * time, then a number-rewriting application might add an area code if
2731 * one was not specified.</p>
2732 * <p>For consistency, any receiver whose purpose is to prohibit phone
2733 * calls should have a priority of 0, to ensure it will see the final
2734 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002735 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002736 * should have a positive priority.
2737 * Negative priorities are reserved for the system for this broadcast;
2738 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002739 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2740 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002741 * <p>Emergency calls cannot be intercepted using this mechanism, and
2742 * other calls cannot be modified to call emergency numbers using this
2743 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002744 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2745 * call to use their own service instead. Those apps should first prevent
2746 * the call from being placed by setting resultData to <code>null</code>
2747 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002748 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002749 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2750 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002751 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002752 * <p class="note">This is a protected intent that can only be sent
2753 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002754 */
2755 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2756 public static final String ACTION_NEW_OUTGOING_CALL =
2757 "android.intent.action.NEW_OUTGOING_CALL";
2758
2759 /**
2760 * Broadcast Action: Have the device reboot. This is only for use by
2761 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002762 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002763 * <p class="note">This is a protected intent that can only be sent
2764 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002765 */
2766 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2767 public static final String ACTION_REBOOT =
2768 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002769
Wei Huang97ecc9c2009-05-11 17:44:20 -07002770 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002771 * Broadcast Action: A sticky broadcast for changes in the physical
2772 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002773 *
2774 * <p>The intent will have the following extra values:
2775 * <ul>
2776 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002777 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002778 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002779 * <p>This is intended for monitoring the current physical dock state.
2780 * See {@link android.app.UiModeManager} for the normal API dealing with
2781 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002782 */
2783 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2784 public static final String ACTION_DOCK_EVENT =
2785 "android.intent.action.DOCK_EVENT";
2786
2787 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002788 * Broadcast Action: A broadcast when idle maintenance can be started.
2789 * This means that the user is not interacting with the device and is
2790 * not expected to do so soon. Typical use of the idle maintenance is
2791 * to perform somehow expensive tasks that can be postponed at a moment
2792 * when they will not degrade user experience.
2793 * <p>
2794 * <p class="note">In order to keep the device responsive in case of an
2795 * unexpected user interaction, implementations of a maintenance task
2796 * should be interruptible. In such a scenario a broadcast with action
2797 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2798 * should not do the maintenance work in
2799 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2800 * maintenance service by {@link Context#startService(Intent)}. Also
2801 * you should hold a wake lock while your maintenance service is running
2802 * to prevent the device going to sleep.
2803 * </p>
2804 * <p>
2805 * <p class="note">This is a protected intent that can only be sent by
2806 * the system.
2807 * </p>
2808 *
2809 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002810 *
2811 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002812 */
2813 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2814 public static final String ACTION_IDLE_MAINTENANCE_START =
2815 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2816
2817 /**
2818 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2819 * This means that the user was not interacting with the device as a result
2820 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2821 * was sent and now the user started interacting with the device. Typical
2822 * use of the idle maintenance is to perform somehow expensive tasks that
2823 * can be postponed at a moment when they will not degrade user experience.
2824 * <p>
2825 * <p class="note">In order to keep the device responsive in case of an
2826 * unexpected user interaction, implementations of a maintenance task
2827 * should be interruptible. Hence, on receiving a broadcast with this
2828 * action, the maintenance task should be interrupted as soon as possible.
2829 * In other words, you should not do the maintenance work in
2830 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2831 * maintenance service that was started on receiving of
2832 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2833 * lock you acquired when your maintenance service started.
2834 * </p>
2835 * <p class="note">This is a protected intent that can only be sent
2836 * by the system.
2837 *
2838 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002839 *
2840 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002841 */
2842 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2843 public static final String ACTION_IDLE_MAINTENANCE_END =
2844 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2845
2846 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002847 * Broadcast Action: a remote intent is to be broadcasted.
2848 *
2849 * A remote intent is used for remote RPC between devices. The remote intent
2850 * is serialized and sent from one device to another device. The receiving
2851 * device parses the remote intent and broadcasts it. Note that anyone can
2852 * broadcast a remote intent. However, if the intent receiver of the remote intent
2853 * does not trust intent broadcasts from arbitrary intent senders, it should require
2854 * the sender to hold certain permissions so only trusted sender's broadcast will be
2855 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002856 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002857 */
2858 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002859 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002860
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002861 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002862 * Broadcast Action: This is broadcast once when the user is booting after a
2863 * system update. It can be used to perform cleanup or upgrades after a
2864 * system update.
2865 * <p>
2866 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2867 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2868 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2869 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002870 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002871 * @hide
2872 */
2873 public static final String ACTION_PRE_BOOT_COMPLETED =
2874 "android.intent.action.PRE_BOOT_COMPLETED";
2875
Amith Yamasani13593602012-03-22 16:16:17 -07002876 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002877 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002878 * on restricted users. The broadcast intent contains an extra
2879 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2880 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2881 * String[] depending on the restriction type.<p/>
2882 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002883 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2884 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2885 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002886 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2887 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002888 * @see RestrictionEntry
2889 */
2890 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2891 "android.intent.action.GET_RESTRICTION_ENTRIES";
2892
2893 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002894 * Sent the first time a user is starting, to allow system apps to
2895 * perform one time initialization. (This will not be seen by third
2896 * party applications because a newly initialized user does not have any
2897 * third party applications installed for it.) This is sent early in
2898 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002899 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2900 * broadcast, since it is part of a visible user interaction; be as quick
2901 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002902 */
2903 public static final String ACTION_USER_INITIALIZE =
2904 "android.intent.action.USER_INITIALIZE";
2905
2906 /**
2907 * Sent when a user switch is happening, causing the process's user to be
2908 * brought to the foreground. This is only sent to receivers registered
2909 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2910 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002911 * foreground. This is sent as a foreground
2912 * broadcast, since it is part of a visible user interaction; be as quick
2913 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002914 */
2915 public static final String ACTION_USER_FOREGROUND =
2916 "android.intent.action.USER_FOREGROUND";
2917
2918 /**
2919 * Sent when a user switch is happening, causing the process's user to be
2920 * sent to the background. This is only sent to receivers registered
2921 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2922 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002923 * background. This is sent as a foreground
2924 * broadcast, since it is part of a visible user interaction; be as quick
2925 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002926 */
2927 public static final String ACTION_USER_BACKGROUND =
2928 "android.intent.action.USER_BACKGROUND";
2929
2930 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002931 * Broadcast sent to the system when a user is added. Carries an extra
2932 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2933 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002934 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002935 * @hide
2936 */
2937 public static final String ACTION_USER_ADDED =
2938 "android.intent.action.USER_ADDED";
2939
2940 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002941 * Broadcast sent by the system when a user is started. Carries an extra
2942 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002943 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002944 * that has been started. This is sent as a foreground
2945 * broadcast, since it is part of a visible user interaction; be as quick
2946 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002947 * @hide
2948 */
2949 public static final String ACTION_USER_STARTED =
2950 "android.intent.action.USER_STARTED";
2951
2952 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002953 * Broadcast sent when a user is in the process of starting. Carries an extra
2954 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2955 * sent to registered receivers, not manifest receivers. It is sent to all
2956 * users (including the one that is being started). You must hold
2957 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2958 * this broadcast. This is sent as a background broadcast, since
2959 * its result is not part of the primary UX flow; to safely keep track of
2960 * started/stopped state of a user you can use this in conjunction with
2961 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2962 * other user state broadcasts since those are foreground broadcasts so can
2963 * execute in a different order.
2964 * @hide
2965 */
2966 public static final String ACTION_USER_STARTING =
2967 "android.intent.action.USER_STARTING";
2968
2969 /**
2970 * Broadcast sent when a user is going to be stopped. Carries an extra
2971 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2972 * sent to registered receivers, not manifest receivers. It is sent to all
2973 * users (including the one that is being stopped). You must hold
2974 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2975 * this broadcast. The user will not stop until all receivers have
2976 * handled the broadcast. This is sent as a background broadcast, since
2977 * its result is not part of the primary UX flow; to safely keep track of
2978 * started/stopped state of a user you can use this in conjunction with
2979 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2980 * other user state broadcasts since those are foreground broadcasts so can
2981 * execute in a different order.
2982 * @hide
2983 */
2984 public static final String ACTION_USER_STOPPING =
2985 "android.intent.action.USER_STOPPING";
2986
2987 /**
2988 * Broadcast sent to the system when a user is stopped. Carries an extra
2989 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2990 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2991 * specific package. This is only sent to registered receivers, not manifest
2992 * receivers. It is sent to all running users <em>except</em> the one that
2993 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002994 * @hide
2995 */
2996 public static final String ACTION_USER_STOPPED =
2997 "android.intent.action.USER_STOPPED";
2998
2999 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003000 * 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 -07003001 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003002 * one that has been removed. The user will not be completely removed until all receivers have
3003 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003004 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003005 * @hide
3006 */
3007 public static final String ACTION_USER_REMOVED =
3008 "android.intent.action.USER_REMOVED";
3009
3010 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003011 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003012 * the userHandle of the user to become the current one. This is only sent to
3013 * registered receivers, not manifest receivers. It is sent to all running users.
3014 * You must hold
3015 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003016 * @hide
3017 */
3018 public static final String ACTION_USER_SWITCHED =
3019 "android.intent.action.USER_SWITCHED";
3020
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003021 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003022 * Broadcast Action: Sent when the credential-encrypted private storage has
3023 * become unlocked for the target user. This is only sent to registered
3024 * receivers, not manifest receivers.
3025 */
3026 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3027 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3028
3029 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003030 * Broadcast sent to the system when a user's information changes. Carries an extra
3031 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003032 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003033 * @hide
3034 */
3035 public static final String ACTION_USER_INFO_CHANGED =
3036 "android.intent.action.USER_INFO_CHANGED";
3037
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003038 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003039 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3040 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003041 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3042 * that need to display merged content across both primary and managed profiles need to
3043 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003044 * not manifest receivers.
3045 */
3046 public static final String ACTION_MANAGED_PROFILE_ADDED =
3047 "android.intent.action.MANAGED_PROFILE_ADDED";
3048
3049 /**
3050 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003051 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3052 * Only applications (for example Launchers) that need to display merged content across both
3053 * primary and managed profiles need to worry about this broadcast. This is only sent to
3054 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003055 */
3056 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3057 "android.intent.action.MANAGED_PROFILE_REMOVED";
3058
3059 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003060 * Broadcast sent to the primary user when the credential-encrypted private storage for
3061 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3062 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3063 * Launchers) that need to display merged content across both primary and managed profiles
3064 * need to worry about this broadcast. This is only sent to registered receivers,
3065 * not manifest receivers.
3066 */
3067 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3068 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3069
3070 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003071 * Broadcast sent to the primary user when an associated managed profile's availability has
Rubin Xuf13c9802016-01-21 18:06:00 +00003072 * changed. This includes when the user toggles the profile's quiet mode. Carries an extra
3073 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3074 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3075 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003076 */
3077 public static final String ACTION_MANAGED_PROFILE_AVAILABILITY_CHANGED =
3078 "android.intent.action.MANAGED_PROFILE_AVAILABILITY_CHANGED";
3079
3080 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003081 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3082 */
3083 public static final String ACTION_QUICK_CLOCK =
3084 "android.intent.action.QUICK_CLOCK";
3085
Michael Wright0087a142013-02-05 16:29:39 -08003086 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003087 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003088 * @hide
3089 */
3090 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3091 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3092
Justin Kohd378ad72013-04-01 12:18:26 -07003093 /**
3094 * Broadcast Action: A global button was pressed. Includes a single
3095 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3096 * caused the broadcast.
3097 * @hide
3098 */
3099 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3100
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003101 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003102 * Broadcast Action: Sent when media resource is granted.
3103 * <p>
3104 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3105 * granted.
3106 * </p>
3107 * <p class="note">
3108 * This is a protected intent that can only be sent by the system.
3109 * </p>
3110 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003111 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003112 * </p>
3113 *
3114 * @hide
3115 */
3116 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3117 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3118
3119 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003120 * Activity Action: Allow the user to select and return one or more existing
3121 * documents. When invoked, the system will display the various
3122 * {@link DocumentsProvider} instances installed on the device, letting the
3123 * user interactively navigate through them. These documents include local
3124 * media, such as photos and video, and documents provided by installed
3125 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003126 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003127 * Each document is represented as a {@code content://} URI backed by a
3128 * {@link DocumentsProvider}, which can be opened as a stream with
3129 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3130 * {@link android.provider.DocumentsContract.Document} metadata.
3131 * <p>
3132 * All selected documents are returned to the calling application with
3133 * persistable read and write permission grants. If you want to maintain
3134 * access to the documents across device reboots, you need to explicitly
3135 * take the persistable permissions using
3136 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3137 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003138 * Callers must indicate the acceptable document MIME types through
3139 * {@link #setType(String)}. For example, to select photos, use
3140 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3141 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3142 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003143 * <p>
3144 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003145 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3146 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003147 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003148 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3149 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003150 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003151 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003152 * Output: The URI of the item that was picked, returned in
3153 * {@link #getData()}. This must be a {@code content://} URI so that any
3154 * receiver can access it. If multiple documents were selected, they are
3155 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003156 *
3157 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003158 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003159 * @see #ACTION_CREATE_DOCUMENT
3160 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003161 */
3162 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3163 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3164
3165 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003166 * Activity Action: Allow the user to create a new document. When invoked,
3167 * the system will display the various {@link DocumentsProvider} instances
3168 * installed on the device, letting the user navigate through them. The
3169 * returned document may be a newly created document with no content, or it
3170 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003171 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003172 * Each document is represented as a {@code content://} URI backed by a
3173 * {@link DocumentsProvider}, which can be opened as a stream with
3174 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3175 * {@link android.provider.DocumentsContract.Document} metadata.
3176 * <p>
3177 * Callers must indicate the concrete MIME type of the document being
3178 * created by setting {@link #setType(String)}. This MIME type cannot be
3179 * changed after the document is created.
3180 * <p>
3181 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3182 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003183 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003184 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3185 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003186 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003187 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003188 * Output: The URI of the item that was created. This must be a
3189 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003190 *
3191 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003192 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003193 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003194 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003195 */
3196 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3197 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3198
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003199 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003200 * Activity Action: Allow the user to pick a directory subtree. When
3201 * invoked, the system will display the various {@link DocumentsProvider}
3202 * instances installed on the device, letting the user navigate through
3203 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003204 * <p>
3205 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003206 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3207 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3208 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003209 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003210 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003211 *
3212 * @see DocumentsContract
3213 */
3214 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003215 public static final String
3216 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003217
Felipe Lemec7b1f892016-01-15 15:02:31 -08003218 /**
Peng Xua35b5532016-01-20 00:05:45 -08003219 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3220 * exisiting sensor being disconnected.
3221 *
3222 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3223 *
3224 * {@hide}
3225 */
3226 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3227 public static final String
3228 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3229
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003230 /** {@hide} */
3231 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3232
Christopher Tate6597e342015-02-17 12:15:25 -08003233 /**
3234 * Broadcast action: report that a settings element is being restored from backup. The intent
3235 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3236 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3237 * is the value of that settings entry prior to the restore operation. All of these values are
3238 * represented as strings.
3239 *
3240 * <p>This broadcast is sent only for settings provider entries known to require special handling
3241 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3242 * the provider's backup agent implementation.
3243 *
3244 * @see #EXTRA_SETTING_NAME
3245 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3246 * @see #EXTRA_SETTING_NEW_VALUE
3247 * {@hide}
3248 */
3249 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3250
3251 /** {@hide} */
3252 public static final String EXTRA_SETTING_NAME = "setting_name";
3253 /** {@hide} */
3254 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3255 /** {@hide} */
3256 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3257
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003258 /**
3259 * Activity Action: Process a piece of text.
3260 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3261 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3262 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3263 */
3264 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3265 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3266 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003267 * The name of the extra used to define the text to be processed, as a
3268 * CharSequence. Note that this may be a styled CharSequence, so you must use
3269 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003270 */
3271 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3272 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003273 * 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 +00003274 */
3275 public static final String EXTRA_PROCESS_TEXT_READONLY =
3276 "android.intent.extra.PROCESS_TEXT_READONLY";
3277
Bryce Leebc58f592015-09-25 16:43:01 -07003278 /**
3279 * Broadcast action: reports when a new thermal event has been reached. When the device
3280 * is reaching its maximum temperatue, the thermal level reported
3281 * {@hide}
3282 */
3283 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3284 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3285
3286 /** {@hide} */
3287 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3288
3289 /**
3290 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003291 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003292 * {@hide}
3293 */
3294 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3295
3296 /**
3297 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003298 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003299 * {@hide}
3300 */
3301 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3302
3303 /**
3304 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003305 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003306 * {@hide}
3307 */
3308 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3309
3310
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003311 // ---------------------------------------------------------------------
3312 // ---------------------------------------------------------------------
3313 // Standard intent categories (see addCategory()).
3314
3315 /**
3316 * Set if the activity should be an option for the default action
3317 * (center press) to perform on a piece of data. Setting this will
3318 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003319 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003320 * Intent when initiating an action -- it is for use in intent filters
3321 * specified in packages.
3322 */
3323 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3324 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3325 /**
3326 * Activities that can be safely invoked from a browser must support this
3327 * category. For example, if the user is viewing a web page or an e-mail
3328 * and clicks on a link in the text, the Intent generated execute that
3329 * link will require the BROWSABLE category, so that only activities
3330 * supporting this category will be considered as possible actions. By
3331 * supporting this category, you are promising that there is nothing
3332 * damaging (without user intervention) that can happen by invoking any
3333 * matching Intent.
3334 */
3335 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3336 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3337 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003338 * Categories for activities that can participate in voice interaction.
3339 * An activity that supports this category must be prepared to run with
3340 * no UI shown at all (though in some case it may have a UI shown), and
3341 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3342 */
3343 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3344 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3345 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003346 * Set if the activity should be considered as an alternative action to
3347 * the data the user is currently viewing. See also
3348 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3349 * applies to the selection in a list of items.
3350 *
3351 * <p>Supporting this category means that you would like your activity to be
3352 * displayed in the set of alternative things the user can do, usually as
3353 * part of the current activity's options menu. You will usually want to
3354 * include a specific label in the &lt;intent-filter&gt; of this action
3355 * describing to the user what it does.
3356 *
3357 * <p>The action of IntentFilter with this category is important in that it
3358 * describes the specific action the target will perform. This generally
3359 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3360 * a specific name such as "com.android.camera.action.CROP. Only one
3361 * alternative of any particular action will be shown to the user, so using
3362 * a specific action like this makes sure that your alternative will be
3363 * displayed while also allowing other applications to provide their own
3364 * overrides of that particular action.
3365 */
3366 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3367 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3368 /**
3369 * Set if the activity should be considered as an alternative selection
3370 * action to the data the user has currently selected. This is like
3371 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3372 * of items from which the user can select, giving them alternatives to the
3373 * default action that will be performed on it.
3374 */
3375 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3376 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3377 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003378 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003379 */
3380 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3381 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3382 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003383 * Should be displayed in the top-level launcher.
3384 */
3385 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3386 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3387 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003388 * Indicates an activity optimized for Leanback mode, and that should
3389 * be displayed in the Leanback launcher.
3390 */
3391 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3392 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3393 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003394 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3395 * @hide
3396 */
3397 @SystemApi
3398 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3399 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003400 * Provides information about the package it is in; typically used if
3401 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3402 * a front-door to the user without having to be shown in the all apps list.
3403 */
3404 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3405 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3406 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003407 * This is the home activity, that is the first activity that is displayed
3408 * when the device boots.
3409 */
3410 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3411 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3412 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003413 * This is the home activity that is displayed when the device is finished setting up and ready
3414 * for use.
3415 * @hide
3416 */
3417 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3418 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3419 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003420 * This is the setup wizard activity, that is the first activity that is displayed
3421 * when the user sets up the device for the first time.
3422 * @hide
3423 */
3424 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3425 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3426 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003427 * This activity is a preference panel.
3428 */
3429 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3430 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3431 /**
3432 * This activity is a development preference panel.
3433 */
3434 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3435 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3436 /**
3437 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003438 */
3439 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3440 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3441 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003442 * This activity allows the user to browse and download new applications.
3443 */
3444 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3445 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3446 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003447 * This activity may be exercised by the monkey or other automated test tools.
3448 */
3449 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3450 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3451 /**
3452 * To be used as a test (not part of the normal user experience).
3453 */
3454 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3455 /**
3456 * To be used as a unit test (run through the Test Harness).
3457 */
3458 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3459 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003460 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003461 * experience).
3462 */
3463 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003464
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003465 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003466 * Used to indicate that an intent only wants URIs that can be opened with
3467 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3468 * must support at least the columns defined in {@link OpenableColumns} when
3469 * queried.
3470 *
3471 * @see #ACTION_GET_CONTENT
3472 * @see #ACTION_OPEN_DOCUMENT
3473 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003474 */
3475 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3476 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3477
3478 /**
3479 * To be used as code under test for framework instrumentation tests.
3480 */
3481 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3482 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003483 /**
3484 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003485 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3486 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003487 */
3488 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3489 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3490 /**
3491 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003492 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3493 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003494 */
3495 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3496 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003497 /**
3498 * An activity to run when device is inserted into a analog (low end) dock.
3499 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3500 * information, see {@link android.app.UiModeManager}.
3501 */
3502 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3503 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3504
3505 /**
3506 * An activity to run when device is inserted into a digital (high end) dock.
3507 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3508 * information, see {@link android.app.UiModeManager}.
3509 */
3510 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3511 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003512
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003513 /**
3514 * Used to indicate that the activity can be used in a car environment.
3515 */
3516 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3517 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3518
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003519 // ---------------------------------------------------------------------
3520 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003521 // Application launch intent categories (see addCategory()).
3522
3523 /**
3524 * Used with {@link #ACTION_MAIN} to launch the browser application.
3525 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003526 * <p>NOTE: This should not be used as the primary key of an Intent,
3527 * since it will not result in the app launching with the correct
3528 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003529 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003530 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003531 */
3532 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3533 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3534
3535 /**
3536 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3537 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003538 * <p>NOTE: This should not be used as the primary key of an Intent,
3539 * since it will not result in the app launching with the correct
3540 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003541 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003542 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003543 */
3544 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3545 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3546
3547 /**
3548 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3549 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003550 * <p>NOTE: This should not be used as the primary key of an Intent,
3551 * since it will not result in the app launching with the correct
3552 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003553 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003554 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003555 */
3556 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3557 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3558
3559 /**
3560 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3561 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003562 * <p>NOTE: This should not be used as the primary key of an Intent,
3563 * since it will not result in the app launching with the correct
3564 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003565 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003566 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003567 */
3568 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3569 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3570
3571 /**
3572 * Used with {@link #ACTION_MAIN} to launch the email application.
3573 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003574 * <p>NOTE: This should not be used as the primary key of an Intent,
3575 * since it will not result in the app launching with the correct
3576 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003577 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003578 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003579 */
3580 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3581 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3582
3583 /**
3584 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3585 * The activity should be able to view and manipulate image and video files
3586 * stored on the device.
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_GALLERY = "android.intent.category.APP_GALLERY";
3595
3596 /**
3597 * Used with {@link #ACTION_MAIN} to launch the maps application.
3598 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003599 * <p>NOTE: This should not be used as the primary key of an Intent,
3600 * since it will not result in the app launching with the correct
3601 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003602 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003603 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003604 */
3605 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3606 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3607
3608 /**
3609 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3610 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003611 * <p>NOTE: This should not be used as the primary key of an Intent,
3612 * since it will not result in the app launching with the correct
3613 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003614 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003615 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003616 */
3617 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3618 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3619
3620 /**
3621 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003622 * The activity should be able to play, browse, or manipulate music files
3623 * stored on the device.
3624 * <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_MUSIC = "android.intent.category.APP_MUSIC";
3632
3633 // ---------------------------------------------------------------------
3634 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003635 // Standard extra data keys.
3636
3637 /**
3638 * The initial data to place in a newly created record. Use with
3639 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3640 * fields as would be given to the underlying ContentProvider.insert()
3641 * call.
3642 */
3643 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3644
3645 /**
3646 * A constant CharSequence that is associated with the Intent, used with
3647 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3648 * this may be a styled CharSequence, so you must use
3649 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3650 * retrieve it.
3651 */
3652 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3653
3654 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003655 * A constant String that is associated with the Intent, used with
3656 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3657 * as HTML formatted text. Note that you <em>must</em> also supply
3658 * {@link #EXTRA_TEXT}.
3659 */
3660 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3661
3662 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003663 * A content: URI holding a stream of data associated with the Intent,
3664 * used with {@link #ACTION_SEND} to supply the data being sent.
3665 */
3666 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3667
3668 /**
3669 * A String[] holding e-mail addresses that should be delivered to.
3670 */
3671 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3672
3673 /**
3674 * A String[] holding e-mail addresses that should be carbon copied.
3675 */
3676 public static final String EXTRA_CC = "android.intent.extra.CC";
3677
3678 /**
3679 * A String[] holding e-mail addresses that should be blind carbon copied.
3680 */
3681 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3682
3683 /**
3684 * A constant string holding the desired subject line of a message.
3685 */
3686 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3687
3688 /**
3689 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003690 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003691 */
3692 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3693
3694 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003695 * An int representing the user id to be used.
3696 *
3697 * @hide
3698 */
3699 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3700
3701 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003702 * An int representing the task id to be retrieved. This is used when a launch from recents is
3703 * intercepted by another action such as credentials confirmation to remember which task should
3704 * be resumed when complete.
3705 *
3706 * @hide
3707 */
3708 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3709
3710 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003711 * An Intent[] describing additional, alternate choices you would like shown with
3712 * {@link #ACTION_CHOOSER}.
3713 *
3714 * <p>An app may be capable of providing several different payload types to complete a
3715 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3716 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3717 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3718 * photo data or a hosted link where the photos can be viewed.</p>
3719 *
3720 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3721 * first/primary/preferred intent in the set. Additional intents specified in
3722 * this extra are ordered; by default intents that appear earlier in the array will be
3723 * preferred over intents that appear later in the array as matches for the same
3724 * target component. To alter this preference, a calling app may also supply
3725 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3726 */
3727 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3728
3729 /**
3730 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3731 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3732 *
3733 * <p>An app preparing an action for another app to complete may wish to allow the user to
3734 * disambiguate between several options for completing the action based on the chosen target
3735 * or otherwise refine the action before it is invoked.
3736 * </p>
3737 *
3738 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3739 * <ul>
3740 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3741 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3742 * chosen target beyond the first</li>
3743 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3744 * should fill in and send once the disambiguation is complete</li>
3745 * </ul>
3746 */
3747 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3748 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3749
3750 /**
3751 * A {@link ResultReceiver} used to return data back to the sender.
3752 *
3753 * <p>Used to complete an app-specific
3754 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3755 *
3756 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3757 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3758 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3759 * when the user selects a target component from the chooser. It is up to the recipient
3760 * to send a result to this ResultReceiver to signal that disambiguation is complete
3761 * and that the chooser should invoke the user's choice.</p>
3762 *
3763 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3764 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3765 * to match and fill in the final Intent or ChooserTarget before starting it.
3766 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3767 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3768 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3769 *
3770 * <p>The result code passed to the ResultReceiver should be
3771 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3772 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3773 * the chooser should finish without starting a target.</p>
3774 */
3775 public static final String EXTRA_RESULT_RECEIVER
3776 = "android.intent.extra.RESULT_RECEIVER";
3777
3778 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003779 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003780 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003781 */
3782 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3783
3784 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003785 * A Parcelable[] of {@link Intent} or
3786 * {@link android.content.pm.LabeledIntent} objects as set with
3787 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3788 * a the front of the list of choices, when shown to the user with a
3789 * {@link #ACTION_CHOOSER}.
3790 */
3791 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3792
3793 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003794 * A {@link IntentSender} to start after ephemeral installation success.
3795 * @hide
3796 */
3797 @SystemApi
3798 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3799
3800 /**
3801 * A {@link IntentSender} to start after ephemeral installation failure.
3802 * @hide
3803 */
3804 @SystemApi
3805 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3806
3807 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003808 * A Bundle forming a mapping of potential target package names to different extras Bundles
3809 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3810 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3811 * be currently installed on the device.
3812 *
3813 * <p>An application may choose to provide alternate extras for the case where a user
3814 * selects an activity from a predetermined set of target packages. If the activity
3815 * the user selects from the chooser belongs to a package with its package name as
3816 * a key in this bundle, the corresponding extras for that package will be merged with
3817 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3818 * extra has the same key as an extra already present in the intent it will overwrite
3819 * the extra from the intent.</p>
3820 *
3821 * <p><em>Examples:</em>
3822 * <ul>
3823 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3824 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3825 * parameters for that target.</li>
3826 * <li>An application may offer additional metadata for known targets of a given intent
3827 * to pass along information only relevant to that target such as account or content
3828 * identifiers already known to that application.</li>
3829 * </ul></p>
3830 */
3831 public static final String EXTRA_REPLACEMENT_EXTRAS =
3832 "android.intent.extra.REPLACEMENT_EXTRAS";
3833
3834 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003835 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3836 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3837 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3838 * {@link ComponentName} of the chosen component.
3839 *
3840 * <p>In some situations this callback may never come, for example if the user abandons
3841 * the chooser, switches to another task or any number of other reasons. Apps should not
3842 * be written assuming that this callback will always occur.</p>
3843 */
3844 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3845 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3846
3847 /**
3848 * The {@link ComponentName} chosen by the user to complete an action.
3849 *
3850 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3851 */
3852 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3853
3854 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003855 * A {@link android.view.KeyEvent} object containing the event that
3856 * triggered the creation of the Intent it is in.
3857 */
3858 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3859
3860 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003861 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3862 * before shutting down.
3863 *
3864 * {@hide}
3865 */
3866 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3867
3868 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003869 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3870 * requested by the user.
3871 *
3872 * {@hide}
3873 */
3874 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3875 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3876
3877 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003878 * 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 -07003879 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3880 * of restarting the application.
3881 */
3882 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3883
3884 /**
3885 * A String holding the phone number originally entered in
3886 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3887 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3888 */
3889 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003890
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003891 /**
3892 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3893 * intents to supply the uid the package had been assigned. Also an optional
3894 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3895 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3896 * purpose.
3897 */
3898 public static final String EXTRA_UID = "android.intent.extra.UID";
3899
3900 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003901 * @hide String array of package names.
3902 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003903 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003904 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3905
3906 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003907 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3908 * intents to indicate whether this represents a full uninstall (removing
3909 * both the code and its data) or a partial uninstall (leaving its data,
3910 * implying that this is an update).
3911 */
3912 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003913
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003914 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003915 * @hide
3916 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3917 * intents to indicate that at this point the package has been removed for
3918 * all users on the device.
3919 */
3920 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3921 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3922
3923 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003924 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3925 * intents to indicate that this is a replacement of the package, so this
3926 * broadcast will immediately be followed by an add broadcast for a
3927 * different version of the same package.
3928 */
3929 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003930
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003931 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003932 * Used as an int extra field in {@link android.app.AlarmManager} intents
3933 * to tell the application being invoked how many pending alarms are being
3934 * delievered with the intent. For one-shot alarms this will always be 1.
3935 * For recurring alarms, this might be greater than 1 if the device was
3936 * asleep or powered off at the time an earlier alarm would have been
3937 * delivered.
3938 */
3939 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003940
Jacek Surazski86b6c532009-05-13 14:38:28 +02003941 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003942 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3943 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003944 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3945 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003946 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3947 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3948 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003949 */
3950 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3951
3952 /**
3953 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3954 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003955 */
3956 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3957
3958 /**
3959 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3960 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003961 */
3962 public static final int EXTRA_DOCK_STATE_DESK = 1;
3963
3964 /**
3965 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3966 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003967 */
3968 public static final int EXTRA_DOCK_STATE_CAR = 2;
3969
3970 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003971 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3972 * to represent that the phone is in a analog (low end) dock.
3973 */
3974 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3975
3976 /**
3977 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3978 * to represent that the phone is in a digital (high end) dock.
3979 */
3980 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3981
3982 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003983 * Boolean that can be supplied as meta-data with a dock activity, to
3984 * indicate that the dock should take over the home key when it is active.
3985 */
3986 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003987
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003988 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003989 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3990 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003991 */
3992 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3993
3994 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003995 * Used in the extra field in the remote intent. It's astring token passed with the
3996 * remote intent.
3997 */
3998 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3999 "android.intent.extra.remote_intent_token";
4000
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004001 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004002 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004003 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004004 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004005 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004006 "android.intent.extra.changed_component_name";
4007
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004008 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004009 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004010 * and contains a string array of all of the components that have changed. If
4011 * the state of the overall package has changed, then it will contain an entry
4012 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004013 */
4014 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4015 "android.intent.extra.changed_component_name_list";
4016
4017 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004018 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004019 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004020 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4021 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4022 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004023 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004024 */
4025 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4026 "android.intent.extra.changed_package_list";
4027
4028 /**
4029 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004030 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4031 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004032 * and contains an integer array of uids of all of the components
4033 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004034 */
4035 public static final String EXTRA_CHANGED_UID_LIST =
4036 "android.intent.extra.changed_uid_list";
4037
4038 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004039 * @hide
4040 * Magic extra system code can use when binding, to give a label for
4041 * who it is that has bound to a service. This is an integer giving
4042 * a framework string resource that can be displayed to the user.
4043 */
4044 public static final String EXTRA_CLIENT_LABEL =
4045 "android.intent.extra.client_label";
4046
4047 /**
4048 * @hide
4049 * Magic extra system code can use when binding, to give a PendingIntent object
4050 * that can be launched for the user to disable the system's use of this
4051 * service.
4052 */
4053 public static final String EXTRA_CLIENT_INTENT =
4054 "android.intent.extra.client_intent";
4055
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004056 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004057 * Extra used to indicate that an intent should only return data that is on
4058 * the local device. This is a boolean extra; the default is false. If true,
4059 * an implementation should only allow the user to select data that is
4060 * already on the device, not requiring it be downloaded from a remote
4061 * service when opened.
4062 *
4063 * @see #ACTION_GET_CONTENT
4064 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004065 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004066 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004067 */
4068 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004069 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004070
Amith Yamasani13593602012-03-22 16:16:17 -07004071 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004072 * Extra used to indicate that an intent can allow the user to select and
4073 * return multiple items. This is a boolean extra; the default is false. If
4074 * true, an implementation is allowed to present the user with a UI where
4075 * they can pick multiple items that are all returned to the caller. When
4076 * this happens, they should be returned as the {@link #getClipData()} part
4077 * of the result Intent.
4078 *
4079 * @see #ACTION_GET_CONTENT
4080 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004081 */
4082 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004083 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004084
4085 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004086 * The integer userHandle carried with broadcast intents related to addition, removal and
4087 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4088 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4089 *
Amith Yamasani13593602012-03-22 16:16:17 -07004090 * @hide
4091 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004092 public static final String EXTRA_USER_HANDLE =
4093 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004094
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004095 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004096 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4097 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4098 */
4099 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004100 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004101
4102 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004103 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004104 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4105 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004106 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004107 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4108
4109 /**
4110 * Extra sent in the intent to the BroadcastReceiver that handles
4111 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4112 * the restrictions as key/value pairs.
4113 */
4114 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4115 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004116
Amith Yamasani86118ba2013-03-28 14:33:16 -07004117 /**
4118 * Extra used in the response from a BroadcastReceiver that handles
4119 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4120 */
4121 public static final String EXTRA_RESTRICTIONS_INTENT =
4122 "android.intent.extra.restrictions_intent";
4123
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004124 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004125 * Extra used to communicate a set of acceptable MIME types. The type of the
4126 * extra is {@code String[]}. Values may be a combination of concrete MIME
4127 * types (such as "image/png") and/or partial MIME types (such as
4128 * "audio/*").
4129 *
4130 * @see #ACTION_GET_CONTENT
4131 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004132 */
4133 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4134
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004135 /**
4136 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4137 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004138 * When this is true, hardware devices can use this information to determine that
4139 * they shouldn't do a complete shutdown of their device since this is not a
4140 * complete shutdown down to the kernel, but only user space restarting.
4141 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004142 */
4143 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4144 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4145
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004146 /**
4147 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4148 * user has set their time format preferences to the 24 hour format.
4149 *
4150 * @hide for internal use only.
4151 */
4152 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4153 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4154
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004155 /** {@hide} */
4156 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4157
Rubin Xue8490f12015-06-25 12:17:48 +01004158 /** {@hide} */
4159 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4160
Santos Cordon15a13782015-03-31 18:32:31 -07004161 /**
4162 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4163 * activation request.
4164 * TODO: Add information about the structure and response data used with the pending intent.
4165 * @hide
4166 */
4167 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4168 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4169
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004170 /**
4171 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004172 *
4173 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004174 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004175 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4176
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004177 /**
4178 * Optional boolean extra indicating whether quiet mode has been switched on or off.
4179 */
4180 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004181
4182 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004183 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004184 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004185 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4186 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004187 *
4188 * @hide
4189 */
4190 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4191 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4192
4193 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004194 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004195 * to represent that a video codec is allowed to use.
4196 *
4197 * @hide
4198 */
4199 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4200
4201 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004202 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004203 * to represent that a audio codec is allowed to use.
4204 *
4205 * @hide
4206 */
4207 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4208
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004209 // ---------------------------------------------------------------------
4210 // ---------------------------------------------------------------------
4211 // Intent flags (see mFlags variable).
4212
Tor Norbyed9273d62013-05-30 15:59:53 -07004213 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004214 @IntDef(flag = true, value = {
4215 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4216 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004217 @Retention(RetentionPolicy.SOURCE)
4218 public @interface GrantUriMode {}
4219
Jeff Sharkey846318a2014-04-04 12:12:41 -07004220 /** @hide */
4221 @IntDef(flag = true, value = {
4222 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4223 @Retention(RetentionPolicy.SOURCE)
4224 public @interface AccessUriMode {}
4225
4226 /**
4227 * Test if given mode flags specify an access mode, which must be at least
4228 * read and/or write.
4229 *
4230 * @hide
4231 */
4232 public static boolean isAccessUriMode(int modeFlags) {
4233 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4234 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4235 }
4236
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004237 /**
4238 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004239 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004240 * specified in its ClipData. When applying to an Intent's ClipData,
4241 * all URIs as well as recursive traversals through data or other ClipData
4242 * in Intent items will be granted; only the grant flags of the top-level
4243 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004244 */
4245 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4246 /**
4247 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004248 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004249 * specified in its ClipData. When applying to an Intent's ClipData,
4250 * all URIs as well as recursive traversals through data or other ClipData
4251 * in Intent items will be granted; only the grant flags of the top-level
4252 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004253 */
4254 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4255 /**
4256 * Can be set by the caller to indicate that this Intent is coming from
4257 * a background operation, not from direct user interaction.
4258 */
4259 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4260 /**
4261 * A flag you can enable for debugging: when set, log messages will be
4262 * printed during the resolution of this intent to show you what has
4263 * been found to create the final resolved list.
4264 */
4265 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004266 /**
4267 * If set, this intent will not match any components in packages that
4268 * are currently stopped. If this is not set, then the default behavior
4269 * is to include such applications in the result.
4270 */
4271 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4272 /**
4273 * If set, this intent will always match any components in packages that
4274 * are currently stopped. This is the default behavior when
4275 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4276 * flags are set, this one wins (it allows overriding of exclude for
4277 * places where the framework may automatically set the exclude flag).
4278 */
4279 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004280
4281 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004282 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004283 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004284 * persisted across device reboots until explicitly revoked with
4285 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4286 * grant for possible persisting; the receiving application must call
4287 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4288 * actually persist.
4289 *
4290 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4291 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4292 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004293 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004294 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004295 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004296
4297 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004298 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4299 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4300 * applies to any URI that is a prefix match against the original granted
4301 * URI. (Without this flag, the URI must match exactly for access to be
4302 * granted.) Another URI is considered a prefix match only when scheme,
4303 * authority, and all path segments defined by the prefix are an exact
4304 * match.
4305 */
4306 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4307
4308 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004309 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004310 * homework and verified that they correctly handle packages and components
4311 * that come and go over time. In particular:
4312 * <ul>
4313 * <li>Apps installed on external storage, which will appear to be
4314 * uninstalled while the the device is ejected.
4315 * <li>Apps with encryption unaware components, which will appear to not
4316 * exist while the device is locked.
4317 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004318 *
4319 * @hide
4320 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004321 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004322
4323 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004324 * If set, the new activity is not kept in the history stack. As soon as
4325 * the user navigates away from it, the activity is finished. This may also
4326 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4327 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004328 *
4329 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4330 * is never invoked when the current activity starts a new activity which
4331 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004332 */
4333 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4334 /**
4335 * If set, the activity will not be launched if it is already running
4336 * at the top of the history stack.
4337 */
4338 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4339 /**
4340 * If set, this activity will become the start of a new task on this
4341 * history stack. A task (from the activity that started it to the
4342 * next task activity) defines an atomic group of activities that the
4343 * user can move to. Tasks can be moved to the foreground and background;
4344 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004345 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004346 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4347 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004348 *
4349 * <p>This flag is generally used by activities that want
4350 * to present a "launcher" style behavior: they give the user a list of
4351 * separate things that can be done, which otherwise run completely
4352 * independently of the activity launching them.
4353 *
4354 * <p>When using this flag, if a task is already running for the activity
4355 * you are now starting, then a new activity will not be started; instead,
4356 * the current task will simply be brought to the front of the screen with
4357 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4358 * to disable this behavior.
4359 *
4360 * <p>This flag can not be used when the caller is requesting a result from
4361 * the activity being launched.
4362 */
4363 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4364 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004365 * This flag is used to create a new task and launch an activity into it.
4366 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4367 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4368 * search through existing tasks for ones matching this Intent. Only if no such
4369 * task is found would a new task be created. When paired with
4370 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4371 * the search for a matching task and unconditionally start a new task.
4372 *
4373 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4374 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004375 * top-level application launcher.</strong> Used in conjunction with
4376 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4377 * behavior of bringing an existing task to the foreground. When set,
4378 * a new task is <em>always</em> started to host the Activity for the
4379 * Intent, regardless of whether there is already an existing task running
4380 * the same thing.
4381 *
4382 * <p><strong>Because the default system does not include graphical task management,
4383 * you should not use this flag unless you provide some way for a user to
4384 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004385 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004386 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4387 * creating new document tasks.
4388 *
4389 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004390 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004391 *
Scott Main7aee61f2011-02-08 11:25:01 -08004392 * <p>See
4393 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4394 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004395 *
4396 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4397 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004398 */
4399 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4400 /**
4401 * If set, and the activity being launched is already running in the
4402 * current task, then instead of launching a new instance of that activity,
4403 * all of the other activities on top of it will be closed and this Intent
4404 * will be delivered to the (now on top) old activity as a new Intent.
4405 *
4406 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4407 * If D calls startActivity() with an Intent that resolves to the component
4408 * of activity B, then C and D will be finished and B receive the given
4409 * Intent, resulting in the stack now being: A, B.
4410 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004411 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004412 * either receive the new intent you are starting here in its
4413 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004414 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004415 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4416 * the same intent, then it will be finished and re-created; for all other
4417 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4418 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004419 *
4420 * <p>This launch mode can also be used to good effect in conjunction with
4421 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4422 * of a task, it will bring any currently running instance of that task
4423 * to the foreground, and then clear it to its root state. This is
4424 * especially useful, for example, when launching an activity from the
4425 * notification manager.
4426 *
Scott Main7aee61f2011-02-08 11:25:01 -08004427 * <p>See
4428 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4429 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004430 */
4431 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4432 /**
4433 * If set and this intent is being used to launch a new activity from an
4434 * existing one, then the reply target of the existing activity will be
4435 * transfered to the new activity. This way the new activity can call
4436 * {@link android.app.Activity#setResult} and have that result sent back to
4437 * the reply target of the original activity.
4438 */
4439 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4440 /**
4441 * If set and this intent is being used to launch a new activity from an
4442 * existing one, the current activity will not be counted as the top
4443 * activity for deciding whether the new intent should be delivered to
4444 * the top instead of starting a new one. The previous activity will
4445 * be used as the top, with the assumption being that the current activity
4446 * will finish itself immediately.
4447 */
4448 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4449 /**
4450 * If set, the new activity is not kept in the list of recently launched
4451 * activities.
4452 */
4453 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4454 /**
4455 * This flag is not normally set by application code, but set for you by
4456 * the system as described in the
4457 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4458 * launchMode} documentation for the singleTask mode.
4459 */
4460 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4461 /**
4462 * If set, and this activity is either being started in a new task or
4463 * bringing to the top an existing task, then it will be launched as
4464 * the front door of the task. This will result in the application of
4465 * any affinities needed to have that task in the proper state (either
4466 * moving activities to or from it), or simply resetting that task to
4467 * its initial state if needed.
4468 */
4469 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4470 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004471 * This flag is not normally set by application code, but set for you by
4472 * the system if this activity is being launched from history
4473 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004474 */
4475 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004476 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004477 * @deprecated As of API 21 this performs identically to
4478 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004479 */
4480 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004481 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004482 * This flag is used to open a document into a new task rooted at the activity launched
4483 * by this Intent. Through the use of this flag, or its equivalent attribute,
4484 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004485 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004486 *
Craig Mautner026596b2014-05-21 15:35:44 -07004487 * <p>The use of the activity attribute form of this,
4488 * {@link android.R.attr#documentLaunchMode}, is
4489 * preferred over the Intent flag described here. The attribute form allows the
4490 * Activity to specify multiple document behavior for all launchers of the Activity
4491 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004492 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004493 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4494 * it is kept after the activity is finished is different than the use of
4495 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4496 * this flag is being used to create a new recents entry, then by default that entry
4497 * will be removed once the activity is finished. You can modify this behavior with
4498 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4499 *
Craig Mautner026596b2014-05-21 15:35:44 -07004500 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4501 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4502 * equivalent of the Activity manifest specifying {@link
4503 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4504 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4505 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004506 *
Craig Mautner026596b2014-05-21 15:35:44 -07004507 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004508 *
Craig Mautner026596b2014-05-21 15:35:44 -07004509 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004510 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4511 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004512 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004513 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004514 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004515 * callback from occurring on the current frontmost activity before it is
4516 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004517 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004518 * <p>Typically, an activity can rely on that callback to indicate that an
4519 * explicit user action has caused their activity to be moved out of the
4520 * foreground. The callback marks an appropriate point in the activity's
4521 * lifecycle for it to dismiss any notifications that it intends to display
4522 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004523 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004524 * <p>If an activity is ever started via any non-user-driven events such as
4525 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4526 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004527 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004528 */
4529 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004530 /**
4531 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4532 * this flag will cause the launched activity to be brought to the front of its
4533 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004534 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004535 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4536 * If D calls startActivity() with an Intent that resolves to the component
4537 * of activity B, then B will be brought to the front of the history stack,
4538 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004539 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004540 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004541 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004542 */
4543 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004544 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004545 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4546 * this flag will prevent the system from applying an activity transition
4547 * animation to go to the next activity state. This doesn't mean an
4548 * animation will never run -- if another activity change happens that doesn't
4549 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004550 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004551 * when you are going to do a series of activity operations but the
4552 * animation seen by the user shouldn't be driven by the first activity
4553 * change but rather a later one.
4554 */
4555 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4556 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004557 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4558 * this flag will cause any existing task that would be associated with the
4559 * activity to be cleared before the activity is started. That is, the activity
4560 * becomes the new root of an otherwise empty task, and any old activities
4561 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4562 */
4563 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4564 /**
4565 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4566 * this flag will cause a newly launching task to be placed on top of the current
4567 * home activity task (if there is one). That is, pressing back from the task
4568 * will always return the user to home even if that was not the last activity they
4569 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4570 */
4571 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4572 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004573 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4574 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004575 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004576 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004577 * this flag. When set and the task's activity is finished, the recents
4578 * entry will remain in the interface for the user to re-launch it, like a
4579 * recents entry for a top-level application.
4580 * <p>
4581 * The receiving activity can override this request with
4582 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4583 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004584 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004585 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004586 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004587
4588 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004589 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4590 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004591 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4592 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004593 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004594 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004595
4596 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004597 * If set, when sending a broadcast only registered receivers will be
4598 * called -- no BroadcastReceiver components will be launched.
4599 */
4600 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004601 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004602 * If set, when sending a broadcast the new broadcast will replace
4603 * any existing pending broadcast that matches it. Matching is defined
4604 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4605 * true for the intents of the two broadcasts. When a match is found,
4606 * the new broadcast (and receivers associated with it) will replace the
4607 * existing one in the pending broadcast list, remaining at the same
4608 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004609 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004610 * <p>This flag is most typically used with sticky broadcasts, which
4611 * only care about delivering the most recent values of the broadcast
4612 * to their receivers.
4613 */
4614 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4615 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004616 * If set, when sending a broadcast the recipient is allowed to run at
4617 * foreground priority, with a shorter timeout interval. During normal
4618 * broadcasts the receivers are not automatically hoisted out of the
4619 * background priority class.
4620 */
4621 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4622 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004623 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4624 * They can still propagate results through to later receivers, but they can not prevent
4625 * later receivers from seeing the broadcast.
4626 */
4627 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4628 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004629 * If set, when sending a broadcast <i>before boot has completed</i> only
4630 * registered receivers will be called -- no BroadcastReceiver components
4631 * will be launched. Sticky intent state will be recorded properly even
4632 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4633 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004634 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004635 * <p>This flag is only for use by system sevices as a convenience to
4636 * avoid having to implement a more complex mechanism around detection
4637 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004638 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004639 * @hide
4640 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004641 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004642 /**
4643 * Set when this broadcast is for a boot upgrade, a special mode that
4644 * allows the broadcast to be sent before the system is ready and launches
4645 * the app process with no providers running in it.
4646 * @hide
4647 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004648 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004649 /**
4650 * If set, the broadcast will always go to manifest receivers in background (cached
4651 * or not running) apps, regardless of whether that would be done by default. By
4652 * default they will only receive broadcasts if the broadcast has specified an
4653 * explicit component or package name.
4654 * @hide
4655 */
4656 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4657 /**
4658 * If set, the broadcast will never go to manifest receivers in background (cached
4659 * or not running) apps, regardless of whether that would be done by default. By
4660 * default they will receive broadcasts if the broadcast has specified an
4661 * explicit component or package name.
4662 * @hide
4663 */
4664 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004665
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004666 /**
4667 * @hide Flags that can't be changed with PendingIntent.
4668 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004669 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4670 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4671 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004672
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004673 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004674 // ---------------------------------------------------------------------
4675 // toUri() and parseUri() options.
4676
4677 /**
4678 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4679 * always has the "intent:" scheme. This syntax can be used when you want
4680 * to later disambiguate between URIs that are intended to describe an
4681 * Intent vs. all others that should be treated as raw URIs. When used
4682 * with {@link #parseUri}, any other scheme will result in a generic
4683 * VIEW action for that raw URI.
4684 */
4685 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004686
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004687 /**
4688 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4689 * always has the "android-app:" scheme. This is a variation of
4690 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4691 * http/https URI being delivered to a specific package name. The format
4692 * is:
4693 *
4694 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004695 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004696 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004697 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4698 * you must also include a scheme; including a path also requires both a host and a scheme.
4699 * The final #Intent; fragment can be used without a scheme, host, or path.
4700 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004701 * used with intents that have a {@link #setSelector}, since the base intent
4702 * will always have an explicit package name.</p>
4703 *
4704 * <p>Some examples of how this scheme maps to Intent objects:</p>
4705 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4706 * <colgroup align="left" />
4707 * <colgroup align="left" />
4708 * <thead>
4709 * <tr><th>URI</th> <th>Intent</th></tr>
4710 * </thead>
4711 *
4712 * <tbody>
4713 * <tr><td><code>android-app://com.example.app</code></td>
4714 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4715 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4716 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4717 * </table></td>
4718 * </tr>
4719 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4720 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4721 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4722 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4723 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4724 * </table></td>
4725 * </tr>
4726 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4727 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4728 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4729 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4730 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4731 * </table></td>
4732 * </tr>
4733 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4734 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4735 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4736 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4737 * </table></td>
4738 * </tr>
4739 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4740 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4741 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4742 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4743 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4744 * </table></td>
4745 * </tr>
4746 * <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>
4747 * <td><table border="" style="margin:0" >
4748 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4749 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4750 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4751 * </table></td>
4752 * </tr>
4753 * </tbody>
4754 * </table>
4755 */
4756 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4757
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004758 /**
4759 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4760 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4761 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4762 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4763 * generated Intent can not cause unexpected data access to happen.
4764 *
4765 * <p>If you do not trust the source of the URI being parsed, you should still do further
4766 * processing to protect yourself from it. In particular, when using it to start an
4767 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4768 * that can handle it.</p>
4769 */
4770 public static final int URI_ALLOW_UNSAFE = 1<<2;
4771
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004772 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004773
4774 private String mAction;
4775 private Uri mData;
4776 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004777 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004778 private ComponentName mComponent;
4779 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004780 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004781 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004782 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004783 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004784 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004785 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004786
4787 // ---------------------------------------------------------------------
4788
4789 /**
4790 * Create an empty intent.
4791 */
4792 public Intent() {
4793 }
4794
4795 /**
4796 * Copy constructor.
4797 */
4798 public Intent(Intent o) {
4799 this.mAction = o.mAction;
4800 this.mData = o.mData;
4801 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004802 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004803 this.mComponent = o.mComponent;
4804 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004805 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004806 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004807 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004808 }
4809 if (o.mExtras != null) {
4810 this.mExtras = new Bundle(o.mExtras);
4811 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004812 if (o.mSourceBounds != null) {
4813 this.mSourceBounds = new Rect(o.mSourceBounds);
4814 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004815 if (o.mSelector != null) {
4816 this.mSelector = new Intent(o.mSelector);
4817 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004818 if (o.mClipData != null) {
4819 this.mClipData = new ClipData(o.mClipData);
4820 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004821 }
4822
4823 @Override
4824 public Object clone() {
4825 return new Intent(this);
4826 }
4827
4828 private Intent(Intent o, boolean all) {
4829 this.mAction = o.mAction;
4830 this.mData = o.mData;
4831 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004832 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004833 this.mComponent = o.mComponent;
4834 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004835 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004836 }
4837 }
4838
4839 /**
4840 * Make a clone of only the parts of the Intent that are relevant for
4841 * filter matching: the action, data, type, component, and categories.
4842 */
4843 public Intent cloneFilter() {
4844 return new Intent(this, false);
4845 }
4846
4847 /**
4848 * Create an intent with a given action. All other fields (data, type,
4849 * class) are null. Note that the action <em>must</em> be in a
4850 * namespace because Intents are used globally in the system -- for
4851 * example the system VIEW action is android.intent.action.VIEW; an
4852 * application's custom action would be something like
4853 * com.google.app.myapp.CUSTOM_ACTION.
4854 *
4855 * @param action The Intent action, such as ACTION_VIEW.
4856 */
4857 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004858 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004859 }
4860
4861 /**
4862 * Create an intent with a given action and for a given data url. Note
4863 * that the action <em>must</em> be in a namespace because Intents are
4864 * used globally in the system -- for example the system VIEW action is
4865 * android.intent.action.VIEW; an application's custom action would be
4866 * something like com.google.app.myapp.CUSTOM_ACTION.
4867 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004868 * <p><em>Note: scheme and host name matching in the Android framework is
4869 * case-sensitive, unlike the formal RFC. As a result,
4870 * you should always ensure that you write your Uri with these elements
4871 * using lower case letters, and normalize any Uris you receive from
4872 * outside of Android to ensure the scheme and host is lower case.</em></p>
4873 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004874 * @param action The Intent action, such as ACTION_VIEW.
4875 * @param uri The Intent data URI.
4876 */
4877 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004878 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004879 mData = uri;
4880 }
4881
4882 /**
4883 * Create an intent for a specific component. All other fields (action, data,
4884 * type, class) are null, though they can be modified later with explicit
4885 * calls. This provides a convenient way to create an intent that is
4886 * intended to execute a hard-coded class name, rather than relying on the
4887 * system to find an appropriate class for you; see {@link #setComponent}
4888 * for more information on the repercussions of this.
4889 *
4890 * @param packageContext A Context of the application package implementing
4891 * this class.
4892 * @param cls The component class that is to be used for the intent.
4893 *
4894 * @see #setClass
4895 * @see #setComponent
4896 * @see #Intent(String, android.net.Uri , Context, Class)
4897 */
4898 public Intent(Context packageContext, Class<?> cls) {
4899 mComponent = new ComponentName(packageContext, cls);
4900 }
4901
4902 /**
4903 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004904 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004905 * construct the Intent and then calling {@link #setClass} to set its
4906 * class.
4907 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004908 * <p><em>Note: scheme and host name matching in the Android framework is
4909 * case-sensitive, unlike the formal RFC. As a result,
4910 * you should always ensure that you write your Uri with these elements
4911 * using lower case letters, and normalize any Uris you receive from
4912 * outside of Android to ensure the scheme and host is lower case.</em></p>
4913 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004914 * @param action The Intent action, such as ACTION_VIEW.
4915 * @param uri The Intent data URI.
4916 * @param packageContext A Context of the application package implementing
4917 * this class.
4918 * @param cls The component class that is to be used for the intent.
4919 *
4920 * @see #Intent(String, android.net.Uri)
4921 * @see #Intent(Context, Class)
4922 * @see #setClass
4923 * @see #setComponent
4924 */
4925 public Intent(String action, Uri uri,
4926 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004927 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004928 mData = uri;
4929 mComponent = new ComponentName(packageContext, cls);
4930 }
4931
4932 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004933 * Create an intent to launch the main (root) activity of a task. This
4934 * is the Intent that is started when the application's is launched from
4935 * Home. For anything else that wants to launch an application in the
4936 * same way, it is important that they use an Intent structured the same
4937 * way, and can use this function to ensure this is the case.
4938 *
4939 * <p>The returned Intent has the given Activity component as its explicit
4940 * component, {@link #ACTION_MAIN} as its action, and includes the
4941 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4942 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4943 * to do that through {@link #addFlags(int)} on the returned Intent.
4944 *
4945 * @param mainActivity The main activity component that this Intent will
4946 * launch.
4947 * @return Returns a newly created Intent that can be used to launch the
4948 * activity as a main application entry.
4949 *
4950 * @see #setClass
4951 * @see #setComponent
4952 */
4953 public static Intent makeMainActivity(ComponentName mainActivity) {
4954 Intent intent = new Intent(ACTION_MAIN);
4955 intent.setComponent(mainActivity);
4956 intent.addCategory(CATEGORY_LAUNCHER);
4957 return intent;
4958 }
4959
4960 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004961 * Make an Intent for the main activity of an application, without
4962 * specifying a specific activity to run but giving a selector to find
4963 * the activity. This results in a final Intent that is structured
4964 * the same as when the application is launched from
4965 * Home. For anything else that wants to launch an application in the
4966 * same way, it is important that they use an Intent structured the same
4967 * way, and can use this function to ensure this is the case.
4968 *
4969 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4970 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4971 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4972 * to do that through {@link #addFlags(int)} on the returned Intent.
4973 *
4974 * @param selectorAction The action name of the Intent's selector.
4975 * @param selectorCategory The name of a category to add to the Intent's
4976 * selector.
4977 * @return Returns a newly created Intent that can be used to launch the
4978 * activity as a main application entry.
4979 *
4980 * @see #setSelector(Intent)
4981 */
4982 public static Intent makeMainSelectorActivity(String selectorAction,
4983 String selectorCategory) {
4984 Intent intent = new Intent(ACTION_MAIN);
4985 intent.addCategory(CATEGORY_LAUNCHER);
4986 Intent selector = new Intent();
4987 selector.setAction(selectorAction);
4988 selector.addCategory(selectorCategory);
4989 intent.setSelector(selector);
4990 return intent;
4991 }
4992
4993 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004994 * Make an Intent that can be used to re-launch an application's task
4995 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4996 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4997 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4998 *
4999 * @param mainActivity The activity component that is the root of the
5000 * task; this is the activity that has been published in the application's
5001 * manifest as the main launcher icon.
5002 *
5003 * @return Returns a newly created Intent that can be used to relaunch the
5004 * activity's task in its root state.
5005 */
5006 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5007 Intent intent = makeMainActivity(mainActivity);
5008 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5009 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5010 return intent;
5011 }
5012
5013 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005014 * Call {@link #parseUri} with 0 flags.
5015 * @deprecated Use {@link #parseUri} instead.
5016 */
5017 @Deprecated
5018 public static Intent getIntent(String uri) throws URISyntaxException {
5019 return parseUri(uri, 0);
5020 }
Tom Taylord4a47292009-12-21 13:59:18 -08005021
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005022 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005023 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005024 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005025 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005026 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005027 *
5028 * <p>The URI given here must not be relative -- that is, it must include
5029 * the scheme and full path.
5030 *
5031 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005032 * @param flags Additional processing flags. Either 0,
5033 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005034 *
5035 * @return Intent The newly created Intent object.
5036 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005037 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5038 * it bad (as parsed by the Uri class) or the Intent data within the
5039 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005040 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005041 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005042 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005043 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005044 int i = 0;
5045 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005046 final boolean androidApp = uri.startsWith("android-app:");
5047
5048 // Validate intent scheme if requested.
5049 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5050 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005051 Intent intent = new Intent(ACTION_VIEW);
5052 try {
5053 intent.setData(Uri.parse(uri));
5054 } catch (IllegalArgumentException e) {
5055 throw new URISyntaxException(uri, e.getMessage());
5056 }
5057 return intent;
5058 }
5059 }
Tom Taylord4a47292009-12-21 13:59:18 -08005060
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005061 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005062 // simple case
5063 if (i == -1) {
5064 if (!androidApp) {
5065 return new Intent(ACTION_VIEW, Uri.parse(uri));
5066 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005067
5068 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005069 } else if (!uri.startsWith("#Intent;", i)) {
5070 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005071 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005072 } else {
5073 i = -1;
5074 }
5075 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005076
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005077 // new format
5078 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005079 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005080 boolean explicitAction = false;
5081 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005082
5083 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005084 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005085 String data;
5086 if (i >= 0) {
5087 data = uri.substring(0, i);
5088 i += 8; // length of "#Intent;"
5089 } else {
5090 data = uri;
5091 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005092
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005093 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005094 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005095 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005096 if (eq < 0) eq = i-1;
5097 int semi = uri.indexOf(';', i);
5098 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005099
5100 // action
5101 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005102 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005103 if (!inSelector) {
5104 explicitAction = true;
5105 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005106 }
5107
5108 // categories
5109 else if (uri.startsWith("category=", i)) {
5110 intent.addCategory(value);
5111 }
5112
5113 // type
5114 else if (uri.startsWith("type=", i)) {
5115 intent.mType = value;
5116 }
5117
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005118 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005119 else if (uri.startsWith("launchFlags=", i)) {
5120 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005121 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5122 intent.mFlags &= ~IMMUTABLE_FLAGS;
5123 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005124 }
5125
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005126 // package
5127 else if (uri.startsWith("package=", i)) {
5128 intent.mPackage = value;
5129 }
5130
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005131 // component
5132 else if (uri.startsWith("component=", i)) {
5133 intent.mComponent = ComponentName.unflattenFromString(value);
5134 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005135
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005136 // scheme
5137 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005138 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005139 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005140 } else {
5141 scheme = value;
5142 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005143 }
5144
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005145 // source bounds
5146 else if (uri.startsWith("sourceBounds=", i)) {
5147 intent.mSourceBounds = Rect.unflattenFromString(value);
5148 }
5149
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005150 // selector
5151 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5152 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005153 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005154 }
5155
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005156 // extra
5157 else {
5158 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005159 // create Bundle if it doesn't already exist
5160 if (intent.mExtras == null) intent.mExtras = new Bundle();
5161 Bundle b = intent.mExtras;
5162 // add EXTRA
5163 if (uri.startsWith("S.", i)) b.putString(key, value);
5164 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5165 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5166 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5167 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5168 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5169 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5170 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5171 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5172 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5173 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005174
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005175 // move to the next item
5176 i = semi + 1;
5177 }
5178
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005179 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005180 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005181 if (baseIntent.mPackage == null) {
5182 baseIntent.setSelector(intent);
5183 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005184 intent = baseIntent;
5185 }
5186
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005187 if (data != null) {
5188 if (data.startsWith("intent:")) {
5189 data = data.substring(7);
5190 if (scheme != null) {
5191 data = scheme + ':' + data;
5192 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005193 } else if (data.startsWith("android-app:")) {
5194 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5195 // Correctly formed android-app, first part is package name.
5196 int end = data.indexOf('/', 14);
5197 if (end < 0) {
5198 // All we have is a package name.
5199 intent.mPackage = data.substring(14);
5200 if (!explicitAction) {
5201 intent.setAction(ACTION_MAIN);
5202 }
5203 data = "";
5204 } else {
5205 // Target the Intent at the given package name always.
5206 String authority = null;
5207 intent.mPackage = data.substring(14, end);
5208 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005209 if ((end+1) < data.length()) {
5210 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5211 // Found a scheme, remember it.
5212 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005213 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005214 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5215 // Found a authority, remember it.
5216 authority = data.substring(end+1, newEnd);
5217 end = newEnd;
5218 }
5219 } else {
5220 // All we have is a scheme.
5221 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005222 }
5223 }
5224 if (scheme == null) {
5225 // If there was no scheme, then this just targets the package.
5226 if (!explicitAction) {
5227 intent.setAction(ACTION_MAIN);
5228 }
5229 data = "";
5230 } else if (authority == null) {
5231 data = scheme + ":";
5232 } else {
5233 data = scheme + "://" + authority + data.substring(end);
5234 }
5235 }
5236 } else {
5237 data = "";
5238 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005239 }
Tom Taylord4a47292009-12-21 13:59:18 -08005240
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005241 if (data.length() > 0) {
5242 try {
5243 intent.mData = Uri.parse(data);
5244 } catch (IllegalArgumentException e) {
5245 throw new URISyntaxException(uri, e.getMessage());
5246 }
5247 }
5248 }
Tom Taylord4a47292009-12-21 13:59:18 -08005249
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005250 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005251
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005252 } catch (IndexOutOfBoundsException e) {
5253 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5254 }
5255 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005256
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005257 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005258 return getIntentOld(uri, 0);
5259 }
5260
5261 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005262 Intent intent;
5263
5264 int i = uri.lastIndexOf('#');
5265 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005266 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005267 final int intentFragmentStart = i;
5268 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005269
5270 i++;
5271
5272 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005273 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005274 i += 7;
5275 int j = uri.indexOf(')', i);
5276 action = uri.substring(i, j);
5277 i = j + 1;
5278 }
5279
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005280 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005281
5282 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005283 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005284 i += 11;
5285 int j = uri.indexOf(')', i);
5286 while (i < j) {
5287 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005288 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005289 if (i < sep) {
5290 intent.addCategory(uri.substring(i, sep));
5291 }
5292 i = sep + 1;
5293 }
5294 i = j + 1;
5295 }
5296
5297 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005298 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005299 i += 5;
5300 int j = uri.indexOf(')', i);
5301 intent.mType = uri.substring(i, j);
5302 i = j + 1;
5303 }
5304
5305 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005306 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005307 i += 12;
5308 int j = uri.indexOf(')', i);
5309 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005310 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5311 intent.mFlags &= ~IMMUTABLE_FLAGS;
5312 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005313 i = j + 1;
5314 }
5315
5316 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005317 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005318 i += 10;
5319 int j = uri.indexOf(')', i);
5320 int sep = uri.indexOf('!', i);
5321 if (sep >= 0 && sep < j) {
5322 String pkg = uri.substring(i, sep);
5323 String cls = uri.substring(sep + 1, j);
5324 intent.mComponent = new ComponentName(pkg, cls);
5325 }
5326 i = j + 1;
5327 }
5328
5329 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005330 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005331 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005332
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005333 final int closeParen = uri.indexOf(')', i);
5334 if (closeParen == -1) throw new URISyntaxException(uri,
5335 "EXTRA missing trailing ')'", i);
5336
5337 while (i < closeParen) {
5338 // fetch the key value
5339 int j = uri.indexOf('=', i);
5340 if (j <= i + 1 || i >= closeParen) {
5341 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5342 }
5343 char type = uri.charAt(i);
5344 i++;
5345 String key = uri.substring(i, j);
5346 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005347
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005348 // get type-value
5349 j = uri.indexOf('!', i);
5350 if (j == -1 || j >= closeParen) j = closeParen;
5351 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5352 String value = uri.substring(i, j);
5353 i = j;
5354
5355 // create Bundle if it doesn't already exist
5356 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005357
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005358 // add item to bundle
5359 try {
5360 switch (type) {
5361 case 'S':
5362 intent.mExtras.putString(key, Uri.decode(value));
5363 break;
5364 case 'B':
5365 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5366 break;
5367 case 'b':
5368 intent.mExtras.putByte(key, Byte.parseByte(value));
5369 break;
5370 case 'c':
5371 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5372 break;
5373 case 'd':
5374 intent.mExtras.putDouble(key, Double.parseDouble(value));
5375 break;
5376 case 'f':
5377 intent.mExtras.putFloat(key, Float.parseFloat(value));
5378 break;
5379 case 'i':
5380 intent.mExtras.putInt(key, Integer.parseInt(value));
5381 break;
5382 case 'l':
5383 intent.mExtras.putLong(key, Long.parseLong(value));
5384 break;
5385 case 's':
5386 intent.mExtras.putShort(key, Short.parseShort(value));
5387 break;
5388 default:
5389 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5390 }
5391 } catch (NumberFormatException e) {
5392 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5393 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005394
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005395 char ch = uri.charAt(i);
5396 if (ch == ')') break;
5397 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5398 i++;
5399 }
5400 }
5401
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005402 if (isIntentFragment) {
5403 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5404 } else {
5405 intent.mData = Uri.parse(uri);
5406 }
Tom Taylord4a47292009-12-21 13:59:18 -08005407
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005408 if (intent.mAction == null) {
5409 // By default, if no action is specified, then use VIEW.
5410 intent.mAction = ACTION_VIEW;
5411 }
5412
5413 } else {
5414 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5415 }
5416
5417 return intent;
5418 }
5419
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005420 /** @hide */
5421 public interface CommandOptionHandler {
5422 boolean handleOption(String opt, ShellCommand cmd);
5423 }
5424
5425 /** @hide */
5426 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5427 throws URISyntaxException {
5428 Intent intent = new Intent();
5429 Intent baseIntent = intent;
5430 boolean hasIntentInfo = false;
5431
5432 Uri data = null;
5433 String type = null;
5434
5435 String opt;
5436 while ((opt=cmd.getNextOption()) != null) {
5437 switch (opt) {
5438 case "-a":
5439 intent.setAction(cmd.getNextArgRequired());
5440 if (intent == baseIntent) {
5441 hasIntentInfo = true;
5442 }
5443 break;
5444 case "-d":
5445 data = Uri.parse(cmd.getNextArgRequired());
5446 if (intent == baseIntent) {
5447 hasIntentInfo = true;
5448 }
5449 break;
5450 case "-t":
5451 type = cmd.getNextArgRequired();
5452 if (intent == baseIntent) {
5453 hasIntentInfo = true;
5454 }
5455 break;
5456 case "-c":
5457 intent.addCategory(cmd.getNextArgRequired());
5458 if (intent == baseIntent) {
5459 hasIntentInfo = true;
5460 }
5461 break;
5462 case "-e":
5463 case "--es": {
5464 String key = cmd.getNextArgRequired();
5465 String value = cmd.getNextArgRequired();
5466 intent.putExtra(key, value);
5467 }
5468 break;
5469 case "--esn": {
5470 String key = cmd.getNextArgRequired();
5471 intent.putExtra(key, (String) null);
5472 }
5473 break;
5474 case "--ei": {
5475 String key = cmd.getNextArgRequired();
5476 String value = cmd.getNextArgRequired();
5477 intent.putExtra(key, Integer.decode(value));
5478 }
5479 break;
5480 case "--eu": {
5481 String key = cmd.getNextArgRequired();
5482 String value = cmd.getNextArgRequired();
5483 intent.putExtra(key, Uri.parse(value));
5484 }
5485 break;
5486 case "--ecn": {
5487 String key = cmd.getNextArgRequired();
5488 String value = cmd.getNextArgRequired();
5489 ComponentName cn = ComponentName.unflattenFromString(value);
5490 if (cn == null)
5491 throw new IllegalArgumentException("Bad component name: " + value);
5492 intent.putExtra(key, cn);
5493 }
5494 break;
5495 case "--eia": {
5496 String key = cmd.getNextArgRequired();
5497 String value = cmd.getNextArgRequired();
5498 String[] strings = value.split(",");
5499 int[] list = new int[strings.length];
5500 for (int i = 0; i < strings.length; i++) {
5501 list[i] = Integer.decode(strings[i]);
5502 }
5503 intent.putExtra(key, list);
5504 }
5505 break;
5506 case "--eial": {
5507 String key = cmd.getNextArgRequired();
5508 String value = cmd.getNextArgRequired();
5509 String[] strings = value.split(",");
5510 ArrayList<Integer> list = new ArrayList<>(strings.length);
5511 for (int i = 0; i < strings.length; i++) {
5512 list.add(Integer.decode(strings[i]));
5513 }
5514 intent.putExtra(key, list);
5515 }
5516 break;
5517 case "--el": {
5518 String key = cmd.getNextArgRequired();
5519 String value = cmd.getNextArgRequired();
5520 intent.putExtra(key, Long.valueOf(value));
5521 }
5522 break;
5523 case "--ela": {
5524 String key = cmd.getNextArgRequired();
5525 String value = cmd.getNextArgRequired();
5526 String[] strings = value.split(",");
5527 long[] list = new long[strings.length];
5528 for (int i = 0; i < strings.length; i++) {
5529 list[i] = Long.valueOf(strings[i]);
5530 }
5531 intent.putExtra(key, list);
5532 hasIntentInfo = true;
5533 }
5534 break;
5535 case "--elal": {
5536 String key = cmd.getNextArgRequired();
5537 String value = cmd.getNextArgRequired();
5538 String[] strings = value.split(",");
5539 ArrayList<Long> list = new ArrayList<>(strings.length);
5540 for (int i = 0; i < strings.length; i++) {
5541 list.add(Long.valueOf(strings[i]));
5542 }
5543 intent.putExtra(key, list);
5544 hasIntentInfo = true;
5545 }
5546 break;
5547 case "--ef": {
5548 String key = cmd.getNextArgRequired();
5549 String value = cmd.getNextArgRequired();
5550 intent.putExtra(key, Float.valueOf(value));
5551 hasIntentInfo = true;
5552 }
5553 break;
5554 case "--efa": {
5555 String key = cmd.getNextArgRequired();
5556 String value = cmd.getNextArgRequired();
5557 String[] strings = value.split(",");
5558 float[] list = new float[strings.length];
5559 for (int i = 0; i < strings.length; i++) {
5560 list[i] = Float.valueOf(strings[i]);
5561 }
5562 intent.putExtra(key, list);
5563 hasIntentInfo = true;
5564 }
5565 break;
5566 case "--efal": {
5567 String key = cmd.getNextArgRequired();
5568 String value = cmd.getNextArgRequired();
5569 String[] strings = value.split(",");
5570 ArrayList<Float> list = new ArrayList<>(strings.length);
5571 for (int i = 0; i < strings.length; i++) {
5572 list.add(Float.valueOf(strings[i]));
5573 }
5574 intent.putExtra(key, list);
5575 hasIntentInfo = true;
5576 }
5577 break;
5578 case "--esa": {
5579 String key = cmd.getNextArgRequired();
5580 String value = cmd.getNextArgRequired();
5581 // Split on commas unless they are preceeded by an escape.
5582 // The escape character must be escaped for the string and
5583 // again for the regex, thus four escape characters become one.
5584 String[] strings = value.split("(?<!\\\\),");
5585 intent.putExtra(key, strings);
5586 hasIntentInfo = true;
5587 }
5588 break;
5589 case "--esal": {
5590 String key = cmd.getNextArgRequired();
5591 String value = cmd.getNextArgRequired();
5592 // Split on commas unless they are preceeded by an escape.
5593 // The escape character must be escaped for the string and
5594 // again for the regex, thus four escape characters become one.
5595 String[] strings = value.split("(?<!\\\\),");
5596 ArrayList<String> list = new ArrayList<>(strings.length);
5597 for (int i = 0; i < strings.length; i++) {
5598 list.add(strings[i]);
5599 }
5600 intent.putExtra(key, list);
5601 hasIntentInfo = true;
5602 }
5603 break;
5604 case "--ez": {
5605 String key = cmd.getNextArgRequired();
5606 String value = cmd.getNextArgRequired().toLowerCase();
5607 // Boolean.valueOf() results in false for anything that is not "true", which is
5608 // error-prone in shell commands
5609 boolean arg;
5610 if ("true".equals(value) || "t".equals(value)) {
5611 arg = true;
5612 } else if ("false".equals(value) || "f".equals(value)) {
5613 arg = false;
5614 } else {
5615 try {
5616 arg = Integer.decode(value) != 0;
5617 } catch (NumberFormatException ex) {
5618 throw new IllegalArgumentException("Invalid boolean value: " + value);
5619 }
5620 }
5621
5622 intent.putExtra(key, arg);
5623 }
5624 break;
5625 case "-n": {
5626 String str = cmd.getNextArgRequired();
5627 ComponentName cn = ComponentName.unflattenFromString(str);
5628 if (cn == null)
5629 throw new IllegalArgumentException("Bad component name: " + str);
5630 intent.setComponent(cn);
5631 if (intent == baseIntent) {
5632 hasIntentInfo = true;
5633 }
5634 }
5635 break;
5636 case "-p": {
5637 String str = cmd.getNextArgRequired();
5638 intent.setPackage(str);
5639 if (intent == baseIntent) {
5640 hasIntentInfo = true;
5641 }
5642 }
5643 break;
5644 case "-f":
5645 String str = cmd.getNextArgRequired();
5646 intent.setFlags(Integer.decode(str).intValue());
5647 break;
5648 case "--grant-read-uri-permission":
5649 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5650 break;
5651 case "--grant-write-uri-permission":
5652 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5653 break;
5654 case "--grant-persistable-uri-permission":
5655 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5656 break;
5657 case "--grant-prefix-uri-permission":
5658 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5659 break;
5660 case "--exclude-stopped-packages":
5661 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5662 break;
5663 case "--include-stopped-packages":
5664 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5665 break;
5666 case "--debug-log-resolution":
5667 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5668 break;
5669 case "--activity-brought-to-front":
5670 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5671 break;
5672 case "--activity-clear-top":
5673 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5674 break;
5675 case "--activity-clear-when-task-reset":
5676 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5677 break;
5678 case "--activity-exclude-from-recents":
5679 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5680 break;
5681 case "--activity-launched-from-history":
5682 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5683 break;
5684 case "--activity-multiple-task":
5685 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5686 break;
5687 case "--activity-no-animation":
5688 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5689 break;
5690 case "--activity-no-history":
5691 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5692 break;
5693 case "--activity-no-user-action":
5694 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5695 break;
5696 case "--activity-previous-is-top":
5697 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5698 break;
5699 case "--activity-reorder-to-front":
5700 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5701 break;
5702 case "--activity-reset-task-if-needed":
5703 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5704 break;
5705 case "--activity-single-top":
5706 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5707 break;
5708 case "--activity-clear-task":
5709 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5710 break;
5711 case "--activity-task-on-home":
5712 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5713 break;
5714 case "--receiver-registered-only":
5715 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5716 break;
5717 case "--receiver-replace-pending":
5718 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5719 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005720 case "--receiver-foreground":
5721 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5722 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005723 case "--selector":
5724 intent.setDataAndType(data, type);
5725 intent = new Intent();
5726 break;
5727 default:
5728 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5729 // Okay, caller handled this option.
5730 } else {
5731 throw new IllegalArgumentException("Unknown option: " + opt);
5732 }
5733 break;
5734 }
5735 }
5736 intent.setDataAndType(data, type);
5737
5738 final boolean hasSelector = intent != baseIntent;
5739 if (hasSelector) {
5740 // A selector was specified; fix up.
5741 baseIntent.setSelector(intent);
5742 intent = baseIntent;
5743 }
5744
5745 String arg = cmd.getNextArg();
5746 baseIntent = null;
5747 if (arg == null) {
5748 if (hasSelector) {
5749 // If a selector has been specified, and no arguments
5750 // have been supplied for the main Intent, then we can
5751 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5752 // need to have a component name specified yet, the
5753 // selector will take care of that.
5754 baseIntent = new Intent(Intent.ACTION_MAIN);
5755 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5756 }
5757 } else if (arg.indexOf(':') >= 0) {
5758 // The argument is a URI. Fully parse it, and use that result
5759 // to fill in any data not specified so far.
5760 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5761 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5762 } else if (arg.indexOf('/') >= 0) {
5763 // The argument is a component name. Build an Intent to launch
5764 // it.
5765 baseIntent = new Intent(Intent.ACTION_MAIN);
5766 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5767 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5768 } else {
5769 // Assume the argument is a package name.
5770 baseIntent = new Intent(Intent.ACTION_MAIN);
5771 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5772 baseIntent.setPackage(arg);
5773 }
5774 if (baseIntent != null) {
5775 Bundle extras = intent.getExtras();
5776 intent.replaceExtras((Bundle)null);
5777 Bundle uriExtras = baseIntent.getExtras();
5778 baseIntent.replaceExtras((Bundle)null);
5779 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5780 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5781 for (String c : cats) {
5782 baseIntent.removeCategory(c);
5783 }
5784 }
5785 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5786 if (extras == null) {
5787 extras = uriExtras;
5788 } else if (uriExtras != null) {
5789 uriExtras.putAll(extras);
5790 extras = uriExtras;
5791 }
5792 intent.replaceExtras(extras);
5793 hasIntentInfo = true;
5794 }
5795
5796 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5797 return intent;
5798 }
5799
5800 /** @hide */
5801 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5802 final String[] lines = new String[] {
5803 "<INTENT> specifications include these flags and arguments:",
5804 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5805 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5806 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5807 " [--esn <EXTRA_KEY> ...]",
5808 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5809 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5810 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5811 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5812 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5813 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5814 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5815 " (mutiple extras passed as Integer[])",
5816 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5817 " (mutiple extras passed as List<Integer>)",
5818 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5819 " (mutiple extras passed as Long[])",
5820 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5821 " (mutiple extras passed as List<Long>)",
5822 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5823 " (mutiple extras passed as Float[])",
5824 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5825 " (mutiple extras passed as List<Float>)",
5826 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5827 " (mutiple extras passed as String[]; to embed a comma into a string,",
5828 " escape it using \"\\,\")",
5829 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5830 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5831 " escape it using \"\\,\")",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005832 " [--f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005833 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5834 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5835 " [--debug-log-resolution] [--exclude-stopped-packages]",
5836 " [--include-stopped-packages]",
5837 " [--activity-brought-to-front] [--activity-clear-top]",
5838 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5839 " [--activity-launched-from-history] [--activity-multiple-task]",
5840 " [--activity-no-animation] [--activity-no-history]",
5841 " [--activity-no-user-action] [--activity-previous-is-top]",
5842 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5843 " [--activity-single-top] [--activity-clear-task]",
5844 " [--activity-task-on-home]",
5845 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005846 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005847 " [--selector]",
5848 " [<URI> | <PACKAGE> | <COMPONENT>]"
5849 };
5850 for (String line : lines) {
5851 pw.print(prefix);
5852 pw.println(line);
5853 }
5854 }
5855
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005856 /**
5857 * Retrieve the general action to be performed, such as
5858 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5859 * the information in the intent should be interpreted -- most importantly,
5860 * what to do with the data returned by {@link #getData}.
5861 *
5862 * @return The action of this intent or null if none is specified.
5863 *
5864 * @see #setAction
5865 */
5866 public String getAction() {
5867 return mAction;
5868 }
5869
5870 /**
5871 * Retrieve data this intent is operating on. This URI specifies the name
5872 * of the data; often it uses the content: scheme, specifying data in a
5873 * content provider. Other schemes may be handled by specific activities,
5874 * such as http: by the web browser.
5875 *
5876 * @return The URI of the data this intent is targeting or null.
5877 *
5878 * @see #getScheme
5879 * @see #setData
5880 */
5881 public Uri getData() {
5882 return mData;
5883 }
5884
5885 /**
5886 * The same as {@link #getData()}, but returns the URI as an encoded
5887 * String.
5888 */
5889 public String getDataString() {
5890 return mData != null ? mData.toString() : null;
5891 }
5892
5893 /**
5894 * Return the scheme portion of the intent's data. If the data is null or
5895 * does not include a scheme, null is returned. Otherwise, the scheme
5896 * prefix without the final ':' is returned, i.e. "http".
5897 *
5898 * <p>This is the same as calling getData().getScheme() (and checking for
5899 * null data).
5900 *
5901 * @return The scheme of this intent.
5902 *
5903 * @see #getData
5904 */
5905 public String getScheme() {
5906 return mData != null ? mData.getScheme() : null;
5907 }
5908
5909 /**
5910 * Retrieve any explicit MIME type included in the intent. This is usually
5911 * null, as the type is determined by the intent data.
5912 *
5913 * @return If a type was manually set, it is returned; else null is
5914 * returned.
5915 *
5916 * @see #resolveType(ContentResolver)
5917 * @see #setType
5918 */
5919 public String getType() {
5920 return mType;
5921 }
5922
5923 /**
5924 * Return the MIME data type of this intent. If the type field is
5925 * explicitly set, that is simply returned. Otherwise, if the data is set,
5926 * the type of that data is returned. If neither fields are set, a null is
5927 * returned.
5928 *
5929 * @return The MIME type of this intent.
5930 *
5931 * @see #getType
5932 * @see #resolveType(ContentResolver)
5933 */
5934 public String resolveType(Context context) {
5935 return resolveType(context.getContentResolver());
5936 }
5937
5938 /**
5939 * Return the MIME data type of this intent. If the type field is
5940 * explicitly set, that is simply returned. Otherwise, if the data is set,
5941 * the type of that data is returned. If neither fields are set, a null is
5942 * returned.
5943 *
5944 * @param resolver A ContentResolver that can be used to determine the MIME
5945 * type of the intent's data.
5946 *
5947 * @return The MIME type of this intent.
5948 *
5949 * @see #getType
5950 * @see #resolveType(Context)
5951 */
5952 public String resolveType(ContentResolver resolver) {
5953 if (mType != null) {
5954 return mType;
5955 }
5956 if (mData != null) {
5957 if ("content".equals(mData.getScheme())) {
5958 return resolver.getType(mData);
5959 }
5960 }
5961 return null;
5962 }
5963
5964 /**
5965 * Return the MIME data type of this intent, only if it will be needed for
5966 * intent resolution. This is not generally useful for application code;
5967 * it is used by the frameworks for communicating with back-end system
5968 * services.
5969 *
5970 * @param resolver A ContentResolver that can be used to determine the MIME
5971 * type of the intent's data.
5972 *
5973 * @return The MIME type of this intent, or null if it is unknown or not
5974 * needed.
5975 */
5976 public String resolveTypeIfNeeded(ContentResolver resolver) {
5977 if (mComponent != null) {
5978 return mType;
5979 }
5980 return resolveType(resolver);
5981 }
5982
5983 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005984 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005985 *
5986 * @param category The category to check.
5987 *
5988 * @return boolean True if the intent contains the category, else false.
5989 *
5990 * @see #getCategories
5991 * @see #addCategory
5992 */
5993 public boolean hasCategory(String category) {
5994 return mCategories != null && mCategories.contains(category);
5995 }
5996
5997 /**
5998 * Return the set of all categories in the intent. If there are no categories,
5999 * returns NULL.
6000 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006001 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006002 *
6003 * @see #hasCategory
6004 * @see #addCategory
6005 */
6006 public Set<String> getCategories() {
6007 return mCategories;
6008 }
6009
6010 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006011 * Return the specific selector associated with this Intent. If there is
6012 * none, returns null. See {@link #setSelector} for more information.
6013 *
6014 * @see #setSelector
6015 */
6016 public Intent getSelector() {
6017 return mSelector;
6018 }
6019
6020 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006021 * Return the {@link ClipData} associated with this Intent. If there is
6022 * none, returns null. See {@link #setClipData} for more information.
6023 *
John Spurlock125d1332013-11-25 11:58:37 -05006024 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006025 */
6026 public ClipData getClipData() {
6027 return mClipData;
6028 }
6029
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006030 /** @hide */
6031 public int getContentUserHint() {
6032 return mContentUserHint;
6033 }
6034
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006035 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006036 * Sets the ClassLoader that will be used when unmarshalling
6037 * any Parcelable values from the extras of this Intent.
6038 *
6039 * @param loader a ClassLoader, or null to use the default loader
6040 * at the time of unmarshalling.
6041 */
6042 public void setExtrasClassLoader(ClassLoader loader) {
6043 if (mExtras != null) {
6044 mExtras.setClassLoader(loader);
6045 }
6046 }
6047
6048 /**
6049 * Returns true if an extra value is associated with the given name.
6050 * @param name the extra's name
6051 * @return true if the given extra is present.
6052 */
6053 public boolean hasExtra(String name) {
6054 return mExtras != null && mExtras.containsKey(name);
6055 }
6056
6057 /**
6058 * Returns true if the Intent's extras contain a parcelled file descriptor.
6059 * @return true if the Intent contains a parcelled file descriptor.
6060 */
6061 public boolean hasFileDescriptors() {
6062 return mExtras != null && mExtras.hasFileDescriptors();
6063 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006064
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006065 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006066 public void setAllowFds(boolean allowFds) {
6067 if (mExtras != null) {
6068 mExtras.setAllowFds(allowFds);
6069 }
6070 }
6071
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006072 /** {@hide} */
6073 public void setDefusable(boolean defusable) {
6074 if (mExtras != null) {
6075 mExtras.setDefusable(defusable);
6076 }
6077 }
6078
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006079 /**
6080 * Retrieve extended data from the intent.
6081 *
6082 * @param name The name of the desired item.
6083 *
6084 * @return the value of an item that previously added with putExtra()
6085 * or null if none was found.
6086 *
6087 * @deprecated
6088 * @hide
6089 */
6090 @Deprecated
6091 public Object getExtra(String name) {
6092 return getExtra(name, null);
6093 }
6094
6095 /**
6096 * Retrieve extended data from the intent.
6097 *
6098 * @param name The name of the desired item.
6099 * @param defaultValue the value to be returned if no value of the desired
6100 * type is stored with the given name.
6101 *
6102 * @return the value of an item that previously added with putExtra()
6103 * or the default value if none was found.
6104 *
6105 * @see #putExtra(String, boolean)
6106 */
6107 public boolean getBooleanExtra(String name, boolean defaultValue) {
6108 return mExtras == null ? defaultValue :
6109 mExtras.getBoolean(name, defaultValue);
6110 }
6111
6112 /**
6113 * Retrieve extended data from the intent.
6114 *
6115 * @param name The name of the desired item.
6116 * @param defaultValue the value to be returned if no value of the desired
6117 * type is stored with the given name.
6118 *
6119 * @return the value of an item that previously added with putExtra()
6120 * or the default value if none was found.
6121 *
6122 * @see #putExtra(String, byte)
6123 */
6124 public byte getByteExtra(String name, byte defaultValue) {
6125 return mExtras == null ? defaultValue :
6126 mExtras.getByte(name, defaultValue);
6127 }
6128
6129 /**
6130 * Retrieve extended data from the intent.
6131 *
6132 * @param name The name of the desired item.
6133 * @param defaultValue the value to be returned if no value of the desired
6134 * type is stored with the given name.
6135 *
6136 * @return the value of an item that previously added with putExtra()
6137 * or the default value if none was found.
6138 *
6139 * @see #putExtra(String, short)
6140 */
6141 public short getShortExtra(String name, short defaultValue) {
6142 return mExtras == null ? defaultValue :
6143 mExtras.getShort(name, defaultValue);
6144 }
6145
6146 /**
6147 * Retrieve extended data from the intent.
6148 *
6149 * @param name The name of the desired item.
6150 * @param defaultValue the value to be returned if no value of the desired
6151 * type is stored with the given name.
6152 *
6153 * @return the value of an item that previously added with putExtra()
6154 * or the default value if none was found.
6155 *
6156 * @see #putExtra(String, char)
6157 */
6158 public char getCharExtra(String name, char defaultValue) {
6159 return mExtras == null ? defaultValue :
6160 mExtras.getChar(name, defaultValue);
6161 }
6162
6163 /**
6164 * Retrieve extended data from the intent.
6165 *
6166 * @param name The name of the desired item.
6167 * @param defaultValue the value to be returned if no value of the desired
6168 * type is stored with the given name.
6169 *
6170 * @return the value of an item that previously added with putExtra()
6171 * or the default value if none was found.
6172 *
6173 * @see #putExtra(String, int)
6174 */
6175 public int getIntExtra(String name, int defaultValue) {
6176 return mExtras == null ? defaultValue :
6177 mExtras.getInt(name, defaultValue);
6178 }
6179
6180 /**
6181 * Retrieve extended data from the intent.
6182 *
6183 * @param name The name of the desired item.
6184 * @param defaultValue the value to be returned if no value of the desired
6185 * type is stored with the given name.
6186 *
6187 * @return the value of an item that previously added with putExtra()
6188 * or the default value if none was found.
6189 *
6190 * @see #putExtra(String, long)
6191 */
6192 public long getLongExtra(String name, long defaultValue) {
6193 return mExtras == null ? defaultValue :
6194 mExtras.getLong(name, defaultValue);
6195 }
6196
6197 /**
6198 * Retrieve extended data from the intent.
6199 *
6200 * @param name The name of the desired item.
6201 * @param defaultValue the value to be returned if no value of the desired
6202 * type is stored with the given name.
6203 *
6204 * @return the value of an item that previously added with putExtra(),
6205 * or the default value if no such item is present
6206 *
6207 * @see #putExtra(String, float)
6208 */
6209 public float getFloatExtra(String name, float defaultValue) {
6210 return mExtras == null ? defaultValue :
6211 mExtras.getFloat(name, defaultValue);
6212 }
6213
6214 /**
6215 * Retrieve extended data from the intent.
6216 *
6217 * @param name The name of the desired item.
6218 * @param defaultValue the value to be returned if no value of the desired
6219 * type is stored with the given name.
6220 *
6221 * @return the value of an item that previously added with putExtra()
6222 * or the default value if none was found.
6223 *
6224 * @see #putExtra(String, double)
6225 */
6226 public double getDoubleExtra(String name, double defaultValue) {
6227 return mExtras == null ? defaultValue :
6228 mExtras.getDouble(name, defaultValue);
6229 }
6230
6231 /**
6232 * Retrieve extended data from the intent.
6233 *
6234 * @param name The name of the desired item.
6235 *
6236 * @return the value of an item that previously added with putExtra()
6237 * or null if no String value was found.
6238 *
6239 * @see #putExtra(String, String)
6240 */
6241 public String getStringExtra(String name) {
6242 return mExtras == null ? null : mExtras.getString(name);
6243 }
6244
6245 /**
6246 * Retrieve extended data from the intent.
6247 *
6248 * @param name The name of the desired item.
6249 *
6250 * @return the value of an item that previously added with putExtra()
6251 * or null if no CharSequence value was found.
6252 *
6253 * @see #putExtra(String, CharSequence)
6254 */
6255 public CharSequence getCharSequenceExtra(String name) {
6256 return mExtras == null ? null : mExtras.getCharSequence(name);
6257 }
6258
6259 /**
6260 * Retrieve extended data from the intent.
6261 *
6262 * @param name The name of the desired item.
6263 *
6264 * @return the value of an item that previously added with putExtra()
6265 * or null if no Parcelable value was found.
6266 *
6267 * @see #putExtra(String, Parcelable)
6268 */
6269 public <T extends Parcelable> T getParcelableExtra(String name) {
6270 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6271 }
6272
6273 /**
6274 * Retrieve extended data from the intent.
6275 *
6276 * @param name The name of the desired item.
6277 *
6278 * @return the value of an item that previously added with putExtra()
6279 * or null if no Parcelable[] value was found.
6280 *
6281 * @see #putExtra(String, Parcelable[])
6282 */
6283 public Parcelable[] getParcelableArrayExtra(String name) {
6284 return mExtras == null ? null : mExtras.getParcelableArray(name);
6285 }
6286
6287 /**
6288 * Retrieve extended data from the intent.
6289 *
6290 * @param name The name of the desired item.
6291 *
6292 * @return the value of an item that previously added with putExtra()
6293 * or null if no ArrayList<Parcelable> value was found.
6294 *
6295 * @see #putParcelableArrayListExtra(String, ArrayList)
6296 */
6297 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6298 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6299 }
6300
6301 /**
6302 * Retrieve extended data from the intent.
6303 *
6304 * @param name The name of the desired item.
6305 *
6306 * @return the value of an item that previously added with putExtra()
6307 * or null if no Serializable value was found.
6308 *
6309 * @see #putExtra(String, Serializable)
6310 */
6311 public Serializable getSerializableExtra(String name) {
6312 return mExtras == null ? null : mExtras.getSerializable(name);
6313 }
6314
6315 /**
6316 * Retrieve extended data from the intent.
6317 *
6318 * @param name The name of the desired item.
6319 *
6320 * @return the value of an item that previously added with putExtra()
6321 * or null if no ArrayList<Integer> value was found.
6322 *
6323 * @see #putIntegerArrayListExtra(String, ArrayList)
6324 */
6325 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6326 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6327 }
6328
6329 /**
6330 * Retrieve extended data from the intent.
6331 *
6332 * @param name The name of the desired item.
6333 *
6334 * @return the value of an item that previously added with putExtra()
6335 * or null if no ArrayList<String> value was found.
6336 *
6337 * @see #putStringArrayListExtra(String, ArrayList)
6338 */
6339 public ArrayList<String> getStringArrayListExtra(String name) {
6340 return mExtras == null ? null : mExtras.getStringArrayList(name);
6341 }
6342
6343 /**
6344 * Retrieve extended data from the intent.
6345 *
6346 * @param name The name of the desired item.
6347 *
6348 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006349 * or null if no ArrayList<CharSequence> value was found.
6350 *
6351 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6352 */
6353 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6354 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6355 }
6356
6357 /**
6358 * Retrieve extended data from the intent.
6359 *
6360 * @param name The name of the desired item.
6361 *
6362 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006363 * or null if no boolean array value was found.
6364 *
6365 * @see #putExtra(String, boolean[])
6366 */
6367 public boolean[] getBooleanArrayExtra(String name) {
6368 return mExtras == null ? null : mExtras.getBooleanArray(name);
6369 }
6370
6371 /**
6372 * Retrieve extended data from the intent.
6373 *
6374 * @param name The name of the desired item.
6375 *
6376 * @return the value of an item that previously added with putExtra()
6377 * or null if no byte array value was found.
6378 *
6379 * @see #putExtra(String, byte[])
6380 */
6381 public byte[] getByteArrayExtra(String name) {
6382 return mExtras == null ? null : mExtras.getByteArray(name);
6383 }
6384
6385 /**
6386 * Retrieve extended data from the intent.
6387 *
6388 * @param name The name of the desired item.
6389 *
6390 * @return the value of an item that previously added with putExtra()
6391 * or null if no short array value was found.
6392 *
6393 * @see #putExtra(String, short[])
6394 */
6395 public short[] getShortArrayExtra(String name) {
6396 return mExtras == null ? null : mExtras.getShortArray(name);
6397 }
6398
6399 /**
6400 * Retrieve extended data from the intent.
6401 *
6402 * @param name The name of the desired item.
6403 *
6404 * @return the value of an item that previously added with putExtra()
6405 * or null if no char array value was found.
6406 *
6407 * @see #putExtra(String, char[])
6408 */
6409 public char[] getCharArrayExtra(String name) {
6410 return mExtras == null ? null : mExtras.getCharArray(name);
6411 }
6412
6413 /**
6414 * Retrieve extended data from the intent.
6415 *
6416 * @param name The name of the desired item.
6417 *
6418 * @return the value of an item that previously added with putExtra()
6419 * or null if no int array value was found.
6420 *
6421 * @see #putExtra(String, int[])
6422 */
6423 public int[] getIntArrayExtra(String name) {
6424 return mExtras == null ? null : mExtras.getIntArray(name);
6425 }
6426
6427 /**
6428 * Retrieve extended data from the intent.
6429 *
6430 * @param name The name of the desired item.
6431 *
6432 * @return the value of an item that previously added with putExtra()
6433 * or null if no long array value was found.
6434 *
6435 * @see #putExtra(String, long[])
6436 */
6437 public long[] getLongArrayExtra(String name) {
6438 return mExtras == null ? null : mExtras.getLongArray(name);
6439 }
6440
6441 /**
6442 * Retrieve extended data from the intent.
6443 *
6444 * @param name The name of the desired item.
6445 *
6446 * @return the value of an item that previously added with putExtra()
6447 * or null if no float array value was found.
6448 *
6449 * @see #putExtra(String, float[])
6450 */
6451 public float[] getFloatArrayExtra(String name) {
6452 return mExtras == null ? null : mExtras.getFloatArray(name);
6453 }
6454
6455 /**
6456 * Retrieve extended data from the intent.
6457 *
6458 * @param name The name of the desired item.
6459 *
6460 * @return the value of an item that previously added with putExtra()
6461 * or null if no double array value was found.
6462 *
6463 * @see #putExtra(String, double[])
6464 */
6465 public double[] getDoubleArrayExtra(String name) {
6466 return mExtras == null ? null : mExtras.getDoubleArray(name);
6467 }
6468
6469 /**
6470 * Retrieve extended data from the intent.
6471 *
6472 * @param name The name of the desired item.
6473 *
6474 * @return the value of an item that previously added with putExtra()
6475 * or null if no String array value was found.
6476 *
6477 * @see #putExtra(String, String[])
6478 */
6479 public String[] getStringArrayExtra(String name) {
6480 return mExtras == null ? null : mExtras.getStringArray(name);
6481 }
6482
6483 /**
6484 * Retrieve extended data from the intent.
6485 *
6486 * @param name The name of the desired item.
6487 *
6488 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006489 * or null if no CharSequence array value was found.
6490 *
6491 * @see #putExtra(String, CharSequence[])
6492 */
6493 public CharSequence[] getCharSequenceArrayExtra(String name) {
6494 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6495 }
6496
6497 /**
6498 * Retrieve extended data from the intent.
6499 *
6500 * @param name The name of the desired item.
6501 *
6502 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006503 * or null if no Bundle value was found.
6504 *
6505 * @see #putExtra(String, Bundle)
6506 */
6507 public Bundle getBundleExtra(String name) {
6508 return mExtras == null ? null : mExtras.getBundle(name);
6509 }
6510
6511 /**
6512 * Retrieve extended data from the intent.
6513 *
6514 * @param name The name of the desired item.
6515 *
6516 * @return the value of an item that previously added with putExtra()
6517 * or null if no IBinder value was found.
6518 *
6519 * @see #putExtra(String, IBinder)
6520 *
6521 * @deprecated
6522 * @hide
6523 */
6524 @Deprecated
6525 public IBinder getIBinderExtra(String name) {
6526 return mExtras == null ? null : mExtras.getIBinder(name);
6527 }
6528
6529 /**
6530 * Retrieve extended data from the intent.
6531 *
6532 * @param name The name of the desired item.
6533 * @param defaultValue The default value to return in case no item is
6534 * associated with the key 'name'
6535 *
6536 * @return the value of an item that previously added with putExtra()
6537 * or defaultValue if none was found.
6538 *
6539 * @see #putExtra
6540 *
6541 * @deprecated
6542 * @hide
6543 */
6544 @Deprecated
6545 public Object getExtra(String name, Object defaultValue) {
6546 Object result = defaultValue;
6547 if (mExtras != null) {
6548 Object result2 = mExtras.get(name);
6549 if (result2 != null) {
6550 result = result2;
6551 }
6552 }
6553
6554 return result;
6555 }
6556
6557 /**
6558 * Retrieves a map of extended data from the intent.
6559 *
6560 * @return the map of all extras previously added with putExtra(),
6561 * or null if none have been added.
6562 */
6563 public Bundle getExtras() {
6564 return (mExtras != null)
6565 ? new Bundle(mExtras)
6566 : null;
6567 }
6568
6569 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006570 * Filter extras to only basic types.
6571 * @hide
6572 */
6573 public void removeUnsafeExtras() {
6574 if (mExtras != null) {
6575 mExtras.filterValues();
6576 }
6577 }
6578
6579 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006580 * Retrieve any special flags associated with this intent. You will
6581 * normally just set them with {@link #setFlags} and let the system
6582 * take the appropriate action with them.
6583 *
6584 * @return int The currently set flags.
6585 *
6586 * @see #setFlags
6587 */
6588 public int getFlags() {
6589 return mFlags;
6590 }
6591
Dianne Hackborne7f97212011-02-24 14:40:20 -08006592 /** @hide */
6593 public boolean isExcludingStopped() {
6594 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6595 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6596 }
6597
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006598 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006599 * Retrieve the application package name this Intent is limited to. When
6600 * resolving an Intent, if non-null this limits the resolution to only
6601 * components in the given application package.
6602 *
6603 * @return The name of the application package for the Intent.
6604 *
6605 * @see #resolveActivity
6606 * @see #setPackage
6607 */
6608 public String getPackage() {
6609 return mPackage;
6610 }
6611
6612 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006613 * Retrieve the concrete component associated with the intent. When receiving
6614 * an intent, this is the component that was found to best handle it (that is,
6615 * yourself) and will always be non-null; in all other cases it will be
6616 * null unless explicitly set.
6617 *
6618 * @return The name of the application component to handle the intent.
6619 *
6620 * @see #resolveActivity
6621 * @see #setComponent
6622 */
6623 public ComponentName getComponent() {
6624 return mComponent;
6625 }
6626
6627 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006628 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6629 * used as a hint to the receiver for animations and the like. Null means that there
6630 * is no source bounds.
6631 */
6632 public Rect getSourceBounds() {
6633 return mSourceBounds;
6634 }
6635
6636 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006637 * Return the Activity component that should be used to handle this intent.
6638 * The appropriate component is determined based on the information in the
6639 * intent, evaluated as follows:
6640 *
6641 * <p>If {@link #getComponent} returns an explicit class, that is returned
6642 * without any further consideration.
6643 *
6644 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6645 * category to be considered.
6646 *
6647 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6648 * action.
6649 *
6650 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6651 * this type.
6652 *
6653 * <p>If {@link #addCategory} has added any categories, the activity must
6654 * handle ALL of the categories specified.
6655 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006656 * <p>If {@link #getPackage} is non-NULL, only activity components in
6657 * that application package will be considered.
6658 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006659 * <p>If there are no activities that satisfy all of these conditions, a
6660 * null string is returned.
6661 *
6662 * <p>If multiple activities are found to satisfy the intent, the one with
6663 * the highest priority will be used. If there are multiple activities
6664 * with the same priority, the system will either pick the best activity
6665 * based on user preference, or resolve to a system class that will allow
6666 * the user to pick an activity and forward from there.
6667 *
6668 * <p>This method is implemented simply by calling
6669 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6670 * true.</p>
6671 * <p> This API is called for you as part of starting an activity from an
6672 * intent. You do not normally need to call it yourself.</p>
6673 *
6674 * @param pm The package manager with which to resolve the Intent.
6675 *
6676 * @return Name of the component implementing an activity that can
6677 * display the intent.
6678 *
6679 * @see #setComponent
6680 * @see #getComponent
6681 * @see #resolveActivityInfo
6682 */
6683 public ComponentName resolveActivity(PackageManager pm) {
6684 if (mComponent != null) {
6685 return mComponent;
6686 }
6687
6688 ResolveInfo info = pm.resolveActivity(
6689 this, PackageManager.MATCH_DEFAULT_ONLY);
6690 if (info != null) {
6691 return new ComponentName(
6692 info.activityInfo.applicationInfo.packageName,
6693 info.activityInfo.name);
6694 }
6695
6696 return null;
6697 }
6698
6699 /**
6700 * Resolve the Intent into an {@link ActivityInfo}
6701 * describing the activity that should execute the intent. Resolution
6702 * follows the same rules as described for {@link #resolveActivity}, but
6703 * you get back the completely information about the resolved activity
6704 * instead of just its class name.
6705 *
6706 * @param pm The package manager with which to resolve the Intent.
6707 * @param flags Addition information to retrieve as per
6708 * {@link PackageManager#getActivityInfo(ComponentName, int)
6709 * PackageManager.getActivityInfo()}.
6710 *
6711 * @return PackageManager.ActivityInfo
6712 *
6713 * @see #resolveActivity
6714 */
6715 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6716 ActivityInfo ai = null;
6717 if (mComponent != null) {
6718 try {
6719 ai = pm.getActivityInfo(mComponent, flags);
6720 } catch (PackageManager.NameNotFoundException e) {
6721 // ignore
6722 }
6723 } else {
6724 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006725 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006726 if (info != null) {
6727 ai = info.activityInfo;
6728 }
6729 }
6730
6731 return ai;
6732 }
6733
6734 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006735 * Special function for use by the system to resolve service
6736 * intents to system apps. Throws an exception if there are
6737 * multiple potential matches to the Intent. Returns null if
6738 * there are no matches.
6739 * @hide
6740 */
6741 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6742 if (mComponent != null) {
6743 return mComponent;
6744 }
6745
6746 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6747 if (results == null) {
6748 return null;
6749 }
6750 ComponentName comp = null;
6751 for (int i=0; i<results.size(); i++) {
6752 ResolveInfo ri = results.get(i);
6753 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6754 continue;
6755 }
6756 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6757 ri.serviceInfo.name);
6758 if (comp != null) {
6759 throw new IllegalStateException("Multiple system services handle " + this
6760 + ": " + comp + ", " + foundComp);
6761 }
6762 comp = foundComp;
6763 }
6764 return comp;
6765 }
6766
6767 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006768 * Set the general action to be performed.
6769 *
6770 * @param action An action name, such as ACTION_VIEW. Application-specific
6771 * actions should be prefixed with the vendor's package name.
6772 *
6773 * @return Returns the same Intent object, for chaining multiple calls
6774 * into a single statement.
6775 *
6776 * @see #getAction
6777 */
6778 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006779 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006780 return this;
6781 }
6782
6783 /**
6784 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006785 * clears any type that was previously set by {@link #setType} or
6786 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006787 *
Nick Pellyccae4122012-01-09 14:12:58 -08006788 * <p><em>Note: scheme matching in the Android framework is
6789 * case-sensitive, unlike the formal RFC. As a result,
6790 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006791 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006792 * {@link #setDataAndNormalize}
6793 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006794 *
Nick Pellyccae4122012-01-09 14:12:58 -08006795 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006796 *
6797 * @return Returns the same Intent object, for chaining multiple calls
6798 * into a single statement.
6799 *
6800 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006801 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006802 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006803 */
6804 public Intent setData(Uri data) {
6805 mData = data;
6806 mType = null;
6807 return this;
6808 }
6809
6810 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006811 * Normalize and set the data this intent is operating on.
6812 *
6813 * <p>This method automatically clears any type that was
6814 * previously set (for example, by {@link #setType}).
6815 *
6816 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006817 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006818 * so really this is just a convenience method for
6819 * <pre>
6820 * setData(data.normalize())
6821 * </pre>
6822 *
6823 * @param data The Uri of the data this intent is now targeting.
6824 *
6825 * @return Returns the same Intent object, for chaining multiple calls
6826 * into a single statement.
6827 *
6828 * @see #getData
6829 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006830 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006831 */
6832 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006833 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006834 }
6835
6836 /**
6837 * Set an explicit MIME data type.
6838 *
6839 * <p>This is used to create intents that only specify a type and not data,
6840 * for example to indicate the type of data to return.
6841 *
6842 * <p>This method automatically clears any data that was
6843 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006844 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006845 * <p><em>Note: MIME type matching in the Android framework is
6846 * case-sensitive, unlike formal RFC MIME types. As a result,
6847 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006848 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6849 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006850 *
6851 * @param type The MIME type of the data being handled by this intent.
6852 *
6853 * @return Returns the same Intent object, for chaining multiple calls
6854 * into a single statement.
6855 *
6856 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006857 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006858 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006859 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006860 */
6861 public Intent setType(String type) {
6862 mData = null;
6863 mType = type;
6864 return this;
6865 }
6866
6867 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006868 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006869 *
Nick Pellyccae4122012-01-09 14:12:58 -08006870 * <p>This is used to create intents that only specify a type and not data,
6871 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006872 *
Nick Pellyccae4122012-01-09 14:12:58 -08006873 * <p>This method automatically clears any data that was
6874 * previously set (for example by {@link #setData}).
6875 *
6876 * <p>The MIME type is normalized using
6877 * {@link #normalizeMimeType} before it is set,
6878 * so really this is just a convenience method for
6879 * <pre>
6880 * setType(Intent.normalizeMimeType(type))
6881 * </pre>
6882 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006883 * @param type The MIME type of the data being handled by this intent.
6884 *
6885 * @return Returns the same Intent object, for chaining multiple calls
6886 * into a single statement.
6887 *
Nick Pellyccae4122012-01-09 14:12:58 -08006888 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006889 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006890 * @see #normalizeMimeType
6891 */
6892 public Intent setTypeAndNormalize(String type) {
6893 return setType(normalizeMimeType(type));
6894 }
6895
6896 /**
6897 * (Usually optional) Set the data for the intent along with an explicit
6898 * MIME data type. This method should very rarely be used -- it allows you
6899 * to override the MIME type that would ordinarily be inferred from the
6900 * data with your own type given here.
6901 *
6902 * <p><em>Note: MIME type and Uri scheme matching in the
6903 * Android framework is case-sensitive, unlike the formal RFC definitions.
6904 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006905 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006906 * {@link #setDataAndTypeAndNormalize}
6907 * to ensure that they are converted to lower case.</em>
6908 *
6909 * @param data The Uri of the data this intent is now targeting.
6910 * @param type The MIME type of the data being handled by this intent.
6911 *
6912 * @return Returns the same Intent object, for chaining multiple calls
6913 * into a single statement.
6914 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006915 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006916 * @see #setData
6917 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006918 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006919 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006920 */
6921 public Intent setDataAndType(Uri data, String type) {
6922 mData = data;
6923 mType = type;
6924 return this;
6925 }
6926
6927 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006928 * (Usually optional) Normalize and set both the data Uri and an explicit
6929 * MIME data type. This method should very rarely be used -- it allows you
6930 * to override the MIME type that would ordinarily be inferred from the
6931 * data with your own type given here.
6932 *
6933 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006934 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006935 * before they are set, so really this is just a convenience method for
6936 * <pre>
6937 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6938 * </pre>
6939 *
6940 * @param data The Uri of the data this intent is now targeting.
6941 * @param type The MIME type of the data being handled by this intent.
6942 *
6943 * @return Returns the same Intent object, for chaining multiple calls
6944 * into a single statement.
6945 *
6946 * @see #setType
6947 * @see #setData
6948 * @see #setDataAndType
6949 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006950 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006951 */
6952 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006953 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006954 }
6955
6956 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006957 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006958 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006959 * activities that provide <em>all</em> of the requested categories will be
6960 * used.
6961 *
6962 * @param category The desired category. This can be either one of the
6963 * predefined Intent categories, or a custom category in your own
6964 * namespace.
6965 *
6966 * @return Returns the same Intent object, for chaining multiple calls
6967 * into a single statement.
6968 *
6969 * @see #hasCategory
6970 * @see #removeCategory
6971 */
6972 public Intent addCategory(String category) {
6973 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006974 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006975 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006976 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006977 return this;
6978 }
6979
6980 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006981 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006982 *
6983 * @param category The category to remove.
6984 *
6985 * @see #addCategory
6986 */
6987 public void removeCategory(String category) {
6988 if (mCategories != null) {
6989 mCategories.remove(category);
6990 if (mCategories.size() == 0) {
6991 mCategories = null;
6992 }
6993 }
6994 }
6995
6996 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006997 * Set a selector for this Intent. This is a modification to the kinds of
6998 * things the Intent will match. If the selector is set, it will be used
6999 * when trying to find entities that can handle the Intent, instead of the
7000 * main contents of the Intent. This allows you build an Intent containing
7001 * a generic protocol while targeting it more specifically.
7002 *
7003 * <p>An example of where this may be used is with things like
7004 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7005 * Intent that will launch the Browser application. However, the correct
7006 * main entry point of an application is actually {@link #ACTION_MAIN}
7007 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7008 * used to specify the actual Activity to launch. If you launch the browser
7009 * with something different, undesired behavior may happen if the user has
7010 * previously or later launches it the normal way, since they do not match.
7011 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7012 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7013 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7014 *
7015 * <p>Setting a selector does not impact the behavior of
7016 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7017 * desired behavior of a selector -- it does not impact the base meaning
7018 * of the Intent, just what kinds of things will be matched against it
7019 * when determining who can handle it.</p>
7020 *
7021 * <p>You can not use both a selector and {@link #setPackage(String)} on
7022 * the same base Intent.</p>
7023 *
7024 * @param selector The desired selector Intent; set to null to not use
7025 * a special selector.
7026 */
7027 public void setSelector(Intent selector) {
7028 if (selector == this) {
7029 throw new IllegalArgumentException(
7030 "Intent being set as a selector of itself");
7031 }
7032 if (selector != null && mPackage != null) {
7033 throw new IllegalArgumentException(
7034 "Can't set selector when package name is already set");
7035 }
7036 mSelector = selector;
7037 }
7038
7039 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007040 * Set a {@link ClipData} associated with this Intent. This replaces any
7041 * previously set ClipData.
7042 *
7043 * <p>The ClipData in an intent is not used for Intent matching or other
7044 * such operations. Semantically it is like extras, used to transmit
7045 * additional data with the Intent. The main feature of using this over
7046 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7047 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7048 * items included in the clip data. This is useful, in particular, if
7049 * you want to transmit an Intent containing multiple <code>content:</code>
7050 * URIs for which the recipient may not have global permission to access the
7051 * content provider.
7052 *
7053 * <p>If the ClipData contains items that are themselves Intents, any
7054 * grant flags in those Intents will be ignored. Only the top-level flags
7055 * of the main Intent are respected, and will be applied to all Uri or
7056 * Intent items in the clip (or sub-items of the clip).
7057 *
7058 * <p>The MIME type, label, and icon in the ClipData object are not
7059 * directly used by Intent. Applications should generally rely on the
7060 * MIME type of the Intent itself, not what it may find in the ClipData.
7061 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007062 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007063 *
7064 * @param clip The new clip to set. May be null to clear the current clip.
7065 */
7066 public void setClipData(ClipData clip) {
7067 mClipData = clip;
7068 }
7069
7070 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007071 * This is NOT a secure mechanism to identify the user who sent the intent.
7072 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7073 * who sent the intent.
7074 * @hide
7075 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007076 public void prepareToLeaveUser(int userId) {
7077 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7078 // We want mContentUserHint to refer to the original user, so don't do anything.
7079 if (mContentUserHint == UserHandle.USER_CURRENT) {
7080 mContentUserHint = userId;
7081 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007082 }
7083
7084 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007085 * Add extended data to the intent. The name must include a package
7086 * prefix, for example the app com.android.contacts would use names
7087 * like "com.android.contacts.ShowAll".
7088 *
7089 * @param name The name of the extra data, with package prefix.
7090 * @param value The boolean data value.
7091 *
7092 * @return Returns the same Intent object, for chaining multiple calls
7093 * into a single statement.
7094 *
7095 * @see #putExtras
7096 * @see #removeExtra
7097 * @see #getBooleanExtra(String, boolean)
7098 */
7099 public Intent putExtra(String name, boolean value) {
7100 if (mExtras == null) {
7101 mExtras = new Bundle();
7102 }
7103 mExtras.putBoolean(name, value);
7104 return this;
7105 }
7106
7107 /**
7108 * Add extended data to the intent. The name must include a package
7109 * prefix, for example the app com.android.contacts would use names
7110 * like "com.android.contacts.ShowAll".
7111 *
7112 * @param name The name of the extra data, with package prefix.
7113 * @param value The byte data value.
7114 *
7115 * @return Returns the same Intent object, for chaining multiple calls
7116 * into a single statement.
7117 *
7118 * @see #putExtras
7119 * @see #removeExtra
7120 * @see #getByteExtra(String, byte)
7121 */
7122 public Intent putExtra(String name, byte value) {
7123 if (mExtras == null) {
7124 mExtras = new Bundle();
7125 }
7126 mExtras.putByte(name, value);
7127 return this;
7128 }
7129
7130 /**
7131 * Add extended data to the intent. The name must include a package
7132 * prefix, for example the app com.android.contacts would use names
7133 * like "com.android.contacts.ShowAll".
7134 *
7135 * @param name The name of the extra data, with package prefix.
7136 * @param value The char data value.
7137 *
7138 * @return Returns the same Intent object, for chaining multiple calls
7139 * into a single statement.
7140 *
7141 * @see #putExtras
7142 * @see #removeExtra
7143 * @see #getCharExtra(String, char)
7144 */
7145 public Intent putExtra(String name, char value) {
7146 if (mExtras == null) {
7147 mExtras = new Bundle();
7148 }
7149 mExtras.putChar(name, value);
7150 return this;
7151 }
7152
7153 /**
7154 * Add extended data to the intent. The name must include a package
7155 * prefix, for example the app com.android.contacts would use names
7156 * like "com.android.contacts.ShowAll".
7157 *
7158 * @param name The name of the extra data, with package prefix.
7159 * @param value The short data value.
7160 *
7161 * @return Returns the same Intent object, for chaining multiple calls
7162 * into a single statement.
7163 *
7164 * @see #putExtras
7165 * @see #removeExtra
7166 * @see #getShortExtra(String, short)
7167 */
7168 public Intent putExtra(String name, short value) {
7169 if (mExtras == null) {
7170 mExtras = new Bundle();
7171 }
7172 mExtras.putShort(name, value);
7173 return this;
7174 }
7175
7176 /**
7177 * Add extended data to the intent. The name must include a package
7178 * prefix, for example the app com.android.contacts would use names
7179 * like "com.android.contacts.ShowAll".
7180 *
7181 * @param name The name of the extra data, with package prefix.
7182 * @param value The integer data value.
7183 *
7184 * @return Returns the same Intent object, for chaining multiple calls
7185 * into a single statement.
7186 *
7187 * @see #putExtras
7188 * @see #removeExtra
7189 * @see #getIntExtra(String, int)
7190 */
7191 public Intent putExtra(String name, int value) {
7192 if (mExtras == null) {
7193 mExtras = new Bundle();
7194 }
7195 mExtras.putInt(name, value);
7196 return this;
7197 }
7198
7199 /**
7200 * Add extended data to the intent. The name must include a package
7201 * prefix, for example the app com.android.contacts would use names
7202 * like "com.android.contacts.ShowAll".
7203 *
7204 * @param name The name of the extra data, with package prefix.
7205 * @param value The long data value.
7206 *
7207 * @return Returns the same Intent object, for chaining multiple calls
7208 * into a single statement.
7209 *
7210 * @see #putExtras
7211 * @see #removeExtra
7212 * @see #getLongExtra(String, long)
7213 */
7214 public Intent putExtra(String name, long value) {
7215 if (mExtras == null) {
7216 mExtras = new Bundle();
7217 }
7218 mExtras.putLong(name, value);
7219 return this;
7220 }
7221
7222 /**
7223 * Add extended data to the intent. The name must include a package
7224 * prefix, for example the app com.android.contacts would use names
7225 * like "com.android.contacts.ShowAll".
7226 *
7227 * @param name The name of the extra data, with package prefix.
7228 * @param value The float data value.
7229 *
7230 * @return Returns the same Intent object, for chaining multiple calls
7231 * into a single statement.
7232 *
7233 * @see #putExtras
7234 * @see #removeExtra
7235 * @see #getFloatExtra(String, float)
7236 */
7237 public Intent putExtra(String name, float value) {
7238 if (mExtras == null) {
7239 mExtras = new Bundle();
7240 }
7241 mExtras.putFloat(name, value);
7242 return this;
7243 }
7244
7245 /**
7246 * Add extended data to the intent. The name must include a package
7247 * prefix, for example the app com.android.contacts would use names
7248 * like "com.android.contacts.ShowAll".
7249 *
7250 * @param name The name of the extra data, with package prefix.
7251 * @param value The double data value.
7252 *
7253 * @return Returns the same Intent object, for chaining multiple calls
7254 * into a single statement.
7255 *
7256 * @see #putExtras
7257 * @see #removeExtra
7258 * @see #getDoubleExtra(String, double)
7259 */
7260 public Intent putExtra(String name, double value) {
7261 if (mExtras == null) {
7262 mExtras = new Bundle();
7263 }
7264 mExtras.putDouble(name, value);
7265 return this;
7266 }
7267
7268 /**
7269 * Add extended data to the intent. The name must include a package
7270 * prefix, for example the app com.android.contacts would use names
7271 * like "com.android.contacts.ShowAll".
7272 *
7273 * @param name The name of the extra data, with package prefix.
7274 * @param value The String data value.
7275 *
7276 * @return Returns the same Intent object, for chaining multiple calls
7277 * into a single statement.
7278 *
7279 * @see #putExtras
7280 * @see #removeExtra
7281 * @see #getStringExtra(String)
7282 */
7283 public Intent putExtra(String name, String value) {
7284 if (mExtras == null) {
7285 mExtras = new Bundle();
7286 }
7287 mExtras.putString(name, value);
7288 return this;
7289 }
7290
7291 /**
7292 * Add extended data to the intent. The name must include a package
7293 * prefix, for example the app com.android.contacts would use names
7294 * like "com.android.contacts.ShowAll".
7295 *
7296 * @param name The name of the extra data, with package prefix.
7297 * @param value The CharSequence data value.
7298 *
7299 * @return Returns the same Intent object, for chaining multiple calls
7300 * into a single statement.
7301 *
7302 * @see #putExtras
7303 * @see #removeExtra
7304 * @see #getCharSequenceExtra(String)
7305 */
7306 public Intent putExtra(String name, CharSequence value) {
7307 if (mExtras == null) {
7308 mExtras = new Bundle();
7309 }
7310 mExtras.putCharSequence(name, value);
7311 return this;
7312 }
7313
7314 /**
7315 * Add extended data to the intent. The name must include a package
7316 * prefix, for example the app com.android.contacts would use names
7317 * like "com.android.contacts.ShowAll".
7318 *
7319 * @param name The name of the extra data, with package prefix.
7320 * @param value The Parcelable data value.
7321 *
7322 * @return Returns the same Intent object, for chaining multiple calls
7323 * into a single statement.
7324 *
7325 * @see #putExtras
7326 * @see #removeExtra
7327 * @see #getParcelableExtra(String)
7328 */
7329 public Intent putExtra(String name, Parcelable value) {
7330 if (mExtras == null) {
7331 mExtras = new Bundle();
7332 }
7333 mExtras.putParcelable(name, value);
7334 return this;
7335 }
7336
7337 /**
7338 * Add extended data to the intent. The name must include a package
7339 * prefix, for example the app com.android.contacts would use names
7340 * like "com.android.contacts.ShowAll".
7341 *
7342 * @param name The name of the extra data, with package prefix.
7343 * @param value The Parcelable[] data value.
7344 *
7345 * @return Returns the same Intent object, for chaining multiple calls
7346 * into a single statement.
7347 *
7348 * @see #putExtras
7349 * @see #removeExtra
7350 * @see #getParcelableArrayExtra(String)
7351 */
7352 public Intent putExtra(String name, Parcelable[] value) {
7353 if (mExtras == null) {
7354 mExtras = new Bundle();
7355 }
7356 mExtras.putParcelableArray(name, value);
7357 return this;
7358 }
7359
7360 /**
7361 * Add extended data to the intent. The name must include a package
7362 * prefix, for example the app com.android.contacts would use names
7363 * like "com.android.contacts.ShowAll".
7364 *
7365 * @param name The name of the extra data, with package prefix.
7366 * @param value The ArrayList<Parcelable> data value.
7367 *
7368 * @return Returns the same Intent object, for chaining multiple calls
7369 * into a single statement.
7370 *
7371 * @see #putExtras
7372 * @see #removeExtra
7373 * @see #getParcelableArrayListExtra(String)
7374 */
7375 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7376 if (mExtras == null) {
7377 mExtras = new Bundle();
7378 }
7379 mExtras.putParcelableArrayList(name, value);
7380 return this;
7381 }
7382
7383 /**
7384 * Add extended data to the intent. The name must include a package
7385 * prefix, for example the app com.android.contacts would use names
7386 * like "com.android.contacts.ShowAll".
7387 *
7388 * @param name The name of the extra data, with package prefix.
7389 * @param value The ArrayList<Integer> data value.
7390 *
7391 * @return Returns the same Intent object, for chaining multiple calls
7392 * into a single statement.
7393 *
7394 * @see #putExtras
7395 * @see #removeExtra
7396 * @see #getIntegerArrayListExtra(String)
7397 */
7398 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7399 if (mExtras == null) {
7400 mExtras = new Bundle();
7401 }
7402 mExtras.putIntegerArrayList(name, value);
7403 return this;
7404 }
7405
7406 /**
7407 * Add extended data to the intent. The name must include a package
7408 * prefix, for example the app com.android.contacts would use names
7409 * like "com.android.contacts.ShowAll".
7410 *
7411 * @param name The name of the extra data, with package prefix.
7412 * @param value The ArrayList<String> data value.
7413 *
7414 * @return Returns the same Intent object, for chaining multiple calls
7415 * into a single statement.
7416 *
7417 * @see #putExtras
7418 * @see #removeExtra
7419 * @see #getStringArrayListExtra(String)
7420 */
7421 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7422 if (mExtras == null) {
7423 mExtras = new Bundle();
7424 }
7425 mExtras.putStringArrayList(name, value);
7426 return this;
7427 }
7428
7429 /**
7430 * Add extended data to the intent. The name must include a package
7431 * prefix, for example the app com.android.contacts would use names
7432 * like "com.android.contacts.ShowAll".
7433 *
7434 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007435 * @param value The ArrayList<CharSequence> data value.
7436 *
7437 * @return Returns the same Intent object, for chaining multiple calls
7438 * into a single statement.
7439 *
7440 * @see #putExtras
7441 * @see #removeExtra
7442 * @see #getCharSequenceArrayListExtra(String)
7443 */
7444 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7445 if (mExtras == null) {
7446 mExtras = new Bundle();
7447 }
7448 mExtras.putCharSequenceArrayList(name, value);
7449 return this;
7450 }
7451
7452 /**
7453 * Add extended data to the intent. The name must include a package
7454 * prefix, for example the app com.android.contacts would use names
7455 * like "com.android.contacts.ShowAll".
7456 *
7457 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007458 * @param value The Serializable data value.
7459 *
7460 * @return Returns the same Intent object, for chaining multiple calls
7461 * into a single statement.
7462 *
7463 * @see #putExtras
7464 * @see #removeExtra
7465 * @see #getSerializableExtra(String)
7466 */
7467 public Intent putExtra(String name, Serializable value) {
7468 if (mExtras == null) {
7469 mExtras = new Bundle();
7470 }
7471 mExtras.putSerializable(name, value);
7472 return this;
7473 }
7474
7475 /**
7476 * Add extended data to the intent. The name must include a package
7477 * prefix, for example the app com.android.contacts would use names
7478 * like "com.android.contacts.ShowAll".
7479 *
7480 * @param name The name of the extra data, with package prefix.
7481 * @param value The boolean array data value.
7482 *
7483 * @return Returns the same Intent object, for chaining multiple calls
7484 * into a single statement.
7485 *
7486 * @see #putExtras
7487 * @see #removeExtra
7488 * @see #getBooleanArrayExtra(String)
7489 */
7490 public Intent putExtra(String name, boolean[] value) {
7491 if (mExtras == null) {
7492 mExtras = new Bundle();
7493 }
7494 mExtras.putBooleanArray(name, value);
7495 return this;
7496 }
7497
7498 /**
7499 * Add extended data to the intent. The name must include a package
7500 * prefix, for example the app com.android.contacts would use names
7501 * like "com.android.contacts.ShowAll".
7502 *
7503 * @param name The name of the extra data, with package prefix.
7504 * @param value The byte array data value.
7505 *
7506 * @return Returns the same Intent object, for chaining multiple calls
7507 * into a single statement.
7508 *
7509 * @see #putExtras
7510 * @see #removeExtra
7511 * @see #getByteArrayExtra(String)
7512 */
7513 public Intent putExtra(String name, byte[] value) {
7514 if (mExtras == null) {
7515 mExtras = new Bundle();
7516 }
7517 mExtras.putByteArray(name, value);
7518 return this;
7519 }
7520
7521 /**
7522 * Add extended data to the intent. The name must include a package
7523 * prefix, for example the app com.android.contacts would use names
7524 * like "com.android.contacts.ShowAll".
7525 *
7526 * @param name The name of the extra data, with package prefix.
7527 * @param value The short array data value.
7528 *
7529 * @return Returns the same Intent object, for chaining multiple calls
7530 * into a single statement.
7531 *
7532 * @see #putExtras
7533 * @see #removeExtra
7534 * @see #getShortArrayExtra(String)
7535 */
7536 public Intent putExtra(String name, short[] value) {
7537 if (mExtras == null) {
7538 mExtras = new Bundle();
7539 }
7540 mExtras.putShortArray(name, value);
7541 return this;
7542 }
7543
7544 /**
7545 * Add extended data to the intent. The name must include a package
7546 * prefix, for example the app com.android.contacts would use names
7547 * like "com.android.contacts.ShowAll".
7548 *
7549 * @param name The name of the extra data, with package prefix.
7550 * @param value The char array data value.
7551 *
7552 * @return Returns the same Intent object, for chaining multiple calls
7553 * into a single statement.
7554 *
7555 * @see #putExtras
7556 * @see #removeExtra
7557 * @see #getCharArrayExtra(String)
7558 */
7559 public Intent putExtra(String name, char[] value) {
7560 if (mExtras == null) {
7561 mExtras = new Bundle();
7562 }
7563 mExtras.putCharArray(name, value);
7564 return this;
7565 }
7566
7567 /**
7568 * Add extended data to the intent. The name must include a package
7569 * prefix, for example the app com.android.contacts would use names
7570 * like "com.android.contacts.ShowAll".
7571 *
7572 * @param name The name of the extra data, with package prefix.
7573 * @param value The int array data value.
7574 *
7575 * @return Returns the same Intent object, for chaining multiple calls
7576 * into a single statement.
7577 *
7578 * @see #putExtras
7579 * @see #removeExtra
7580 * @see #getIntArrayExtra(String)
7581 */
7582 public Intent putExtra(String name, int[] value) {
7583 if (mExtras == null) {
7584 mExtras = new Bundle();
7585 }
7586 mExtras.putIntArray(name, value);
7587 return this;
7588 }
7589
7590 /**
7591 * Add extended data to the intent. The name must include a package
7592 * prefix, for example the app com.android.contacts would use names
7593 * like "com.android.contacts.ShowAll".
7594 *
7595 * @param name The name of the extra data, with package prefix.
7596 * @param value The byte array data value.
7597 *
7598 * @return Returns the same Intent object, for chaining multiple calls
7599 * into a single statement.
7600 *
7601 * @see #putExtras
7602 * @see #removeExtra
7603 * @see #getLongArrayExtra(String)
7604 */
7605 public Intent putExtra(String name, long[] value) {
7606 if (mExtras == null) {
7607 mExtras = new Bundle();
7608 }
7609 mExtras.putLongArray(name, value);
7610 return this;
7611 }
7612
7613 /**
7614 * Add extended data to the intent. The name must include a package
7615 * prefix, for example the app com.android.contacts would use names
7616 * like "com.android.contacts.ShowAll".
7617 *
7618 * @param name The name of the extra data, with package prefix.
7619 * @param value The float array data value.
7620 *
7621 * @return Returns the same Intent object, for chaining multiple calls
7622 * into a single statement.
7623 *
7624 * @see #putExtras
7625 * @see #removeExtra
7626 * @see #getFloatArrayExtra(String)
7627 */
7628 public Intent putExtra(String name, float[] value) {
7629 if (mExtras == null) {
7630 mExtras = new Bundle();
7631 }
7632 mExtras.putFloatArray(name, value);
7633 return this;
7634 }
7635
7636 /**
7637 * Add extended data to the intent. The name must include a package
7638 * prefix, for example the app com.android.contacts would use names
7639 * like "com.android.contacts.ShowAll".
7640 *
7641 * @param name The name of the extra data, with package prefix.
7642 * @param value The double array data value.
7643 *
7644 * @return Returns the same Intent object, for chaining multiple calls
7645 * into a single statement.
7646 *
7647 * @see #putExtras
7648 * @see #removeExtra
7649 * @see #getDoubleArrayExtra(String)
7650 */
7651 public Intent putExtra(String name, double[] value) {
7652 if (mExtras == null) {
7653 mExtras = new Bundle();
7654 }
7655 mExtras.putDoubleArray(name, value);
7656 return this;
7657 }
7658
7659 /**
7660 * Add extended data to the intent. The name must include a package
7661 * prefix, for example the app com.android.contacts would use names
7662 * like "com.android.contacts.ShowAll".
7663 *
7664 * @param name The name of the extra data, with package prefix.
7665 * @param value The String array data value.
7666 *
7667 * @return Returns the same Intent object, for chaining multiple calls
7668 * into a single statement.
7669 *
7670 * @see #putExtras
7671 * @see #removeExtra
7672 * @see #getStringArrayExtra(String)
7673 */
7674 public Intent putExtra(String name, String[] value) {
7675 if (mExtras == null) {
7676 mExtras = new Bundle();
7677 }
7678 mExtras.putStringArray(name, value);
7679 return this;
7680 }
7681
7682 /**
7683 * Add extended data to the intent. The name must include a package
7684 * prefix, for example the app com.android.contacts would use names
7685 * like "com.android.contacts.ShowAll".
7686 *
7687 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007688 * @param value The CharSequence array data value.
7689 *
7690 * @return Returns the same Intent object, for chaining multiple calls
7691 * into a single statement.
7692 *
7693 * @see #putExtras
7694 * @see #removeExtra
7695 * @see #getCharSequenceArrayExtra(String)
7696 */
7697 public Intent putExtra(String name, CharSequence[] value) {
7698 if (mExtras == null) {
7699 mExtras = new Bundle();
7700 }
7701 mExtras.putCharSequenceArray(name, value);
7702 return this;
7703 }
7704
7705 /**
7706 * Add extended data to the intent. The name must include a package
7707 * prefix, for example the app com.android.contacts would use names
7708 * like "com.android.contacts.ShowAll".
7709 *
7710 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007711 * @param value The Bundle data value.
7712 *
7713 * @return Returns the same Intent object, for chaining multiple calls
7714 * into a single statement.
7715 *
7716 * @see #putExtras
7717 * @see #removeExtra
7718 * @see #getBundleExtra(String)
7719 */
7720 public Intent putExtra(String name, Bundle value) {
7721 if (mExtras == null) {
7722 mExtras = new Bundle();
7723 }
7724 mExtras.putBundle(name, value);
7725 return this;
7726 }
7727
7728 /**
7729 * Add extended data to the intent. The name must include a package
7730 * prefix, for example the app com.android.contacts would use names
7731 * like "com.android.contacts.ShowAll".
7732 *
7733 * @param name The name of the extra data, with package prefix.
7734 * @param value The IBinder data value.
7735 *
7736 * @return Returns the same Intent object, for chaining multiple calls
7737 * into a single statement.
7738 *
7739 * @see #putExtras
7740 * @see #removeExtra
7741 * @see #getIBinderExtra(String)
7742 *
7743 * @deprecated
7744 * @hide
7745 */
7746 @Deprecated
7747 public Intent putExtra(String name, IBinder value) {
7748 if (mExtras == null) {
7749 mExtras = new Bundle();
7750 }
7751 mExtras.putIBinder(name, value);
7752 return this;
7753 }
7754
7755 /**
7756 * Copy all extras in 'src' in to this intent.
7757 *
7758 * @param src Contains the extras to copy.
7759 *
7760 * @see #putExtra
7761 */
7762 public Intent putExtras(Intent src) {
7763 if (src.mExtras != null) {
7764 if (mExtras == null) {
7765 mExtras = new Bundle(src.mExtras);
7766 } else {
7767 mExtras.putAll(src.mExtras);
7768 }
7769 }
7770 return this;
7771 }
7772
7773 /**
7774 * Add a set of extended data to the intent. The keys must include a package
7775 * prefix, for example the app com.android.contacts would use names
7776 * like "com.android.contacts.ShowAll".
7777 *
7778 * @param extras The Bundle of extras to add to this intent.
7779 *
7780 * @see #putExtra
7781 * @see #removeExtra
7782 */
7783 public Intent putExtras(Bundle extras) {
7784 if (mExtras == null) {
7785 mExtras = new Bundle();
7786 }
7787 mExtras.putAll(extras);
7788 return this;
7789 }
7790
7791 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007792 * Completely replace the extras in the Intent with the extras in the
7793 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007794 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007795 * @param src The exact extras contained in this Intent are copied
7796 * into the target intent, replacing any that were previously there.
7797 */
7798 public Intent replaceExtras(Intent src) {
7799 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7800 return this;
7801 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007802
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007803 /**
7804 * Completely replace the extras in the Intent with the given Bundle of
7805 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007806 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007807 * @param extras The new set of extras in the Intent, or null to erase
7808 * all extras.
7809 */
7810 public Intent replaceExtras(Bundle extras) {
7811 mExtras = extras != null ? new Bundle(extras) : null;
7812 return this;
7813 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007814
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007815 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007816 * Remove extended data from the intent.
7817 *
7818 * @see #putExtra
7819 */
7820 public void removeExtra(String name) {
7821 if (mExtras != null) {
7822 mExtras.remove(name);
7823 if (mExtras.size() == 0) {
7824 mExtras = null;
7825 }
7826 }
7827 }
7828
7829 /**
7830 * Set special flags controlling how this intent is handled. Most values
7831 * here depend on the type of component being executed by the Intent,
7832 * specifically the FLAG_ACTIVITY_* flags are all for use with
7833 * {@link Context#startActivity Context.startActivity()} and the
7834 * FLAG_RECEIVER_* flags are all for use with
7835 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7836 *
Scott Main7aee61f2011-02-08 11:25:01 -08007837 * <p>See the
7838 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7839 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007840 * the behavior of your application.
7841 *
7842 * @param flags The desired flags.
7843 *
7844 * @return Returns the same Intent object, for chaining multiple calls
7845 * into a single statement.
7846 *
7847 * @see #getFlags
7848 * @see #addFlags
7849 *
7850 * @see #FLAG_GRANT_READ_URI_PERMISSION
7851 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007852 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7853 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007854 * @see #FLAG_DEBUG_LOG_RESOLUTION
7855 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007856 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007857 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007858 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007859 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007860 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7861 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007862 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007863 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007864 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007865 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007866 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007867 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007868 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007869 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7870 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007871 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007872 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007873 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007874 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7875 */
7876 public Intent setFlags(int flags) {
7877 mFlags = flags;
7878 return this;
7879 }
7880
7881 /**
7882 * Add additional flags to the intent (or with existing flags
7883 * value).
7884 *
7885 * @param flags The new flags to set.
7886 *
7887 * @return Returns the same Intent object, for chaining multiple calls
7888 * into a single statement.
7889 *
7890 * @see #setFlags
7891 */
7892 public Intent addFlags(int flags) {
7893 mFlags |= flags;
7894 return this;
7895 }
7896
7897 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007898 * (Usually optional) Set an explicit application package name that limits
7899 * the components this Intent will resolve to. If left to the default
7900 * value of null, all components in all applications will considered.
7901 * If non-null, the Intent can only match the components in the given
7902 * application package.
7903 *
7904 * @param packageName The name of the application package to handle the
7905 * intent, or null to allow any application package.
7906 *
7907 * @return Returns the same Intent object, for chaining multiple calls
7908 * into a single statement.
7909 *
7910 * @see #getPackage
7911 * @see #resolveActivity
7912 */
7913 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007914 if (packageName != null && mSelector != null) {
7915 throw new IllegalArgumentException(
7916 "Can't set package name when selector is already set");
7917 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007918 mPackage = packageName;
7919 return this;
7920 }
7921
7922 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007923 * (Usually optional) Explicitly set the component to handle the intent.
7924 * If left with the default value of null, the system will determine the
7925 * appropriate class to use based on the other fields (action, data,
7926 * type, categories) in the Intent. If this class is defined, the
7927 * specified class will always be used regardless of the other fields. You
7928 * should only set this value when you know you absolutely want a specific
7929 * class to be used; otherwise it is better to let the system find the
7930 * appropriate class so that you will respect the installed applications
7931 * and user preferences.
7932 *
7933 * @param component The name of the application component to handle the
7934 * intent, or null to let the system find one for you.
7935 *
7936 * @return Returns the same Intent object, for chaining multiple calls
7937 * into a single statement.
7938 *
7939 * @see #setClass
7940 * @see #setClassName(Context, String)
7941 * @see #setClassName(String, String)
7942 * @see #getComponent
7943 * @see #resolveActivity
7944 */
7945 public Intent setComponent(ComponentName component) {
7946 mComponent = component;
7947 return this;
7948 }
7949
7950 /**
7951 * Convenience for calling {@link #setComponent} with an
7952 * explicit class name.
7953 *
7954 * @param packageContext A Context of the application package implementing
7955 * this class.
7956 * @param className The name of a class inside of the application package
7957 * that will be used as the component for this Intent.
7958 *
7959 * @return Returns the same Intent object, for chaining multiple calls
7960 * into a single statement.
7961 *
7962 * @see #setComponent
7963 * @see #setClass
7964 */
7965 public Intent setClassName(Context packageContext, String className) {
7966 mComponent = new ComponentName(packageContext, className);
7967 return this;
7968 }
7969
7970 /**
7971 * Convenience for calling {@link #setComponent} with an
7972 * explicit application package name and class name.
7973 *
7974 * @param packageName The name of the package implementing the desired
7975 * component.
7976 * @param className The name of a class inside of the application package
7977 * that will be used as the component for this Intent.
7978 *
7979 * @return Returns the same Intent object, for chaining multiple calls
7980 * into a single statement.
7981 *
7982 * @see #setComponent
7983 * @see #setClass
7984 */
7985 public Intent setClassName(String packageName, String className) {
7986 mComponent = new ComponentName(packageName, className);
7987 return this;
7988 }
7989
7990 /**
7991 * Convenience for calling {@link #setComponent(ComponentName)} with the
7992 * name returned by a {@link Class} object.
7993 *
7994 * @param packageContext A Context of the application package implementing
7995 * this class.
7996 * @param cls The class name to set, equivalent to
7997 * <code>setClassName(context, cls.getName())</code>.
7998 *
7999 * @return Returns the same Intent object, for chaining multiple calls
8000 * into a single statement.
8001 *
8002 * @see #setComponent
8003 */
8004 public Intent setClass(Context packageContext, Class<?> cls) {
8005 mComponent = new ComponentName(packageContext, cls);
8006 return this;
8007 }
8008
8009 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008010 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8011 * used as a hint to the receiver for animations and the like. Null means that there
8012 * is no source bounds.
8013 */
8014 public void setSourceBounds(Rect r) {
8015 if (r != null) {
8016 mSourceBounds = new Rect(r);
8017 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008018 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008019 }
8020 }
8021
Tor Norbyed9273d62013-05-30 15:59:53 -07008022 /** @hide */
8023 @IntDef(flag = true,
8024 value = {
8025 FILL_IN_ACTION,
8026 FILL_IN_DATA,
8027 FILL_IN_CATEGORIES,
8028 FILL_IN_COMPONENT,
8029 FILL_IN_PACKAGE,
8030 FILL_IN_SOURCE_BOUNDS,
8031 FILL_IN_SELECTOR,
8032 FILL_IN_CLIP_DATA
8033 })
8034 @Retention(RetentionPolicy.SOURCE)
8035 public @interface FillInFlags {}
8036
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008037 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008038 * Use with {@link #fillIn} to allow the current action value to be
8039 * overwritten, even if it is already set.
8040 */
8041 public static final int FILL_IN_ACTION = 1<<0;
8042
8043 /**
8044 * Use with {@link #fillIn} to allow the current data or type value
8045 * overwritten, even if it is already set.
8046 */
8047 public static final int FILL_IN_DATA = 1<<1;
8048
8049 /**
8050 * Use with {@link #fillIn} to allow the current categories to be
8051 * overwritten, even if they are already set.
8052 */
8053 public static final int FILL_IN_CATEGORIES = 1<<2;
8054
8055 /**
8056 * Use with {@link #fillIn} to allow the current component value to be
8057 * overwritten, even if it is already set.
8058 */
8059 public static final int FILL_IN_COMPONENT = 1<<3;
8060
8061 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008062 * Use with {@link #fillIn} to allow the current package value to be
8063 * overwritten, even if it is already set.
8064 */
8065 public static final int FILL_IN_PACKAGE = 1<<4;
8066
8067 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008068 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008069 * overwritten, even if it is already set.
8070 */
8071 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8072
8073 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008074 * Use with {@link #fillIn} to allow the current selector to be
8075 * overwritten, even if it is already set.
8076 */
8077 public static final int FILL_IN_SELECTOR = 1<<6;
8078
8079 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008080 * Use with {@link #fillIn} to allow the current ClipData to be
8081 * overwritten, even if it is already set.
8082 */
8083 public static final int FILL_IN_CLIP_DATA = 1<<7;
8084
8085 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008086 * Copy the contents of <var>other</var> in to this object, but only
8087 * where fields are not defined by this object. For purposes of a field
8088 * being defined, the following pieces of data in the Intent are
8089 * considered to be separate fields:
8090 *
8091 * <ul>
8092 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008093 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008094 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8095 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008096 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008097 * <li> component, as set by {@link #setComponent(ComponentName)} or
8098 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008099 * <li> source bounds, as set by {@link #setSourceBounds}.
8100 * <li> selector, as set by {@link #setSelector(Intent)}.
8101 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008102 * <li> each top-level name in the associated extras.
8103 * </ul>
8104 *
8105 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008106 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008107 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8108 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8109 * the restriction where the corresponding field will not be replaced if
8110 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008111 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008112 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8113 * is explicitly specified. The selector will only be copied if
8114 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008115 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008116 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8117 * and Intent B with {action="gotit", data-type="some/thing",
8118 * categories="one","two"}.
8119 *
8120 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8121 * containing: {action="gotit", data-type="some/thing",
8122 * categories="bar"}.
8123 *
8124 * @param other Another Intent whose values are to be used to fill in
8125 * the current one.
8126 * @param flags Options to control which fields can be filled in.
8127 *
8128 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008129 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008130 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8131 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8132 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008133 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008134 @FillInFlags
8135 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008136 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008137 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008138 if (other.mAction != null
8139 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008140 mAction = other.mAction;
8141 changes |= FILL_IN_ACTION;
8142 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008143 if ((other.mData != null || other.mType != null)
8144 && ((mData == null && mType == null)
8145 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008146 mData = other.mData;
8147 mType = other.mType;
8148 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008149 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008150 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008151 if (other.mCategories != null
8152 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008153 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008154 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008155 }
8156 changes |= FILL_IN_CATEGORIES;
8157 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008158 if (other.mPackage != null
8159 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008160 // Only do this if mSelector is not set.
8161 if (mSelector == null) {
8162 mPackage = other.mPackage;
8163 changes |= FILL_IN_PACKAGE;
8164 }
8165 }
8166 // Selector is special: it can only be set if explicitly allowed,
8167 // for the same reason as the component name.
8168 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8169 if (mPackage == null) {
8170 mSelector = new Intent(other.mSelector);
8171 mPackage = null;
8172 changes |= FILL_IN_SELECTOR;
8173 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008174 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008175 if (other.mClipData != null
8176 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8177 mClipData = other.mClipData;
8178 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008179 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008180 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008181 // Component is special: it can -only- be set if explicitly allowed,
8182 // since otherwise the sender could force the intent somewhere the
8183 // originator didn't intend.
8184 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008185 mComponent = other.mComponent;
8186 changes |= FILL_IN_COMPONENT;
8187 }
8188 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008189 if (other.mSourceBounds != null
8190 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8191 mSourceBounds = new Rect(other.mSourceBounds);
8192 changes |= FILL_IN_SOURCE_BOUNDS;
8193 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008194 if (mExtras == null) {
8195 if (other.mExtras != null) {
8196 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008197 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008198 }
8199 } else if (other.mExtras != null) {
8200 try {
8201 Bundle newb = new Bundle(other.mExtras);
8202 newb.putAll(mExtras);
8203 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008204 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008205 } catch (RuntimeException e) {
8206 // Modifying the extras can cause us to unparcel the contents
8207 // of the bundle, and if we do this in the system process that
8208 // may fail. We really should handle this (i.e., the Bundle
8209 // impl shouldn't be on top of a plain map), but for now just
8210 // ignore it and keep the original contents. :(
8211 Log.w("Intent", "Failure filling in extras", e);
8212 }
8213 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008214 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8215 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8216 mContentUserHint = other.mContentUserHint;
8217 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008218 return changes;
8219 }
8220
8221 /**
8222 * Wrapper class holding an Intent and implementing comparisons on it for
8223 * the purpose of filtering. The class implements its
8224 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8225 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8226 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8227 * on the wrapped Intent.
8228 */
8229 public static final class FilterComparison {
8230 private final Intent mIntent;
8231 private final int mHashCode;
8232
8233 public FilterComparison(Intent intent) {
8234 mIntent = intent;
8235 mHashCode = intent.filterHashCode();
8236 }
8237
8238 /**
8239 * Return the Intent that this FilterComparison represents.
8240 * @return Returns the Intent held by the FilterComparison. Do
8241 * not modify!
8242 */
8243 public Intent getIntent() {
8244 return mIntent;
8245 }
8246
8247 @Override
8248 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008249 if (obj instanceof FilterComparison) {
8250 Intent other = ((FilterComparison)obj).mIntent;
8251 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008252 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008253 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008254 }
8255
8256 @Override
8257 public int hashCode() {
8258 return mHashCode;
8259 }
8260 }
8261
8262 /**
8263 * Determine if two intents are the same for the purposes of intent
8264 * resolution (filtering). That is, if their action, data, type,
8265 * class, and categories are the same. This does <em>not</em> compare
8266 * any extra data included in the intents.
8267 *
8268 * @param other The other Intent to compare against.
8269 *
8270 * @return Returns true if action, data, type, class, and categories
8271 * are the same.
8272 */
8273 public boolean filterEquals(Intent other) {
8274 if (other == null) {
8275 return false;
8276 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008277 if (!Objects.equals(this.mAction, other.mAction)) return false;
8278 if (!Objects.equals(this.mData, other.mData)) return false;
8279 if (!Objects.equals(this.mType, other.mType)) return false;
8280 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8281 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8282 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008283
8284 return true;
8285 }
8286
8287 /**
8288 * Generate hash code that matches semantics of filterEquals().
8289 *
8290 * @return Returns the hash value of the action, data, type, class, and
8291 * categories.
8292 *
8293 * @see #filterEquals
8294 */
8295 public int filterHashCode() {
8296 int code = 0;
8297 if (mAction != null) {
8298 code += mAction.hashCode();
8299 }
8300 if (mData != null) {
8301 code += mData.hashCode();
8302 }
8303 if (mType != null) {
8304 code += mType.hashCode();
8305 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008306 if (mPackage != null) {
8307 code += mPackage.hashCode();
8308 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008309 if (mComponent != null) {
8310 code += mComponent.hashCode();
8311 }
8312 if (mCategories != null) {
8313 code += mCategories.hashCode();
8314 }
8315 return code;
8316 }
8317
8318 @Override
8319 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008320 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008321
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008322 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008323 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008324 b.append(" }");
8325
8326 return b.toString();
8327 }
8328
8329 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008330 public String toInsecureString() {
8331 StringBuilder b = new StringBuilder(128);
8332
8333 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008334 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008335 b.append(" }");
8336
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008337 return b.toString();
8338 }
Romain Guy4969af72009-06-17 10:53:19 -07008339
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008340 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008341 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008342 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008343
8344 b.append("Intent { ");
8345 toShortString(b, false, true, true, true);
8346 b.append(" }");
8347
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008348 return b.toString();
8349 }
8350
8351 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008352 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8353 StringBuilder b = new StringBuilder(128);
8354 toShortString(b, secure, comp, extras, clip);
8355 return b.toString();
8356 }
8357
8358 /** @hide */
8359 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8360 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008361 boolean first = true;
8362 if (mAction != null) {
8363 b.append("act=").append(mAction);
8364 first = false;
8365 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008366 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008367 if (!first) {
8368 b.append(' ');
8369 }
8370 first = false;
8371 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008372 for (int i=0; i<mCategories.size(); i++) {
8373 if (i > 0) b.append(',');
8374 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008375 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008376 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008377 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008378 if (mData != null) {
8379 if (!first) {
8380 b.append(' ');
8381 }
8382 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008383 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008384 if (secure) {
8385 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008386 } else {
8387 b.append(mData);
8388 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008389 }
8390 if (mType != null) {
8391 if (!first) {
8392 b.append(' ');
8393 }
8394 first = false;
8395 b.append("typ=").append(mType);
8396 }
8397 if (mFlags != 0) {
8398 if (!first) {
8399 b.append(' ');
8400 }
8401 first = false;
8402 b.append("flg=0x").append(Integer.toHexString(mFlags));
8403 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008404 if (mPackage != null) {
8405 if (!first) {
8406 b.append(' ');
8407 }
8408 first = false;
8409 b.append("pkg=").append(mPackage);
8410 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008411 if (comp && mComponent != null) {
8412 if (!first) {
8413 b.append(' ');
8414 }
8415 first = false;
8416 b.append("cmp=").append(mComponent.flattenToShortString());
8417 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008418 if (mSourceBounds != null) {
8419 if (!first) {
8420 b.append(' ');
8421 }
8422 first = false;
8423 b.append("bnds=").append(mSourceBounds.toShortString());
8424 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008425 if (mClipData != null) {
8426 if (!first) {
8427 b.append(' ');
8428 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008429 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008430 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008431 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008432 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008433 if (mClipData.getDescription() != null) {
8434 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8435 } else {
8436 first = true;
8437 }
8438 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008439 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008440 first = false;
8441 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008442 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008443 if (extras && mExtras != null) {
8444 if (!first) {
8445 b.append(' ');
8446 }
8447 first = false;
8448 b.append("(has extras)");
8449 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008450 if (mContentUserHint != UserHandle.USER_CURRENT) {
8451 if (!first) {
8452 b.append(' ');
8453 }
8454 first = false;
8455 b.append("u=").append(mContentUserHint);
8456 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008457 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008458 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008459 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008460 b.append("}");
8461 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008462 }
8463
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008464 /**
8465 * Call {@link #toUri} with 0 flags.
8466 * @deprecated Use {@link #toUri} instead.
8467 */
8468 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008469 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008470 return toUri(0);
8471 }
8472
8473 /**
8474 * Convert this Intent into a String holding a URI representation of it.
8475 * The returned URI string has been properly URI encoded, so it can be
8476 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8477 * Intent's data as the base URI, with an additional fragment describing
8478 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008479 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008480 * <p>You can convert the returned string back to an Intent with
8481 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008482 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008483 * @param flags Additional operating flags. Either 0,
8484 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008485 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008486 * @return Returns a URI encoding URI string describing the entire contents
8487 * of the Intent.
8488 */
8489 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008490 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008491 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8492 if (mPackage == null) {
8493 throw new IllegalArgumentException(
8494 "Intent must include an explicit package name to build an android-app: "
8495 + this);
8496 }
8497 uri.append("android-app://");
8498 uri.append(mPackage);
8499 String scheme = null;
8500 if (mData != null) {
8501 scheme = mData.getScheme();
8502 if (scheme != null) {
8503 uri.append('/');
8504 uri.append(scheme);
8505 String authority = mData.getEncodedAuthority();
8506 if (authority != null) {
8507 uri.append('/');
8508 uri.append(authority);
8509 String path = mData.getEncodedPath();
8510 if (path != null) {
8511 uri.append(path);
8512 }
8513 String queryParams = mData.getEncodedQuery();
8514 if (queryParams != null) {
8515 uri.append('?');
8516 uri.append(queryParams);
8517 }
8518 String fragment = mData.getEncodedFragment();
8519 if (fragment != null) {
8520 uri.append('#');
8521 uri.append(fragment);
8522 }
8523 }
8524 }
8525 }
8526 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8527 mPackage, flags);
8528 return uri.toString();
8529 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008530 String scheme = null;
8531 if (mData != null) {
8532 String data = mData.toString();
8533 if ((flags&URI_INTENT_SCHEME) != 0) {
8534 final int N = data.length();
8535 for (int i=0; i<N; i++) {
8536 char c = data.charAt(i);
8537 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8538 || c == '.' || c == '-') {
8539 continue;
8540 }
8541 if (c == ':' && i > 0) {
8542 // Valid scheme.
8543 scheme = data.substring(0, i);
8544 uri.append("intent:");
8545 data = data.substring(i+1);
8546 break;
8547 }
Tom Taylord4a47292009-12-21 13:59:18 -08008548
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008549 // No scheme.
8550 break;
8551 }
8552 }
8553 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008554
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008555 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8556 uri.append("intent:");
8557 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008558
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008559 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008560
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008561 return uri.toString();
8562 }
8563
8564 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8565 String defPackage, int flags) {
8566 StringBuilder frag = new StringBuilder(128);
8567
8568 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008569 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008570 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008571 // Note that for now we are not going to try to handle the
8572 // data part; not clear how to represent this as a URI, and
8573 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008574 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8575 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008576 }
8577
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008578 if (frag.length() > 0) {
8579 uri.append("#Intent;");
8580 uri.append(frag);
8581 uri.append("end");
8582 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008583 }
8584
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008585 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8586 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008587 if (scheme != null) {
8588 uri.append("scheme=").append(scheme).append(';');
8589 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008590 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008591 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008592 }
8593 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008594 for (int i=0; i<mCategories.size(); i++) {
8595 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008596 }
8597 }
8598 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008599 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008600 }
8601 if (mFlags != 0) {
8602 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8603 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008604 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008605 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8606 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008607 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008608 uri.append("component=").append(Uri.encode(
8609 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008610 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008611 if (mSourceBounds != null) {
8612 uri.append("sourceBounds=")
8613 .append(Uri.encode(mSourceBounds.flattenToString()))
8614 .append(';');
8615 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008616 if (mExtras != null) {
8617 for (String key : mExtras.keySet()) {
8618 final Object value = mExtras.get(key);
8619 char entryType =
8620 value instanceof String ? 'S' :
8621 value instanceof Boolean ? 'B' :
8622 value instanceof Byte ? 'b' :
8623 value instanceof Character ? 'c' :
8624 value instanceof Double ? 'd' :
8625 value instanceof Float ? 'f' :
8626 value instanceof Integer ? 'i' :
8627 value instanceof Long ? 'l' :
8628 value instanceof Short ? 's' :
8629 '\0';
8630
8631 if (entryType != '\0') {
8632 uri.append(entryType);
8633 uri.append('.');
8634 uri.append(Uri.encode(key));
8635 uri.append('=');
8636 uri.append(Uri.encode(value.toString()));
8637 uri.append(';');
8638 }
8639 }
8640 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008641 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008642
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008643 public int describeContents() {
8644 return (mExtras != null) ? mExtras.describeContents() : 0;
8645 }
8646
8647 public void writeToParcel(Parcel out, int flags) {
8648 out.writeString(mAction);
8649 Uri.writeToParcel(out, mData);
8650 out.writeString(mType);
8651 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008652 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008653 ComponentName.writeToParcel(mComponent, out);
8654
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008655 if (mSourceBounds != null) {
8656 out.writeInt(1);
8657 mSourceBounds.writeToParcel(out, flags);
8658 } else {
8659 out.writeInt(0);
8660 }
8661
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008662 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008663 final int N = mCategories.size();
8664 out.writeInt(N);
8665 for (int i=0; i<N; i++) {
8666 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008667 }
8668 } else {
8669 out.writeInt(0);
8670 }
8671
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008672 if (mSelector != null) {
8673 out.writeInt(1);
8674 mSelector.writeToParcel(out, flags);
8675 } else {
8676 out.writeInt(0);
8677 }
8678
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008679 if (mClipData != null) {
8680 out.writeInt(1);
8681 mClipData.writeToParcel(out, flags);
8682 } else {
8683 out.writeInt(0);
8684 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008685 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008686 out.writeBundle(mExtras);
8687 }
8688
8689 public static final Parcelable.Creator<Intent> CREATOR
8690 = new Parcelable.Creator<Intent>() {
8691 public Intent createFromParcel(Parcel in) {
8692 return new Intent(in);
8693 }
8694 public Intent[] newArray(int size) {
8695 return new Intent[size];
8696 }
8697 };
8698
Dianne Hackborneb034652009-09-07 00:49:58 -07008699 /** @hide */
8700 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008701 readFromParcel(in);
8702 }
8703
8704 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008705 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008706 mData = Uri.CREATOR.createFromParcel(in);
8707 mType = in.readString();
8708 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008709 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008710 mComponent = ComponentName.readFromParcel(in);
8711
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008712 if (in.readInt() != 0) {
8713 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8714 }
8715
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008716 int N = in.readInt();
8717 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008718 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008719 int i;
8720 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008721 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008722 }
8723 } else {
8724 mCategories = null;
8725 }
8726
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008727 if (in.readInt() != 0) {
8728 mSelector = new Intent(in);
8729 }
8730
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008731 if (in.readInt() != 0) {
8732 mClipData = new ClipData(in);
8733 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008734 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008735 mExtras = in.readBundle();
8736 }
8737
8738 /**
8739 * Parses the "intent" element (and its children) from XML and instantiates
8740 * an Intent object. The given XML parser should be located at the tag
8741 * where parsing should start (often named "intent"), from which the
8742 * basic action, data, type, and package and class name will be
8743 * retrieved. The function will then parse in to any child elements,
8744 * looking for <category android:name="xxx"> tags to add categories and
8745 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8746 * to the intent.
8747 *
8748 * @param resources The Resources to use when inflating resources.
8749 * @param parser The XML parser pointing at an "intent" tag.
8750 * @param attrs The AttributeSet interface for retrieving extended
8751 * attribute data at the current <var>parser</var> location.
8752 * @return An Intent object matching the XML data.
8753 * @throws XmlPullParserException If there was an XML parsing error.
8754 * @throws IOException If there was an I/O error.
8755 */
8756 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8757 throws XmlPullParserException, IOException {
8758 Intent intent = new Intent();
8759
8760 TypedArray sa = resources.obtainAttributes(attrs,
8761 com.android.internal.R.styleable.Intent);
8762
8763 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8764
8765 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8766 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8767 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8768
8769 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8770 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8771 if (packageName != null && className != null) {
8772 intent.setComponent(new ComponentName(packageName, className));
8773 }
8774
8775 sa.recycle();
8776
8777 int outerDepth = parser.getDepth();
8778 int type;
8779 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8780 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8781 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8782 continue;
8783 }
8784
8785 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008786 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008787 sa = resources.obtainAttributes(attrs,
8788 com.android.internal.R.styleable.IntentCategory);
8789 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8790 sa.recycle();
8791
8792 if (cat != null) {
8793 intent.addCategory(cat);
8794 }
8795 XmlUtils.skipCurrentTag(parser);
8796
Craig Mautner21d24a22014-04-23 11:45:37 -07008797 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008798 if (intent.mExtras == null) {
8799 intent.mExtras = new Bundle();
8800 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008801 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008802 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008803
8804 } else {
8805 XmlUtils.skipCurrentTag(parser);
8806 }
8807 }
8808
8809 return intent;
8810 }
Nick Pellyccae4122012-01-09 14:12:58 -08008811
Craig Mautner21d24a22014-04-23 11:45:37 -07008812 /** @hide */
8813 public void saveToXml(XmlSerializer out) throws IOException {
8814 if (mAction != null) {
8815 out.attribute(null, ATTR_ACTION, mAction);
8816 }
8817 if (mData != null) {
8818 out.attribute(null, ATTR_DATA, mData.toString());
8819 }
8820 if (mType != null) {
8821 out.attribute(null, ATTR_TYPE, mType);
8822 }
8823 if (mComponent != null) {
8824 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8825 }
8826 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8827
8828 if (mCategories != null) {
8829 out.startTag(null, TAG_CATEGORIES);
8830 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8831 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8832 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008833 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008834 }
8835 }
8836
8837 /** @hide */
8838 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8839 XmlPullParserException {
8840 Intent intent = new Intent();
8841 final int outerDepth = in.getDepth();
8842
8843 int attrCount = in.getAttributeCount();
8844 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8845 final String attrName = in.getAttributeName(attrNdx);
8846 final String attrValue = in.getAttributeValue(attrNdx);
8847 if (ATTR_ACTION.equals(attrName)) {
8848 intent.setAction(attrValue);
8849 } else if (ATTR_DATA.equals(attrName)) {
8850 intent.setData(Uri.parse(attrValue));
8851 } else if (ATTR_TYPE.equals(attrName)) {
8852 intent.setType(attrValue);
8853 } else if (ATTR_COMPONENT.equals(attrName)) {
8854 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8855 } else if (ATTR_FLAGS.equals(attrName)) {
8856 intent.setFlags(Integer.valueOf(attrValue, 16));
8857 } else {
8858 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8859 }
8860 }
8861
8862 int event;
8863 String name;
8864 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8865 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8866 if (event == XmlPullParser.START_TAG) {
8867 name = in.getName();
8868 if (TAG_CATEGORIES.equals(name)) {
8869 attrCount = in.getAttributeCount();
8870 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8871 intent.addCategory(in.getAttributeValue(attrNdx));
8872 }
8873 } else {
8874 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8875 XmlUtils.skipCurrentTag(in);
8876 }
8877 }
8878 }
8879
8880 return intent;
8881 }
8882
Nick Pellyccae4122012-01-09 14:12:58 -08008883 /**
8884 * Normalize a MIME data type.
8885 *
8886 * <p>A normalized MIME type has white-space trimmed,
8887 * content-type parameters removed, and is lower-case.
8888 * This aligns the type with Android best practices for
8889 * intent filtering.
8890 *
8891 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8892 * "text/x-vCard" becomes "text/x-vcard".
8893 *
8894 * <p>All MIME types received from outside Android (such as user input,
8895 * or external sources like Bluetooth, NFC, or the Internet) should
8896 * be normalized before they are used to create an Intent.
8897 *
8898 * @param type MIME data type to normalize
8899 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008900 * @see #setType
8901 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008902 */
8903 public static String normalizeMimeType(String type) {
8904 if (type == null) {
8905 return null;
8906 }
8907
Elliott Hughescb64d432013-08-02 10:00:44 -07008908 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008909
8910 final int semicolonIndex = type.indexOf(';');
8911 if (semicolonIndex != -1) {
8912 type = type.substring(0, semicolonIndex);
8913 }
8914 return type;
8915 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008916
8917 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008918 * Prepare this {@link Intent} to leave an app process.
8919 *
8920 * @hide
8921 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07008922 public void prepareToLeaveProcess(Context context) {
8923 final boolean leavingPackage = (mComponent == null)
8924 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
8925 prepareToLeaveProcess(leavingPackage);
8926 }
8927
8928 /**
8929 * Prepare this {@link Intent} to leave an app process.
8930 *
8931 * @hide
8932 */
8933 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008934 setAllowFds(false);
8935
8936 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008937 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008938 }
8939 if (mClipData != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008940 mClipData.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008941 }
8942
Jeff Sharkeya8b42782016-01-30 17:58:09 -07008943 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
8944 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008945 switch (mAction) {
8946 case ACTION_MEDIA_REMOVED:
8947 case ACTION_MEDIA_UNMOUNTED:
8948 case ACTION_MEDIA_CHECKING:
8949 case ACTION_MEDIA_NOFS:
8950 case ACTION_MEDIA_MOUNTED:
8951 case ACTION_MEDIA_SHARED:
8952 case ACTION_MEDIA_UNSHARED:
8953 case ACTION_MEDIA_BAD_REMOVAL:
8954 case ACTION_MEDIA_UNMOUNTABLE:
8955 case ACTION_MEDIA_EJECT:
8956 case ACTION_MEDIA_SCANNER_STARTED:
8957 case ACTION_MEDIA_SCANNER_FINISHED:
8958 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07008959 case ACTION_PACKAGE_NEEDS_VERIFICATION:
8960 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07008961 // Ignore legacy actions
8962 break;
8963 default:
8964 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008965 }
8966 }
8967 }
8968
8969 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008970 * @hide
8971 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008972 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07008973 // We just entered destination process, so we should be able to read all
8974 // parcelables inside.
8975 setDefusable(true);
8976
8977 if (mSelector != null) {
8978 mSelector.prepareToEnterProcess();
8979 }
8980 if (mClipData != null) {
8981 mClipData.prepareToEnterProcess();
8982 }
8983
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008984 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008985 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8986 fixUris(mContentUserHint);
8987 mContentUserHint = UserHandle.USER_CURRENT;
8988 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008989 }
8990 }
8991
8992 /**
8993 * @hide
8994 */
8995 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008996 Uri data = getData();
8997 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008998 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008999 }
9000 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009001 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009002 }
9003 String action = getAction();
9004 if (ACTION_SEND.equals(action)) {
9005 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9006 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009007 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009008 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009009 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009010 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9011 if (streams != null) {
9012 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9013 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009014 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009015 }
9016 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9017 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009018 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9019 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9020 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9021 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9022 if (output != null) {
9023 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9024 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009025 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009026 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009027
9028 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009029 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009030 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9031 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009032 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009033 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009034 * @hide
9035 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009036 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009037 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009038 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009039
9040 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009041 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009042
9043 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009044 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009045 // Inspect contained intents to see if we need to migrate extras. We
9046 // don't promote ClipData to the parent, since ChooserActivity will
9047 // already start the picked item as the caller, and we can't combine
9048 // the flags in a safe way.
9049
9050 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009051 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009052 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9053 if (intent != null) {
9054 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009055 }
9056 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009057 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009058 try {
9059 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9060 if (intents != null) {
9061 for (int i = 0; i < intents.length; i++) {
9062 final Intent intent = (Intent) intents[i];
9063 if (intent != null) {
9064 migrated |= intent.migrateExtraStreamToClipData();
9065 }
9066 }
9067 }
9068 } catch (ClassCastException e) {
9069 }
9070 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009071
9072 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009073 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009074 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9075 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9076 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9077 if (stream != null || text != null || htmlText != null) {
9078 final ClipData clipData = new ClipData(
9079 null, new String[] { getType() },
9080 new ClipData.Item(text, htmlText, null, stream));
9081 setClipData(clipData);
9082 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009083 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009084 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009085 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009086 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009087
9088 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009089 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009090 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9091 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9092 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9093 int num = -1;
9094 if (streams != null) {
9095 num = streams.size();
9096 }
9097 if (texts != null) {
9098 if (num >= 0 && num != texts.size()) {
9099 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009100 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009101 }
9102 num = texts.size();
9103 }
9104 if (htmlTexts != null) {
9105 if (num >= 0 && num != htmlTexts.size()) {
9106 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009107 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009108 }
9109 num = htmlTexts.size();
9110 }
9111 if (num > 0) {
9112 final ClipData clipData = new ClipData(
9113 null, new String[] { getType() },
9114 makeClipItem(streams, texts, htmlTexts, 0));
9115
9116 for (int i = 1; i < num; i++) {
9117 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9118 }
9119
9120 setClipData(clipData);
9121 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009122 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009123 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009124 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009125 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009126 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9127 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9128 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9129 final Uri output;
9130 try {
9131 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9132 } catch (ClassCastException e) {
9133 return false;
9134 }
9135 if (output != null) {
9136 setClipData(ClipData.newRawUri("", output));
9137 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9138 return true;
9139 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009140 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009141
9142 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009143 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009144
9145 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9146 ArrayList<String> htmlTexts, int which) {
9147 Uri uri = streams != null ? streams.get(which) : null;
9148 CharSequence text = texts != null ? texts.get(which) : null;
9149 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9150 return new ClipData.Item(text, htmlText, null, uri);
9151 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009152
9153 /** @hide */
9154 public boolean isDocument() {
9155 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9156 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009157}